Embeddings — POST /v1/embeddings

O endpoint /v1/embeddings gera embeddings vetoriais para entrada de texto. Os embeddings representam o significado semântico do texto como um array de floats de alta dimensão, permitindo busca por similaridade, clustering e geração aumentada por recuperação (RAG). O endpoint é compatível com a API de Embeddings da OpenAI.

Endpoint

POST https://router.flatkey.ai/v1/embeddings

Modelos de embedding suportados

Modelo	Dimensões	Provedor
`gemini-embedding-001`	3072	Google
`text-embedding-3-small`	1536	OpenAI
`text-embedding-3-large`	3072	OpenAI

Consulte o Diretório de Modelos para disponibilidade e preços atuais.

Requisição

Cabeçalhos

Cabeçalho	Valor
`Authorization`	`Bearer $FLATKEY_API_KEY`
`Content-Type`	`application/json`

Parâmetros do corpo

string

obrigatório

ID do modelo de embedding. Exemplo: "gemini-embedding-001", "text-embedding-3-small".

string | array

obrigatório

Texto a ser embedado. Pode ser uma string única ou um array de strings para embedding em lote.

string

"float" (padrão) retorna um array de floats. "base64" retorna uma string codificada em base64.

integer

Número de dimensões para o embedding de saída. Não suportado por todos os modelos.

Exemplos de requisição

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

# Single text
response = client.embeddings.create(
    model="gemini-embedding-001",
    input="The quick brown fox jumps over the lazy dog",
)

embedding = response.data[0].embedding
print(f"Embedding dimensions: {len(embedding)}")
print(f"First 5 values: {embedding[:5]}")

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

# Batch embedding
texts = [
    "What is machine learning?",
    "How does neural network training work?",
    "Explain gradient descent",
]

response = client.embeddings.create(
    model="gemini-embedding-001",
    input=texts,
)

for i, item in enumerate(response.data):
    print(f"{texts[i]}: {len(item.embedding)} dimensions")

curl https://router.flatkey.ai/v1/embeddings \
  -H "Authorization: Bearer $FLATKEY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gemini-embedding-001",
    "input": "The quick brown fox jumps over the lazy dog"
  }'

Resposta

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [0.0023064255, -0.009327292, ...]
    }
  ],
  "model": "gemini-embedding-001",
  "usage": {
    "prompt_tokens": 9,
    "total_tokens": 9
  }
}

Campos da resposta

array

Array de objetos de embedding, um por string de entrada.

Mostrar objeto embedding

integer

Posição no array de entrada.

array

Array de floats do vetor de embedding.

integer

Número de tokens processados.

Exemplo de similaridade por cosseno

python

import os
import numpy as np
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["FLATKEY_API_KEY"],
    base_url="https://router.flatkey.ai/v1",
)

def embed(text):
    return client.embeddings.create(
        model="gemini-embedding-001",
        input=text,
    ).data[0].embedding

def cosine_similarity(a, b):
    a, b = np.array(a), np.array(b)
    return np.dot(a, b) / (np.linalg.norm(a) * np.linalg.norm(b))

q = embed("capital city of France")
doc1 = embed("Paris is the capital and most populous city of France.")
doc2 = embed("The Eiffel Tower is a famous landmark.")

print(cosine_similarity(q, doc1))  # higher — more relevant
print(cosine_similarity(q, doc2))  # lower

Visão geral

Endpoints

Embeddings — POST /v1/embeddings

Endpoint

Modelos de embedding suportados

Requisição

Cabeçalhos

Parâmetros do corpo

Exemplos de requisição

Resposta

Campos da resposta

Exemplo de similaridade por cosseno

​Endpoint

​Modelos de embedding suportados

​Requisição

​Cabeçalhos

​Parâmetros do corpo

​Exemplos de requisição

​Resposta

​Campos da resposta

​Exemplo de similaridade por cosseno

Endpoint

Modelos de embedding suportados

Requisição

Cabeçalhos

Parâmetros do corpo

Exemplos de requisição

Resposta

Campos da resposta

Exemplo de similaridade por cosseno