DefaultInstructionsMiddleware

Namespace: Vercel.AI

public sealed class DefaultInstructionsMiddleware : LanguageModelMiddleware, ILanguageModelMiddleware

Prepends system instructions when the prompt has none. Maps to defaultInstructionsMiddleware.

Inheritance: object → LanguageModelMiddleware

Implements: ILanguageModelMiddleware

View source

Constructors

DefaultInstructionsMiddleware(string)

public DefaultInstructionsMiddleware(string instructions)

Creates middleware.

Parameters

Name	Type	Description
instructions	string

View source

Properties

Instructions

public string Instructions { get; }

Instructions to prepend.

Value: string

View source

Methods

WrapGenerateAsync(LanguageModelCallOptions, Func<LanguageModelCallOptions, CancellationToken, Task<LanguageModelGenerateResult>>, CancellationToken)

public override Task<LanguageModelGenerateResult> WrapGenerateAsync(LanguageModelCallOptions options, Func<LanguageModelCallOptions, CancellationToken, Task<LanguageModelGenerateResult>> next, CancellationToken cancellationToken)

Wraps a generate call.

Parameters

Name	Type	Description
options	LanguageModelCallOptions
next	Func<LanguageModelCallOptions, CancellationToken, Task<LanguageModelGenerateResult>>
cancellationToken	CancellationToken

Returns: Task<LanguageModelGenerateResult>

View source