機能の概要
このAPIは、テキストやマルチモーダルコンテンツのベクトル表現（Embeddings）を生成するために使用されます。自然言語やその他のモダリティデータを数値ベクトルに変換し、類似度計算、検索、分類などのダウンストリームタスクを実行するシナリオに適しています。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理をご参照ください。
リクエストパス
POST {BASE_URL}/api/v1/embeddings
リクエストヘッダー
プロパティ |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
なし
Queryパラメータ
なし
Bodyパラメータ
プロパティ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| model | string | はい | text-embedding-3-small | 埋め込みベクトルを生成するために使用するモデル名を指定します |
| input | unknown | はい | “The quick brown fox jumps over the lazy dog” | ベクトルを生成するための入力コンテンツ。文字列、文字列配列、またはその他の形式が可能です |
| encoding_format | string | いいえ | float | ベクトルエンコーディング形式。例：“float”または“base64” |
| dimensions | integer | いいえ | 512 | ベクトルの次元数を指定します |
| parameters | object | いいえ | {} | モデル固有の追加パラメータ |
実行結果
レスポンスパラメータ
プロパティ |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうかを示します。 |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータ |
dataフィールドの説明
プロパティ |
型 |
説明 |
|---|---|---|
| id | string | リソースの一意のID |
| name | string | リソース名 |
| status | string | リソースの状態 |
| createTime | string | 作成日時 |
リクエスト例
curl --request POST '{BASE_URL}/api/v1/embeddings' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data '{
"model": "text-embedding-3-small",
"input": "The quick brown fox jumps over the lazy dog",
"encoding_format": "float",
"dimensions": 512
}'
レスポンス例
{
"success": true,
"code": "200",
"message": "successful",
"data": {
"id": "emb_abc123",
"name": "embedding-result",
"status": "COMPLETED",
"createTime": "2026-04-10T10:00:00Z"
}
}