StreamTextResult

Namespace: Vercel.AI

public sealed class StreamTextResult

Result of streamText. Enumerating Stream(CancellationToken) or awaiting Text consumes the same buffered events.

Inheritance: object

View source

Properties

FinishReason

public Task<FinishReason> FinishReason { get; }

Finish reason. Completes when the stream finishes.

Value: Task<FinishReason>

View source

Request

public Task<LanguageModelRequestMetadata> Request { get; }

Additional request information of the last step. Body and Messages are set only when Include asks for them. Completes when the stream finishes. Maps to request.

Value: Task<LanguageModelRequestMetadata>

View source

Response

public Task<StepResponse> Response { get; }

Additional response information of the last step, with the messages that step added. Completes when the stream finishes. Maps to response.

Value: Task<StepResponse>

View source

Steps

public Task<IReadOnlyList<StepResult>> Steps { get; }

Completed steps. Completes when the stream finishes.

Value: Task<IReadOnlyList<StepResult>>

View source

Text

public Task<string> Text { get; }

Full text from the last step. Completes when the stream finishes.

Value: Task<string>

View source

Usage

public Task<LanguageModelUsage> Usage { get; }

Total usage. Completes when the stream finishes.

Value: Task<LanguageModelUsage>

View source

Methods

Stream(CancellationToken)

public IAsyncEnumerable<TextStreamPart> Stream(CancellationToken cancellationToken = default)

Every stream part, including tool calls, tool results, and finish.

Parameters

Name	Type	Description
cancellationToken	CancellationToken

Returns: IAsyncEnumerable<TextStreamPart>

View source

TextStream(CancellationToken)

public IAsyncEnumerable<string> TextStream(CancellationToken cancellationToken = default)

Text deltas only.

Parameters

Name	Type	Description
cancellationToken	CancellationToken

Returns: IAsyncEnumerable<string>

View source