向量降维服务

服务名称	服务ID	服务描述	API调用QPS限制（含主账号与RAM子账号）
OpenSearch向量降维服务-001	ops-embedding-dim-reduction-001	提供向量降维服务，可通过微调向量降维模型，获取业务专属降维服务，支持4k以内向量降维。	50 说明 如需扩充QPS，请通过工单联系技术支持协助。

前提条件

• 获取身份鉴权信息

  通过API调用AI搜索开放平台服务时，需要对调用者身份进行鉴权，如何获取鉴权信息请参见获取API-KEY。

• 获取服务调用地址

  支持通过公网和VPC两种方式调用服务，详情请参见获取服务接入地址。

请求说明

公共说明

• 请求body最大不能超过8MB。

HTTP请求方式

POST

URL

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

• host：调用服务的地址，支持通过公网和VPC两种环境调用API服务，可参见获取服务接入地址。登录AI搜索开放平台控制台，在左侧导航栏单击API Keys，在访问域名区域获取公网或私网API域名作为{host}的值。公网API域名适用于公网环境，私网API域名适用于上海、杭州、深圳、北京、张家口、青岛区域的VPC环境。单击创建API Key可创建新的密钥用于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	内部错误

更多状态码说明，请参见状态码说明。