向量降維服務 - OpenSearch

服務名稱

服務ID

服務描述

API調用QPS限制（含主帳號與RAM子帳號）

OpenSearch向量降維服務-001

ops-embedding-dim-reduction-001

提供向量降維服務，可通過微調向量降維模型，擷取業務專屬降維服務，支援4k以內向量降維。

說明

如需擴充QPS，請通過工單聯絡支援人員協助。

前提條件

擷取身份鑒權資訊
通過API調用AI搜尋開放平台服務時，需要對調用者身份進行鑒權，如何擷取鑒權資訊請參見擷取API-KEY。
擷取服務調用地址
支援通過公網和VPC兩種方式調用服務，詳情請參見擷取服務接入地址。

請求說明

公用說明

請求body最大不能超過8MB。

HTTP請求方式

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}

host：調用服務的地址，支援通過公網和VPC兩種環境調用API服務，可參見擷取服務接入地址。
workspace_name：工作空間名稱，例如default

service_id：系統內建服務id，例如ops-embedding-dim-reduction-001。

請求參數

Header參數

API-KEY認證

參數	類型	必填	描述	樣本值
Content-Type	String	是	請求類型：application/json	application/json
Authorization	String	是	API-Key	Bearer OS-d1**2a

Body參數

參數	類型	必填	描述	樣本值
input	List<List<Float>>	是	輸入向量集合。	[0.111,0.222,0.333]
parameters	Map	否	請求可調整參數，該參數基於不同服務ID會有所不同。
parameters.output_dimension	Integer	否	輸出維度，預設512。	512
parameters.model_name	String	否	使用者訓練好的模型名稱，如果是向量壓縮服務，則必填。	xxxx-model

返回參數

參數	類型	描述	樣本值
result.output	List<List<Float>>	微調之後的向量結果。
usage.doc_count	Int	本次請求輸入的向量條數.	2

Curl請求樣本

curl --location 'http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/embedding-tuning/ops-embedding-dim-reduction-001/' \
--header 'Authorization: Bearer 您的API-KEY' \
--header 'Content-Type: application/json' \
--data '{  
  "input": [
    [0.111,0.222,0.333],
    [0.121,0.221,0.331]
  ],
  "parameters":{
    "output_dimension": "512",
    "model_name" : "xxxx"
  }
}'

響應樣本

正常響應樣本

{
  "request_id": "450fcb80-f796-46c1-8d69-e1e86d29aa9f",
  "latency": 564.903929,
  "usage": {
    "doc_count": 2
  }
  "result": {
    "output":[
      [0.111,0.222,0.333],
      [0.121,0.221,0.331]
    ]
  }
}

異常響應樣本

在訪問請求出錯的情況下，輸出的結果中會通過code和message指明出錯原因。

{
    "request_id": "590A7EB8-AA84-****-AF31-8C35DC965972",
    "latency": 0.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "document.file_name required"
}

狀態代碼說明

HTTP 狀態代碼	錯誤碼	描述
200	-	請求成功，包括任務失敗情境，實際任務狀態需從result.status中判斷
404	BadRequest.TaskNotExist	任務不存在
400	InvalidParameter	不合法請求
500	InternalServerError	內部錯誤

更多狀態代碼說明，請參見狀態代碼說明。