FinishStreamPart

Namespace: Vercel.AI.Provider

public sealed class FinishStreamPart : LanguageModelStreamPart

The stream finished.

Inheritance: object → LanguageModelStreamPart

View source

Constructors

FinishStreamPart(FinishReason, LanguageModelUsage, string?, JsonElement?)

public FinishStreamPart(FinishReason finishReason, LanguageModelUsage usage, string? rawFinishReason = null, JsonElement? providerMetadata = null)

Creates a finish part.

Parameters

Name	Type	Description
finishReason	FinishReason
usage	LanguageModelUsage
rawFinishReason	string
providerMetadata	JsonElement?

View source

Properties

FinishReason

public FinishReason FinishReason { get; }

Finish reason.

Value: FinishReason

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; }

Provider metadata reported with the finish event.

Value: JsonElement?

View source

RawFinishReason

public string? RawFinishReason { get; }

Provider finish reason.

Value: string

View source

Usage

public LanguageModelUsage Usage { get; }

Usage reported with the finish part.

Value: LanguageModelUsage

View source