Skip to main content

Class: XaiAssistant

Defined in: packages/core/src/llm/grok.ts:16

XAi Grok Assistant LLM for Client only

Extends​

Properties​

llm​

llm: null | LanguageModelV1 = null

Defined in: packages/core/src/llm/vercelai-client.ts:78

Language model instance

Inherited from​

VercelAiClient.llm

Methods​

addAdditionalContext()​

addAdditionalContext(props): Promise<void>

Defined in: packages/core/src/llm/assistant.ts:86

Add additional context to the conversation, so LLM can understand the context better

Parameters​

props​
callback?​

() => void

context​

string

Returns​

Promise<void>

Inherited from​

VercelAiClient.addAdditionalContext

audioToText()​

audioToText(params): Promise<string>

Defined in: packages/core/src/llm/vercelai-client.ts:483

Converts audio to text using the configured LLM

Parameters​

params​

AudioToTextProps

Audio conversion parameters

Returns​

Promise<string>

Transcribed text

Throws​

If LLM is not configured or audio blob is missing

Inherited from​

VercelAiClient.audioToText

close()​

close(): Promise<void>

Defined in: packages/core/src/llm/assistant.ts:30

Close the LLM instance

Returns​

Promise<void>

Inherited from​

VercelAiClient.close

getComponents()​

getComponents(): ToolCallComponents

Defined in: packages/core/src/llm/vercelai.ts:230

Returns​

ToolCallComponents

Inherited from​

VercelAiClient.getComponents

getMessages()​

getMessages(): AIMessage[]

Defined in: packages/core/src/llm/vercelai.ts:222

Returns​

AIMessage[]

Inherited from​

VercelAiClient.getMessages

processImageMessage()​

processImageMessage(__namedParameters): Promise<void>

Defined in: packages/core/src/llm/vercelai.ts:277

Process image message

Parameters​

__namedParameters​

ProcessImageMessageProps

Returns​

Promise<void>

Inherited from​

VercelAiClient.processImageMessage

processTextMessage()​

processTextMessage(__namedParameters): Promise<{ messages: AIMessage[]; }>

Defined in: packages/core/src/llm/vercelai.ts:299

Process the text message by sending it to the LLM.

Parameters​

__namedParameters​

ProcessMessageProps

Returns​

Promise<{ messages: AIMessage[]; }>

Promise containing the newly added message

Inherited from​

VercelAiClient.processTextMessage

restart()​

restart(): void

Defined in: packages/core/src/llm/grok.ts:87

Restarts the chat by clearing messages and resetting the LLM instance

Returns​

void

Overrides​

VercelAiClient.restart

setAbortController()​

setAbortController(abortController): void

Defined in: packages/core/src/llm/vercelai.ts:255

Parameters​

abortController​

AbortController

Returns​

void

Inherited from​

VercelAiClient.setAbortController

setMessages()​

setMessages(messages): void

Defined in: packages/core/src/llm/vercelai.ts:226

Parameters​

messages​

Message[]

Returns​

void

Inherited from​

VercelAiClient.setMessages

stop()​

stop(): void

Defined in: packages/core/src/llm/vercelai.ts:259

Stop processing

Returns​

void

Inherited from​

VercelAiClient.stop

translateVoiceToText()​

translateVoiceToText(audioBlob): Promise<string>

Defined in: packages/core/src/llm/assistant.ts:58

Voice to text

Parameters​

audioBlob​

Blob

Returns​

Promise<string>

Inherited from​

VercelAiClient.translateVoiceToText

configure()​

static configure(config): void

Defined in: packages/core/src/llm/grok.ts:26

Configures the client with the provided settings

Parameters​

config​

VercelAiClientConfigureProps

Configuration options

Returns​

void

Overrides​

VercelAiClient.configure

getBaseURL()​

abstract static getBaseURL(): string

Defined in: packages/core/src/llm/grok.ts:22

Gets the base URL for API requests

Returns​

string

Throws​

Always throws as this is an abstract class

Overrides​

VercelAiClient.getBaseURL

getInstance()​

static getInstance(): Promise<XaiAssistant>

Defined in: packages/core/src/llm/grok.ts:74

Get instance using singleton pattern

Returns​

Promise<XaiAssistant>

Overrides​

VercelAiClient.getInstance

registerFunctionCalling()​

static registerFunctionCalling(__namedParameters): void

Defined in: packages/core/src/llm/vercelai.ts:190

Register custom function for function calling

Parameters​

__namedParameters​

RegisterFunctionCallingProps

Returns​

void

Inherited from​

VercelAiClient.registerFunctionCalling

testConnection()​

static testConnection(apiKey, model): Promise<boolean>

Defined in: packages/core/src/llm/grok.ts:41

Test connection

Parameters​

apiKey​

string

model​

string

Returns​

Promise<boolean>

Overrides​

VercelAiClient.testConnection