EmbeddingsOptions Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

Source:: EmbeddingsOptions.cs

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.

The configuration information for an embeddings request. Embeddings measure the relatedness of text strings and are commonly used for search, clustering, recommendations, and other similar scenarios.

public class EmbeddingsOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.EmbeddingsOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.EmbeddingsOptions>

type EmbeddingsOptions = class
    interface IJsonModel<EmbeddingsOptions>
    interface IPersistableModel<EmbeddingsOptions>

Public Class EmbeddingsOptions
Implements IJsonModel(Of EmbeddingsOptions), IPersistableModel(Of EmbeddingsOptions)

Inheritance: Object
EmbeddingsOptions

Implements: IJsonModel<EmbeddingsOptions> IPersistableModel<EmbeddingsOptions> IPersistableModel<T>

Constructors

EmbeddingsOptions()	Initializes a new instance of EmbeddingsOptions.
EmbeddingsOptions(String, IEnumerable<String>)	Initializes a new instance of EmbeddingsOptions.

Properties

DeploymentName	The deployment name to use for an embeddings request.
Dimensions	The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models.
Input	Input texts to get embeddings for, encoded as a an array of strings. Each input must not exceed 2048 tokens in length. Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present.
InputType	When using Azure OpenAI, specifies the input type to use for embedding search.
User	An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.

Explicit Interface Implementations

IJsonModel<EmbeddingsOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<EmbeddingsOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<EmbeddingsOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<EmbeddingsOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<EmbeddingsOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to