MockLanguageModelV2

Namespace: Vercel.AI.Testing

public sealed class MockLanguageModelV2

Language model v2 test double. Array-backed results are returned in order, starting at the first entry.

Inheritance: object

View source

Constructors

MockLanguageModelV2(string, string, IReadOnlyList<MockGenerateResult>?, IReadOnlyList<MockStreamResult>?, Func<MockLanguageModelCallOptions?, Task<MockGenerateResult>>?, Func<MockLanguageModelCallOptions?, Task<MockStreamResult>>?)

public MockLanguageModelV2(string provider = "mock-provider", string modelId = "mock-model-id", IReadOnlyList<MockGenerateResult>? doGenerate = null, IReadOnlyList<MockStreamResult>? doStream = null, Func<MockLanguageModelCallOptions?, Task<MockGenerateResult>>? generate = null, Func<MockLanguageModelCallOptions?, Task<MockStreamResult>>? stream = null)

Creates a model. List results are consumed from the first entry.

Parameters

Name	Type	Description
provider	string
modelId	string
doGenerate	IReadOnlyList<MockGenerateResult>
doStream	IReadOnlyList<MockStreamResult>
generate	Func<MockLanguageModelCallOptions, Task<MockGenerateResult>>
stream	Func<MockLanguageModelCallOptions, Task<MockStreamResult>>

View source

Properties

DoGenerateCalls

public List<MockLanguageModelCallOptions> DoGenerateCalls { get; }

Generate calls in order.

Value: List<MockLanguageModelCallOptions>

View source

DoStreamCalls

public List<MockLanguageModelCallOptions> DoStreamCalls { get; }

Stream calls in order.

Value: List<MockLanguageModelCallOptions>

View source

ModelId

public string ModelId { get; }

Model id.

Value: string

View source

Provider

public string Provider { get; }

Provider id.

Value: string

View source

SpecificationVersion

public string SpecificationVersion { get; }

Specification version.

Value: string

View source

Methods

DoGenerateAsync(MockLanguageModelCallOptions?)

public Task<MockGenerateResult> DoGenerateAsync(MockLanguageModelCallOptions? options)

Returns the next scripted generate result.

Parameters

Name	Type	Description
options	MockLanguageModelCallOptions

Returns: Task<MockGenerateResult>

View source

DoStreamAsync(MockLanguageModelCallOptions?)

public Task<MockStreamResult> DoStreamAsync(MockLanguageModelCallOptions? options)

Returns the next scripted stream result.

Parameters

Name	Type	Description
options	MockLanguageModelCallOptions

Returns: Task<MockStreamResult>

View source