OpenAI埋め込み形式（Embeddings）

OpenAI 埋め込みフォーマット（Embeddings）

本ページの概要

公式ドキュメント

OpenAI Embeddings

📝 概要

指定した入力テキストのベクトル表現を取得します。これらのベクトルは、機械学習モデルやアルゴリズムで簡単に利用できます。関連ガイドについては Embeddings Guide を参照してください。

注意事項:

• 一部のモデルでは、入力全体の token 数に制限がある場合があります
• token 数の計算には サンプル Python コード を利用できます
• たとえば、text-embedding-ada-002 モデルの出力ベクトルの次元数は 1536 です

💡 リクエスト例

テキスト埋め込みを作成 ✅

curl https://4All API地址/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $4All API_API_KEY" \
  -d '{
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

レスポンス例:

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        -0.009327292,
        // ... (1536 个浮点数,用于 ada-002)
        -0.0028842222
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

一括で埋め込みを作成 ✅

curl https://4All API地址/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $4All API_API_KEY" \
  -d '{
    "input": ["The food was delicious", "The waiter was friendly"],
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

レスポンス例:

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255,
        // ... (1536 个浮点数)
      ],
      "index": 0
    },
    {
      "object": "embedding",
      "embedding": [
        -0.008815289,
        // ... (1536 个浮点数)
      ],
      "index": 1
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 12,
    "total_tokens": 12
  }
}

📮 リクエスト

エンドポイント

POST /v1/embeddings

入力テキストを表す埋め込みベクトルを作成します。

認証方法

API キー認証を行うには、リクエストヘッダーに以下を含めます:

Authorization: Bearer $4All API_API_KEY

ここで $OPENAI_API_KEY はあなたの API キーです。

リクエスト本文のパラメータ

input

• 型: 文字列または配列
• 必須: はい

埋め込み対象の入力テキストです。文字列、または token 配列としてエンコードします。1 回のリクエストで複数の入力を埋め込むには、文字列の配列、または token 配列の配列を指定します。入力はモデルの最大入力 token 数を超えてはいけません（text-embedding-ada-002 は 8192 token）、空文字列は不可です。また、配列の各次元は 2048 以下である必要があります。

model

• 型: 文字列
• 必須: はい

使用するモデル ID です。利用可能なモデルの一覧は List models API で確認するか、モデル概要で説明をご覧ください。

encoding_format

• 型: 文字列
• 必須: いいえ
• デフォルト値: float

埋め込みの返却形式です。float または base64 を指定できます。

dimensions

• 型: 整数
• 必須: いいえ

生成される出力埋め込みの次元数です。text-embedding-3 以降のモデルでのみサポートされています。

user

• 型: 文字列
• 必須: いいえ

あなたの最終ユーザーを一意に識別する ID です。OpenAI による不正利用の監視や検知に役立ちます。詳細はこちら。

📥 レスポンス

成功レスポンス

埋め込みオブジェクトの一覧を返します。

object

• 型: 文字列
• 説明: オブジェクトの種類。値は “list”

data

• 型: 配列
• 説明: 埋め込みオブジェクトを含む配列
• 属性:
• object : オブジェクトの種類。値は “embedding”
• embedding : 埋め込みベクトル。浮動小数点数のリスト。ベクトル長はモデルによって異なります
• index : 一覧内での埋め込みのインデックス

model

• 型: 文字列
• 説明: 使用したモデル名

usage

• 型: オブジェクト
• 説明: token 使用状況の統計
• 属性:
• prompt_tokens : プロンプトで使用した token 数
• total_tokens : 合計 token 数

埋め込みオブジェクト

埋め込みエンドポイントが返す埋め込みベクトルを表します。

{
  "object": "embedding",
  "embedding": [
    0.0023064255,
    -0.009327292,
    // ... (ada-002 总共 1536 个浮点数)
    -0.0028842222
  ],
  "index": 0
}

index

• 型: 整数
• 説明: 一覧内での埋め込みのインデックス

embedding

• 型: 配列
• 説明: 埋め込みベクトル。浮動小数点数のリスト。ベクトル長はモデルによって異なります。詳細は埋め込みガイドを参照してください

object

• 型: 文字列
• 説明: オブジェクトの種類。常に “embedding”

エラーレスポンス

リクエストに問題がある場合、API はエラー応答オブジェクトを返し、HTTP ステータスコードは 4XX〜5XX の範囲になります。

よくあるエラーコード

• 401 Unauthorized : API キーが無効、または指定されていない
• 400 Bad Request : 入力が空、または token 制限超過など、リクエストパラメータが無効
• 429 Too Many Requests : API 呼び出し制限を超過
• 500 Internal Server Error : サーバー内部エラー

エラーレスポンス例:

{
  "error": {
    "message": "The input exceeds the maximum length. Please reduce the length of your input.",
    "type": "invalid_request_error",
    "param": "input",
    "code": "context_length_exceeded"
  }
}