Get Embeddings - Get Embeddings

Referencia

Servicio:: AI Foundry

Versión de la API:: 2024-05-01-preview

Devuelve los vectores de inserción de mensajes de texto especificados. El método realiza una llamada API REST a la ruta /embeddings en el punto de conexión especificado.

POST https:///embeddings?api-version=2024-05-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
extra-parameters		ExtraParameters	Controla lo que sucede si se pasan parámetros adicionales, sin definir por la API REST, en la carga de la solicitud JSON. Esto establece el encabezado de solicitud HTTP `extra-parameters`.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
input	True	string[]	Texto de entrada para insertar, codificado como una cadena o matriz de tokens. Para insertar varias entradas en una sola solicitud, pase una matriz de cadenas o matriz de matrices de tokens.
dimensions		integer (int32)	Opcional. Número de dimensiones que deben tener las incrustaciones de salida resultantes. Pasar null hace que el modelo use su valor predeterminado. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
encoding_format		EmbeddingEncodingFormat	Opcional. El formato deseado para las incrustaciones devueltas.
input_type		EmbeddingInputType	Opcional. Tipo de la entrada. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
model		string	Identificador del modelo de IA específico que se va a usar, si hay más de un modelo disponible en el punto de conexión.

Respuestas

Nombre	Tipo	Description
200 OK	EmbeddingsResult	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

EmbeddingsResult

La solicitud se ha realizado correctamente.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

Nombre	Description
https://ml.azure.com/.default

Ejemplos

maximum set embeddings

minimum set embeddings

maximum set embeddings

Solicitud de ejemplo

HTTP

POST https:///embeddings?api-version=2024-05-01-preview


