OpenSearch:Pencarian Internet

Daftar layanan

• Dapatkan kredensial otentikasi

  Platform terbuka AI Search memerlukan Kunci API untuk otentikasi. Untuk petunjuknya, lihat Dapatkan Kunci API.

• Dapatkan titik akhir layanan

  Anda dapat memanggil layanan melalui jaringan publik atau VPC. Untuk detailnya, lihat Dapatkan titik akhir layanan.

Metode permintaan

POST

URL

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

• host: Alamat akses layanan. Anda dapat memanggil API melalui internet atau VPC. Untuk informasi lebih lanjut, lihat Dapatkan alamat akses layanan.

  Pada halaman API Keys, pilih ruang kerja target di bagian atas, misalnya default. Di bagian Access Endpoints, alihkan antara tab Public API Endpoints dan Private API Endpoints untuk melihat alamat akses layanan yang sesuai.

• workspace_name: Nama ruang kerja. Contohnya, default.

• service_id: ID layanan bawaan. Contohnya, ops-web-search-001.

Parameter permintaan

Parameter header

Parameter body

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

Parameter respons

Contoh respons

Respons berhasil

{
  "result":{
    "search_result": [
        {
          "title": "Hangzhou Weather",
          "link": "https://www.hzqx.com/pc/hztq/",
          "snippet": "Cloudy tonight; sunny to partly cloudy tomorrow; partly cloudy to overcast the day after tomorrow. Northerly winds at level 2-3 tonight, easterly winds at level 2 tomorrow. Maximum temperature tomorrow is 10°C, minimum temperature tomorrow morning is 3°C, and average relative humidity is 65%.",
          "position": 3,
          "content": "Hangzhou Weather\nCloudy tonight; sunny to partly cloudy tomorrow; partly cloudy to overcast the day after tomorrow. Northerly winds at level 2-3 tonight, easterly winds at level 2 tomorrow. Maximum temperature tomorrow is 10°C, minimum temperature tomorrow morning is 3°C, and average relative humidity is 65%."
        },
        {
          "title": "Hangzhou City Weather Forecast_Weather Query - Moji Weather",
          "link": "https://tianqi.moji.com/weather/china/zhejiang/hangzhou",
          "snippet": "Hangzhou's current conditions: 3°C and sunny, humidity at 66%, northwesterly winds at level 3. Daytime: 10°C, sunny. Nighttime: cloudy, 3°C. It's getting cooler, Moji Weather recommends wearing a thick coat over a wool sweater. The elderly and infirm may want to wear a woolen overcoat for additional warmth.",
          "position": 4,
          "content": "Hangzhou City Weather Forecast_Weather Query - Moji Weather\nHangzhou's current conditions: 3°C and sunny, humidity at 66%, northwesterly winds at level 3. Daytime: 10°C, sunny. Nighttime: cloudy, 3°C. It's getting cooler, Moji Weather recommends wearing a thick coat over a wool sweater. The elderly and infirm may want to wear a woolen overcoat for additional 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
    }
}

Respons error

Jika terjadi error, respons mencakup kode dan pesan yang menjelaskan penyebab error tersebut.

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

Kode status

Untuk informasi lebih lanjut, lihat Kode status untuk AI Search Open Platform.