通過SDK 調用召回引擎版執行個體進行資料檢索
程式碼範例
# -*- coding: utf-8 -*-
from alibabacloud_ha3engine import models, client
from alibabacloud_tea_util import models as util_models
from Tea.exceptions import TeaException, RetryError
def search():
Config = models.Config(
endpoint="ha-cn-7mz2ougaw02.ha.aliyuncs.com",
instance_id="ha-cn-7mz2ougaw02",
protocol="http",
access_user_name="user",
access_pass_word="111111"
)
# 如使用者請求時間較長. 可通過此配置增加請求等待時間. 單位 ms
# 此參數可在 search_with_options 方法中使用
runtime = util_models.RuntimeOptions(
connect_timeout=5000,
read_timeout=10000,
autoretry=False,
ignore_ssl=False,
max_idle_conns=50
)
# 初始化 Ha3Engine Client
ha3EngineClient = client.Client(Config)
optionsHeaders = {}
try:
# 樣本1: 直接使用 ha 查詢串進行搜尋.
# =====================================================
query_str = "config=hit:4,format:json,fetch_summary_type:pk,qrs_chain:search&&query=id:<pk>&&cluster=general"
haSearchQuery = models.SearchQuery(query=query_str)
# method可不指定，僅支援GET和POST請求方式, 預設為GET方式
haSearchRequestModel = models.SearchRequestModel(headers=optionsHeaders, query=haSearchQuery, method='POST')
hastrSearchResponseModel = ha3EngineClient.search(haSearchRequestModel)
print(hastrSearchResponseModel)
# =====================================================
# 樣本 2: 使用構造的查詢進行 ha 查詢.
# =====================================================
# 設定彙總打散子句
DistinctClauses = []
# 設定統計子句設定物件
aggregateClauses = []
haQueryAggregateClause = models.HaQueryAggregateClause(
group_key="cate_id", # 設定group_key
agg_fun="count()", # 設定agg_fun
range="0~10", # 設定分段統計
max_group="5", # 設定最大返回組數
agg_filter="cate_id=1", # 設定agg_filter
agg_sampler_thres_hold="5", # 設定採樣閾值
agg_sampler_step="5", # 設定採樣步長
)
# 添加Aggregate對象參數, 支援設定一個或多個統計欄位樣本
aggregateClauses.append(haQueryAggregateClause)
# 定義Config對象，用於設定config子句參數，分頁或資料返回格式等.
CustomConfig = dict()
CustomConfig.__setitem__("no_summary", "yes")
CustomConfig.__setitem__("qrs_chain", "search")
haQueryconfig = models.HaQueryconfigClause(
# 設定 查詢起始位置
start="1",
# 設定查詢頁返回數量
hit="10",
# Format目前支援返回 XML，JSON, protobuf 等格式
format="JSON",
# 設定自訂 config 參數.
custom_config=CustomConfig
)
# 設定sort條件
haQuerySortClauseList = []
haQuerySortClause = models.HaQuerySortClause(
# 設定排序id欄位
sort_key="id",
# 設定排序配置: + 為升序, - 為降序.
sort_order="+"
)
haQuerySortClauseList.append(haQuerySortClause)
# haQuery 中 Kvpairs 為 dict 類型. 具體 key 範圍. 請參詢開飯文檔.
haKvpairs = dict()
haKvpairs.__setitem__("uniqfield", "cate_id")
# 設定彙總打散子句
DistinctClauses = []
dist = models.HaQueryDistinctClause(
# 設定dist_key
dist_key="cate_id",
# 設定dist_count
dist_count="1",
# 設定dist_times
dist_times="1",
# 設定reserved
reserved="false",
# 設定過濾條件
dist_filter="cate_id<=3",
# 設定update_total_hit
update_total_hit="false",
# 設定grade
grade="1.2",
)
# 添加Distinct對象參數, 支援一個或者多個.dist內容需為 unique.
DistinctClauses.append(dist)
# 定義 自訂 query Config 子句.
CustomQuery = dict()
CustomQuery.__setitem__("searcher_cache", "use:no")
haQuery = models.HaQuery(
# 設定查詢子句，為索引及查詢內容.
query="id:8148508889615505646",
# 佈建要求叢集名稱.
cluster="general",
# 設定 config 子句參數
config=haQueryconfig,
# 設定查詢過濾條件
# 支援設定一個或多個 filter 參數.請使用 AND | OR 對多個 filter 進行串連.
# 比較支援: '=' | '>' | '<' | '<=' | '>=' | '!='
filter="id>100 AND id<=1000",
# 設定 aggregate 子句參數
aggregate=aggregateClauses,
# 設定 Kvpairs 子句參數
kvpairs=haKvpairs,
# 設定 sort 子句參數
sort=haQuerySortClauseList,
# 設定 distinct 子句參數
distinct=DistinctClauses,
custom_query=CustomQuery
)
searchQuery = models.SearchQuery(query=ha3EngineClient.build_ha_search_query(haQuery))
searchRequestModel = models.SearchRequestModel(optionsHeaders, searchQuery)
# 使用預設 運行時參數進行請求, method可不指定，僅支援GET和POST請求方式, 預設為GET方式，查詢query長度超過30K請使用POST請求
haStructResponseModel = ha3EngineClient.search(query=searchRequestModel, method='POST')
print(haStructResponseModel)
# 樣本3: 直接使用 ha - sql 查詢串進行搜尋.
# =====================================================
sql_str = "select * from <indexTableName>&&kvpair=trace:INFO;formatType:json"
sqlsearchQuery = models.SearchQuery(sql=sql_str)
sqlSearchRequestModel = models.SearchRequestModel(optionsHeaders, sqlsearchQuery)
# method可不指定，僅支援GET和POST請求方式, 預設為GET方式，查詢query長度超過30K請使用POST請求
sqlstrSearchResponseModel = ha3EngineClient.search(query=sqlSearchRequestModel, method='POST')
print(sqlstrSearchResponseModel)
# 樣本4 : 直接使用 ha - sql 結構化進行搜尋.
# =====================================================
sqlQueryKvpairs =dict()
sqlQueryKvpairs.__setitem__("trace", "INFO")
sqlQueryKvpairs.__setitem__("formatType", "full_json")
sqlQuery =models.SQLQuery(
query ="select * from odps",
kvpairs=sqlQueryKvpairs
)
searchQuery = models.SearchQuery(sql=ha3EngineClient.build_sqlsearch_query(sqlQuery))
searchRequestModel = models.SearchRequestModel(optionsHeaders, searchQuery)
# 使用預設 運行時參數進行請求, method可不指定，僅支援GET和POST請求方式, 預設為GET方式，查詢query長度超過30K請使用POST請求
sqlStructResponseModel = ha3EngineClient.search(query=searchRequestModel, method='POST')
print(sqlStructResponseModel)
except TeaException as e:
print(f"send request with TeaException : {e}")
except RetryError as e:
print(f"send request with Connection Exception : {e}")