Skip to content

EmbedEndEvent

Namespace: Vercel.AI.Operations

public sealed class EmbedEndEvent

End event for embed and embedMany.

Inheritance: object

View source

EmbedEndEvent(string, string, IReadOnlyDictionary<string, object?>, string, string, EmbedEventValue<string, IReadOnlyList<string>>, EmbedEventValue<double[], IReadOnlyList<double[]>>, OperationUsage, IReadOnlyList<OperationWarning>, JsonElement?, EmbedEventValue<ProviderResponse?, IReadOnlyList<ProviderResponse?>>)

Section titled “EmbedEndEvent(string, string, IReadOnlyDictionary<string, object?>, string, string, EmbedEventValue<string, IReadOnlyList<string>>, EmbedEventValue<double[], IReadOnlyList<double[]>>, OperationUsage, IReadOnlyList<OperationWarning>, JsonElement?, EmbedEventValue<ProviderResponse?, IReadOnlyList<ProviderResponse?>>)”
public EmbedEndEvent(string callId, string operationId, IReadOnlyDictionary<string, object?> runtimeContext, string provider, string modelId, EmbedEventValue<string, IReadOnlyList<string>> value, EmbedEventValue<double[], IReadOnlyList<double[]>> embedding, OperationUsage usage, IReadOnlyList<OperationWarning> warnings, JsonElement? providerMetadata, EmbedEventValue<ProviderResponse?, IReadOnlyList<ProviderResponse?>> response)

Creates an end event.

Parameters

Name Type Description
callId string
operationId string
runtimeContext IReadOnlyDictionary<string, object>
provider string
modelId string
value EmbedEventValue&lt;string, IReadOnlyList&lt;string&gt;&gt;
embedding EmbedEventValue&lt;double\[\], IReadOnlyList&lt;double\[\]&gt;&gt;
usage OperationUsage
warnings IReadOnlyList<OperationWarning>
providerMetadata JsonElement?
response EmbedEventValue&lt;ProviderResponse, IReadOnlyList&lt;ProviderResponse&gt;&gt;

View source

public string CallId { get; }

Correlates start and end.

Value: string

View source

public EmbedEventValue<double[], IReadOnlyList<double[]>> Embedding { get; }

One vector, or the vector list for embedMany.

Value: EmbedEventValue&lt;double\[\], IReadOnlyList&lt;double\[\]&gt;&gt;

View source

public string ModelId { get; }

Model id.

Value: string

View source

public string OperationId { get; }

ai.embed or ai.embedMany.

Value: string

View source

public string Provider { get; }

Provider id.

Value: string

View source

public JsonElement? ProviderMetadata { get; }

Merged provider metadata.

Value: JsonElement?

View source

public EmbedEventValue<ProviderResponse?, IReadOnlyList<ProviderResponse?>> Response { get; }

One response for embed, or the response list for embedMany.

Value: EmbedEventValue&lt;ProviderResponse, IReadOnlyList&lt;ProviderResponse&gt;&gt;

View source

public IReadOnlyDictionary<string, object?> RuntimeContext { get; }

Caller runtime context.

Value: IReadOnlyDictionary<string, object>

View source

public OperationUsage Usage { get; }

Token usage.

Value: OperationUsage

View source

public EmbedEventValue<string, IReadOnlyList<string>> Value { get; }

Embedded value or values.

Value: EmbedEventValue&lt;string, IReadOnlyList&lt;string&gt;&gt;

View source

public IReadOnlyList<OperationWarning> Warnings { get; }

Aggregated warnings.

Value: IReadOnlyList<OperationWarning>

View source

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