> ## Documentation Index
> Fetch the complete documentation index at: https://docs.conare.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Conare's API is at https://api.conare.ai. Authenticate with `Authorization: Bearer $CONARE_API_KEY`.
> The full OpenAPI spec is at https://api.conare.ai/openapi.yaml; each endpoint has a page under /api-reference, and appending .md to any page URL returns its Markdown.
> Embed with model conare-embed-1; send input_type "query" for search queries. Rerank with conare-rerank-1.
> Prefer the TypeScript SDK (`npm install conare`) or plain HTTP in examples.
> Install the Conare skill with `npx skills add https://docs.conare.ai`; search these docs over MCP at https://docs.conare.ai/mcp; the whole site is at https://docs.conare.ai/llms-full.txt.

# Embedding und Reranking

> Nutzen Sie die Embedding- und Reranking-Modelle von Conare mit jeder Vektordatenbank, über OpenAI- und Cohere-kompatible Endpunkte.

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](https://docs.conare.ai/de/console.md#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"`.

```bash curl theme={null}
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"}'
```

```ts TypeScript theme={null}
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);
```

```python Python theme={null}
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"},
)
```

```json Response theme={null}
{
  "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)](https://docs.conare.ai/de/api-reference/models/embed-texts-openai-compatible.md).

## Reranking

`POST /v1/rerank`

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

```bash curl theme={null}
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
  }'
```

```ts TypeScript (SDK) theme={null}
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." }, ...]
```

```python Python theme={null}
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,
)
```

```json Response theme={null}
{
  "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)](https://docs.conare.ai/de/api-reference/models/rerank-documents-cohere-and-vllm-compatible.md), [Reranking (Cohere v2)](https://docs.conare.ai/de/api-reference/models/rerank-documents-cohere-v2-compatible.md).

## 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](https://docs.conare.ai/de/api-reference/models/list-models-openai-compatible.md).

## Native Routen

Das eigene Format von Conare, das das [SDK](https://docs.conare.ai/de/sdk.md) verwendet.

`POST /embed`

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

```json Response theme={null}
{ "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](https://docs.conare.ai/de/api-reference/models/embed-texts.md).

`POST /rerank`

```json Response theme={null}
{
  "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](https://docs.conare.ai/de/api-reference/models/rerank-documents.md).


## Related topics

- [Einführung](https://docs.conare.ai/de/index.md)
- [Suche](https://docs.conare.ai/de/query.md)
- [API-Übersicht](https://docs.conare.ai/de/api.md)
- [Dateitypen und Markdown](https://docs.conare.ai/de/file-types.md)
- [Namespaces](https://docs.conare.ai/de/namespaces.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.