Pular para o conteúdo 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
  }
}

Autorizações

​
Authorization
string
header
obrigatório

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>.

Corpo

application/json

Parâmetros de solicitação para criar embeddings. Gera representações vetoriais do(s) texto(s) de entrada.

​
input
obrigatório

O texto de entrada ou array de textos para gerar embeddings. Pode ser uma única string ou um array de strings. Nota: os limites de tamanho do lote e de comprimento de entrada variam conforme o modelo. Veja GET /embeddings/models para limites específicos do modelo.

Required string length: 1 - 100000
​
model
string
obrigatório

ID do modelo a ser usado para gerar embeddings. Use o formato provider:model. Consulte GET /embeddings/models para ver os modelos disponíveis e seus limites.

Minimum string length: 1
​
dimensions
integer

O número de dimensões que os embeddings de saída resultantes devem ter. Suportado apenas em certos modelos.

Intervalo obrigatório: 1 <= x <= 9007199254740991
​
encoding_format
enum<string>
padrão:float

O formato para retornar os embeddings. Pode ser 'float' (array de números) ou 'base64' (binário codificado em base64).

Opções disponíveis:
float,
base64
​
user
string

Um identificador único representando seu usuário final.

Resposta

200 - application/json

OK

Resposta do endpoint de embeddings contendo os embeddings gerados e informações de uso.

​
data
object[]
obrigatório

Uma lista de objetos de incorporação. Cada objeto contém o vetor de incorporação como um array de números de ponto flutuante ou uma string codificada em base64 que representa o significado semântico do texto de entrada.

​
model
string
obrigatório

O modelo utilizado para gerar os embeddings

​
object
any
padrão:list
​
usage
object

Estatísticas de uso para a solicitação de embeddings