Lingua

InferenceModelFactory.EmbeddingResult Method

Definition

The result of an embedding operation.

public static Azure.Data.AI.EmbeddingResult EmbeddingResult(string model = default, Azure.Data.AI.EmbeddingOutputDataKind outputDataKind = default, System.Collections.Generic.IEnumerable<Azure.Data.AI.EmbeddingItem> data = default, Azure.Data.AI.EmbeddingUsage usage = default, System.Collections.Generic.IEnumerable<Azure.Data.AI.EmbeddingWarning> warnings = default, Azure.Data.AI.EmbeddingOutput output = default);
static member EmbeddingResult : string * Azure.Data.AI.EmbeddingOutputDataKind * seq<Azure.Data.AI.EmbeddingItem> * Azure.Data.AI.EmbeddingUsage * seq<Azure.Data.AI.EmbeddingWarning> * Azure.Data.AI.EmbeddingOutput -> Azure.Data.AI.EmbeddingResult
Public Shared Function EmbeddingResult (Optional model As String = Nothing, Optional outputDataKind As EmbeddingOutputDataKind = Nothing, Optional data As IEnumerable(Of EmbeddingItem) = Nothing, Optional usage As EmbeddingUsage = Nothing, Optional warnings As IEnumerable(Of EmbeddingWarning) = Nothing, Optional output As EmbeddingOutput = Nothing) As EmbeddingResult

Parameters

model
String

The name of the model that produced the vectors.

outputDataKind
EmbeddingOutputDataKind

The numeric type of the returned values.

data
IEnumerable<EmbeddingItem>

One entry per item in inputs, in request order. Empty when output is present.

usage
EmbeddingUsage

Usage for the operation.

warnings
IEnumerable<EmbeddingWarning>

Things to know about a successful response, such as truncated items. Omitted when there are none.

output
EmbeddingOutput

With delivery: link: where to read the results.

Returns

A new EmbeddingResult instance for mocking.

Applies to