Embedding und Reranking

Richten Sie Ihren OpenAI- oder Cohere-Client auf https://api.conare.ai/v1, um die Modelle von Conare eigenständig zu nutzen. Ein Nur-Modelle-Schlüssel kann sie aufrufen und erreicht keinen Namespace.

Modell	Verwendung	Ausgabe
`conare-embed-1`	Embeddings für Dokumente und Anfragen	1.024 Dimensionen
`conare-rerank-1`	Reranking (der Standard)	Ein Relevanzwert pro Dokument

Embedding

POST /v1/embeddings Betten Sie Dokumente unverändert ein und Suchanfragen mit 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 }
}

Option	Typ	Funktion
`input`	string oder array, erforderlich	1–128 Texte, jeweils bis zu 32 KiB
`model`	string	`conare-embed-1` (der Standard) oder die ID Ihres eigenen Modells
`input_type`	string, Standard `document`	`query` für Suchanfragen
`encoding_format`	string, Standard `float`	`float` oder `base64` für Little-Endian-float32
`dimensions`	integer	Nur die des Modells selbst, 1.024

data enthält pro Eingabe ein embedding aus 1.024 Zahlen, mit seinem index. Vollständiges Schema: Texte einbetten (OpenAI-kompatibel).

Reranking

POST /v1/rerank Bewertet Dokumente anhand einer Anfrage, das beste zuerst; die Route akzeptiert Coheres Request, und /v2/rerank akzeptiert Coheres ClientV2.

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

Option	Typ	Funktion
`query`	string, erforderlich	Bis zu 8.192 Zeichen
`documents`	array, erforderlich	1–100 Strings oder Objekte mit einem `text`; bis zu 1.000 mit einem für Sie trainierten Modell
`model`	string	Weglassen für `conare-rerank-1`; ein unbekanntes Modell gibt `400` zurück
`top_n`	integer	Nur die besten `top_n` zurückgeben
`return_documents`	boolean, Standard `false`	Den Text jedes Dokuments als `document` einschließen
`max_tokens_per_doc`	integer	Jedes Dokument auf etwa so viele Tokens kürzen

Feld	Bedeutung
`results`	Das beste zuerst: `index` in `documents` und `relevance_score` (höher ist besser)
`unscored`	Dokumente, die der Reranker nicht rechtzeitig erreicht hat
`id`, `usage`	Die Request-ID und die gelesenen Tokens

Vollständiges Schema: Reranking (Cohere-kompatibel), Reranking (Cohere v2).

Modelle

GET /v1/models Listet in data die Modelle auf, die Ihr Schlüssel aufrufen kann, einschließlich der für Ihre Organisation trainierten Modelle.

Jedes hat seine id und seinen type (embedding oder rerank); ein auslaufendes Modell hat ein sunset-Datum und einen successor.
GET /v1/models/:id gibt ein Modell zurück oder 404 model_not_found.

Vollständiges Schema: Modelle auflisten.

Native Routen

Das eigene Format von Conare, das das SDK verwendet. 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" }

Option	Typ	Funktion
`input`	array, erforderlich	1–128 Texte
`type`	string, Standard `document`	`query` für Suchanfragen
`output_dtype`	string, Standard `float`	`int8` gibt ganze Zahlen von -127 bis 127 und einen Skalierungsfaktor pro Vektor in `scales` zurück; die Kosinus-Ähnlichkeit bleibt gleich

Vollständiges Schema: Texte einbetten. POST /rerank

Response

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

Option	Typ	Funktion
`query`	string, erforderlich	Bis zu 8.192 Zeichen
`documents`	array, erforderlich	1–100 Strings oder bis zu 1.000 mit einem für Sie trainierten Modell
`top_k`	integer	Nur die besten `top_k` zurückgeben

Vollständiges Schema: Dokumente reranken.

Erste Schritte

Grundlagen

Dateien

Synchronisierung

Modelle

Tools

Embedding und Reranking

Embedding

Reranking

Modelle

Native Routen

​Embedding

​Reranking

​Modelle

​Native Routen

Embedding

Reranking

Modelle

Native Routen