说明

Viking AI 搜索是一款基于生成式 AI 的企业级 AI 搜索产品，基于大模型的多模态语义表征和理解能力，结合字节跳动信息检索领域多年最佳实践，为客户提供开箱即用的 AI 搜索搭建平台服务，帮助客户轻松搭建和集成端到端的多模态图文搜索和推荐能力。

*

想要体验更多 Viking AI 搜索能力，点击前往：Viking AI 搜索引擎，企业搜推问一体化智能引擎

在体验配置界面进行搜索策略的配置和效果测试后，您可以通过控制台生效配置到在线搜索引擎，然后通过接口将配置好的AI 搜索场景集成至您的平台。 # 生效AI 搜索配置 ![图片](https://p9-arcosite.byteimg.com/tos-cn-i-goo7wpa0wc/1c1fbaf56ab24f238adeb1f8c994e7e4~tplv-goo7wpa0wc-image.image) 在 **应用 \> 体验配置 \> 搜索体验** 右侧配置栏中，点击\*\*【生效当前配置】\*\*即可将配置生效至正式接口调用的在线引擎。生效后可开始集成搜索接口，将AI 搜索能力集成至您的平台。 # 调用搜索API 按照以下说明调用搜索API ```Bash curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/application_id}/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer API key' \ -d '{ "query": { "text": query文本字符串 "image_url"：image文件 "image_query_instruction": 图片检索指令 }, "dataset_id": 指定的数据集ID "page_number": 搜索页码，从 1 开始, "page_size": 每页搜索结果的数量, "user": { "user_id": 用户ID }, "context":{ "location":地理位置对象 } "filter": 搜索过滤条件 "sort_by": 指定的排序字段 "sort_order": 排序顺序 }' ``` `*application_id*`：您创建的应用ID `*query文本字符串*`：用字符串的形式传入用户输入的query文本 `*image文件*`：用base64的形式传入用户上传的，用于图片搜索的图片 `*搜索页码*`：搜索页码，可用于列表分页功能，必传项，从 1 开始 `*每页搜索结果的数量*`：搜索每页的数据量，必传项 `*用户ID*`：上传此次调用对应的用户ID，非必传项，建议上传。 `*地理位置对象*`：使用JSON对象上传用户地理位置，例如{"latitude": "12.1243","longitude": "\-012.1223"} `*搜索过滤条件*`：JSON对象格式的过滤语句，在搜索时对召回的物品数据进行过滤筛选，使用前请确认被过滤的字段已经在应用配置中配置为了可筛选字段。过滤在API参数中的传入方式见：[在搜索时过滤](https://www.volcengine.com/docs/85296/1873488) `*指定的排序字段*` ** *&* ** `*排序顺序*`：指定物品数据集的字段作为搜索列表排序的依据，非必传，使用方法详见：[对搜索返回列表进行排序](https://www.volcengine.com/docs/85296/1873489) `*指定的*` *\*\** `*数据集ID*`: 您创建的数据集ID，必传项

说明

完整接口使用说明详见：API参考 \> Search\-搜索

## 使用文本搜索当用户在搜索框输入文本时，将用户输入的文本传入 `query.text`字段。 ### 参数说明 #### query.text **参数类型：** `String` **参数含义：** 用户输入的query文本内容 ### 调用示例 ```Bash curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/your_app_id/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "query": { "text": "适合雨季登山的运动鞋" }, "user_id":"u89001829UXHKS", "context":{ "location":{ "latitude": "12.1243", "longitude": "-012.1223" } } "dataset_id": "106265704", "page_number": 1, "page_size": 50, }' ``` ## 使用图片搜索您可以在 query.image 中传入base64格式的图片文件进行图片搜索。 ### 参数说明 #### query.image_url **参数类型**：`String` **参数含义：** 用户输入的图片内容，以**Base64**格式的字符串传入 **参数说明：** 上传图片数据时，您必须上传符合以下说明中格式和限制的图片文件，AI 搜索引擎才可以对图片进行处理并进行图片搜索：

说明

1.

支持格式：jpeg、png、 webp、bmp、tiff、ico、dib、icns、sgi、jpeg2000。其中，tiff、sgi、icns、jpeg2000 格式图片，需要保证和元数据对齐，如在对象存储中正确设置文件元数据，否则会解析失败。

2.

宽高比（宽/高）：在范围[1/100, 100] 。

3.

边长： [10, 6000] px，即短边像素需大于 10 px，长边像素需小于6000 px。

最佳的图片边长最好在[300, 3600]以内，图片文件大小在300KB以内，图片过大将导致搜索接口的响应时长过长。

请确保Base64编码符合标准格式，包含**数据头（Data URI Scheme）** 与 **Base64 编码正文**两部分：格式 ```JSON data:;base64, ``` JPEG 图片 ```JSON data:image/jpeg;base64, ``` PNG 图片 ```JSON data:image/png;base64, ``` WebP 图片 ```JSON data:image/webp;base64, ``` #### query.image_query_instruction **参数类型**：`String` **参数含义：** 一段文本的图片搜索指令，可以理解为为模型提供一个“如何匹配query图片和候选图片”的指导。可在特定的图片搜索场景下采用一个固定的指令来提升检索的准确性。 **参数说明：** 目前验证有效的图片搜索指令覆盖相同图片搜索、相似商品搜索和相似素材搜索以下是我们结合内部测试与实际应用场景，为您总结的一些最佳实践指令，供您参考： ```Bash 搜索相似图片：基于图片的整体内容召回相似的图片，而不是仅关注图片中的局部信息搜索相同图片：查找与本图完全相同的图片，可能经过了ps处理，包含缩放、裁剪和水印，请忽略PS处理痕迹搜索同款商品：忽略背景以及人物主体并查找这张图片中出现的同款商品图片 ``` ### 调用示例 **电商图搜场景：传入一张图片进行搜索** ```Bash curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/your_app_id/search' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ' \ -d '{ "query": { "image_url": "image_query_instruction":"忽略背景以及人物主体并查找这张图片中出现的同款商品图片" }, "dataset_id": "106265704", "page_number": 1, "page_size": 50, }' ```

说明

想要体验更多 Viking AI 搜索能力，点击前往：Viking AI 搜索引擎，企业搜推问一体化智能引擎