OpenAICompatibleCompletionLanguageModel

Namespace: Vercel.AI.OpenAICompatible

public sealed class OpenAICompatibleCompletionLanguageModel : ILanguageModel

Legacy Completions language model.

Inheritance: object

Implements: ILanguageModel

View source

Constructors

OpenAICompatibleCompletionLanguageModel(OpenAICompatibleProvider, string)

public OpenAICompatibleCompletionLanguageModel(OpenAICompatibleProvider provider, string modelId)

Creates a completion model.

Parameters

Name	Type	Description
provider	OpenAICompatibleProvider
modelId	string

View source

OpenAICompatibleCompletionLanguageModel(OpenAICompatibleProvider, string, string?)

public OpenAICompatibleCompletionLanguageModel(OpenAICompatibleProvider provider, string modelId, string? providerId)

Creates a completion model with an explicit provider id.

Parameters

Name	Type	Description
provider	OpenAICompatibleProvider
modelId	string
providerId	string

View source

OpenAICompatibleCompletionLanguageModel(OpenAICompatibleProvider, string, string?, string?)

public OpenAICompatibleCompletionLanguageModel(OpenAICompatibleProvider provider, string modelId, string? providerId, string? requestModelId)

Creates a completion model whose reported ModelId differs from the model sent to the API. <code class=“paramref”>requestModelId</code>, when set, is used for the request model and the deployment route.

Parameters

Name	Type	Description
provider	OpenAICompatibleProvider
modelId	string
providerId	string
requestModelId	string

View source

Properties

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id, such as openai.

Value: string

View source

ProviderOptionsName

public string ProviderOptionsName { get; }

Provider-options key. The segment before the first dot of Provider.

Value: string

View source

SpecificationVersion

public string SpecificationVersion { get; }

Always V4.

Value: string

View source

Methods

DoGenerateAsync(LanguageModelCallOptions, CancellationToken)

public Task<LanguageModelGenerateResult> DoGenerateAsync(LanguageModelCallOptions options, CancellationToken cancellationToken)

Generates a complete result.

Parameters

Name	Type	Description
options	LanguageModelCallOptions
cancellationToken	CancellationToken

Returns: Task<LanguageModelGenerateResult>

View source

DoStreamAsync(LanguageModelCallOptions, CancellationToken)

public Task<LanguageModelStreamResult> DoStreamAsync(LanguageModelCallOptions options, CancellationToken cancellationToken)

Streams partial results. The result carries the stream with the request and response info.

Parameters

Name	Type	Description
options	LanguageModelCallOptions
cancellationToken	CancellationToken

Returns: Task<LanguageModelStreamResult>

View source