Skip to main content

Class: abstract VercelAiClient

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

Abstract Vercel AI Client for client-side usage. Extends the VercelAi class to handle LLM interactions directly from the browser using Vercel AI SDK instead of API endpoints.

Extends​

Extended by​

Properties​

llm​

llm: null | LanguageModelV1 = null

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

Language model instance

Methods​

addMessage()​

addMessage(message): void

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

Parameters​

message​

CoreMessage

Returns​

void

Inherited from​

VercelAi.addMessage

audioToText()​

audioToText(params): Promise<string>

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

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

Overrides​

VercelAi.audioToText

close()​

close(): Promise<void>

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

Close the LLM instance

Returns​

Promise<void>

Inherited from​

VercelAi.close

getComponents()​

getComponents(): ToolCallComponents

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

Returns​

ToolCallComponents

Inherited from​

VercelAi.getComponents

getMessages()​

getMessages(): CoreMessage[]

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

Returns​

CoreMessage[]

Inherited from​

VercelAi.getMessages

processImageMessage()​

processImageMessage(__namedParameters): Promise<void>

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

Process image message

Parameters​

__namedParameters​

ProcessImageMessageProps

Returns​

Promise<void>

Inherited from​

VercelAi.processImageMessage

processTextMessage()​

processTextMessage(__namedParameters): Promise<{ messages: CoreMessage[]; streamMessage: StreamMessage; }>

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

Process text message

Parameters​

__namedParameters​

ProcessMessageProps

Returns​

Promise<{ messages: CoreMessage[]; streamMessage: StreamMessage; }>

Inherited from​

VercelAi.processTextMessage

restart()​

restart(): void

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

Restarts the chat by clearing messages and resetting the LLM instance

Returns​

void

Overrides​

VercelAi.restart

setAbortController()​

setAbortController(abortController): void

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

Parameters​

abortController​

AbortController

Returns​

void

Inherited from​

VercelAi.setAbortController

setMessages()​

setMessages(messages): void

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

Parameters​

messages​

CoreMessage[]

Returns​

void

Inherited from​

VercelAi.setMessages

stop()​

stop(): void

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

Stop processing

Returns​

void

Inherited from​

VercelAi.stop

temporaryPrompt()​

temporaryPrompt(__namedParameters): Promise<string>

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

One time prompt without saving the conversation

Parameters​

__namedParameters​
prompt​

string

temperature?​

number

Returns​

Promise<string>

Overrides​

VercelAi.temporaryPrompt

translateVoiceToText()​

translateVoiceToText(audioBlob): Promise<string>

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

Voice to text

Parameters​

audioBlob​

Blob

Returns​

Promise<string>

Inherited from​

VercelAi.translateVoiceToText

addToolResult()​

static addToolResult(toolCallId, additionalData): void

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

Parameters​

toolCallId​

string

additionalData​

unknown

Returns​

void

Inherited from​

VercelAi.addToolResult

configure()​

static configure(config): void

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

Configures the client with the provided settings

Parameters​

config​

VercelAiClientConfigureProps

Configuration options

Returns​

void

Overrides​

VercelAi.configure

getBaseURL()​

abstract static getBaseURL(): void

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

Gets the base URL for API requests

Returns​

void

Throws​

Always throws as this is an abstract class

Overrides​

VercelAi.getBaseURL

getInstance()​

static getInstance(): Promise<VercelAi>

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

Get instance using singleton pattern

Returns​

Promise<VercelAi>

Inherited from​

VercelAi.getInstance

getToolResult()​

static getToolResult(toolCallId): unknown

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

Parameters​

toolCallId​

string

Returns​

unknown

Inherited from​

VercelAi.getToolResult

getToolResults()​

static getToolResults(): void

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

Returns​

void

Inherited from​

VercelAi.getToolResults

registerTool()​

static registerTool(__namedParameters): void

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

Parameters​

__namedParameters​

RegisterToolProps

Returns​

void

Inherited from​

VercelAi.registerTool

testConnection()​

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

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

Test connection

Parameters​

apiKey​

string

model​

string

Returns​

Promise<boolean>

Inherited from​

VercelAi.testConnection