Referencia: Incrustaciones | Inteligencia artificial de Azure Studio

Artículo
09/03/2024

Importante

Los elementos marcados (versión preliminar) en este artículo se encuentran actualmente en versión preliminar pública. Esta versión preliminar se ofrece sin acuerdo de nivel de servicio y no se recomienda para las cargas de trabajo de producción. Es posible que algunas características no sean compatibles o que tengan sus funcionalidades limitadas. Para más información, consulte Términos de uso complementarios de las Versiones Preliminares de Microsoft Azure.

Crea un vector de inserción que representa el texto de entrada.

POST /embeddings?api-version=2024-04-01-preview

Parámetros de identificador URI

Nombre	En	Obligatorio	Type	Descripción
`api-version`	consulta	True	string	La versión de la API con el formato "AAAA-MM-DD" o "AAAA-MM-DD-preview".

Encabezado de solicitud

Nombre	Obligatorio	Type	Descripción
parámetros adicionales		string	El comportamiento de la API cuando se indican parámetros adicionales en la carga. El uso de `pass-through` hace que la API pase el parámetro al modelo subyacente. Use este valor cuando desee pasar parámetros que sepa que el modelo subyacente puede admitir. El uso de `ignore` hace que la API quite cualquier parámetro no compatible. Use este valor cuando necesite usar la misma carga en diferentes modelos, pero uno de los parámetros adicionales puede hacer que se produzca un error en un modelo si no se admite. El uso de `error` hace que la API rechace cualquier parámetro adicional en la carga. Solo se pueden indicar los parámetros especificados en esta API o se devuelve un error 400.
azureml-model-deployment		string	Nombre de la implementación a la que desea enrutar la solicitud. Compatible con puntos de conexión que admiten varias implementaciones.

Cuerpo de la solicitud

Nombre	Obligatorio	Type	Descripción
model		string	Nombre del modelo. Este parámetro se omite si el punto de conexión solo sirve a un modelo.
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.
dimensiones		integer	Número de dimensiones que deben tener las incrustaciones de salida resultantes. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
encoding_format		EmbeddingEncodingFormat	Formato en el que se devuelven las incrustaciones. Base64, float, int8, uint8, binary o ubinary. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
input-type		EmbeddingInputType	El tipo de la entrada. `text`, `query` o `document`. Devuelve un error 422 si el modelo no admite el valor o el parámetro.

Respuestas

Nombre	Escribir	Descripción
200 OK	CreateEmbeddingResponse	OK (CORRECTO)
401 No autorizado	UnauthorizedError	Falta el token de acceso o no es válido encabezados x-ms-error-code: cadena
404 No encontrado	NotFoundError	Modalidad no compatible con el modelo. Compruebe la documentación del modelo para ver qué rutas están disponibles. encabezados x-ms-error-code: cadena
422 Entidad no procesable	UnprocessableContentError	La solicitud contiene contenido no procesable encabezados x-ms-error-code: cadena
429 Demasiadas solicitudes	TooManyRequestsError	Ha alcanzado el límite de tasa asignado y su solicitud necesita controlarse. encabezados x-ms-error-code: cadena
Otros códigos de estado	ContentFilterError	Solicitud incorrecta encabezados x-ms-error-code: cadena

Seguridad

Authorization

El token con Bearer: prefix, por ejemplo, Bearer abcde12345

Tipo: apiKey In: encabezado

AADToken

Autenticación OAuth2 de Azure Active Directory

Tipo: oauth2 Flujo: aplicación URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ejemplos

Crea un vector de inserción que representa el texto de entrada

Solicitud de muestra

POST /embeddings?api-version=2024-04-01-preview

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

Respuesta de ejemplo

Código de estado: 200

