如何使用文本向量化模型服務 - OpenSearch

本文為您介紹文本向量化API介面。

前提條件

擷取身份鑒權API Key：調用OpenSearch-LLM智能問答版服務時，需要對調用者身份進行鑒權，具體請參見管理API Key。
擷取服務調用地址：調用OpenSearch-LLM智能問答版服務時，需要提供服務的調用地址，具體請參見擷取服務調用地址。

介面資訊

要求方法	請求協議	請求資料格式
POST	HTTP	JSON

請求URL

{host}/v3/openapi/apps/[app_group_identity]/actions/knowledge-embedding

{host}：調用服務的地址，支援通過公網和VPC兩種方式調用API服務，可參見擷取服務調用地址。
{app_group_identity}：應用程式名稱，需要登入OpenSearch-LLM智能問答版控制台，在執行個體管理中查看對應執行個體的應用程式名稱。

請求參數

Header參數

參數	類型	是否必填	描述	樣本值
Content-Type	string	是	請求的資料格式，目前僅支援JSON格式，固定填寫"application/json"。	application/json
Authorization	string	是	請求鑒權的API Key，Bearer開頭。	Bearer OS-d1**2a

Body參數

參數	類型	是否必填	描述	樣本值
content	string	是	處理資料內容。	測試文本
query	boolean	是	進行向量化的文本是否是query，預設為false。	false
model	string	否	需要使用的向量化模型。

請求體樣本

{
  "content":"測試文本",
  "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"
}

說明

文本向量化後的向量維度為1536維。