向量降維服務(wù)
服務(wù)名稱 | 服務(wù)ID | 服務(wù)描述 | API調(diào)用QPS限制(含主賬號與RAM子賬號) |
OpenSearch向量降維服務(wù)-001 | ops-embedding-dim-reduction-001 | 提供向量降維服務(wù),可通過微調(diào)向量降維模型,獲取業(yè)務(wù)專屬降維服務(wù),支持4k以內(nèi)向量降維。 | 50 說明 如需擴(kuò)充QPS,請通過工單聯(lián)系技術(shù)支持協(xié)助。
|
前提條件
獲取身份鑒權(quán)信息
通過API調(diào)用AI搜索開放平臺服務(wù)時,需要對調(diào)用者身份進(jìn)行鑒權(quán),如何獲取鑒權(quán)信息請參見獲取API-KEY。
獲取服務(wù)調(diào)用地址
支持通過公網(wǎng)和VPC兩種方式調(diào)用服務(wù),詳情請參見獲取服務(wù)接入地址。
請求說明
公共說明
請求body最大不能超過8MB。
HTTP請求方式
POST
URL
{host}/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}
host:調(diào)用服務(wù)的地址,支持通過公網(wǎng)和VPC兩種環(huán)境調(diào)用API服務(wù),可參見獲取服務(wù)接入地址。
workspace_name:工作空間名稱,例如default
service_id: 系統(tǒng)內(nèi)置服務(wù)id,例如ops-embedding-dim-reduction-001。
請求參數(shù)
Header參數(shù)
API-KEY認(rèn)證
參數(shù) | 類型 | 必填 | 描述 | 示例值 |
Content-Type | String | 是 | 請求類型:application/json | application/json |
Authorization | String | 是 | API-Key | Bearer OS-d1**2a |
Body參數(shù)
參數(shù) | 類型 | 必填 | 描述 | 示例值 |
input | List<List<Float>> | 是 | 輸入向量集合。 | [0.111,0.222,0.333] |
parameters | Map | 否 | 請求可調(diào)整參數(shù),該參數(shù)基于不同服務(wù)ID會有所不同。 | |
parameters.output_dimension | Integer | 否 | 輸出維度,默認(rèn)512。 | 512 |
parameters.model_name | String | 否 | 用戶訓(xùn)練好的模型名稱,如果是向量壓縮服務(wù),則必填。 | xxxx-model |
返回參數(shù)
參數(shù) | 類型 | 描述 | 示例值 |
result.output | List<List<Float>> | 微調(diào)之后的向量結(jié)果。 | |
usage.doc_count | Int | 本次請求輸入的向量條數(shù). | 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"
}
}'
響應(yīng)示例
正常響應(yīng)示例
{
"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]
]
}
}
異常響應(yīng)示例
在訪問請求出錯的情況下,輸出的結(jié)果中會通過code和message指明出錯原因。
{
"request_id": "590A7EB8-AA84-****-AF31-8C35DC965972",
"latency": 0.0,
"code": "InvalidParameter",
"http_code": 400,
"message": "document.file_name required"
}
狀態(tài)碼說明
HTTP 狀態(tài)碼 | 錯誤碼 | 描述 |
200 | - | 請求成功,包括任務(wù)失敗場景,實際任務(wù)狀態(tài)需從result.status中判斷 |
404 | BadRequest.TaskNotExist | 任務(wù)不存在 |
400 | InvalidParameter | 不合法請求 |
500 | InternalServerError | 內(nèi)部錯誤 |
更多狀態(tài)碼說明,請參見狀態(tài)碼說明。