> ## 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.

# 埋め込みとリランク

> OpenAI および Cohere 互換のエンドポイントを通じて、Conare の埋め込みモデルとリランクモデルを任意のベクトルデータベースで使います。

OpenAI または Cohere のクライアントを `https://api.conare.ai/v1` に向けると、Conare のモデルを単体で使えます。**Models only** の[キー](https://docs.conare.ai/ja/console.md#キー)はこれらを呼び出せますが、namespace にはアクセスできません。

| モデル | 用途 | 出力 |
| - | - | - |
| `conare-embed-1` | ドキュメントとクエリの埋め込み | 1,024 次元 |
| `conare-rerank-1` | リランク（デフォルト） | ドキュメントごとの関連度スコア |

## 埋め込み

`POST /v1/embeddings`

ドキュメントはそのまま埋め込み、検索クエリは `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 }
}
```

| オプション | 型 | 内容 |
| - | - | - |
| `input` | string または array、必須 | 1〜128 個のテキスト。各 32 KiB まで |
| `model` | string | `conare-embed-1`（デフォルト）、または独自モデルの id |
| `input_type` | string、デフォルト `document` | 検索クエリには `query` |
| `encoding_format` | string、デフォルト `float` | `float`、またはリトルエンディアン float32 の場合は `base64` |
| `dimensions` | integer | モデル固有の 1,024 のみ |

`data` には入力ごとに 1,024 個の数値からなる `embedding` が 1 つ、その `index` とともに含まれます。完全なスキーマ：[テキストを埋め込む（OpenAI 互換）](https://docs.conare.ai/ja/api-reference/models/embed-texts-openai-compatible.md)。

## リランク

`POST /v1/rerank`

クエリに対してドキュメントをスコア付けし、上位から返します。Cohere のリクエストを受け付け、`/v2/rerank` は Cohere の `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 }
}
```

| オプション | 型 | 内容 |
| - | - | - |
| `query` | string、必須 | 最大 8,192 文字 |
| `documents` | array、必須 | 1〜100 個の文字列、または `text` を持つオブジェクト。専用にトレーニングされたモデルでは最大 1,000 個 |
| `model` | string | 省略すると `conare-rerank-1`。不明なモデルは `400` を返します |
| `top_n` | integer | 上位 `top_n` 件のみを返します |
| `return_documents` | boolean、デフォルト `false` | 各ドキュメントのテキストを `document` として含めます |
| `max_tokens_per_doc` | integer | 各ドキュメントをおよそこのトークン数に切り詰めます |

| フィールド | 意味 |
| - | - |
| `results` | 上位から順に、`documents` 内の `index` と `relevance_score`（高いほど良い） |
| `unscored` | リランカーが時間内に処理できなかったドキュメント |
| `id`, `usage` | リクエスト id と、読み取ったトークン数 |

完全なスキーマ：[リランク（Cohere 互換）](https://docs.conare.ai/ja/api-reference/models/rerank-documents-cohere-and-vllm-compatible.md)、[リランク（Cohere v2）](https://docs.conare.ai/ja/api-reference/models/rerank-documents-cohere-v2-compatible.md)。

## モデル

`GET /v1/models`

キーで呼び出せるモデルを `data` に一覧表示します。組織向けにトレーニングされたモデルも含まれます。

* 各モデルには `id` と `type`（`embedding` または `rerank`）があります。廃止予定のモデルには `sunset` の日付と `successor` があります。
* `GET /v1/models/:id` は 1 つのモデル、または `404 model_not_found` を返します。

完全なスキーマ：[モデルを一覧表示する](https://docs.conare.ai/ja/api-reference/models/list-models-openai-compatible.md)。

## ネイティブルート

Conare 独自の形式で、[SDK](https://docs.conare.ai/ja/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" }
```

| オプション | 型 | 内容 |
| - | - | - |
| `input` | array、必須 | 1〜128 個のテキスト |
| `type` | string、デフォルト `document` | 検索クエリには `query` |
| `output_dtype` | string、デフォルト `float` | `int8` は -127〜127 の整数と、ベクトルごとに 1 つのスケールを `scales` に返します。コサイン類似度は変わりません |

完全なスキーマ：[テキストを埋め込む](https://docs.conare.ai/ja/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": []
}
```

| オプション | 型 | 内容 |
| - | - | - |
| `query` | string、必須 | 最大 8,192 文字 |
| `documents` | array、必須 | 1〜100 個の文字列。専用にトレーニングされたモデルでは最大 1,000 個 |
| `top_k` | integer | 上位 `top_k` 件のみを返します |

完全なスキーマ：[ドキュメントをリランクする](https://docs.conare.ai/ja/api-reference/models/rerank-documents.md)。


## Related topics

- [はじめに](https://docs.conare.ai/ja/index.md)
- [API の概要](https://docs.conare.ai/ja/api.md)
- [ドキュメントを書き込む](https://docs.conare.ai/ja/write.md)
- [コンソール](https://docs.conare.ai/ja/console.md)
- [MCP](https://docs.conare.ai/ja/mcp-server.md)


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