カスタムデプロイメントサービス API リファレンス - OpenSearch

このトピックでは、カスタムデプロイメントサービスを呼び出す方法について説明します。

基本情報

エンドポイント

コンソールの [サービスデプロイメント] ページからエンドポイント (インターネットまたはプライベートネットワーク) を取得します。

対象サービスの [操作] 列で、[呼び出し情報] をクリックします。表示されるダイアログボックスに、インターネットエンドポイント、プライベートネットワークエンドポイント、および対応する アクセストークン が表示されます。

ヘッダー

Content-Type: application/json
Authorization: Bearer ${your_workspace_api_key}
Token: ${your_service_deployment_token}。このトークンは、サービスデプロイ > 呼び出し情報 から取得します。

マルチモーダル埋め込みモデル

リクエストパラメーター

パラメーター

タイプ

説明

例

type

String

有効な値：

text：入力がテキストであることを指定します。
image：入力が画像であることを指定します。

image

data

List[String]

各要素には、埋め込みに変換するテキストまたは画像が含まれます。リクエストごとに最大 16 枚の画像を送信することを推奨します。サポートされている画像形式は PNG と JPEG です。形式は data:image/{format};base64,{base64_image} である必要があります。

画像の場合：

["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
テキストの場合：

["a", "b", "c"]

リクエスト例

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_workspace_api_key>" \
-H "Token: <your_service_deployment_token>" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "type": "image",
  "data": ["data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wCEAAoHCB..."]
}'

説明

1 つのリクエストにテキストと画像の両方の入力を含めることはできません。

応答例

{
	"embeddings": [{
			"index": 0,
			"embedding": [0.02272411249577999, -0.0535903535783],
			"type": "image"
		}, {
			"index": 1,
			"embedding": [0.02272411249577999, -0.0535903535783],
			"type": "image"
		}
	]
}

テキスト埋め込み API

リクエストパラメーター

パラメーター	タイプ	必須	場所	説明	例
input	Array/String	はい	body	変換するテキスト入力。リクエストごとに最大 16 個の入力が可能です。各入力の最大長は、選択したモデルによって異なります。空の文字列はサポートされていません。	["今日の天気は晴れです", "Open Search 製品ドキュメント"]
input_type	String	いいえ	body	`input` のデータ型を指定します。有効な値： `query` `document` デフォルト値は `document` です。	document
dimension	Int	いいえ	body	出力ベクターのディメンション。説明このパラメーターは、ベクター次元削減が有効なカスタムモデルにのみ適用されます。指定されたディメンションは、基盤モデルのディメンションを超えることはできません。	567

リクエスト例

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_workspace_api_key>" \
-H "Token: <your_service_deployment_token>" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
  "input":[
    "今日の天気は晴れです",
    "Open Search 製品ドキュメント"
  ],
  "input_type" : "document",
  "dimension": 567 # モデルでベクター次元削減が有効な場合にのみ適用されます。その値は基盤モデルのディメンションを超えることはできません。
}'

応答パラメーター

パラメーター	タイプ	説明	例
embeddings	List	オブジェクトの配列。各オブジェクトには、対応する入力テキストから生成された埋め込みが含まれます。	`[ { "index": 0, "embedding": [0.003143,0.009750,...,-0.017395] }, {} ]`
embeddings[].index	Int	`input` 配列内の対応するテキストのインデックス。	0
embeddings[].embedding	List(Double)	生成されたベクター埋め込み。	[0.003143,0.009750,...,-0.017395]

応答例

{
    "embeddings":[
        {
            "index":0,
            "embedding":[0.003143,0.009750,...,-0.017395]
        },
        {
            "index":1,
            "embedding":[]
        }
    ]
}

リランカー API

リクエストパラメーター

パラメーター	タイプ	必須	場所	説明
query	String	はい	body	クエリの内容。
docs	List<String>	はい	body	クエリに対して再ランク付けするドキュメント。リクエストごとに最大 16 個のドキュメントを含めることができます。

リクエスト例

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <your_workspace_api_key>" \
-H "Token: <your_service_deployment_token>" \
"http://xxxxxx.opensearch.aliyuncs.com/v3/openapi/xxxxxx" \
-d '{
    "query": "Open Search 製品ドキュメント",
    "docs": [
        "Open Search 製品ドキュメント",
        "Elasticsearch 製品ドキュメント"
    ]
}'

応答パラメーター

パラメーター	タイプ	説明	例
scores	List<Double>	`docs` 配列内の各ドキュメントのスコア。	[0.9860338568687439,0.793461263179779]

応答例

{
    "scores":[
        0.9999276399612427,
        0.8209319710731506
    ]
}

ステータスコード

詳細については、Open Search の「ステータスコード」をご参照ください。