OpenSearch:インターネット検索

サービス一覧

• 認証情報の取得

  AI Search オープンプラットフォームでは、認証に API キーが必要です。手順については、「API キーの取得」をご参照ください。

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

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

リクエストメソッド

POST

URL

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

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

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

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

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

リクエストパラメーター

ヘッダーパラメーター

ボディパラメーター

cURL の例

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <お使いのAPIキー>" \
"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"
}'

レスポンスパラメーター

レスポンスの例

成功レスポンス

{
  "result":{
    "search_result": [
        {
          "title": "杭州の天気",
          "link": "https://www.hzqx.com/pc/hztq/",
          "snippet": "今夜は曇り、明日は晴れ時々曇り、明後日は曇り時々くもりです。今夜は北風レベル 2-3、明日は東風レベル 2 です。明日の最高気温は 10 °C、明朝の最低気温は 3 °C、平均相対湿度は 65% です。",
          "position": 3,
          "content": "杭州の天気\n詳細な天気予報：今夜は曇り、明日は晴れ時々曇り、明後日は曇り時々くもりです。今夜は北風レベル 2-3、明日は東風レベル 2 です。明日の最高気温は 10 °C、明朝の最低気温は 3 °C、平均相対湿度は 65% です。空気質指数は良好で、屋外での活動に適しています。"
        },
        {
          "title": "杭州市の天気予報_天気照会 - Moji Weather",
          "link": "https://tianqi.moji.com/weather/china/zhejiang/hangzhou",
          "snippet": "杭州の現在の状況: 3 °C で晴れ、湿度 66%、北西の風レベル 3 です。昼間: 10 °C、晴れ。夜間: 曇り、3 °C です。冷え込んできました。Moji Weather では、厚手のコートにウールのセーターを着ることを推奨します。",
          "position": 4,
          "content": "杭州市の天気予報_天気照会 - Moji Weather\n杭州の現在の状況: 3 °C で晴れ、湿度 66%、北西の風レベル 3 です。昼間: 10 °C、晴れ。夜間: 曇り、3 °C です。体感温度は 1 °C です。冷え込んできました。Moji Weather では、厚手のコートにウールのセーターを着ることを推奨します。高齢者や体の弱い方は、さらに暖かくするためにウールのオーバーコートを着用することをお勧めします。週末の天気は土曜日が雨、日曜日が曇りの予報です。"
        }
    ]
  },
    "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
    }
}

エラーレスポンス

エラーが発生した場合、レスポンスにはエラーの原因を説明するコードとメッセージが含まれます。

{
    "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 の「ステータスコード」をご参照ください。