Class VercelAiModel

See also VS Code ILanguageModelChatMetadata

Implements

LanguageModel

Constructors

constructor

new VercelAiModel(
    id: string,
    model: string,
    status: LanguageModelStatus,
    enableStreaming: boolean,
    supportsStructuredOutput: boolean,
    url: undefined | string,
    logger: ILogger,
    languageModelFactory: VercelAiLanguageModelFactory,
    providerConfig: () => VercelAiProviderConfig,
    maxRetries?: number,
): VercelAiModel
Parameters
- id: string
- model: string
- status: LanguageModelStatus
- enableStreaming: boolean
- supportsStructuredOutput: boolean
- url: undefined | string
- logger: ILogger
- languageModelFactory: VercelAiLanguageModelFactory
- providerConfig: () => VercelAiProviderConfig
- maxRetries: number = 3
Returns VercelAiModel
- Defined in node/vercel-ai-language-model.ts:186

Properties

enableStreaming

enableStreaming: boolean

`Readonly`id

id: string

`Protected` `Readonly`languageModelFactory

languageModelFactory: VercelAiLanguageModelFactory

`Protected` `Readonly`logger

logger: ILogger

maxRetries

maxRetries: number = 3

model

model: string

`Protected`providerConfig

providerConfig: () => VercelAiProviderConfig

status

status: LanguageModelStatus

supportsStructuredOutput

supportsStructuredOutput: boolean

url

url: undefined | string

Methods

`Protected`createCancellationToken

createCancellationToken(
cancellationToken?: CancellationToken,
): VercelCancellationToken
Parameters
- OptionalcancellationToken: CancellationToken
Returns VercelCancellationToken
- Defined in node/vercel-ai-language-model.ts:235

`Protected`createTools

createTools(request: UserRequest): undefined | ToolSet
Parameters
- request: UserRequest
Returns undefined | ToolSet
- Defined in node/vercel-ai-language-model.ts:284

`Protected`getSettings

getSettings(request: LanguageModelRequest): Record<string, unknown>
Parameters
- request: LanguageModelRequest
Returns Record<string, unknown>
- Defined in node/vercel-ai-language-model.ts:199

`Protected`handleNonStreamingRequest

handleNonStreamingRequest(
    model: LanguageModelV1,
    request: UserRequest,
    cancellationToken?: VercelCancellationToken,
): Promise<LanguageModelTextResponse>
Parameters
- model: LanguageModelV1
- request: UserRequest
- OptionalcancellationToken: VercelCancellationToken
Returns Promise<LanguageModelTextResponse>
- Defined in node/vercel-ai-language-model.ts:255

`Protected`handleStreamingRequest

handleStreamingRequest(
    model: LanguageModelV1,
    request: UserRequest,
    cancellationToken?: VercelCancellationToken,
): Promise<LanguageModelStreamResponse>
Parameters
- model: LanguageModelV1
- request: UserRequest
- OptionalcancellationToken: VercelCancellationToken
Returns Promise<LanguageModelStreamResponse>
- Defined in node/vercel-ai-language-model.ts:348

`Protected`handleStructuredOutputRequest

handleStructuredOutputRequest(
    model: LanguageModelV1,
    request: UserRequest,
    cancellationToken?: VercelCancellationToken,
): Promise<LanguageModelStreamResponse | LanguageModelParsedResponse>
Parameters
- model: LanguageModelV1
- request: UserRequest
- OptionalcancellationToken: VercelCancellationToken
Returns Promise<LanguageModelStreamResponse | LanguageModelParsedResponse>
- Defined in node/vercel-ai-language-model.ts:308

`Protected`mergeConsecutiveAssistantMessages

mergeConsecutiveAssistantMessages(messages: CoreMessage[]): CoreMessage[]
Parameters
- messages: CoreMessage[]
Returns CoreMessage[]
- Defined in node/vercel-ai-language-model.ts:404

`Protected`processMessages

processMessages(messages: LanguageModelMessage[]): CoreMessage[]
Parameters
- messages: LanguageModelMessage[]
Returns CoreMessage[]
- Defined in node/vercel-ai-language-model.ts:379

request

request(
request: UserRequest,
cancellationToken?: CancellationToken,
): Promise<LanguageModelResponse>
Parameters
- request: UserRequest
- OptionalcancellationToken: CancellationToken
Returns Promise<LanguageModelResponse>
Implementation of LanguageModel.request
- Defined in node/vercel-ai-language-model.ts:203

Class VercelAiModel

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VercelAiModel

Properties

enableStreaming

Readonlyid

Protected ReadonlylanguageModelFactory

Protected Readonlylogger

maxRetries

model

ProtectedproviderConfig

status

supportsStructuredOutput

url

Methods

ProtectedcreateCancellationToken

Parameters

Returns VercelCancellationToken

ProtectedcreateTools

Parameters

Returns undefined | ToolSet

ProtectedgetSettings

Parameters

Returns Record<string, unknown>

ProtectedhandleNonStreamingRequest

Parameters

Returns Promise<LanguageModelTextResponse>

ProtectedhandleStreamingRequest

Parameters

Returns Promise<LanguageModelStreamResponse>

ProtectedhandleStructuredOutputRequest

Parameters

Returns Promise<LanguageModelStreamResponse | LanguageModelParsedResponse>

ProtectedmergeConsecutiveAssistantMessages

Parameters

Returns CoreMessage[]

ProtectedprocessMessages

Parameters

Returns CoreMessage[]

request

Parameters

Returns Promise<LanguageModelResponse>

Settings

On This Page

`Readonly`id

`Protected` `Readonly`languageModelFactory

`Protected` `Readonly`logger

`Protected`providerConfig

`Protected`createCancellationToken

`Protected`createTools

`Protected`getSettings

`Protected`handleNonStreamingRequest

`Protected`handleStreamingRequest

`Protected`handleStructuredOutputRequest

`Protected`mergeConsecutiveAssistantMessages

`Protected`processMessages