EmbeddingsResult Class

  • Reference

Definition

Namespace:
Azure.AI.Inference
Assembly:
Azure.AI.Inference.dll
Package:
Azure.AI.Inference v1.0.0-beta.2
Source:
EmbeddingsResult.cs

Representation of the response data from an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.

public class EmbeddingsResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.EmbeddingsResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.EmbeddingsResult>
type EmbeddingsResult = class
    interface IJsonModel<EmbeddingsResult>
    interface IPersistableModel<EmbeddingsResult>
Public Class EmbeddingsResult
Implements IJsonModel(Of EmbeddingsResult), IPersistableModel(Of EmbeddingsResult)
Inheritance
Object
EmbeddingsResult
Implements
IJsonModel<EmbeddingsResult> IPersistableModel<EmbeddingsResult> IPersistableModel<T>

Properties

Data

Embedding values for the prompts submitted in the request.
Id

Unique identifier for the embeddings result.
Model

The model ID used to generate this result.
Usage

Usage counts for tokens input using the embeddings API.

Explicit Interface Implementations

IJsonModel<EmbeddingsResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<EmbeddingsResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<EmbeddingsResult>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<EmbeddingsResult>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<EmbeddingsResult>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to