埋め込みを作成

テキスト(対応モデルの場合はマルチモーダルコンテンツも)をベクトル埋め込みに変換します。リクエストとレスポンスの形式は OpenAI の embeddings API と一致しており、client.embeddings.create() でそのまま使用できます。input には単一文字列または文字列の配列を指定できます。

POST/api/v1/embeddings

認証

Authorization必須

string · header

Authorization ヘッダーに Bearer トークンとして API キーを渡します。

Body

model必須

string

使用する埋め込みモデル。プロバイダー修飾形式、例:"openai/text-embedding-3-small"。

minLength: 1

Example: "openai/text-embedding-3-small"

input必須

string | string[]

埋め込み対象のテキスト。単一文字列、または 1 回のリクエストで複数入力を埋め込むための文字列配列を指定できます。一部のモデルは構造化されたマルチモーダルコンテンツ項目も受け付け、アップストリームにそのまま転送されます。実際の対応可否はモデルによります。

Example: "The quick brown fox"

encoding_format

string

エンコーディング形式。ローカルでの検証なしにアップストリームへそのまま転送されます。対応する値はアップストリームによって異なります。

Example: "float"

dimensions

integer

出力ベクトルの次元数。ローカルでの検証なしにアップストリームへそのまま転送されます。カスタム次元数に対応するモデルは一部のみで、非対応の場合の挙動(通常は無視またはエラー)はアップストリームが決定します。

provider

object

プロバイダールーティング設定(order、only、ignore、allow_fallbacks、sort など)。一部のモデルルートでのみ転送・適用されます。対応していないルートではこのフィールドは静かに無視され、送信されません。

POST /api/v1/embeddings

1
2
3
4
5
6
7
curl https://bazaarlink.ai/api/v1/embeddings \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/text-embedding-3-small",
    "input": "The quick brown fox"
  }'

レスポンス例

成功。OpenAI 互換形式を返します。data[] は input の順序に対応し、usage.cost は今回のリクエストで実際に課金された金額です。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.0023064255,
        -0.009327292,
        0.015797347
      ]
    }
  ],
  "model": "openai/text-embedding-3-small",
  "usage": {
    "prompt_tokens": 5,
    "total_tokens": 5,
    "cost": 1e-7
  }
}