Class LLM

LLM Base Class

Hierarchy (View Summary)

LLM

Constructors

constructor

new LLM(input?: Options | Input, options?: Options): LLM
Parameters
- Optionalinput: Options | Input
- options: Options = {}
Returns LLM
- Defined in LLM.ts:47

Properties

baseUrl

baseUrl: string

extended

extended: boolean

`Optional`json

json?: boolean

`Optional`max_thinking_tokens

max_thinking_tokens?: number

max_tokens

max_tokens: number

messages

messages: Message[]

model

model: string

modelUsage

modelUsage: ModelUsage

options

options: Options

`Optional`parser

parser?: ParserResponse

qualityFilter

qualityFilter: QualityFilter

service

service: string

stream

stream: boolean

`Optional`temperature

temperature?: number

think

think: boolean

`Optional`tools

tools?: Tool[]

`Static`DEFAULT_BASE_URL

DEFAULT_BASE_URL: string

`Static`DEFAULT_MODEL

DEFAULT_MODEL: string

`Static`isBearerAuth

isBearerAuth: boolean = false

`Static`isLocal

isLocal: boolean = false

`Static`MessageExtendedContentInputKey

MessageExtendedContentInputKey: string = "text"

`Static`parsers

parsers: parsers = parsers

`Static` `Readonly`service

service: string

Accessors

apiKey

get apiKey(): undefined | null | string
Returns undefined | null | string
- Defined in LLM.ts:76

chatUrl

get chatUrl(): string
Returns string
- Defined in LLM.ts:108

isLocal

get isLocal(): boolean
Returns boolean
- Defined in LLM.ts:75

llmHeaders

get llmHeaders(): Record<string, string>
Returns Record<string, string>
- Defined in LLM.ts:99

llmOptions

get llmOptions(): Options
Returns Options
- Defined in LLM.ts:85

modelsUrl

get modelsUrl(): string
Returns string
- Defined in LLM.ts:109

parsers

get parsers(): Parsers
Returns Parsers
- Defined in LLM.ts:112

Methods

abort

abort(): void
Returns void
- Defined in LLM.ts:141

addMessage

addMessage(role: MessageRole, content: any): void
Parameters
- role: MessageRole
- content: any
Returns void
- Defined in LLM.ts:121

assistant

assistant(content: string): void
Parameters
- content: string
Returns void
- Defined in LLM.ts:130

chat

chat(
    input: string,
    options?: Options,
): Promise<
    | string
    | Response
    | PartialStreamResponse
    | AsyncGenerator<string, any, any>,
>
Parameters
- input: string
- Optionaloptions: Options
Returns Promise<
    | string
    | Response
    | PartialStreamResponse
    | AsyncGenerator<string, any, any>,
>
- Defined in LLM.ts:135

fetchModels

fetchModels(): Promise<Model[]>
Returns Promise<Model[]>
- Defined in LLM.ts:337

filterQualityModel

filterQualityModel(model: Model): boolean
Parameters
- model: Model
Returns boolean
- Defined in LLM.ts:403

getChatUrl

getChatUrl(opts: Options): string
Parameters
- opts: Options
Returns string
- Defined in LLM.ts:110

getDefaultModelUsage

getDefaultModelUsage(model: Model): ModelUsageType
Parameters
- model: Model
Returns ModelUsageType
- Defined in LLM.ts:355

getModels

getModels(quality_filter?: QualityFilter): Promise<Model[]>
Parameters
- quality_filter: QualityFilter = {}
Returns Promise<Model[]>
- Defined in LLM.ts:377

getModelsUrl

getModelsUrl(): string
Returns string
- Defined in LLM.ts:111

getQualityModels

getQualityModels(): Promise<Model[]>
Returns Promise<Model[]>
- Defined in LLM.ts:407

parseAttachment

parseAttachment(attachment: Attachment): any
Parameters
- attachment: Attachment
Returns any
- Defined in LLM.ts:446

parseAttachmentsContent

parseAttachmentsContent(content: any): any[]
Parameters
- content: any
Returns any[]
- Defined in LLM.ts:439

parseContent

parseContent(data: any): string
Parameters
- data: any
Returns string
- Defined in LLM.ts:415

parseContentChunk

parseContentChunk(chunk: any): string
Parameters
- chunk: any
Returns string
- Defined in LLM.ts:418

parseMessages

parseMessages(messages: Message[]): Message[]
Parameters
- messages: Message[]
Returns Message[]
- Defined in LLM.ts:422

parseModel

parseModel(model: any): Model
Parameters
- model: any
Returns Model
- Defined in LLM.ts:421

parseOptions

parseOptions(options: Options): Options
Parameters
- options: Options
Returns Options
- Defined in LLM.ts:450

parseThinking

parseThinking(data: any): string
Parameters
- data: any
Returns string
- Defined in LLM.ts:419

parseThinkingChunk

parseThinkingChunk(chunk: any): string
Parameters
- chunk: any
Returns string
- Defined in LLM.ts:420

parseTokenUsage

parseTokenUsage(usage: any): null | InputOutputTokens
Parameters
- usage: any
Returns null | InputOutputTokens
- Defined in LLM.ts:454

parseTools

parseTools(data: any): ToolCall[]
Parameters
- data: any
Returns ToolCall[]
- Defined in LLM.ts:416

parseToolsChunk

parseToolsChunk(chunk: any): ToolCall[]
Parameters
- chunk: any
Returns ToolCall[]
- Defined in LLM.ts:417

parseUsage

parseUsage(tokenUsage: InputOutputTokens): Usage
Parameters
- tokenUsage: InputOutputTokens
Returns Usage
- Defined in LLM.ts:455

refreshModelUsage

refreshModelUsage(): Promise<void>
Returns Promise<void>
- Defined in LLM.ts:411

response

response(data: any): string
Parameters
- data: any
Returns string
- Defined in LLM.ts:188

send

send(
    options?: Options,
): Promise<
    | string
    | Response
    | PartialStreamResponse
    | AsyncGenerator<string, any, any>,
>
Parameters
- Optionaloptions: Options
Returns Promise<
    | string
    | Response
    | PartialStreamResponse
    | AsyncGenerator<string, any, any>,
>
- Defined in LLM.ts:147

system

system(content: string): void
Parameters
- content: string
Returns void
- Defined in LLM.ts:131

thinking

thinking(content: string): void
Parameters
- content: string
Returns void
- Defined in LLM.ts:132

toolCall

toolCall(tool: ToolCall): void
Parameters
- tool: ToolCall
Returns void
- Defined in LLM.ts:133

user

user(content: string, attachments?: Attachment[]): void
Parameters
- content: string
- Optionalattachments: Attachment[]
Returns void
- Defined in LLM.ts:122

verifyConnection

verifyConnection(): Promise<boolean>
Returns Promise<boolean>
- Defined in LLM.ts:353