Embeddings | ArcBlock

このドキュメントでは、AIGNE Hub Embeddings API エンドポイントの詳細な仕様を説明します。このガイドに従うことで、テキストを数値ベクトル表現に変換する方法を学びます。これは、セマンティック検索、テキストクラスタリング、類似性分析などのタスクの基礎となるステップです。

エンベディングの作成

指定されたテキスト入力のベクトル表現を生成します。これは、テキストの数値表現を必要とする機械学習アプリケーションに役立ちます。

POST /api/embeddings

リクエストボディ

model string (required) — エンベディングの生成に使用するモデルの ID。モデルはエンベディングタスクと互換性がある必要があります。
input string or array (required) — エンベディングする入力テキストまたはトークン。単一の文字列、文字列の配列、整数の配列（トークン）、または整数配列の配列（バッチ処理されたトークン）を指定できます。

リクエスト例

以下は、cURL を使用して embeddings エンドポイントを呼び出す例です。

エンベディングリクエストの作成

curl https://your-aigne-hub-instance.com/api/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "AIGNE Hub is a unified AI gateway."
  }'

レスポンスボディ

API は、エンベディングデータのリストを含むオブジェクトを返します。

data array (required) — エンベディングオブジェクトの配列。各オブジェクトは入力アイテムに対応します。
- embedding array (required) — 入力テキストのベクトル表現。浮動小数点数の配列として返されます。
- index number (required) — リスト内のエンベディングのインデックス。入力アイテムの順序に対応します。
- object string (required) — オブジェクトのタイプ。常に embedding です。
model string (required) — エンベディングの生成に使用されたモデル。
object string (required) — トップレベルオブジェクトのタイプ。常に list です。
usage object (required) — リクエストのトークン使用量の詳細を示すオブジェクト。
- prompt_tokens number (required) — 入力プロンプトのトークン数。
- total_tokens number (required) — リクエストによって消費された合計トークン数。

レスポンス例

レスポンス例

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        -0.006929283495992422,
        -0.005336422007530928,
        ...
        -4.547132266452536e-05
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

まとめ

Embeddings API は、テキストを高次元ベクトルに変換する簡単な方法を提供し、幅広い自然言語処理アプリケーションを可能にします。より複雑な対話型 AI や生成 AI を構築する場合は、Chat Completions API の調査も検討してください。