Embeddings e reranking

Aponte seu cliente OpenAI ou Cohere para https://api.conare.ai/v1 para usar os modelos do Conare de forma independente. Uma chave Models only pode chamá-los e não acessa nenhum namespace.

Modelo	Uso	Saída
`conare-embed-1`	Embeddings para documentos e consultas	1.024 dimensões
`conare-rerank-1`	Reranking (o padrão)	Uma pontuação de relevância por documento

Embeddings

POST /v1/embeddings Gere embeddings de documentos como estão, e de consultas de busca com input_type: "query".

curl https://api.conare.ai/v1/embeddings \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "conare-embed-1", "input": ["Refunds are available for 30 days."]}'

curl https://api.conare.ai/v1/embeddings \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "conare-embed-1", "input": "how do refunds work?", "input_type": "query"}'

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.conare.ai/v1", apiKey: process.env.CONARE_API_KEY });

const docs = await client.embeddings.create({ model: "conare-embed-1", input: ["Refunds are available for 30 days."] });
const query = await client.embeddings.create({
  model: "conare-embed-1",
  input: "how do refunds work?",
  input_type: "query",
} as OpenAI.EmbeddingCreateParams);

import os
from openai import OpenAI

client = OpenAI(base_url="https://api.conare.ai/v1", api_key=os.environ["CONARE_API_KEY"])

docs = client.embeddings.create(model="conare-embed-1", input=["Refunds are available for 30 days."])
query = client.embeddings.create(
    model="conare-embed-1",
    input="how do refunds work?",
    extra_body={"input_type": "query"},
)

Response

{
  "data": [{ "embedding": [0.12506497, 0.07159516, 0.017521178, ...], "index": 0, "object": "embedding" }],
  "model": "conare-embed-1",
  "object": "list",
  "usage": { "prompt_tokens": 12, "total_tokens": 12 }
}

Opção	Tipo	O que faz
`input`	string ou array, obrigatório	1-128 textos, cada um com até 32 KiB
`model`	string	`conare-embed-1` (o padrão), ou o id do seu próprio modelo
`input_type`	string, padrão `document`	`query` para consultas de busca
`encoding_format`	string, padrão `float`	`float`, ou `base64` para float32 little-endian
`dimensions`	integer	Apenas a do próprio modelo, 1.024

data contém um embedding de 1.024 números por entrada, com seu index. Schema completo: Gerar embeddings de textos (compatível com OpenAI).

Reranking

POST /v1/rerank Pontua documentos em relação a uma consulta, do melhor para o pior; aceita a requisição do Cohere, e /v2/rerank aceita o ClientV2 do Cohere.

curl https://api.conare.ai/v1/rerank \
  -H "Authorization: Bearer $CONARE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "how do refunds work?",
    "documents": ["Orders ship within two days.", "Refunds are available for 30 days."],
    "top_n": 1
  }'

import { Conare } from "conare";

const conare = new Conare();
const ranked = await conare.rerank("how do refunds work?", [
  "Orders ship within two days.",
  "Refunds are available for 30 days.",
]);
// [{ index: 1, score: 0.3468, document: "Refunds are available for 30 days." }, ...]

import os
import cohere

co = cohere.Client(base_url="https://api.conare.ai", api_key=os.environ["CONARE_API_KEY"])

response = co.rerank(
    query="how do refunds work?",
    documents=["Orders ship within two days.", "Refunds are available for 30 days."],
    top_n=1,
)

Response

{
  "id": "d9d8ac5739d77af256c01449d7f23bb2",
  "model": "conare-rerank-1",
  "results": [{ "index": 1, "relevance_score": 0.3484 }],
  "unscored": [],
  "usage": { "total_tokens": 57 }
}

Opção	Tipo	O que faz
`query`	string, obrigatório	Até 8.192 caracteres
`documents`	array, obrigatório	1-100 strings, ou objetos com um `text`; até 1.000 com um modelo treinado para você
`model`	string	Omita para usar `conare-rerank-1`; um modelo desconhecido retorna `400`
`top_n`	integer	Retorna apenas os `top_n` melhores
`return_documents`	boolean, padrão `false`	Inclui o texto de cada documento como `document`
`max_tokens_per_doc`	integer	Corta cada documento para aproximadamente esse número de tokens

Campo	Significado
`results`	Do melhor para o pior: `index` em `documents` e `relevance_score` (maior é melhor)
`unscored`	Documentos que o reranker não alcançou a tempo
`id`, `usage`	O id da requisição e os tokens lidos

Schema completo: Rerank (compatível com Cohere), Rerank (Cohere v2).

Modelos

GET /v1/models Lista em data os modelos que sua chave pode chamar, incluindo modelos treinados para sua organização.

Cada um tem seu id e type (embedding ou rerank); um modelo em desativação tem uma data sunset e um successor.
GET /v1/models/:id retorna um modelo, ou 404 model_not_found.

Schema completo: Listar modelos.

Rotas nativas

O formato próprio do Conare, usado pelo SDK. POST /embed

TypeScript

const [vector] = await conare.embed("how do refunds work?", { type: "query" });
const int8 = await conare.embed("how do refunds work?", { type: "query", outputDtype: "int8" });

Response

{ "dimensions": 1024, "embeddings": [[0.15636191, 0.03499228, -0.003388892, ...]], "model": "conare-embed-1" }

Opção	Tipo	O que faz
`input`	array, obrigatório	1-128 textos
`type`	string, padrão `document`	`query` para consultas de busca
`output_dtype`	string, padrão `float`	`int8` retorna números inteiros de -127 a 127 e uma escala por vetor em `scales`; a similaridade de cosseno é a mesma

Schema completo: Gerar embeddings de textos. POST /rerank

Response

{
  "model": "conare-rerank-1",
  "results": [{ "index": 1, "score": 0.3484 }, { "index": 0, "score": 0.1169 }],
  "unscored": []
}

Opção	Tipo	O que faz
`query`	string, obrigatório	Até 8.192 caracteres
`documents`	array, obrigatório	1-100 strings, ou até 1.000 com um modelo treinado para você
`top_k`	integer	Retorna apenas os `top_k` melhores

Schema completo: Reranquear documentos.

Primeiros passos

Essencial

Arquivos

Sincronização

Modelos

Ferramentas

Embeddings e reranking

Embeddings

Reranking

Modelos

Rotas nativas

​Embeddings

​Reranking

​Modelos

​Rotas nativas

Embeddings

Reranking

Modelos

Rotas nativas