Embed y rerank

Apunta tu cliente de OpenAI o Cohere a https://api.conare.ai/v1 para usar los modelos de Conare por separado. Una clave Models only puede llamarlos y no accede a ningún namespace.

Modelo	Uso	Salida
`conare-embed-1`	Embeddings para documentos y consultas	1.024 dimensiones
`conare-rerank-1`	Reranking (el predeterminado)	Una puntuación de relevancia por documento

Embed

POST /v1/embeddings Genera los embeddings de los documentos tal cual, y los de las consultas de búsqueda con 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 }
}

Opción	Tipo	Qué hace
`input`	string o array, obligatorio	De 1 a 128 textos, cada uno de hasta 32 KiB
`model`	string	`conare-embed-1` (el predeterminado), o el id de tu propio modelo
`input_type`	string, predeterminado `document`	`query` para consultas de búsqueda
`encoding_format`	string, predeterminado `float`	`float`, o `base64` para float32 little-endian
`dimensions`	integer	Solo las del propio modelo, 1.024

data contiene un embedding de 1.024 números por entrada, con su index. Esquema completo: Embed texts (OpenAI-compatible).

Rerank

POST /v1/rerank Puntúa documentos frente a una consulta, el mejor primero; acepta la solicitud de Cohere, y /v2/rerank acepta el ClientV2 de 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 }
}

Opción	Tipo	Qué hace
`query`	string, obligatorio	Hasta 8.192 caracteres
`documents`	array, obligatorio	De 1 a 100 strings, u objetos con un `text`; hasta 1.000 con un modelo entrenado para ti
`model`	string	Omítelo para usar `conare-rerank-1`; un modelo desconocido devuelve `400`
`top_n`	integer	Devuelve solo los `top_n` mejores
`return_documents`	boolean, predeterminado `false`	Incluye el texto de cada documento como `document`
`max_tokens_per_doc`	integer	Recorta cada documento a aproximadamente este número de tokens

Campo	Significado
`results`	El mejor primero: `index` en `documents`, y `relevance_score` (cuanto más alto, mejor)
`unscored`	Documentos a los que el reranker no llegó a tiempo
`id`, `usage`	El id de la solicitud y los tokens leídos

Esquema completo: Rerank (Cohere-compatible), Rerank (Cohere v2).

Modelos

GET /v1/models Lista en data los modelos que tu clave puede llamar, incluidos los modelos entrenados para tu organización.

Cada uno tiene su id y su type (embedding o rerank); un modelo en proceso de retirada tiene una fecha sunset y un successor.
GET /v1/models/:id devuelve un modelo, o 404 model_not_found.

Esquema completo: List models.

Rutas nativas

El formato propio de Conare, que usa el 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" }

Opción	Tipo	Qué hace
`input`	array, obligatorio	De 1 a 128 textos
`type`	string, predeterminado `document`	`query` para consultas de búsqueda
`output_dtype`	string, predeterminado `float`	`int8` devuelve números enteros de -127 a 127 y una escala por vector en `scales`; la similitud del coseno es la misma

Esquema completo: Embed texts. POST /rerank

Response

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

Opción	Tipo	Qué hace
`query`	string, obligatorio	Hasta 8.192 caracteres
`documents`	array, obligatorio	De 1 a 100 strings, o hasta 1.000 con un modelo entrenado para ti
`top_k`	integer	Devuelve solo los `top_k` mejores

Esquema completo: Rerank documents.

Primeros pasos

Esenciales

Archivos

Sincronización

Modelos

Herramientas

Embed y rerank

Embed

Rerank

Modelos

Rutas nativas

​Embed

​Rerank

​Modelos

​Rutas nativas

Embed

Rerank

Modelos

Rutas nativas