本文档介绍如何使用Java、Python、Go与Java异步语言进行向量检索、预测检索以及包含过滤条件的检索。
相关依赖
Java
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-sdk-ha3engine-vector</artifactId>
<version>1.1.11</version>
</dependency>python
# Requires: Python >=3.6
pip install alibabacloud_ha3engine_vectorGo
go get github.com/aliyun/alibabacloud-ha3-go-sdk@v1.1.12-vectorJava异步
<dependency>
<groupId>com.aliyun</groupId>
<artifactId>aliyun-sdk-ha3engine-async</artifactId>
<version>1.1.4</version>
</dependency>参数说明
Java、Python SDK中都需要配置如下4个必要参数（endpoint、instance_id、access_user_name、access_pass_word）：
endpoint：私网/公网域名
可在实例详情页中网络信息和API入口查看：
开启公网访问后可以在本地通过公网域名（包含public的域名）调用实例，可以参考添加白名单配置访问的白名单IP。
若有ECS机器，可通过配置相同的交换机通过API域名调用实例。
instance_id：实例ID
access_user_name：用户名
access_pass_word：密码
用户名和密码可以在实例详情页中API入口处进行查看：（密码是购买实例时设置的，可以修改）
向量检索
简单检索
Java
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.QueryRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
QueryRequest request = new QueryRequest();
request.setTableName("gist"); // 必填项, 查询的表名
request.setVector(Arrays.asList(0.183762561f, 0.738372617f)); // 必填项, 查询的向量数据
request.setTopK(100); // 非必填项, 返回个数
request.setIncludeVector(true); // 非必填项, 是否返回文档中的向量信息
SearchResponse searchResponse = client.query(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}
Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
request = QueryRequest(table_name="gist",
vector=[0.1, 0.2, 0.3],
include_vector=True,
top_k=10)
result = client.query(request)Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
query(client)
}
/**
* 简单查询
*/
func query(client *ha3engine.Client) {
searchRequestModel := &ha3engine.QueryRequest{}
searchRequestModel.SetTableName("test1")
// 创建一个指向float32的指针数组
ids := make([]*float32, 4)
// 给指针数组元素赋值
ids[0] = tea.Float32(0.1)
ids[1] = tea.Float32(0.2)
ids[2] = tea.Float32(0.3)
ids[3] = tea.Float32(0.4)
searchRequestModel.SetVector(ids)
response, _requestErr := client.Query(searchRequestModel)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* @author alibaba
*/
public class SimpleQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void simpleQuery() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.tableName("table_name") // 查询的表名
.indexName("index_name") // 查询的索引名
.vector(Arrays.asList(0.0001575F, 0.00682848F)) // 查询的向量数据
.topK(10) // 返回个数
.includeVector(true) //是否返回文档中的向量信息
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.query(queryRequest);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}多向量检索
支持一次检索中包含多个向量，检索结果会合并排序，返回最优的topK。
Java
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.QueryRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
QueryRequest request = new QueryRequest();
request.setTableName("gist"); // 必填项, 查询的表名
request.setVector(Arrays.asList(0.1f, 0.2f, 0.3f, 0.4f)); // 必填项, 查询的向量数据
request.setVectorCount(2); // 非必填项, vector字段中包含的向量个数
request.setTopK(100); // 非必填项, 返回个数
request.setIncludeVector(true); // 非必填项, 是否返回文档中的向量信息
request.setOutputFields(new ArrayList<String>()); // 非必填项, 需要返回值的字段列表
request.setFilter("a>10"); // 非必填项, 过滤表达式
SearchResponse searchResponse = client.query(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}
Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
request = QueryRequest(table_name="t1",
vector=[0.1, 0.2, 0.3, 0.4],
vector_count=2,
include_vector=True,
filter="a > 10",
output_fields=["a", "b"]
top_k=10)
result = client.query(request)Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
multiVectorQuery(client)
}
func multiVectorQuery(client *ha3engine.Client) {
queryRequest := &ha3engine.QueryRequest{}
queryRequest.SetTableName("test1")
// 创建一个指向float32的指针数组
ids := make([]*float32, 8)
// 给指针数组元素赋值
ids[0] = tea.Float32(0.1)
ids[1] = tea.Float32(0.2)
ids[2] = tea.Float32(0.3)
ids[3] = tea.Float32(0.4)
ids[4] = tea.Float32(0.1)
ids[5] = tea.Float32(0.2)
ids[6] = tea.Float32(0.3)
ids[7] = tea.Float32(0.4)
queryRequest.SetVector(ids)
queryRequest.SetVectorCount(2)
response, _requestErr := client.Query(queryRequest)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* 多向量查询
*/
public class MultiVectorQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void multiVectorQuery() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.tableName("test1") // 查询的表名
.indexName("vector") // 查询的索引名
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F,0.62498F, 0.886408F, 0.586114F, 0.043189F)) // 查询的向量数据
.vectorCount(2)// 非必填项, vector字段中包含的向量个数
.topK(10) // 返回个数
.includeVector(false) //是否返回文档中的向量信息
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.query(queryRequest);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("query result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}namespace检索
OpenSearch向量检索版支持通过namespace将索引进行分区，为向量索引配置namespace后，可在指定namespace内查询，因此不同的查询请求可以搜索不同的索引子集。
注意：设置namespace后，查询时必须指定namespace。
Java
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.QueryRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
QueryRequest request = new QueryRequest();
request.setTableName("gist"); // 必填项, 查询的表名
request.setVector(Arrays.asList(0.183762561f, 0.738372617f)); // 必填项, 查询的向量数据
request.setNamespace("namespace"); // 非必填项, 查询向量的空间
request.setTopK(100); // 非必填项, 返回个数
request.setIncludeVector(true); // 非必填项, 是否返回文档中的向量信息
SearchResponse searchResponse = client.query(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}
Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
request = QueryRequest(table_name="t1",
namespace="space_b",
vector=[0.1, 0.2],
include_vector=True,
top_k=10)
result = client.query(request)Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
nameSpaceQuery(client)
}
func nameSpaceQuery(client *ha3engine.Client) {
searchRequestModel := &ha3engine.QueryRequest{}
searchRequestModel.SetTableName("test1")
// 创建一个指向float32的指针数组
ids := make([]*float32, 4)
// 给指针数组元素赋值
ids[0] = tea.Float32(0.1)
ids[1] = tea.Float32(0.2)
ids[2] = tea.Float32(0.3)
ids[3] = tea.Float32(0.4)
searchRequestModel.SetVector(ids)
searchRequestModel.SetNamespace("1")
response, _requestErr := client.Query(searchRequestModel)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
public class NameSpaceQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void nameSpaceQuery() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.tableName("test1") // 查询的表名
.indexName("vector") // 查询的索引名
.namespace("1")
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F)) // 查询的向量数据
.topK(10) // 返回个数
.includeVector(false) //是否返回文档中的向量信息
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.query(queryRequest);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("query result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}多namepsace检索
为向量索引配置namespace后，支持在多个namespace中查询。
Java
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.*;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void multiQuery() throws Exception {
try {
MultiQueryRequest request = new MultiQueryRequest();
request.setTableName("gist");
request.setTopK(3);
request.setIncludeVector(true);
QueryRequest query1 = new QueryRequest();
query1.setVector(Arrays.asList(0.1f, 0.2f, 0.3f));
query1.setNamespace("space_a");
QueryRequest query2 = new QueryRequest();
query2.setVector(Arrays.asList(0.1f, 0.2f, 0.3f));
query2.setNamespace("space_b");
request.setQueries(Arrays.asList(query1, query2));
SearchResponse searchResponse = client.multiQuery(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}
Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import QueryRequest
from alibabacloud_ha3engine_vector.models import MultiQueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
q1 = QueryRequest(vector=[0.1, 0.2, 0.3], namespace="space_a")
q2 = QueryRequest(vector=[0.4, 0.5, 0.6], namespace="space_b")
request = MultiQueryRequest(table_name = "gist",
queries=[q1, q2],
top_k=3,
include_vector=True)
result = client.multi_query(request)Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
multiNameSpaceQuery(client)
}
func multiNameSpaceQuery(client *ha3engine.Client) {
query1 := &ha3engine.QueryRequest{}
// 创建一个指向float32的指针数组
array := make([]*float32, 4)
// 分配内存地址并初始化值
value1 := float32(1.23)
value2 := float32(4.56)
value3 := float32(7.89)
value4 := float32(7.89)
// 给指针数组元素赋值
array[0] = &value1
array[1] = &value2
array[2] = &value3
array[3] = &value4
query1.SetVector(array)
query1.SetNamespace("space_a")
query2 := &ha3engine.QueryRequest{}
query2.SetVector(array)
query2.SetNamespace("space_b")
request := &ha3engine.MultiQueryRequest{}
request.SetTableName("test2")
querys := make([]*ha3engine.QueryRequest, 2)
querys[0] = query1
querys[1] = query2
request.SetQueries(querys)
request.SetTopK(10)
request.SetIncludeVector(false)
request.SetOrder("DESC")
response, _requestErr := client.MultiQuery(request)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.MultiQueryRequest;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
public class MultiNameSpaceQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void multiNameSpaceQuery() {
try {
QueryRequest query1 = QueryRequest.builder()
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F))
.namespace("space_a")
.build();
QueryRequest query2 = QueryRequest.builder()
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F))
.namespace("space_b")
.build();
MultiQueryRequest request = MultiQueryRequest.builder()
.tableName("test1")// 查询的表名
.topK(3)
.includeVector(false)// 是否返回文档中的向量信息
.queries(Arrays.asList(query1, query2))// 多个nameSpace查询条件
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.multiQuery(request);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("multiQuery result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}包含过滤条件的检索
支持使用filter表达式，指定过滤条件进行查询。
Java
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.QueryRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
QueryRequest request = new QueryRequest();
request.setTableName("gist"); // 必填项, 查询的表名
request.setVector(Arrays.asList(0.183762561f, 0.738372617f)); // 必填项, 查询的向量数据
request.setTopK(100); // 非必填项, 返回个数
request.setIncludeVector(true); // 非必填项, 是否返回文档中的向量信息
request.setOutputFields(new ArrayList<String>()); // 非必填项, 需要返回值的字段列表
request.setFilter("a>10"); // 非必填项, 过滤表达式
SearchResponse searchResponse = client.query(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}
Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
request = QueryRequest(table_name="t1",
vector=[0.1, 0.2],
include_vector=True,
filter="a > 10",
output_fields=["a", "b"]
top_k=10)
result = client.query(request)Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
filterQuery(client)
}
func filterQuery(client *ha3engine.Client) {
searchRequestModel := &ha3engine.QueryRequest{}
searchRequestModel.SetTableName("test1")
// 创建一个指向float32的指针数组
ids := make([]*float32, 4)
// 给指针数组元素赋值
ids[0] = tea.Float32(0.1)
ids[1] = tea.Float32(0.2)
ids[2] = tea.Float32(0.3)
ids[3] = tea.Float32(0.4)
searchRequestModel.SetVector(ids)
searchRequestModel.SetFilter("count>25")
response, _requestErr := client.Query(searchRequestModel)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
public class FilterQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void filterQuery() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.tableName("test1") // 查询的表名
.indexName("vector") // 查询的索引名
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F)) // 查询的向量数据
.topK(10) // 返回个数
.filter("count>25")// 过滤条件
.includeVector(false) //是否返回文档中的向量信息
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.query(queryRequest);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("multiQuery result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}filter使用可参考filter表达式。
主键检索
Java
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.FetchRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void fetch() throws Exception {
try {
FetchRequest request = new FetchRequest();
request.setTableName("gist");
request.setIds(Arrays.asList("1", "2"));
SearchResponse searchResponse = client.fetch(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}
Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import FetchRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
request = FetchRequest(table_name="gist", ids=["1", "2"])
result = client.fetch(request)Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
fetch(client)
}
/**
* 主键查询
*/
func fetch(client *ha3engine.Client) {
searchRequestModel := &ha3engine.FetchRequest{}
searchRequestModel.SetTableName("test1")
// 给指针数组元素赋值
ids := make([]*string, 3)
ids[0] = tea.String("1")
ids[1] = tea.String("2")
ids[2] = tea.String("3")
searchRequestModel.SetIds(ids)
response, _requestErr := client.Fetch(searchRequestModel)
//如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
//输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.FetchRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* @author alibaba
*/
public class PrimaryKeyQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void primaryKeyQuery() {
try {
FetchRequest fetchRequest = FetchRequest.builder().tableName("table_name").ids(Arrays.asList("1", "2")).build();
CompletableFuture<SearchResponse> searchResponseCompletableFuture = client.fetch(fetchRequest);
String responseBody = searchResponseCompletableFuture.get().getBody();
System.out.println("result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}预测查询
预测查询是用户通过向量检索版将文本或图片生成向量后，通过文本或图片进行向量化检索时用到的查询方式，SDK说明如下：
Java
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.QueryRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
import java.util.Map;
public class InferenceQuery {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void inferenceQuery() throws Exception {
try {
QueryRequest request = new QueryRequest();
request.setTableName("test"); // 必填项, 查询的表名
request.setContent("小孩"); // 必填项,查询的内容
request.setModal("text"); // 必填项,用于向量化查询词
request.setTopK(100); // 非必填项, 返回个数
request.setSearchParams("{\\\"qc.searcher.scan_ratio\\\":0.01}");
SearchResponse searchResponse = client.inferenceQuery(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
def inference_query():
request = QueryRequest(table_name="test",
content="小狗",
modal="text",
namespace="123",
search_params="{\\\"qc.searcher.scan_ratio\\\":0.01}",
top_k=10)
result = client.inference_query(request)
print(result.body)
if __name__ == "__main__":
inference_query()
Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
inferenceQuery(client)
}
/**
* 预测查询
*/
func inferenceQuery(client *ha3engine.Client) {
searchRequestModel := &ha3engine.QueryRequest{}
searchRequestModel.SetTableName("test1")
// 创建一个指向float32的指针数组
array := make([]*float32, 3)
// 分配内存地址并初始化值
value1 := float32(1.23)
value2 := float32(4.56)
value3 := float32(7.89)
// 给指针数组元素赋值
array[0] = &value1
array[1] = &value2
array[2] = &value3
//searchRequestModel.SetVector(array)
searchRequestModel.SetContent("小狗")
searchRequestModel.SetNamespace("123")
searchRequestModel.SetModal("text") // 必填项,用于向量化查询词
response, _requestErr := client.InferenceQuery(searchRequestModel)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* 预测查询
*/
public class InferenceQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void inferenceQuery() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.tableName("test2") // 查询的表名
.indexName("source_text_vector") // 查询的索引名
.namespace("1")// 查询的命名空间
.modal("text")// 模型名称
.content("测试文本转向量")// 需要向量化的内容
.topK(10) // 返回个数
.includeVector(false) //是否返回文档中的向量信息
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.inferenceQuery(queryRequest);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("queryInference result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}参数说明：
queryRequest中的content表示需要查询的内容，文本向量化场景则输入文本，图片向量化场景可以输入文本或者base64编码后的图片
queryRequest中的modal表示查询的方式，其中text表示文本向量化就是以文搜文，图片向量化就是以文搜图
批量查询
Java
import java.util.Arrays;
import java.util.Map;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.Config;
import com.aliyun.ha3engine.vector.models.MultiQueryRequest;
import com.aliyun.ha3engine.vector.models.QueryRequest;
import com.aliyun.ha3engine.vector.models.SearchResponse;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
/**
* 批量查询
*/
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
MultiQueryRequest multiQueryRequest = new MultiQueryRequest();
multiQueryRequest.setTableName("test1"); //查询的表名
multiQueryRequest.setTopK(50); // 最终返回的结果个数
multiQueryRequest.setOutputFields(Arrays.asList("content", "name", "age")); // 需要返回值的字段列表
multiQueryRequest.setOrder("DESC");
QueryRequest queryRequest = new QueryRequest();
queryRequest.setIndexName("vector"); // 查询的索引名 必须在SearchRequest中指定或者在每个Query中指定
queryRequest.setNamespace("space_a"); // 查询向量的空间
queryRequest.setVector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F)); // 查询的向量数据，多个向量可以平铺开
multiQueryRequest.setQueries(Arrays.asList(queryRequest));
SearchResponse searchResponse = client.multiQuery(multiQueryRequest);
System.out.println(searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config, MultiQueryRequest
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
def multi_query():
query1 = QueryRequest(table_name="test",
vector=[0.1, 0.2, 0.3, 0.4],
include_vector=True,
search_params="{\\\"qc.searcher.scan_ratio\\\":0.01}",
top_k=10)
queries = [query1]
request = MultiQueryRequest(table_name="test",
queries=queries,
top_k=10)
result = client.multi_query(request)
print(result.body)
if __name__ == "__main__":
multi_query()
Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
multiQuery(client)
}
/**
* 批量查询
*/
func multiQuery(client *ha3engine.Client) {
query := &ha3engine.QueryRequest{}
query.SetTableName("test1")
// 创建一个指向float32的指针数组
array := make([]*float32, 4)
// 分配内存地址并初始化值
value1 := float32(1.23)
value2 := float32(4.56)
value3 := float32(7.89)
value4 := float32(7.89)
// 给指针数组元素赋值
array[0] = &value1
array[1] = &value2
array[2] = &value3
array[3] = &value4
query.SetVector(array)
request := &ha3engine.MultiQueryRequest{}
request.SetTableName("test1")
querys := make([]*ha3engine.QueryRequest, 1)
querys[0] = query
request.SetQueries(querys)
request.SetTopK(10)
request.SetIncludeVector(true)
request.SetOrder("DESC")
response, _requestErr := client.MultiQuery(request)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.MultiQueryRequest;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* @author alibaba
*/
public class SearchDoc {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void searchDoc() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.indexName("content_vector") // 查询的索引名
.namespace("150086193") // 查询向量的空间
.vector(Arrays.asList(0.0001575F, 0.00682848F)) // 查询的向量数据
.build();
MultiQueryRequest multiQueryRequest = MultiQueryRequest.builder()
.tableName("hybrid") // 查询的表名
.topK(10) // 返回个数
.outputFields(Arrays.asList("content", "source", "instance_id")) // 需要返回值的字段列表
.filter("type='TEXT'") // 过滤表达式
.order("DESC") // 排序顺序
.queries(Arrays.asList(queryRequest)).build();
CompletableFuture<SearchResponse> searchResponseCompletableFuture = client.multiQuery(multiQueryRequest);
String responseBody = searchResponseCompletableFuture.get().getBody();
System.out.println("result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}混合查询（单向量）
混排查询是用户通过稠密向量和稀疏向量混合查询的方式，SDK说明如下：
Java
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.*;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
QueryRequest queryRequest = new QueryRequest();
queryRequest.setIndexName("index"); // 查询的索引名 必须在SearchRequest中指定或者在每个Query中指定
queryRequest.setNamespace("cate1"); // 查询向量的空间
queryRequest.setVector(Arrays.asList(0.0001575F, 0.00682848F)); // 查询的向量数据，多个向量可以平铺开
SparseData sparseData = new SparseData();
sparseData.setCount(Arrays.asList(2)); // 每个稀疏向量中包含的元素个数
sparseData.setIndices(Arrays.asList(983589459L, 1261855554L)); // 元素下标（需要从小到大排序）
sparseData.setValues(Arrays.asList(0.0001575F, 0.00682848F)); // 元素值（与下标一一对应）
queryRequest.setSparseData(sparseData);
SearchResponse searchResponse = client.query(queryRequest);
System.out.println(searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config, SparseData
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
def mix_query():
sparse_data = SparseData(indices=[101, 203], values=[0.1, 0.5])
request = QueryRequest(table_name="test",
index_name="embedding",
vector=[0.1, 0.2, 0.3, 0.4],
sparse_data=sparse_data,
include_vector = True,
top_k = 10)
result = client.query(request)
print(result.body)
if __name__ == "__main__":
mix_query()Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
mixQuery(client)
}
func mixQuery(client *ha3engine.Client) {
searchRequestModel := &ha3engine.QueryRequest{}
searchRequestModel.SetTableName("test1")
// 创建一个指向float32的指针数组
ids := make([]*float32, 4)
// 给指针数组元素赋值
ids[0] = tea.Float32(0.1)
ids[1] = tea.Float32(0.2)
ids[2] = tea.Float32(0.3)
ids[3] = tea.Float32(0.4)
searchRequestModel.SetVector(ids)
count := make([]*int, 1)
count[0] = tea.Int(2)
indices := make([]*int64, 2)
indices[0] = tea.Int64(1)
indices[1] = tea.Int64(2)
values := make([]*float32, 2)
values[0] = tea.Float32(0.1)
values[1] = tea.Float32(0.2)
sparseDataha := &ha3engine.SparseData{
Count: count,
Indices: indices,
Values: values,
}
searchRequestModel.SetSparseData(sparseDataha)
response, _requestErr := client.Query(searchRequestModel)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.ha3engine.async.models.SparseData;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* 混合查询
*/
public class MixQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void mixQuery() {
try {
QueryRequest queryRequest = QueryRequest.builder()
.tableName("test1") // 查询的表名
.indexName("vector") // 查询的索引名
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F)) // 查询的向量数据
.sparseData(SparseData.builder().count(Arrays.asList(2)).indices(Arrays.asList(1L,2L)).values(Arrays.asList(0.1F,0.2F)).build())// 稀疏向量
.topK(10) // 返回个数
.includeVector(false) //是否返回文档中的向量信息
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.query(queryRequest);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("query result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}混合查询（多向量）
混排查询是用户通过稠密向量和稀疏向量混合查询的方式，SDK说明如下：
Java
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.*;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
public class Demo {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void query() throws Exception {
try {
MultiQueryRequest multiQueryRequest = new MultiQueryRequest();
multiQueryRequest.setTableName("main"); //查询的表名
multiQueryRequest.setTopK(50); // 最终返回的结果个数
multiQueryRequest.setOutputFields(Arrays.asList("content", "source", "instance_id")); // 需要返回值的字段列表
multiQueryRequest.setFilter("type='TEXT'"); // 过滤表达式
multiQueryRequest.setOrder("DESC");
QueryRequest queryRequest = new QueryRequest();
queryRequest.setIndexName("index"); // 查询的索引名 必须在SearchRequest中指定或者在每个Query中指定
queryRequest.setNamespace("cate1"); // 查询向量的空间
queryRequest.setVector(Arrays.asList(0.0001575F, 0.00682848F)); // 查询的向量数据，多个向量可以平铺开
SparseData sparseData = new SparseData();
sparseData.setCount(Arrays.asList(2)); // 每个稀疏向量中包含的元素个数
sparseData.setIndices(Arrays.asList(983589459L, 1261855554L)); // 元素下标（需要从小到大排序）
sparseData.setValues(Arrays.asList(0.0001575F, 0.00682848F)); // 元素值（与下标一一对应）
queryRequest.setSparseData(sparseData);
multiQueryRequest.setQueries(Arrays.asList(queryRequest));
SearchResponse searchResponse = client.multiQuery(multiQueryRequest);
System.out.println(searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config, SparseData, MultiQueryRequest
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
def mix_multi_query():
sd1 = SparseData(indices=[101, 203], values=[0.1, 0.5])
sd2 = SparseData(indices=[200, 405, 502], values=[0.9, 0.5, 0.75])
q1 = QueryRequest(vector=[0.1, 0.2, 0.3, 0.4], sparse_data=sd1)
q2 = QueryRequest(vector=[0.4, 0.5, 0.6, 0.7], sparse_data=sd2)
request = MultiQueryRequest(table_name="test",
queries=[q1, q2],
top_k=3,
include_vector=True)
result = client.multi_query(request)
print(result.body)
if __name__ == "__main__":
mix_multi_query()Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
mixMultiVectorQuery(client)
}
func mixMultiVectorQuery(client *ha3engine.Client) {
query1 := &ha3engine.QueryRequest{}
// 创建一个指向float32的指针数组
array := make([]*float32, 4)
// 分配内存地址并初始化值
value1 := float32(1.23)
value2 := float32(4.56)
value3 := float32(7.89)
value4 := float32(7.89)
// 给指针数组元素赋值
array[0] = &value1
array[1] = &value2
array[2] = &value3
array[3] = &value4
count := make([]*int, 1)
count[0] = tea.Int(2)
indices := make([]*int64, 2)
indices[0] = tea.Int64(1)
indices[1] = tea.Int64(2)
values := make([]*float32, 2)
values[0] = tea.Float32(0.1)
values[1] = tea.Float32(0.2)
sparseData := &ha3engine.SparseData{
Count: count,
Indices: indices,
Values: values,
}
query1.SetSparseData(sparseData)
query1.SetVector(array)
query2 := &ha3engine.QueryRequest{}
query2.SetVector(array)
request := &ha3engine.MultiQueryRequest{}
request.SetTableName("test1")
querys := make([]*ha3engine.QueryRequest, 2)
querys[0] = query1
querys[1] = query2
request.SetQueries(querys)
request.SetTopK(10)
request.SetIncludeVector(false)
request.SetOrder("DESC")
response, _requestErr := client.MultiQuery(request)
// 如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
// 输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.MultiQueryRequest;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.ha3engine.async.models.SparseData;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
/**
* 多向量查询
*/
public class MixMultiVectorQuery {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void mixMultiVectorQuery() {
try {
QueryRequest query1 = QueryRequest.builder()
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F))
.sparseData(SparseData.builder().count(Arrays.asList(2)).indices(Arrays.asList(1L,2L)).values(Arrays.asList(0.1F,0.2F)).build())// 稀疏向量
.namespace("space_a")
.build();
QueryRequest query2 = QueryRequest.builder()
.vector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F))
.sparseData(SparseData.builder().count(Arrays.asList(2)).indices(Arrays.asList(1L,2L)).values(Arrays.asList(0.1F,0.2F)).build())// 稀疏向量
.namespace("space_b")
.build();
MultiQueryRequest request = MultiQueryRequest.builder()
.tableName("test2")// 查询的表名
.topK(3)
.includeVector(false)// 是否返回文档中的向量信息
.queries(Arrays.asList(query1, query2))// 多个nameSpace查询条件
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.multiQuery(request);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("query result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}重要
多向量查询需要多个向量类型相同，如都是稠密向量检索，或者都是混排检索
向量文本混合查询
Java
import java.util.Arrays;
import java.util.Map;
import com.alibaba.fastjson.JSONObject;
import com.aliyun.ha3engine.vector.Client;
import com.aliyun.ha3engine.vector.models.*;
import com.aliyun.tea.TeaException;
import org.junit.Before;
import org.junit.Test;
/**
* 向量文本混合查询demo
**/
public class VectorSearchService {
/**
* 问天引擎client
*/
private Client client;
@Before
public void clientInit() throws Exception {
/*
初始化问天引擎client
*/
Config config = new Config();
// 实例名称，可在实例详情页左上角查看，例:ha-cn-i7*****605
config.setInstanceId("ha-cn-i7*****605");
// 用户名，可在实例详情页>API入口 查看
config.setAccessUserName("username");
// 密码，可在实例详情页>API入口 修改
config.setAccessPassWord("password");
// API域名，可在实例详情页>API入口 查看
config.setEndpoint("ha-cn-i7*****605.public.ha.aliyuncs.com");
client = new Client(config);
}
@Test
public void search() throws Exception {
try {
// 构造搜索请求对象
SearchRequest request = new SearchRequest();
request.setTableName("test1");// 必填项, 搜索的表名
// KNN查询参数
QueryRequest queryRequest = new QueryRequest();
queryRequest.setIndexName("vector");// 索引名称
queryRequest.setTopK(10);
queryRequest.setVector(Arrays.asList(0.62498F, 0.886408F, 0.586114F, 0.043189F));// 搜索向量
// 稀疏向量
SparseData sparseData = new SparseData();
sparseData.setIndices(Arrays.asList(1L, 2L, 3L, 4L));
sparseData.setValues(Arrays.asList(0.0001575F, 0.00682848F, 0.008745F, 0.4583474F));
queryRequest.setSparseData(sparseData);
request.setKnn(queryRequest);
// 构造文本查询参数
TextQuery textQuery = new TextQuery();
textQuery.setQueryString("content:'发布'");
request.setText(textQuery);
request.setSize(10);
request.setOutputFields(Arrays.asList("id", "content", "name"));
SearchResponse searchResponse = client.search(request);
System.out.println("搜索结果:\n" + searchResponse.getBody());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}Python
from alibabacloud_ha3engine_vector.client import Client
from alibabacloud_ha3engine_vector.models import Config, SearchRequest, TextQuery
from alibabacloud_ha3engine_vector.models import QueryRequest
config = Config(
# API域名，可在实例详情页>API入口 查看
endpoint="http://ha-cn-i7*****605.public.ha.aliyuncs.com",
# 用户名，可在实例详情页>API入口 查看
access_user_name="username",
# 密码，可在实例详情页>API入口 修改
access_pass_word="password")
client = Client(config)
def search():
knn = QueryRequest(index_name="vector",
vector=[0.62498, 0.886408, 0.586114, 0.043189],
include_vector=True,
top_k=10)
text = TextQuery(query_string="content:'发布'")
request = SearchRequest(table_name="test1",
size=10,
output_fields=["id", "content", "name"],
knn=knn,
text=text)
result = client.search(request)
print(result.body)
if __name__ == "__main__":
search()Go
package main
import (
"fmt"
"github.com/alibabacloud-go/tea-utils/v2/service"
"github.com/alibabacloud-go/tea/tea"
ha3engine "github.com/aliyun/alibabacloud-ha3-go-sdk/client"
"sync"
)
func main() {
//创建请求客户端实例
config := &ha3engine.Config{
// API域名，可在实例详情页>API入口 查看
Endpoint: tea.String("ha-cn-i7*****605.public.ha.aliyuncs.com"),
// 用户名，可在实例详情页>API入口 查看
AccessUserName: tea.String("username"),
// 密码，可在实例详情页>API入口 修改
AccessPassWord: tea.String("password"),
RuntimeOptions: &service.RuntimeOptions{
KeepAlive: tea.Bool(true),
MaxIdleConns: tea.Int(1000),
ReadTimeout: tea.Int(1000),
},
}
// 初始化一个client, 用以发送请求.
client, _clientErr := ha3engine.NewClient(config)
// 如果 NewClient 过程中出现异常. 则 返回 _clientErr 且输出 错误信息.
if _clientErr != nil {
fmt.Println(_clientErr)
return
}
search(client)
}
func search(client *ha3engine.Client) {
searchRequestModel := &ha3engine.SearchRequest{}
searchRequestModel.SetTableName("test1")
knn := &ha3engine.QueryRequest{}
// 给指针数组元素赋值
ids := make([]*float32, 4)
ids[0] = tea.Float32(0.1)
ids[1] = tea.Float32(0.2)
ids[2] = tea.Float32(0.3)
ids[3] = tea.Float32(0.4)
knn.SetVector(ids)
text := &ha3engine.TextQuery{}
text.SetQueryString("content:'发布'")
searchRequestModel.SetText(text)
searchRequestModel.SetKnn(knn)
response, _requestErr := client.Search(searchRequestModel)
//如果 发送请求 过程中出现异常. 则 返回 _requestErr 且输出 错误信息.
if _requestErr != nil {
fmt.Println(_requestErr)
return
}
//输出正常返回的 response 内容.
fmt.Println(response)
}Java异步
import com.aliyun.ha3engine.async.AsyncClient;
import com.aliyun.ha3engine.async.models.QueryRequest;
import com.aliyun.ha3engine.async.models.SearchRequest;
import com.aliyun.ha3engine.async.models.SearchResponse;
import com.aliyun.ha3engine.async.models.TextQuery;
import com.aliyun.sdk.ha3engine.async.core.AsyncConfigInfoProvider;
import com.aliyun.tea.TeaException;
import darabonba.core.client.ClientOverrideConfiguration;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
public class VectorTextMixSearch {
/**
* 问天引擎client
*/
private AsyncClient client;
@Before
public void clientInit() {
// 配置实例的用户名密码, 可在实例详情页>API入口 查看
AsyncConfigInfoProvider provider = AsyncConfigInfoProvider.create("username", "password");
// 初始化异步客户端
client = AsyncClient.builder()
.credentialsProvider(provider)
.overrideConfiguration(
ClientOverrideConfiguration.create()
.setEndpointOverride("ha-cn-i7*****605.public.ha.aliyuncs.com")
.setProtocol("http")
).build();
}
@Test
public void search() {
try {
SearchRequest request = SearchRequest.builder()
.tableName("test1")// 查询的表名
.size(10)// 返回个数
.knn(QueryRequest.builder()
.vector(Arrays.asList(0.1f, 0.2f, 0.3f,0.4f))// 向量
.namespace("space_a")// 命名空间
.build())// KNN查询参数
.text(TextQuery.builder()
.queryString("content:'内容'")// 检索条件
.build())
.outputFields(Arrays.asList("name", "age", "content"))// 返回字段
.build();
CompletableFuture<SearchResponse> responseCompletableFuture = client.search(request);
String responseBody = responseCompletableFuture.get().getBody();
System.out.println("search result：" + responseBody);
} catch (ExecutionException | InterruptedException e) {
System.out.println(e.getMessage());
} catch (TeaException e) {
System.out.println(e.getCode());
System.out.println(e.getMessage());
Map<String, Object> exceptionData = e.getData();
System.out.println(com.aliyun.teautil.Common.toJSONString(exceptionData));
}
}
}说明
请求的相应结果可参考流量API说明>查询数据对应的查询方式中的返回参数
不要使用
go get github.com/aliyun/alibabacloud-ha3-go-sdk命令拉取git依赖，必须后面指定版本，因为向量检索版和召回引擎版的tag都在同一个github下，拉取依赖的时候需根据实例的版本拉取对应依赖