{
  "input": [
    "This is a very good text"
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

Respuesta de muestra

status code:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

minimum set embeddings

Solicitud de ejemplo

HTTP

POST https:///embeddings?api-version=2024-05-01-preview

{
  "input": [
    "This is a very good text"
  ]
}

Respuesta de muestra

status code:: 200

{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat	Especifica los tipos de incrustaciones que se van a generar. Las incrustaciones comprimidas, como `uint8`, `int8`, `ubinary` y `binary`, pueden reducir los costos de almacenamiento sin sacrificar la integridad de los datos. Devuelve un error 422 si el modelo no admite el valor o el parámetro. Lea la documentación del modelo para conocer los valores admitidos por el modelo.
EmbeddingInputType	Representa los tipos de entrada usados para la búsqueda de inserción.
EmbeddingItem	Representación de una sola comparación de la relación de incrustaciones.
EmbeddingsOptions	La información de configuración de una solicitud de inserción.
EmbeddingsResult	Representación de los datos de respuesta de una solicitud de inserción. Las incrustaciones miden la relación de las cadenas de texto y se usan habitualmente para buscar, agrupar en clústeres, recomendaciones y otros escenarios similares.
EmbeddingsUsage	Medición de la cantidad de tokens usados en esta solicitud y respuesta.
ExtraParameters	Controla lo que sucede si se pasan parámetros adicionales, sin definir por la API REST, en la carga de la solicitud JSON.

Azure.Core.Foundations.Error

Object

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Object

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

EmbeddingEncodingFormat

Enumeración

Especifica los tipos de incrustaciones que se van a generar. Las incrustaciones comprimidas, como uint8, int8, ubinary y binary, pueden reducir los costos de almacenamiento sin sacrificar la integridad de los datos. Devuelve un error 422 si el modelo no admite el valor o el parámetro. Lea la documentación del modelo para conocer los valores admitidos por el modelo.

Valor	Description
base64	Obtenga la representación binaria de las incrustaciones codificadas como cadena Base64. La biblioteca de Python de OpenAI recupera las incrustaciones de la API como datos binarios codificados, en lugar de usar representaciones decimales intermedias como normalmente.
binary	Obtención de incrustaciones binarias firmadas
float	Obtención de incrustaciones de precisión completa
int8	Volver a insertar int8 con sesión iniciada
ubinary	Obtención de incrustaciones binarias sin firmar
uint8	Volver a insertar int8 sin signo

EmbeddingInputType

Enumeración

Representa los tipos de entrada usados para la búsqueda de inserción.

Valor	Description
document	Indica que la entrada representa un documento almacenado en una base de datos vectorial.
query	Indica que la entrada representa una consulta de búsqueda para buscar los documentos más relevantes en la base de datos vectorial.
text	Indica que la entrada es una entrada de texto general.

EmbeddingItem

Object

Representación de una sola comparación de la relación de incrustaciones.

Nombre	Tipo	Description
embedding	number[] (float)	Lista de valores de inserción para el símbolo del sistema de entrada. Representan una medida de la relación basada en vectores de la entrada proporcionada. O una cadena codificada en base64 del vector de inserción.
index	integer (int32)	Índice del símbolo del sistema al que corresponde el objeto EmbeddingItem.
object	enum: embedding	Tipo de objeto de este elemento embeddings. Siempre será `embedding`.

EmbeddingsOptions

Object

La información de configuración de una solicitud de inserción.

Nombre	Tipo	Description
dimensions	integer (int32)	Opcional. Número de dimensiones que deben tener las incrustaciones de salida resultantes. Pasar null hace que el modelo use su valor predeterminado. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
encoding_format	EmbeddingEncodingFormat	Opcional. El formato deseado para las incrustaciones devueltas.
input	string[]	Texto de entrada para insertar, codificado como una cadena o matriz de tokens. Para insertar varias entradas en una sola solicitud, pase una matriz de cadenas o matriz de matrices de tokens.
input_type	EmbeddingInputType	Opcional. Tipo de la entrada. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
model	string	Identificador del modelo de IA específico que se va a usar, si hay más de un modelo disponible en el punto de conexión.

EmbeddingsResult

Object

Representación de los datos de respuesta de una solicitud de inserción. Las incrustaciones miden la relación de las cadenas de texto y se usan habitualmente para buscar, agrupar en clústeres, recomendaciones y otros escenarios similares.

Nombre	Tipo	Description
data	EmbeddingItem[]	Insertar valores para las solicitudes enviadas en la solicitud.
id	string	Identificador único para el resultado de las incrustaciones.
model	string	Identificador del modelo usado para generar este resultado.
object	enum: list	Tipo de objeto del resultado de las inserciones. Siempre será `list`.
usage	EmbeddingsUsage	Recuentos de uso para la entrada de tokens mediante la API de inserción.

EmbeddingsUsage

Object

Medición de la cantidad de tokens usados en esta solicitud y respuesta.

Nombre	Tipo	Description
prompt_tokens	integer (int32)	Número de tokens en la solicitud.
total_tokens	integer (int32)	Número total de tokens transaccionados en esta solicitud o respuesta. Debe ser igual al número de tokens de la solicitud.

ExtraParameters

Enumeración

Controla lo que sucede si se pasan parámetros adicionales, sin definir por la API REST, en la carga de la solicitud JSON.

Valor	Description
drop	El servicio omitirá (quitar) parámetros adicionales en la carga de la solicitud. Solo pasará los parámetros conocidos al modelo de IA de back-end.
error	El servicio producirá un error si detectó parámetros adicionales en la carga de la solicitud. Este es el valor predeterminado del servicio.
pass-through	El servicio pasará parámetros adicionales al modelo de IA de back-end.

Compartir vía

Get Embeddings - Get Embeddings

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

api-key

OAuth2Auth

Ámbitos

Ejemplos

maximum set embeddings

Solicitud de ejemplo

Respuesta de muestra

minimum set embeddings

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

EmbeddingEncodingFormat

EmbeddingInputType

EmbeddingItem

EmbeddingsOptions

EmbeddingsResult

EmbeddingsUsage

ExtraParameters

Recursos adicionales