{
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "BERT",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

Definiciones

Nombre	Descripción
ContentFilterError	Se produce un error en la llamada API cuando el mensaje desencadena un filtro de contenido tal como está configurado. Modifique el comando de entrada e inténtelo de nuevo.
CreateEmbeddingRequest	Solicitud de creación de incrustaciones.
CreateEmbeddingResponse	Respuesta de una solicitud de inserción.
Detalle	Detalles de los errores.
Embedding	Representa el objeto de inserción generado.
EmbeddingEncodingFormat	Formato en el que se devuelven las incrustaciones. Base64, float, int8, uint8, binary o ubinary. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
EmbeddingInputType	El tipo de la entrada. `text`, `query` o `document`. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
EmbeddingObject	El tipo de objeto, que siempre es "embedding".
ListObject	Tipo de objeto, que siempre es "list".
NotFoundError	La ruta no es válida para el modelo implementado.
TooManyRequestsError	Ha alcanzado el límite de tasa asignado y sus solicitudes necesitan controlarse.
UnauthorizedError	Falta la autenticación o no es válida.
UnprocessableContentError	La solicitud contiene contenido no procesable. El error se devuelve cuando la carga indicada es válida según esta especificación. Sin embargo, el modelo subyacente no admite algunas de las instrucciones indicadas en la carga. Use la sección `details` para comprender el parámetro infractor.
Uso	Información de uso de la solicitud.

ContentFilterError

Se produce un error en la llamada API cuando el mensaje desencadena un filtro de contenido tal como está configurado. Modifique el comando de entrada e inténtelo de nuevo.

Nombre	Escribir	Descripción
código	string	Código de error.
error	string	Descripción del error.
message	string	El mensaje de error.
param	string	Parámetro que desencadenó el filtro de contenido.
status	integer	El código de estado HTTP.

CreateEmbeddingRequest

Solicitud de creación de incrustaciones.

Nombre	Obligatorio	Type	Descripción
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.
dimensiones		integer	Número de dimensiones que deben tener las incrustaciones de salida resultantes. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
encoding_format		EmbeddingEncodingFormat	Formato en el que se devuelven las incrustaciones. Base64, float, int8, uint8, binary o ubinary. Devuelve un error 422 si el modelo no admite el valor o el parámetro.
input-type		EmbeddingInputType	El tipo de la entrada. `text`, `query` o `document`. Devuelve un error 422 si el modelo no admite el valor o el parámetro.

CreateEmbeddingResponse

Respuesta de una solicitud de inserción.

Nombre	Escribir	Descripción
data	Embedding[]	Lista de incrustaciones generadas por el modelo.
model	string	Nombre del modelo usado para generar la inserción.
objeto	ListObject	Tipo de objeto, que siempre es "list".
usada	Uso	Información de uso de la solicitud.

Detalle

Detalles del error UnprocessableContentError.

Nombre	Escribir	Descripción
loc	string[]	Parámetro que causa el problema
value	string	Valor pasado al parámetro que provoca problemas.

Embedding

Representa la inserción generada.

Nombre	Escribir	Descripción
insertar	[]	El vector de inserción. La longitud del vector depende del modelo utilizado y el tipo depende del `encoding_format` utilizado.
índice	integer	Índice de la inserción en la lista de inserciones.
objeto	EmbeddingObject	El tipo de objeto, que siempre es "embedding".

EmbeddingEncodingFormat

Formato en el que se devuelven las incrustaciones. Base64, float, int8, uint8, binary o ubinary. Devuelve un error 422 si el modelo no admite el valor o el parámetro.

Nombre	Escribir	Descripción
base64	string
binary	string
flotante	string
int8	string
ubinary	string
uint8	string

EmbeddingInputType

El tipo de la entrada. text, query o document. Devuelve un error 422 si el modelo no admite el valor o el parámetro.

Nombre	Escribir	Descripción
documento	string	Indica que la entrada representa un documento almacenado en una base de datos vectorial.
consulta	string	Indica que la entrada representa una consulta de búsqueda para buscar los documentos más relevantes en la base de datos vectorial.
text	string	Indica que la entrada es una entrada de texto general.

EmbeddingObject

Nombre	Escribir	Descripción
insertar	string

ListObject

Tipo de objeto, que siempre es "list".

Nombre	Escribir	Description
list	string

NotFoundError

Nombre	Escribir	Descripción
error	string	Descripción del error.
message	string	El mensaje de error.
status	integer	El código de estado HTTP.

TooManyRequestsError

Nombre	Escribir	Descripción
error	string	Descripción del error.
message	string	El mensaje de error.
status	integer	El código de estado HTTP.

UnauthorizedError

Nombre	Escribir	Descripción
error	string	Descripción del error.
message	string	El mensaje de error.
status	integer	El código de estado HTTP.

UnprocessableContentError

La solicitud contiene contenido no procesable. El error se devuelve cuando la carga indicada es válida según esta especificación. Sin embargo, el modelo subyacente no admite algunas de las instrucciones indicadas en la carga. Use la sección details para comprender el parámetro infractor.

Nombre	Escribir	Descripción
código	string	Código de error.
detalles	Detalle
error	string	Descripción del error.
message	string	El mensaje de error.
status	integer	El código de estado HTTP.

Uso

Información de uso de la solicitud.

Nombre	Escribir	Descripción
prompt_tokens	integer	El número de tokens usados por la solicitud.
total_tokens	integer	El número total de tokens usados por la solicitud.

Compartir vía