> ## 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 et reranking

> Utilisez les modèles d'embedding et de reranking de Conare avec n'importe quelle base vectorielle, via des endpoints compatibles OpenAI et Cohere.

Pointez votre client OpenAI ou Cohere vers `https://api.conare.ai/v1` pour utiliser les modèles de Conare seuls. Une [clé](https://docs.conare.ai/fr/console.md#clés) **Models only** peut les appeler et n'accède à aucun namespace.

| Modèle | Usage | Sortie |
| - | - | - |
| `conare-embed-1` | Embeddings pour documents et requêtes | 1 024 dimensions |
| `conare-rerank-1` | Reranking (par défaut) | Un score de pertinence par document |

## Embedding

`POST /v1/embeddings`

Encodez les documents tels quels, et les requêtes de recherche avec `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 | Type | Ce qu'elle fait |
| - | - | - |
| `input` | chaîne ou tableau, requis | 1 à 128 textes, chacun jusqu'à 32 Kio |
| `model` | chaîne | `conare-embed-1` (par défaut), ou l'id de votre propre modèle |
| `input_type` | chaîne, `document` par défaut | `query` pour les requêtes de recherche |
| `encoding_format` | chaîne, `float` par défaut | `float`, ou `base64` pour du float32 little-endian |
| `dimensions` | entier | Uniquement celle du modèle, 1 024 |

`data` contient un `embedding` de 1 024 nombres par entrée, avec son `index`. Schéma complet : [Embed texts (OpenAI-compatible)](https://docs.conare.ai/fr/api-reference/models/embed-texts-openai-compatible.md).

## Reranking

`POST /v1/rerank`

Notez des documents par rapport à une requête, le meilleur en premier ; accepte la requête de Cohere, et `/v2/rerank` accepte le `ClientV2` de Cohere.

```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 | Type | Ce qu'elle fait |
| - | - | - |
| `query` | chaîne, requis | Jusqu'à 8 192 caractères |
| `documents` | tableau, requis | 1 à 100 chaînes, ou objets avec un `text` ; jusqu'à 1 000 avec un modèle entraîné pour vous |
| `model` | chaîne | Omettez-le pour `conare-rerank-1` ; un modèle inconnu renvoie `400` |
| `top_n` | entier | Renvoie uniquement les `top_n` meilleurs |
| `return_documents` | booléen, `false` par défaut | Inclut le texte de chaque document dans `document` |
| `max_tokens_per_doc` | entier | Tronque chaque document à environ ce nombre de tokens |

| Champ | Signification |
| - | - |
| `results` | Le meilleur en premier : `index` dans `documents`, et `relevance_score` (plus élevé, c'est mieux) |
| `unscored` | Documents que le reranker n'a pas traités à temps |
| `id`, `usage` | L'id de la requête, et les tokens lus |

Schéma complet : [Rerank (Cohere-compatible)](https://docs.conare.ai/fr/api-reference/models/rerank-documents-cohere-and-vllm-compatible.md), [Rerank (Cohere v2)](https://docs.conare.ai/fr/api-reference/models/rerank-documents-cohere-v2-compatible.md).

## Modèles

`GET /v1/models`

Liste dans `data` les modèles que votre clé peut appeler, y compris ceux entraînés pour votre organisation.

* Chacun a son `id` et son `type` (`embedding` ou `rerank`) ; un modèle en cours de retrait a une date `sunset` et un `successor`.
* `GET /v1/models/:id` renvoie un modèle, ou `404 model_not_found`.

Schéma complet : [List models](https://docs.conare.ai/fr/api-reference/models/list-models-openai-compatible.md).

## Routes natives

Le format propre à Conare, utilisé par le [SDK](https://docs.conare.ai/fr/sdk.md).

`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 | Type | Ce qu'elle fait |
| - | - | - |
| `input` | tableau, requis | 1 à 128 textes |
| `type` | chaîne, `document` par défaut | `query` pour les requêtes de recherche |
| `output_dtype` | chaîne, `float` par défaut | `int8` renvoie des entiers de -127 à 127 et une échelle par vecteur dans `scales` ; la similarité cosinus est identique |

Schéma complet : [Embed texts](https://docs.conare.ai/fr/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 | Type | Ce qu'elle fait |
| - | - | - |
| `query` | chaîne, requis | Jusqu'à 8 192 caractères |
| `documents` | tableau, requis | 1 à 100 chaînes, ou jusqu'à 1 000 avec un modèle entraîné pour vous |
| `top_k` | entier | Renvoie uniquement les `top_k` meilleurs |

Schéma complet : [Rerank documents](https://docs.conare.ai/fr/api-reference/models/rerank-documents.md).


## Related topics

- [Introduction](https://docs.conare.ai/fr/index.md)
- [Recherche](https://docs.conare.ai/fr/query.md)
- [Console](https://docs.conare.ai/fr/console.md)
- [Présentation de l'API](https://docs.conare.ai/fr/api.md)
- [Namespaces](https://docs.conare.ai/fr/namespaces.md)


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