Saltar al contenido principal
POST
/
api
/
v1
/
llm
/
embeddings
Python (SDK)
from openapi import SDK


with SDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as sdk:

    res = sdk.llm.embeddings.embed(input="The quick brown fox jumps over the lazy dog.", model="auto", encoding_format="float")

    # Handle response
    print(res)
{
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023,
        -0.0091,
        0.0156,
        -0.0042,
        0.0089
      ],
      "index": 0
    }
  ],
  "model": "auto",
  "object": "list",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Autorizaciones

​
Authorization
string
header
requerido

Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.

Cuerpo

application/json

Parámetros de solicitud para crear incrustaciones. Genera representaciones vectoriales del(la) texto(s) de entrada.

​
input
requerido

El texto de entrada o el arreglo de textos para generar embeddings. Puede ser una sola cadena o un arreglo de cadenas. Nota: el tamaño del lote y los límites de longitud de entrada varían según el modelo. Consulte GET /embeddings/models para límites específicos del modelo.

Required string length: 1 - 100000
​
model
string
requerido

ID del modelo a utilizar para generar incrustaciones. Utiliza el formato proveedor:modelo. Consulta GET /embeddings/models para ver los modelos disponibles y sus límites.

Minimum string length: 1
​
dimensions
integer

El número de dimensiones que deben tener los embeddings de salida resultantes. Solo es compatible con ciertos modelos.

Rango requerido: 1 <= x <= 9007199254740991
​
encoding_format
enum<string>
predeterminado:float

El formato para devolver las incrustaciones. Puede ser 'float' (matriz de números) o 'base64' (binario codificado en base64).

Opciones disponibles:
float,
base64
​
user
string

Un identificador único que representa a tu usuario final.

Respuesta

200 - application/json

Está bien

Respuesta del punto final de embeddings que contiene los embeddings generados y la información de uso.

​
data
object[]
requerido

Una lista de objetos de incrustación. Cada objeto contiene el vector de incrustación como un arreglo de números de punto flotante o una cadena codificada en base64 que representa el significado semántico del texto de entrada.

​
model
string
requerido

El modelo utilizado para generar las incrustaciones

​
object
any
predeterminado:list
​
usage
object

Estadísticas de uso para la solicitud de incrustaciones.