LanguageModelGenerateResult

Namespace: Vercel.AI.Provider

public sealed class LanguageModelGenerateResult

Result of CancellationToken).

Inheritance: object

View source

Constructors

LanguageModelGenerateResult(IReadOnlyList<GeneratedContent>, FinishReason, LanguageModelUsage, string?, IReadOnlyList<CallWarning>?, string?, JsonElement?, string?, string?, DateTimeOffset?, IReadOnlyDictionary<string, string>?, string?)

public LanguageModelGenerateResult(IReadOnlyList<GeneratedContent> content, FinishReason finishReason, LanguageModelUsage usage, string? rawFinishReason = null, IReadOnlyList<CallWarning>? warnings = null, string? responseId = null, JsonElement? providerMetadata = null, string? rawResponse = null, string? responseModelId = null, DateTimeOffset? responseTimestamp = null, IReadOnlyDictionary<string, string>? responseHeaders = null, string? structuredOutputText = null)

Creates a generate result.

Parameters

Name	Type	Description
content	IReadOnlyList<GeneratedContent>
finishReason	FinishReason
usage	LanguageModelUsage
rawFinishReason	string
warnings	IReadOnlyList<CallWarning>
responseId	string
providerMetadata	JsonElement?
rawResponse	string
responseModelId	string
responseTimestamp	DateTimeOffset?
responseHeaders	IReadOnlyDictionary<string, string>
structuredOutputText	string

View source

Properties

Content

public IReadOnlyList<GeneratedContent> Content { get; }

Generated content parts.

Value: IReadOnlyList<GeneratedContent>

View source

FinishReason

public FinishReason FinishReason { get; }

Normalized finish reason.

Value: FinishReason

View source

ProviderMetadata

public JsonElement? ProviderMetadata { get; }

Provider metadata for this call, keyed by provider name.

Value: JsonElement?

View source

RawFinishReason

public string? RawFinishReason { get; }

Provider finish reason, when it differs from FinishReason.

Value: string

View source

RawResponse

public string? RawResponse { get; }

Raw provider response body, when the model captured it.

Value: string

View source

ResponseHeaders

public IReadOnlyDictionary<string, string> ResponseHeaders { get; }

HTTP response headers.

Value: IReadOnlyDictionary<string, string>

View source

ResponseId

public string? ResponseId { get; }

Provider response id.

Value: string

View source

ResponseModelId

public string? ResponseModelId { get; }

Model id reported by the provider.

Value: string

View source

ResponseTimestamp

public DateTimeOffset? ResponseTimestamp { get; }

Provider timestamp for the response.

Value: DateTimeOffset?

View source

StructuredOutputText

public string? StructuredOutputText { get; }

Text to parse for structured JSON output when it differs from the concatenation of all text parts in Content, such as drafts followed by a final answer. It does not replace or remove any content. When null, consumers concatenate all text parts. An empty string is an explicit selection and does not fall back to the text parts. Maps to structuredOutputText.

Value: string

View source

Text

public string Text { get; }

Concatenated text parts.

Value: string

View source

Usage

public LanguageModelUsage Usage { get; }

Token usage.

Value: LanguageModelUsage

View source

Warnings

public IReadOnlyList<CallWarning> Warnings { get; }

Call warnings.

Value: IReadOnlyList<CallWarning>

View source