OpenSearch：連網搜尋

服務列表

• 擷取身份鑒權資訊

  通過API調用AI搜尋開放平台服務時，需要對調用者身份進行鑒權，如何擷取鑒權資訊請參見擷取API-KEY。

• 擷取服務調用地址

  支援通過公網和VPC兩種方式調用服務，詳情請參見擷取服務接入地址。

請求方式

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/web-search/{service_id}

• host：調用服務的地址，支援通過公網和VPC兩種方式調用API服務，可參見擷取服務接入地址。

• workspace_name：工作空間名稱，例如default。

• service_id： 系統內建服務ID，例如ops-web-search-001。

請求參數

Header參數

API-KEY認證

Body參數

Curl請求樣本

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 您的API-KEY" \
"http://xxxx-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/web-search/ops-web-search-001" \
-d '{
      "history": [
        {"role": "system", "content": "你是一個機器人助手"},
        {"role": "user", "content": "浙江的省會是哪裡"},
        {"role": "assistant", "content": "杭州"}
        ],
      "query":"杭州今日天氣怎麼樣",
      "query_rewrite":true,
      "top_k":5,
      "content_type":"snippet"
}'

返回參數

響應樣本

正常響應樣本

{
  "result":{
    "search_result": [
        {
          "title": "杭州天氣",
          "link": "https://www.hzqx.com/pc/hztq/",
          "snippet": "今天夜裡多雲；明天晴到多雲；後天多雲到陰。 今天夜裡偏北風2-3級，明天偏東風2級。 明天白天最高氣溫10度，明天早晨最低氣溫3度，明天平均相對濕度65%。",
          "position": 3,
          "content": "杭州天氣\n今天夜裡多雲；明天晴到多雲；後天多雲到陰。 今天夜裡偏北風2-3級，明天偏東風2級。 明天白天最高氣溫10度，明天早晨最低氣溫3度，明天平均相對濕度65%。"
        },
        {
          "title": "杭州市天氣預報_天氣查詢- 墨跡天氣",
          "link": "https://tianqi.moji.com/weather/china/zhejiang/hangzhou",
          "snippet": "杭州市今天實況：3度晴，濕度：66%，西北風：3級。白天：10度,晴。 夜間：多雲，3度，天涼了，墨跡天氣建議您在羊毛衫外面套上厚外套，年老體弱者可以穿著呢大衣增加保暖係數。",
          "position": 4,
          "content": "杭州市天氣預報_天氣查詢- 墨跡天氣\n杭州市今天實況：3度晴，濕度：66%，西北風：3級。白天：10度,晴。 夜間：多雲，3度，天涼了，墨跡天氣建議您在羊毛衫外面套上厚外套，年老體弱者可以穿著呢大衣增加保暖係數。"
        }
    ]
  },
    "usage": {
            "search_count": 1,
            "rewrite_model.input_tokens": 249,
            "rewrite_model.output_tokens": 1,
            "rewrite_model.total_tokens": 250,
            "filter_model.input_tokens": 1804,
            "filter_model.output_tokens": 216,
            "filter_model.total_tokens": 2020
    }
}

異常響應樣本

在訪問請求出錯的情況下，輸出的結果中會通過code和message指明出錯原因。

{
    "request_id": "6F33AFB6-A35C-****-AFD2-9EA16CCF4383",
    "latency": 2.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "JSON parse error: Cannot deserialize value of type `ImageStorage` from String \\"xxx\\"
}

狀態代碼說明

詳情請參見AI搜尋開放平台狀態代碼說明。