Referensi API Pencarian Internet - OpenSearch

AI Search Open Platform menyediakan fungsi pencarian Internet, mendukung panggilan langsung ke API Pencarian Internet atau mengaktifkan pencarian Internet saat memanggil layanan pembuatan konten.

Layanan

Nama Layanan	ID Layanan	Deskripsi Layanan
Layanan pencarian Internet	ops-web-search-001	Menyediakan layanan pencarian Internet umum yang dapat digunakan dengan model besar untuk memperluas tanggapan dalam skenario basis pengetahuan pribadi.

Informasi otentikasi diperoleh.
Saat memanggil layanan AI Search Open Platform menggunakan API, Anda perlu mengotentikasi identitas pemanggil.
Alamat akses layanan diperoleh.
Anda dapat memanggil layanan melalui Internet atau virtual private cloud (VPC). Untuk informasi lebih lanjut, lihat Dapatkan alamat pendaftaran layanan.

Metode permintaan

POST

URL

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

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

workspace_name: Nama ruang kerja, seperti default.
service_id: ID layanan bawaan, seperti ops-web-search-001.

Parameter permintaan

Parameter header

Otentikasi API-KEY

Parameter	Tipe	Diperlukan	Deskripsi	Nilai contoh
Content-Type	String	Ya	Tipe permintaan: application/json	application/json
Authorization	String	Ya	API-Key	Bearer OS-d1**2a

Parameter body

Parameter	Tipe	Diperlukan	Deskripsi	Nilai default
query	String	Ya	Kata kunci pencarian.
query_rewrite	Boolean	Tidak	Menentukan apakah akan mengaktifkan LLM untuk menulis ulang kueri. Nilai defaultnya adalah true.	true
top_k	Integer	Tidak	Jumlah hasil pencarian yang akan dikembalikan.	5
history	List	Tidak	Riwayat percakapan antara pengguna dan model. Setiap elemen dalam daftar berbentuk {"role": role, "content": content}, di mana role bisa berupa system, user, atau assistant. system: Mewakili pesan tingkat sistem, yang hanya dapat digunakan untuk pesan pertama dalam riwayat percakapan (messages[0]). Penggunaan role sistem bersifat opsional. Jika ada, harus berada di awal daftar. user dan assistant: Mewakili dialog antara pengguna dan model. Mereka harus muncul bergantian dalam percakapan untuk mensimulasikan alur percakapan sebenarnya.	null
content_type	String	Tidak	Tipe konten dari hasil pencarian. snippet: Deskripsi singkat tentang konten halaman web. summary: Ringkasan teks dari konten halaman web, yang membutuhkan waktu lebih lama dibandingkan snippet.	snippet

Contoh permintaan 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"
}'

Parameter respons

Parameter	Tipe	Deskripsi	Nilai contoh
result.search_result	List<search_result>	Hasil yang dikembalikan dari pencarian Internet ini.
result.search_result[].tilte	String	Judul halaman web.	Cuaca Hangzhou
result.search_result[].link	String	Tautan halaman web.	https://www.xxx.com
result.search_result[].snippet	String	Ringkasan halaman web.	Berawan malam ini; cerah hingga sebagian berawan besok; sebagian berawan hingga berawan lusa
result.search_result[].content	String	Konten halaman web.	Cuaca Hangzhou\nBerawan malam ini; cerah hingga sebagian berawan besok;
result.search_result[].position	Integer	Posisi halaman web dalam hasil pengambilan.	3
usage.search_count	Integer	Jumlah pencarian Internet.	1
usage.rewrite_model.input_tokens	Integer	Token masukan untuk penulisan ulang kueri.	100
usage.rewrite_model.output_tokens	Integer	Token keluaran setelah penulisan ulang kueri.	100
usage.rewrite_model.total_tokens	Integer	Jumlah total token setelah penulisan ulang kueri.	200
usage.filter_model.input_tokens	Integer	Token masukan untuk menyaring hasil pencarian menggunakan model besar.	100
usage.filter_model.output_tokens	Integer	Token keluaran setelah menyaring hasil pencarian menggunakan model besar.	100
usage.filter_model.total_tokens	Integer	Jumlah total token untuk menyaring hasil pencarian menggunakan model besar.	200

Contoh respons

Contoh respons sukses

{
  "result":{
    "search_result": [
        {
          "title": "Cuaca Hangzhou",
          "link": "https://www.hzqx.com/pc/hztq/",
          "snippet": "Berawan malam ini; cerah hingga sebagian berawan besok; sebagian berawan hingga berawan lusa. Angin utara level 2-3 malam ini, angin timur level 2 besok. Suhu maksimum besok siang adalah 10 derajat, suhu minimum besok pagi adalah 3 derajat, kelembaban relatif rata-rata besok adalah 65%.",
          "position": 3,
          "content": "Cuaca Hangzhou\nBerawan malam ini; cerah hingga sebagian berawan besok; sebagian berawan hingga berawan lusa. Angin utara level 2-3 malam ini, angin timur level 2 besok. Suhu maksimum besok siang adalah 10 derajat, suhu minimum besok pagi adalah 3 derajat, kelembaban relatif rata-rata besok adalah 65%."
        },
        {
          "title": "Prakiraan Cuaca Hangzhou_Permintaan Cuaca - Moji Weather",
          "link": "https://tianqi.moji.com/weather/china/zhejiang/hangzhou",
          "snippet": "Kondisi saat ini Hangzhou: 3 derajat cerah, kelembaban: 66%, angin barat laut: level 3. Siang hari: 10 derajat, cerah. Malam: berawan, 3 derajat, semakin dingin, Moji Weather menyarankan Anda memakai mantel tebal di atas sweater wol, dan individu lanjut usia atau lemah dapat memakai mantel wol untuk meningkatkan kehangatan.",
          "position": 4,
          "content": "Prakiraan Cuaca Hangzhou_Permintaan Cuaca - Moji Weather\nKondisi saat ini Hangzhou: 3 derajat cerah, kelembaban: 66%, angin barat laut: level 3. Siang hari: 10 derajat, cerah. Malam: berawan, 3 derajat, semakin dingin, Moji Weather menyarankan Anda memakai mantel tebal di atas sweater wol, dan individu lanjut usia atau lemah dapat memakai mantel wol untuk meningkatkan kehangatan."
        }
    ]
  },
    "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
    }
}

Contoh respons kesalahan

Jika permintaan akses gagal, hasil keluaran menunjukkan penyebab kesalahan melalui bidang kode dan pesan.

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

Kode status HTTP	Pesan kesalahan	Deskripsi
200	-	Permintaan berhasil, termasuk skenario kegagalan tugas. Status tugas aktual perlu ditentukan dari result.status
404	BadRequest.TaskNotExist	Tugas tidak ada
400	InvalidParameter	Permintaan tidak valid
500	InternalServerError	Kesalahan internal

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