URL
/vector-service/fetch
以上 URL 省略了请求Header参数及编码等因素。
以上 URL 中省略了访问应用的 host 地址。
以上URL 中拼接的所有查询参数,请查看下方“查询参数”的参数定义、使用方式及样例。
请求协议
HTTP
请求方式
POST
支持格式
JSON
签名机制
可用以下方法计算签名(authorization)
参数 | 类型 | 描述 |
accessUserName | string | 用户名,可在实例详情页>网络信息查看 |
accessPassWord | string | 密码,可在实例详情页>网络信息修改 |
import com.aliyun.darabonba.encode.Encoder;
import com.aliyun.darabonbastring.Client;
public class GenerateAuthorization {
public static void main(String[] args) throws Exception {
String accessUserName = "username";
String accessPassWord = "password";
String realmStr = "" + accessUserName + ":" + accessPassWord + "";
String authorization = Encoder.base64EncodeToString(Client.toBytes(realmStr, "UTF-8"));
System.out.println(authorization);
}
}
authorization正确返回格式:
cm9vdDp******mdhbA==
使用HTTP请求设置authorization参数是需加上Basic前缀
示例:(加在header中)
authorization: Basic cm9vdDp******mdhbA==
请求body语法
参数 | 描述 | 类型 | 是否必须 |
tableName | 表名 | string | 是 |
ids | id列表 | list[string] | 是 |
示例:(获取指定主键的数据)
{
"tableName": "gist",
"ids": [
"1",
"2",
"3"
]
}
返回参数
字段名 | 描述 | 类型 |
result | 结果列表 | list[Doc] |
totalCount | 结果数量 | int |
totalTime | 引擎查询耗时,单位ms | float |
errorCode | 错误码,有错误时才有该字段 | int |
errorMsg | 错误信息,有错误时才有该字段 | string |
Doc定义
字段名称 | 描述 | 类型 |
id | 主键字段 | 创建表时选择的类型 |
vector | 向量字段 | list[float] |
fields | 向量的属性字段 | map<string, FieldType> |
示例:
{
"result": [
{
"id": "1",
"vector": [
0.1,
0.2,
0.3
],
"fields": {
"a": 11
}
}
],
"totalCount": 1,
"totalTime": 1.2
}