根据用户输入的查询词或图片，在应用所绑定的物品数据源中搜索与用户输入相关联的内容。

注意事项

• 使用限制：
  • 受到HTTP Body大小限制，单次请求的包体大小最大不超过10MB。

请求说明

• 请求方式：POST
• 请求地址：https://aisearch.cn-beijing.volces.com/api/v1/application/{application_id}/search

{application_id}：在控制台创建应用后系统指定的应用唯一标识，可在控制台查看

鉴权方式

可使用API Key或Access Key鉴权，详情参考API 鉴权机制说明

请求参数

请求体

{
    "text":"春夏新款运动装",
}

{
    "_user_id":"U90E89FF8045"
}

数据结构

Query

Query上传图片格式说明：
在query.image_url中传入base64格式的图片文件，图片文件的格式和条件限制详见说明：

请确保Base64编码符合标准格式，包含**数据头（Data URI Scheme）**与 Base64 编码正文两部分：

data:[<MIME类型>];base64,<Base64编码字符串>

User

Filter

Filter各算子示例

{
    "op": "must",
    "field": "region",
    "conds": ["cn", "sg"]
}

{
    "op": "must",
    "field": "status",
    "conds": [1, 2, 3]
}

{
    "op": "must_not",
    "field": "status",
    "conds": [1, 2, 3]
}

//
{
  "op": "range",
  "field": "price",
  "gte": 100.0
}

{
  "op": "range",
  "field": "price",
  "gte": 100.0,
  "lt": 500.0
}

{
  "op": "and",
  "conds": [     // 条件列表，支持嵌套and/or/must/must_not/range 算子
    {
      "op": "must",
      "field": "status",
      "conds": [1, 2, 3]
    },
    {
        ...         // 支持>=1的任意数量的条件进行组合
    }
  ]
}

{
  "op": "or",
  "conds": [ // 条件列表，支持嵌套and/or/must/must_not/range 算子
    {
      "op": "must",
      "field": "status",
      "conds": [1, 2, 3]
    },
    {
        ...      // 支持>=1的任意数量的条件进行组合
    }
  ]
}

Context

{
    "latitude": "12.12",
    "longitude": "-13.43"
}

响应参数

请求响应

数据结构

SpellCorrection

Result

SearchResult

{
    "item_id": "WSHOE001",
    "title": "舒适通勤 尖头浅口高跟鞋 - 黑色",
    "category": "女士高跟鞋",
    "status": 1
}

{
  "_video_generated_summary":"叶文洁为防止发射信号的事被雷志成上报，制造故障引其和杨卫宁下悬崖并锯断绳子将二人杀害，史强因核辐射住院，叶文洁回忆起在齐家屯感受到人间温暖及后续经历，同时作战中心截获三体信息，汪淼和史强进入三体游戏遇到 1379 号监听员。"
  "video generated title":"叶文洁承认杀害雷志成",
  "content_id":"video_900026",
  "content_type":"video",
  "parent_content_id":"collection_342534",
  "sequence_index":26,
  "video_url":["http://xxxx.mp4"],
  "my_title":"三体第二十六集"
}

[
    {
        "recall_reason": "text'",
        "recall_score": 0.7
    },
    {
        "recall_reason": "vlm'",
        "recall_score": 0.5
    }
]

{
    "is_reranked": true,
    "rerank_score":0.993242
}

接口示例

关联图文数据集的应用

请求示例

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": "女鞋 春夏"
    },
    "page_number": 1,
    "page_size": 5,
    "user": {
        "_user_id": "ldy_199432"
    },
    "filter": {
        "op": "must",
        "field": "status",
        "conds": [1, 2]
    },
    "dataset_id": "106265704",
    "context": {
        "location":{
            "latitude": "12.12",
            "longitude": "-13.43"
        }
    }
}'

响应示例

{
    "request_id": "25ee998a-5462-9385-9f18-035f1da7a6e5",
    "result": {
        "search_results": [
            {
                "_id": "WSHOE001",
                "display_fields": {
                    "item_id": "WSHOE001",
                    "title": "舒适通勤 尖头浅口高跟鞋 - 黑色",
                    "category": "女士高跟鞋",
                    "status": 1,
                    "images": [
                        {
                            "image_url": "https://example.com/images/womens_pump_black.jpg"
                        }
                    ]
                }
            },
            {
                "_id": "WSHOE002",
                "display_fields": {
                    "item_id": "WSHOE002",
                    "title": "轻便网面 跑步运动鞋 - 粉色拼灰色",
                    "category": "女士运动鞋",
                    "status": 1,
                    "images": [
                        {
                            "image_url": "https://example.com/images/womens_sneaker_pink.jpg"
                        }
                    ]
                }
            },
            {
                "_id": "WSHOE003",
                "display_fields": {
                    "item_id": "WSHOE003",
                    "title": "波西米亚风格 坡跟凉鞋 - 米色",
                    "category": "女士凉鞋",
                    "status": 2,
                    "images": [
                        {
                            "image_url": "https://example.com/images/womens_sandal_beige.jpg"
                        }
                    ]
                }
            }
        ],
        "spell_correction": {
            "mode":"off"
        }
        "total_items": 300
    }
}

关联视频数据集的应用

请求示例

curl -X POST 'https://aisearch.cn-beijing.volces.com/api/v1/application/${application_id}/search' \ 
  -H 'Content-Type: application/json' \ 
  -H 'Authorization: <火山鉴权的一系列相关header>' \ 
  -d '{ 
    "query": { 
        "text": "科幻片" 
    }, 
    "page_number": 1, 
    "page_size": 5, 
    "user": { 
        "_user_id": "ldy_199432" 
    }, 
    "filter": {
        "op": "must",
        "field": "director",
        "conds": ["郭帆"]
    },
    "dataset_id": "106265704",
    "context": {
        "location":{
            "latitude": "12.12",
            "longitude": "-13.43"
        }
    }
}' 

响应示例

{
    "request_id": "25ee998a-5462-9385-9f18-035f1da7a6e5",
    "result": {
        "search_results": [
            {
                "_id": "video_900026",
                "display_fields": {
                    "content_id": "video_900026",
                    "content_type": "video",
                    "parent_content_id": "collection_342534",
                    "sequence_index": 26,
                    "video_url": [
                        "http://xxxx.mp4"
                    ],
                    "my_title": "三体第二十六集"
                }
            },
            {
                "_id": "video_900027",
                "display_fields": {
                    "content_id": "video_900027",
                    "content_type": "video",
                    "parent_content_id": "collection_342534",
                    "sequence_index": 27,
                    "video_url": [
                        "http://xxxx.mp4"
                    ],
                    "my_title": "三体第二十七集"
                }
            },
            {
                "_id": "video_900028",
                "display_fields": {
                    "content_id": "video_900028",
                    "content_type": "video",
                    "parent_content_id": "collection_342534",
                    "sequence_index": 28,
                    "video_url": [
                        "http://xxxx.mp4"
                    ],
                    "my_title": "三体第二十八集"
                }
            }
        ],
        "spell_correction": {
            "mode":"auto",
            "corrected_query":"三体电视剧集"
        }
        "total_items": 300
    }
}

错误处理

错误码

本接口错误码请参见公共错误码文档。