OpenAICompletionLanguageModel

Namespace: Vercel.AI.OpenAI

public sealed class OpenAICompletionLanguageModel : ILanguageModel

OpenAI legacy completions language model.

Inheritance: object

Implements: ILanguageModel

View source

Constructors

OpenAICompletionLanguageModel(OpenAIProvider, string)

public OpenAICompletionLanguageModel(OpenAIProvider provider, string modelId)

Creates a completion model.

Parameters

Name	Type	Description
provider	OpenAIProvider
modelId	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

SpecificationVersion

public string SpecificationVersion { get; }

Always V4.

Value: string

View source

Methods

ConvertPrompt(IReadOnlyList<ModelMessage>)

public static OpenAICompletionPrompt ConvertPrompt(IReadOnlyList<ModelMessage> prompt)

Converts messages into a completion prompt and the default stop sequence.

Parameters

Name	Type	Description
prompt	IReadOnlyList<ModelMessage>

Returns: OpenAICompletionPrompt

View source

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

Prepare(string, LanguageModelCallOptions, bool)

public static OpenAICompletionPreparedRequest Prepare(string modelId, LanguageModelCallOptions options, bool stream)

Builds the completions body. <code class=“paramref”>stream</code> adds streaming fields.

Parameters

Name	Type	Description
modelId	string
options	LanguageModelCallOptions
stream	bool

Returns: OpenAICompletionPreparedRequest

View source