TestLanguageModel

Namespace: Vercel.AI.Testing

public sealed class TestLanguageModel : ILanguageModel

Language model that returns scripted generate and stream results.

Inheritance: object

Implements: ILanguageModel

View source

Constructors

TestLanguageModel(string)

public TestLanguageModel(string modelId = "test")

Creates a model with id <code class=“paramref”>modelId</code>.

Parameters

Name	Type	Description
modelId	string

View source

Properties

Calls

public List<LanguageModelCallOptions> Calls { get; }

Calls observed by generate and stream.

Value: List<LanguageModelCallOptions>

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

OnGenerate

public Func<LanguageModelCallOptions, LanguageModelGenerateResult>? OnGenerate { get; set; }

When set, generate returns this function’s result.

Value: Func<LanguageModelCallOptions, LanguageModelGenerateResult>

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

StreamParts

public IReadOnlyList<LanguageModelStreamPart>? StreamParts { get; set; }

When set, stream yields these parts instead of a single text delta.

Value: IReadOnlyList<LanguageModelStreamPart>

View source

StreamRequest

public LanguageModelStreamRequest? StreamRequest { get; set; }

The request info stream calls report.

Value: LanguageModelStreamRequest

View source

StreamResponse

public LanguageModelStreamResponse? StreamResponse { get; set; }

The response info stream calls report.

Value: LanguageModelStreamResponse

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

Text(string)

public static LanguageModelGenerateResult Text(string text)

A generate result whose only content is <code class=“paramref”>text</code>.

Parameters

Name	Type	Description
text	string

Returns: LanguageModelGenerateResult

View source