OpenSearch:Web 検索

サービス一覧

• 認証情報の取得

  AI Search Open Platform では、認証に API キーが必要です。手順については、「API キーの取得」をご参照ください。

• サービスエンドポイントの取得

  パブリックネットワークまたは VPC 経由でサービスを呼び出すことができます。詳細については、「サービスエンドポイントの取得」をご参照ください。

リクエストメソッド

POST

URL

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

• host： サービスの呼び出しに使用するアドレスです。パブリックネットワークまたは VPC 経由で API を呼び出すことができます。詳細については、「サービスエンドポイントの取得」をご参照ください。

  [API Keys] ページの上部で、[default (default workspace)] などのターゲットワークスペースを選択します。[Access Endpoints] セクションで、[Public API Endpoint] タブと [Private API Endpoint] タブを切り替えて、対応するサービスエンドポイントを表示します。

• workspace_name： ワークスペースの名前です。例： default。

• service_id： 組み込みサービス ID です。例： ops-web-search-001。

リクエストパラメータ

ヘッダーパラメータ

API キー認証

ボディパラメータ

cURL リクエスト例

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?"},
        {"role": "assistant", "content": "Hangzhou"}
        ],
      "query":"What is the weather like in Hangzhou today?",
      "query_rewrite":true,
      "top_k":5,
      "content_type":"snippet"
}'

検索とコンテンツ抽出ストラテジーの指定

way を使用してより効果的な検索およびコンテンツ抽出ストラテジーを指定し、 content_type を mainText に設定することで、Web ページの本文を取得できます。

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 '{
      "query":"What is the weather like in Hangzhou today?",
      "top_k":5,
      "content_type":"mainText",
      "way":"pro-fetch"
}'

レスポンスパラメータ

レスポンス例

成功レスポンス例

{
  "request_id": "5B9F5A24-8F1D-****-B7E2-3C6A1D9E4F02",
  "latency": 2.3,
  "usage": {
    "ops-web-search-001/pro-fetch": 1,
    "ops-web-search-001/pro": 1
  },
  "result": {
    "search_result": [
      {
        "title": "Hangzhou Weather Weibo",
        "link": "https://www.hzqx.cn/pc/hztq/",
        "snippet": "Same as the same period yesterday Relative humidity: -% Wind: - Pressure: - hPa Precipitation in the past hour: - mm Visibility: - m Real-time data, not manually reviewed 10:55 on August 26, 2026 ...Updated at 08:00 on August 26, 2026 Air quality forecast Hangzhou Environmental Monitoring Station and Hangzhou M ...",
        "position": null,
        "meta_info": {
          "publishedTime": "2026-08-26T10:55:00+08:00"
        },
        "content": "Hangzhou Weather Weibo\nSame as the same period yesterday\nRelative humidity: -- %  Wind: --\nPressure: -- hPa  Precipitation in the past hour: -- mm\nVisibility: -- m\n\n# \\*リアルタイムデータ、手動レビューなし\n\n10:55 on August 26, 2026 | Past 24 hours | Next 24 hours | Next 7 days\n\n# Objective 7-day weather forecast for the main urban area (the forecast data is\n...（ここで切り詰め。実際のレスポンスには Web ページの完全な本文が含まれます）"
      },
      {
        "title": "Hangzhou 7-Day Weather",
        "link": "https://www.ip.cn/tianqi/zhejiang/hangzhou/7day.html",
        "snippet": "Hangzhou weather: 2026-08-20 to 2026-08-26 Weather forecast Mon Tue Wed Thu Fri Sat Sun August 20: moderate rain turning cloudy, 25°C to 31°C, sunrise 05:29, sunset 18:36 August 21: light rain turning overcast, 25°C to 32°C, sunrise 05:29, sunset 18:35 0 ...",
        "position": null,
        "meta_info": {
          "publishedTime": "2026-08-21T00:00:00+08:00"
        },
        "content": "Hangzhou 7-Day Weather\n27° Cloudy 20 Excellent\nEast wind <force 3 Humidity 96% Pressure 1001 Pa\nThe latest 7-day weather for Hangzhou, Zhejiang, including the daily maximum temperature, minimum temperature, weather conditions, and wind direction\nToday 7 days 10 days 15 days Last 30 days\nHangzhou weather: 2026-08-20 to 2026-08-26 Weather forecast\n\n| Mon | Tue | Wed |\n...（ここで切り詰め。実際のレスポンスには Web ページの完全な本文が含まれます）"
      }
    ]
  }
}

エラーレスポンス例

リクエストでエラーが発生した場合、返される結果の 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 Search Open Platform の「ステータスコード」をご参照ください。