Class xAI

Hierarchy (View Summary)

APIv1
- xAI

Constructors

constructor

new xAI(input?: Options | Input, options?: Options): xAI
Parameters
- Optionalinput: Options | Input
- options: Options = {}
Returns xAI
Inherited from APIv1.constructor
- 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 = "https://api.x.ai/v1/"

`Static`DEFAULT_MODEL

DEFAULT_MODEL: string = "grok-3"

`Static`isBearerAuth

isBearerAuth: boolean = true

`Static`isLocal

isLocal: boolean = false

`Static`KEY_REASONING_CONTENT

KEY_REASONING_CONTENT: string = "reasoning_content"

`Static`MessageExtendedContentInputKey

MessageExtendedContentInputKey: string = "text"

`Static`parsers

parsers: parsers = parsers

`Static` `Readonly`service

service: string = "xai"

Accessors

apiKey

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

chatUrl

get chatUrl(): string
Returns string
Inherited from APIv1.chatUrl
- Defined in APIv1.ts:29

isLocal

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

llmHeaders

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

llmOptions

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

modelsUrl

get modelsUrl(): string
Returns string
Inherited from APIv1.modelsUrl
- Defined in APIv1.ts:30

parsers

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

Methods

abort

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

addMessage

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

assistant

assistant(content: string): void
Parameters
- content: string
Returns void
Inherited from APIv1.assistant
- 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>,
>
Inherited from APIv1.chat
- Defined in LLM.ts:135

fetchModels

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

filterQualityModel

filterQualityModel(model: Model): boolean
Parameters
- model: Model
Returns boolean
Inherited from APIv1.filterQualityModel
- Defined in APIv1.ts:105

getChatUrl

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

getDefaultModelUsage

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

getModels

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

getModelsUrl

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

getQualityModels

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

parseAttachment

parseAttachment(
attachment: Attachment,
): { image_url: { detail: string; url: string }; type: string }
Parameters
- attachment: Attachment
Returns { image_url: { detail: string; url: string }; type: string }
Inherited from APIv1.parseAttachment
- Defined in APIv1.ts:110

parseAttachmentsContent

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

parseContent

parseContent(data: any): string
Parameters
- data: any
Returns string
Inherited from APIv1.parseContent
- Defined in APIv1.ts:49

parseContentChunk

parseContentChunk(data: any): string
Parameters
- data: any
Returns string
Inherited from APIv1.parseContentChunk
- Defined in APIv1.ts:57

parseMessages

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

parseModel

parseModel(model: any): Model
Parameters
- model: any
Returns Model
Inherited from APIv1.parseModel
- Defined in APIv1.ts:90

parseOptions

parseOptions(options: APIv1Options): APIv1Options
Parameters
- options: APIv1Options
Returns APIv1Options
Inherited from APIv1.parseOptions
- Defined in APIv1.ts:32

parseThinking

parseThinking(data: any): string
Parameters
- data: any
Returns string
Inherited from APIv1.parseThinking
- Defined in APIv1.ts:66

parseThinkingChunk

parseThinkingChunk(data: any): string
Parameters
- data: any
Returns string
Inherited from APIv1.parseThinkingChunk
- Defined in APIv1.ts:72

parseTokenUsage

parseTokenUsage(data: any): null | { input_tokens: any; output_tokens: any }
Parameters
- data: any
Returns null | { input_tokens: any; output_tokens: any }
Inherited from APIv1.parseTokenUsage
- Defined in APIv1.ts:78

parseTools

parseTools(data: any): ToolCall[]
Parameters
- data: any
Returns ToolCall[]
Inherited from APIv1.parseTools
- Defined in APIv1.ts:95

parseToolsChunk

parseToolsChunk(data: any): ToolCall[]
Parameters
- data: any
Returns ToolCall[]
Inherited from APIv1.parseToolsChunk
- Defined in APIv1.ts:100

parseUsage

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

refreshModelUsage

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

response

response(data: any): string
Parameters
- data: any
Returns string
Inherited from APIv1.response
- 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>,
>
Inherited from APIv1.send
- Defined in LLM.ts:147

system

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

thinking

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

toolCall

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

user

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

verifyConnection

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

Class xAI

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns xAI

Properties

baseUrl

extended

Optionaljson

Optionalmax_thinking_tokens

max_tokens

messages

model

modelUsage

options

Optionalparser

qualityFilter

service

stream

Optionaltemperature

think

Optionaltools

StaticDEFAULT_BASE_URL

StaticDEFAULT_MODEL

StaticisBearerAuth

StaticisLocal

StaticKEY_REASONING_CONTENT

StaticMessageExtendedContentInputKey

Staticparsers

Static Readonlyservice

Accessors

apiKey

Returns undefined | null | string

chatUrl

Returns string

isLocal

Returns boolean

llmHeaders

Returns Record<string, string>

llmOptions

Returns Options

modelsUrl

Returns string

parsers

Returns Parsers

Methods

abort

Returns void

addMessage

Parameters

Returns void

assistant

Parameters

Returns void

chat

Parameters

Returns Promise< | string | Response | PartialStreamResponse | AsyncGenerator<string, any, any>,>

fetchModels

Returns Promise<Model[]>

filterQualityModel

Parameters

Returns boolean

getChatUrl

Parameters

Returns string

getDefaultModelUsage

Parameters

Returns ModelUsageType

getModels

Parameters

Returns Promise<Model[]>

getModelsUrl

Returns string

getQualityModels

`Optional`json

`Optional`max_thinking_tokens

`Optional`parser

`Optional`temperature

`Optional`tools

`Static`DEFAULT_BASE_URL

`Static`DEFAULT_MODEL

`Static`isBearerAuth

`Static`isLocal

`Static`KEY_REASONING_CONTENT

`Static`MessageExtendedContentInputKey

`Static`parsers

`Static` `Readonly`service

Returns Promise<
| string
| Response
| PartialStreamResponse
| AsyncGenerator<string, any, any>,
>

Returns Promise<
| string
| Response
| PartialStreamResponse
| AsyncGenerator<string, any, any>,
>