Share via


EmbeddingItem Class

Definition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Representation of a single embeddings relatedness comparison.

public class EmbeddingItem : System.ClientModel.Primitives.IJsonModel<Azure.AI.Inference.EmbeddingItem>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Inference.EmbeddingItem>
Inheritance
EmbeddingItem
Implements

Properties

Embedding

List of embedding values for the input prompt. These represent a measurement of the vector-based relatedness of the provided input. Or a base64 encoded string of the embedding vector.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

Index

Index of the prompt to which the EmbeddingItem corresponds.

Explicit Interface Implementations

IJsonModel<EmbeddingItem>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<EmbeddingItem>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<EmbeddingItem>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<EmbeddingItem>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<EmbeddingItem>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to

Product Versions
Azure SDK for .NET Preview