事件检索服务提供基于自然语言的摄像头事件检索能力。用户通过自然语言描述查询意图,服务自动解析时间范围、生成向量、检索匹配事件并返回结果。本文介绍该API的请求参数、响应参数和使用示例。
接口说明
该接口为HTTP同步接口。
URL:POST /api/v1/operators/event-search/search
Content-Type:application/json
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
query |
string |
是 |
自然语言查询,例如"3月12号有人出门吗"、"上周五有人回家吗"。 |
|
database |
string |
是 |
数据库名。 |
|
table |
string |
是 |
表名。 |
|
time_field |
string |
是 |
时间过滤字段名,例如 |
|
result_fields |
array[string] |
是 |
指定返回的字段列表,例如 |
|
content_field |
string |
是 |
检索内容的字段名,例如 |
|
embedding_field |
string |
是 |
Embedding内容的字段名,例如 |
|
embedding_dim |
int |
否 |
Embedding列的维度,默认1024。 |
|
top_k |
int |
否 |
向量检索候选集大小,默认10。实际返回条数经Rerank后可能小于此值。 |
|
where_conditions |
string |
否 |
额外过滤条件,作为WHERE子句的SQL表达式。例如 |
|
search_range_limit |
int |
否 |
检索范围上限,单位为天,默认7天。 |
请求示例
curl -X POST "http://amv-xxxx.ads.aliyuncs.com:8000/api/v1/operators/event-search/search" \
-H "Content-Type: application/json" \
-d '{
"query": "3月12号有人出门吗",
"database": "test",
"table": "expr_alarm_events",
"content_field": "alarm_action",
"embedding_field": "embedding",
"time_field": "alarm_time",
"result_fields": ["uid", "alarm_action", "device_uid", "alarm_id", "alarm_time", "alarm_type", "roles"],
"top_k": 10,
"where_conditions": "uid = '\''xxx'\'' AND device_uid = '\''xxx'\''"
}'
响应参数
|
参数 |
类型 |
说明 |
|
code |
int |
状态码,200表示成功。 |
|
message |
string |
响应消息。 |
|
data |
object |
响应数据。 |
|
data.query |
string |
原始查询文本。 |
|
data.parsed |
object |
查询解析结果。 |
|
data.parsed.start_time |
string |
时间范围开始,格式为 |
|
data.parsed.end_time |
string |
时间范围结束,格式为 |
|
data.parsed.real_query |
string |
去除时间信息后的真实查询内容。 |
|
data.results |
array |
匹配结果列表,与result_fields对应。 |
响应示例
{
"code": 200,
"message": null,
"data": {
"query": "3月12号有人出门吗",
"parsed": {
"start_time": "2026-03-12 00:00:00",
"end_time": "2026-03-12 23:59:59",
"real_query": "有人出门吗"
},
"results": [
{
"uid": "U2022059001473",
"device_uid": "1c9ffcc04b644176976a117f0de55a8b",
"alarm_id": "ae0cff54a5d40d6499f92044cc79ea1c",
"alarm_time": "2026-03-12 15:48:37",
"alarm_type": "2",
"roles": "陌生人"
}
]
}
}
时间表达式支持
该服务支持多种时间表达方式:
|
类型 |
示例 |
说明 |
|
绝对时间 |
"3月12号"、"2026年3月12日" |
具体日期。 |
|
相对时间 |
"今天"、"昨天"、"前天" |
相对于当前日期。 |
|
周相关 |
"上周五"、"这周日"、"上周" |
具体某天或整周。 |
|
时间范围 |
"最近7天"、"这周" |
时间范围。 |
若query中未包含时间信息,默认查询今天的数据。