このトピックでは、テキストのベクトル化を実行するために使用される API について説明します。
前提条件
ID 認証用の API キーを取得済みであること。OpenSearch LLM-Based Conversational Search Edition の API 操作を呼び出すときは、認証されている必要があります。詳細については、「API キーを管理する」をご参照ください。LLM は大規模言語モデルの略です。
エンドポイントを取得済みであること。OpenSearch LLM-Based Conversational Search Edition の API 操作を呼び出すときは、エンドポイントを指定する必要があります。詳細については、「エンドポイントを取得する」をご参照ください。
操作情報
リクエストメソッド | リクエストプロトコル | リクエストデータ形式 |
POST | HTTP | JSON |
リクエスト URL
{host}/v3/openapi/apps/[app_group_identity]/actions/knowledge-embedding{host}: API 操作の呼び出しに使用するエンドポイント。インターネットまたは VPC (仮想プライベートクラウド) を介して API 操作を呼び出すことができます。エンドポイントの取得方法の詳細については、「エンドポイントを取得する」をご参照ください。{app_group_identity}: アクセスするアプリケーションの名前。OpenSearch LLM-Based Conversational Search Edition コンソール にログインし、[インスタンス管理] ページで対応するインスタンスのアプリケーション名を確認できます。
リクエストパラメーター
ヘッダーパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
Content-Type | string | はい | リクエストのデータ形式。JSON 形式のみがサポートされています。値を application/json に設定します。 | application/json |
Authorization | string | はい | リクエスト認証に使用する API キー。値は Bearer で始まる必要があります。 | Bearer OS-d1**2a |
ボディパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
content | string | はい | 処理対象のデータコンテンツ。 | Test text |
query | boolean | はい | ベクトル化するテキストが検索クエリかどうかを指定します。デフォルト値: false。 | false |
model | string | いいえ | 使用するベクトル化モデル。 |
リクエストボディの例
{
"content":"Test text",
"query":false
}レスポンスパラメーター
パラメーター | タイプ | 説明 |
contentVector | string | ベクトル化後のベクトル。 |
レスポンスボディの例
{
"request_id":"111111111111",
"status":"OK";
"errors":[],
"result":"-0.010441,-0.002826,-0.022911,0.000847,0.025610,0.019213,-0.019912,0.008210,0.011974,-0.010120,-0.003866,-0.008091,-0.006889,-0.034774,...-0.012572,0.009668,0.010963,-0.005273,-0.005072,-0.002190,-0.001554,-0.000058"
}テキストベクトル化後のベクトルは 1,536 次元です。