Skip to content

EmbedResult

Namespace: Vercel.AI.Operations

public sealed class EmbedResult

Result of CancellationToken).

Inheritance: object

View source

EmbedResult(string, double[], OperationUsage, IReadOnlyList<OperationWarning>, JsonElement?, ProviderResponse?)

Section titled “EmbedResult(string, double[], OperationUsage, IReadOnlyList<OperationWarning>, JsonElement?, ProviderResponse?)”
public EmbedResult(string value, double[] embedding, OperationUsage usage, IReadOnlyList<OperationWarning> warnings, JsonElement? providerMetadata, ProviderResponse? response)

Creates an embed result.

Parameters

Name Type Description
value string
embedding double[]
usage OperationUsage
warnings IReadOnlyList<OperationWarning>
providerMetadata JsonElement?
response ProviderResponse

View source

public double[] Embedding { get; }

Embedding vector.

Value: double[]

View source

public JsonElement? ProviderMetadata { get; }

Provider metadata.

Value: JsonElement?

View source

public ProviderResponse? Response { get; }

Provider response.

Value: ProviderResponse

View source

public OperationUsage Usage { get; }

Token usage.

Value: OperationUsage

View source

public string Value { get; }

Value that was embedded.

Value: string

View source

public IReadOnlyList<OperationWarning> Warnings { get; }

Warnings.

Value: IReadOnlyList<OperationWarning>

View source

Apache-2.0 · Copyright 2023 Vercel, Inc. · unofficial community port, not an official Vercel product