Class: OpenAIAssistant

Defined in: packages/core/src/llm/openai.ts:19

OpenAI Assistant LLM for Client only

Extends

• VercelAiClient

Properties

llm

llm: null | LanguageModelV1 = null

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

Language model instance

Inherited from

VercelAiClient.llm

Methods

addMessage()

addMessage(message): void

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

Parameters

message

CoreMessage

Returns

void

Inherited from

VercelAiClient.addMessage

---

audioToText()

audioToText(audioBlob): Promise<string>

Defined in: packages/core/src/llm/openai.ts:106

Override the audioToText method to use OpenAI Whisper

Parameters

audioBlob

AudioToTextProps

The audio blob to transcribe

Returns

Promise<string>

The transcribed text

Overrides

VercelAiClient.audioToText

---

close()

close(): Promise<void>

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

Close the LLM instance

Returns

Promise<void>

Inherited from

VercelAiClient.close

---

getComponents()

getComponents(): ToolCallComponents

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

Returns

ToolCallComponents

Inherited from

VercelAiClient.getComponents

---

getMessages()

getMessages(): CoreMessage[]

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

Returns

CoreMessage[]

Inherited from

VercelAiClient.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

VercelAiClient.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

VercelAiClient.processTextMessage

---

restart()

restart(): void

Defined in: packages/core/src/llm/openai.ts:93

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:217

Parameters

abortController

AbortController

Returns

void

Inherited from

VercelAiClient.setAbortController

---

setMessages()

setMessages(messages): void

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

Parameters

messages

CoreMessage[]

Returns

void

Inherited from

VercelAiClient.setMessages

---

stop()

stop(): void

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

Stop processing

Returns

void

Inherited from

VercelAiClient.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>

Inherited from

VercelAiClient.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

VercelAiClient.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

VercelAiClient.addToolResult

---

configure()

static configure(config): void

Defined in: packages/core/src/llm/openai.ts:32

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/openai.ts:28

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<OpenAIAssistant>

Defined in: packages/core/src/llm/openai.ts:81

Get instance using singleton pattern

Returns

Promise<OpenAIAssistant>

Overrides

VercelAiClient.getInstance

---

getToolResult()

static getToolResult(toolCallId): unknown

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

Parameters

toolCallId

string

Returns

unknown

Inherited from

VercelAiClient.getToolResult

---

getToolResults()

static getToolResults(): void

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

Returns

void

Inherited from

VercelAiClient.getToolResults

---

registerTool()

static registerTool(__namedParameters): void

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

Parameters

__namedParameters

RegisterToolProps

Returns

void

Inherited from

VercelAiClient.registerTool

---

testConnection()

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

Defined in: packages/core/src/llm/openai.ts:37

Test connection

Parameters

apiKey

string

model

string

Returns

Promise<boolean>

Overrides

VercelAiClient.testConnection