OpenSearch:疎なテキスト埋め込み

サービス名	サービス ID	説明	QPS 制限
OpenSearch 疎なテキスト埋め込みサービス-001	ops-text-sparse-embedding-001	対応言語：100 以上 最大入力長：8,192 トークン	50 説明 API の QPS 制限の引き上げをリクエストする場合は、テクニカルサポートにチケットを送信してください。

前提条件

• 認証情報の取得

  AI Search オープンプラットフォームでは、認証に API キーが必要です。手順については、「API キーの取得」をご参照ください。

• サービスエンドポイントの取得

  サービスは、パブリックネットワークまたは VPC 経由で呼び出すことができます。詳細については、「サービスエンドポイントの取得」をご参照ください。

注意事項

• リクエストボディは 8 MB を超えることはできません。

リクエストメソッド

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/text-sparse-embedding/{service_id} 

URL パラメーター

• host：サービスエンドポイント。API サービスは、インターネットまたは VPC 経由で呼び出すことができます。詳細については、「サービスエンドポイントの取得」をご参照ください。

  コンソールの [API キー] ページの [アクセスドメイン名] セクションで、インターネットおよび VPC API ドメインを確認できます。ドメイン名形式は http://<instance_id>.opensearch.aliyuncs.com です (HTTPS もサポートされています)。VPC API ドメインは、中国 (上海)、中国 (杭州)、中国 (深セン)、中国 (北京)、中国 (張家口)、および中国 (青島) リージョンの VPC 環境に適用されます。

• workspace_name：ワークスペースの名前。例：default。

• service_id：組み込みのサービス ID。例：ops-text-sparse-embedding-001。

リクエストパラメーター

ヘッダーパラメーター

API キー認証

パラメーター	型	必須	説明	例
Content-Type	String	はい	リクエストのメディアタイプ。application/json に設定します。	application/json
Authorization	String	はい	認証用の API キー。フォーマットは Bearer <your_api_key> です。	Bearer OS-d1**2a

ボディパラメーター

パラメーター	型	必須	説明	例
input	Array/String	はい	埋め込む入力テキスト。文字列または文字列の配列として指定します。1 つのリクエストには最大 32 個のエントリを含めることができます。各エントリの最大長はモデルによって異なります。空の文字列はサポートされていません。	["Science and technology are the primary productive forces", "OpenSearch product documentation"]
input_type	String	いいえ	入力のタイプ。有効値： query document デフォルト値は document です。	document
return_token	boolean	いいえ	トークン化されたテキストを返すかどうかを指定します。有効値： true：トークン化されたテキストが返されます。 false：トークン化されたテキストは返されません。 デフォルト値は false です。	false

レスポンスパラメーター

パラメーター	型	説明	例
request_id	String	API 呼び出しの一意の ID。	B4AB89C8-B135-****-A6F8-2BAB801A2CE4
latency	Float/Int	リクエストのレイテンシ (ミリ秒、ms)。	10
usage	Object	呼び出しの使用量情報。	"usage": { "token_count": 11 }
usage.token_count	Int	トークンの数。	11
result.sparse_embeddings	List	埋め込み結果。これはオブジェクトの配列で、各オブジェクトは入力配列内の項目に対応します。	[ { "index": 0, "embedding": [{ "tokenId": 6, "weight": 0.10137939453125 }] }, { "index": 1, "embedding": [{ "tokenId": 9803, "weight": 0.1951904296875 }] } ]
result.sparse_embeddings[].index	Int	入力配列内の対応するテキストのインデックス。	0
result.sparse_embeddings[].embedding	List	疎な埋め込み結果。	[ { "token":"test", "token_id": 900, "weight":0.423 }]
result.sparse_embeddings[].embedding[].token	String	テキストトークン。このフィールドは、リクエストで return_token が true に設定されている場合にのみ返されます。	"xxx"
result.sparse_embeddings[].embedding[].token_id	Int	トークン ID。	123
result.sparse_embeddings[].embedding[].weight	Float	重み。	0.121

cURL の例

curl -XPOST -H "Content-Type: application/json" \
"http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-sparse-embedding/ops-text-sparse-embedding-001" \
-H "Authorization: Bearer <your_api_key>" \
-d '{
    "input": [
          "Science and technology are the primary productive forces", 
          "OpenSearch product documentation"
    ], 
    "input_type": "query", 
    "return_token": false
}'</your_api_key>

レスポンスの例

成功レスポンス

{
	"request_id": "75C50B5B-E79E-4930-****-F48DBB392231",
	"latency": 22,
	"usage": {
		"token_count": 11
	},
	"result": {
		"sparse_embeddings": [
			{
				"index": 0,
				"embedding": [
					{
						"tokenId": 6,
						"weight": 0.10137939453125
					},
					{
						"tokenId": 163040,
						"weight": 0.2841796875
					},
					{
						"tokenId": 354,
						"weight": 0.1431884765625
					},
					{
						"tokenId": 5998,
						"weight": 0.161376953125
					},
					{
						"tokenId": 8550,
						"weight": 0.2388916015625
					},
					{
						"tokenId": 2017,
						"weight": 0.1614990234375
					}
				]
			},
			{
				"index": 1,
				"embedding": [
					{
						"tokenId": 9803,
						"weight": 0.1951904296875
					},
					{
						"tokenId": 86250,
						"weight": 0.317138671875
					},
					{
						"tokenId": 5889,
						"weight": 0.17529296875
					},
					{
						"tokenId": 2564,
						"weight": 0.11614990234375
					},
					{
						"tokenId": 59529,
						"weight": 0.1666259765625
					}
				]
			}
		]
	}
}

エラーレスポンス

エラーが発生した場合、レスポンスにはエラーを説明する code および message フィールドが含まれます。

{
    "request_id": "45C8C9E5-6BCB-****-80D3-E298F788512B",
    "latency": 0,
    "code": "InvalidParameter",
    "message": "JSON parse error: Unexpected character ..."
}

ステータスコード

詳細については、AI Search オープンプラットフォームの「ステータスコード」をご参照ください。