AZazure

Return the embedding vectors for given text prompts. The method makes a REST API call to the /embeddings route on the given endpoint.

Deprecated: This API is deprecated. Use the OpenAI API instead. See migration guide.

post/embeddings

Request

  • Base URL
    https://{resource}.services.ai.azure.com/models
  • URL
    https://{resource}.services.ai.azure.com/models/embeddings
  • Auth
    • API key in header api-key
    • or OAuth 2
      Implicit: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
      Scopes: https://cognitiveservices.azure.com/.default

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

extra-parameters'error' | 'drop' | 'pass-through'

Controls what happens if extra parameters, undefined by the REST API, are passed in the JSON request payload. This sets the HTTP request header extra-parameters.

Request body

inputstring[] required

Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays.

dimensionsinteger

Optional. The number of dimensions the resulting output embeddings should have. Passing null causes the model to use its default value. Returns a 422 error if the model doesn't support the value or parameter.

encoding_format'base64' | 'binary' | 'float' | 'int8' | 'ubinary' | 'uint8'

Specifies the types of embeddings to generate. Compressed embeddings types like uint8, int8, ubinary and binary, may reduce storage costs without sacrificing the integrity of the data. Returns a 422 error if the model doesn't support the value or parameter. Read the model's documentation to know the values supported by your model.

input_type'text' | 'query' | 'document'

Represents the input types used for embedding search.

modelstring

ID of the specific AI model to use, if more than one model is available on the endpoint.

Response

The request has succeeded.

idstring required

Unique identifier for the embeddings result.

object'list' required

The object type of the embeddings result. Will always be list.

modelstring required

The model ID used to generate this result.

Changes

No recorded changes to this operation across all 8 revisions of this API.