OpenSearch:Internet search

Services

• The authentication information is obtained.

  When you call an AI Search Open Platform service by using an API, you need to authenticate the caller's identity.

• The service access address is obtained.

  You can call a service over the Internet or a virtual private cloud (VPC). For more information, see Get service registration address.

Request method

POST

URL

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

• host: The address for calling the service. You can call API services through the internet or VPC. For more information, see Obtain service access address.

• workspace_name: The workspace name, such as default.

• service_id: The built-in service ID, such as ops-web-search-001.

Request parameters

Header parameters

API-KEY authentication

Body parameters

Curl request example

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer Your-API-KEY" \
"http://xxxx-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/web-search/ops-web-search-001" \
-d '{
      "history": [
        {"role": "system", "content": "You are a robot assistant"},
        {"role": "user", "content": "What is the capital of Zhejiang Province"},
        {"role": "assistant", "content": "Hangzhou"}
        ],
      "query":"What is the weather like in Hangzhou today",
      "query_rewrite":true,
      "top_k":5,
      "content_type":"snippet"
}'

Response parameters

Response examples

Sample success response

{
  "result":{
    "search_result": [
        {
          "title": "Hangzhou Weather",
          "link": "https://www.hzqx.com/pc/hztq/",
          "snippet": "Cloudy tonight; sunny to partly cloudy tomorrow; partly cloudy to cloudy the day after tomorrow. North wind 2-3 level tonight, east wind 2 level tomorrow. Maximum temperature tomorrow during the day is 10 degrees, minimum temperature tomorrow morning is 3 degrees, average relative humidity tomorrow is 65%.",
          "position": 3,
          "content": "Hangzhou Weather\nCloudy tonight; sunny to partly cloudy tomorrow; partly cloudy to cloudy the day after tomorrow. North wind 2-3 level tonight, east wind 2 level tomorrow. Maximum temperature tomorrow during the day is 10 degrees, minimum temperature tomorrow morning is 3 degrees, average relative humidity tomorrow is 65%."
        },
        {
          "title": "Hangzhou Weather Forecast_Weather Query - Moji Weather",
          "link": "https://tianqi.moji.com/weather/china/zhejiang/hangzhou",
          "snippet": "Hangzhou current conditions: 3 degrees sunny, humidity: 66%, northwest wind: level 3. Daytime: 10 degrees, sunny. Night: cloudy, 3 degrees, it's getting cool, Moji Weather suggests you wear a thick coat over your wool sweater, and elderly or frail individuals can wear a wool overcoat to increase warmth.",
          "position": 4,
          "content": "Hangzhou Weather Forecast_Weather Query - Moji Weather\nHangzhou current conditions: 3 degrees sunny, humidity: 66%, northwest wind: level 3. Daytime: 10 degrees, sunny. Night: cloudy, 3 degrees, it's getting cool, Moji Weather suggests you wear a thick coat over your wool sweater, and elderly or frail individuals can wear a wool overcoat to increase warmth."
        }
    ]
  },
    "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
    }
}

Sample error response

When an access request fails, the output result indicates the error cause through the code and message fields.

{
    "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\\"
}

Status codes

For more information, see AI Search Open Platform Status codes.