AI Search Open Platform は、API を介したテキスト埋め込みサービスの呼び出しをサポートしています。これらのサービスを使用して、テキストデータを密ベクトル表現に変換し、情報取得、テキスト分類、類似性比較などのシナリオに適しています。
サービス名 | サービス ID | サービスの説明 | API 呼び出しの QPS 制限 (Alibaba Cloud アカウントおよび RAM ユーザー) |
OpenSearch テキストベクトル化サービス -001 | ops-text-embedding-001 |
| 50 説明 より高い QPS を申請するには、チケットを送信してください。 |
OpenSearch テキスト埋め込みサービス-中国語-001 | ops-text-embedding-zh-001 |
| |
OpenSearch テキスト埋め込みサービス-英語-001 | ops-text-embedding-en-001 |
| |
OpenSearch 一般テキスト埋め込みサービス-002 | ops-text-embedding-002 | このモデルは、001 モデルと比較して、言語サポートが強化され、取得タスクのパフォーマンスが向上しています。
| |
GTE テキスト埋め込み-多言語-Base | ops-gte-sentence-embedding-multilingual-base |
| |
Qwen3 テキスト埋め込み-0.6B | ops-qwen3-embedding-0.6b | Qwen3 シリーズ多言語 (100+) テキスト埋め込みサービス。
|
前提条件
認証情報が取得されていること。
API を使用して AI Search Open Platform サービスを呼び出す場合、呼び出し元の ID を認証する必要があります。
サービスアクセスアドレスが取得されていること。
インターネットまたは VPC (仮想プライベートクラウド) 経由でサービスを呼び出すことができます。詳細については、「サービス登録アドレスの取得」をご参照ください。
リクエストの説明
一般的な説明
最大リクエストボディサイズは 8 MB を超えてはなりません。
リクエストメソッド
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/text-embedding/{service_id} host: サービスのエンドポイント。インターネット経由および VPC 経由での API 呼び出しをサポートします。詳細については、「サービスエンドポイントの取得」をご参照ください。
workspace_name: ワークスペースの名前 (例: 'default')。
service_id: システム組み込みのサービス ID (例: 'ops-text-embedding-001')。
リクエストパラメーター
ヘッダーパラメーター
API-KEY 認証
パラメーター | 型 | 必須 | 説明 | 値の例 |
Content-Type | 文字列 | はい | リクエストの型: application/json | application/json |
Authorization | 文字列 | はい | API-Key | Bearer OS-d1**2a |
ボディパラメーター
パラメーター | 型 | 必須 | 説明 | 値の例 |
input | 配列/文字列 | はい | 処理するコンテンツ。複数のテキスト入力をサポートし、リクエストごとに最大 32 です。各入力の長さはモデルに依存します。空の文字列は受け付けられません。 | ["科学技術は第一の生産力である","opensearch 製品ドキュメント"] |
input_type | 文字列 | いいえ | 入力のデータの型
| document |
応答パラメーター
パラメーター | 型 | 説明 | 値の例 |
request_id | 文字列 | リクエスト ID。 | B4AB89C8-B135-****-A6F8-2BAB801A2CE4 |
latency | Float/Int | リクエストの所要時間 (ミリ秒)。 | 10 |
usage | オブジェクト | この呼び出しによって生成されたメータリング情報。 | "usage": { "token_count": 3072 } |
usage.token_count | Int | トークンの数。 | 3072 |
result.embeddings | リスト | 出力された埋め込みコンテンツ、結果の配列。 | [{ "index": 0, "embedding": [0.003143,0.009750,...,-0.017395] }, {}] |
result.embeddings[].index | Int | 入力テキストに対応する序数。 | 0 |
result.embeddings[].embedding | List(Float) | ベクトル化された結果。 | [0.003143,0.009750,...,-0.017395] |
Curl リクエストの例
curl -XPOST -H"Content-Type: application/json"
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001"
-H "Authorization: Bearer your API-KEY"
-d "{
\"input\": [
\"科学技術は第一の生産力である\",
\"opensearch 製品ドキュメント\"
],
\"input_type\": \"query\"
}"応答の例
正常な応答の例
{
"request_id": "B4AB89C8-B135-****-A6F8-2BAB801A2CE4",
"latency": 38,
"usage": {
"token_count": 3072
},
"result": {
"embeddings": [
{
"index": 0,
"embedding": [
-0.02868066355586052,
0.022033605724573135,
-0.0417383536696434,
-0.044081952422857285,
0.02141784131526947,
-8.240503375418484E-4,
-0.01309406291693449,
-0.02169642224907875,
-0.03996409475803375,
0.008053945377469063,
...
-0.05131729692220688,
-0.016595875844359398
]
}
]
}
}異常な応答の例
リクエストでエラーが発生した場合、応答には特定のコードとメッセージで原因が詳述されます。
{
"request_id": "651B3087-8A07-****-B931-9C4E7B60F52D",
"latency": 0,
"code": "InvalidParameter",
"message": "JSON parse error: Cannot deserialize value of type `InputType` from String \"xxx\""
}ステータスコードの説明
詳細については、「ステータスコード」をご参照ください。