WebOperations Kelas
Operasi WebOperations.
Anda tidak boleh membuat instans langsung kelas ini, tetapi membuat instans Klien yang akan membuatnya untuk Anda dan melampirkannya sebagai atribut.
- Warisan
-
builtins.objectWebOperations
Konstruktor
WebOperations(client, config, serializer, deserializer)Parameter
- client
Klien untuk permintaan layanan.
- config
Konfigurasi klien layanan.
- serializer
Serializer model objek.
- deserializer
Deserializer model objek.
Variabel
- x_bing_apis_sdk
Mengaktifkan kepatuhan swagger. Nilai konstanta: "true".
Metode
| search |
API Pencarian Web memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali hasil pencarian yang menyertakan tautan ke halaman web, gambar, dan banyak lagi. |
search
API Pencarian Web memungkinkan Anda mengirim kueri pencarian ke Bing dan mendapatkan kembali hasil pencarian yang menyertakan tautan ke halaman web, gambar, dan banyak lagi.
search(query, accept_language=None, pragma=None, user_agent=None, client_id=None, client_ip=None, location=None, answer_count=None, country_code=None, count=None, freshness=None, market='en-us', offset=None, promote=None, response_filter=None, safe_search=None, set_lang=None, text_decorations=None, text_format=None, custom_headers=None, raw=False, **operation_config)Parameter
- query
- str
Istilah kueri pencarian pengguna. Istilah ini mungkin tidak kosong. Istilah ini mungkin berisi Operator Tingkat Lanjut Bing. Misalnya, untuk membatasi hasil ke domain tertentu, gunakan operator situs: .
- accept_language
- str
Daftar yang dibatasi koma dari satu atau beberapa bahasa yang akan digunakan untuk string antarmuka pengguna. Daftar ini dalam urutan preferensi yang menurun. Untuk informasi tambahan, termasuk format yang diharapkan, lihat RFC2616. Header ini dan parameter kueri setLang saling eksklusif; jangan tentukan keduanya. Jika mengatur header ini, Anda juga harus menentukan parameter kueri cc. Bing akan menggunakan bahasa pertama yang didukung yang ditemukannya dari daftar, dan menggabungkan bahasa tersebut dengan nilai parameter cc untuk menentukan pasar untuk mengembalikan hasil. Jika daftar tidak menyertakan bahasa yang didukung, Bing akan menemukan bahasa dan pasar terdekat yang mendukung permintaan, dan dapat menggunakan pasar agregat atau default untuk hasil, bukan yang ditentukan. Anda harus menggunakan header ini dan parameter kueri cc hanya jika Anda menentukan beberapa bahasa; jika tidak, Anda harus menggunakan parameter kueri mkt dan setLang. String antarmuka pengguna adalah string yang digunakan sebagai label di antarmuka pengguna. Ada sangat sedikit string antarmuka pengguna di objek respons JSON. Setiap tautan dalam objek respons ke properti Bing.com akan menerapkan bahasa yang ditentukan.
- pragma
- str
Secara default, Bing menampilkan konten yang di-cache, jika tersedia. Untuk mencegah Bing menampilkan konten yang di-cache, atur header Pragma ke no-cache (misalnya, Pragma: no-cache).
- user_agent
- str
Agen pengguna yang berasal dari permintaan. Bing menggunakan agen pengguna untuk memberikan pengalaman yang dioptimalkan kepada pengguna seluler. Meskipun opsional, Anda sangat dianjurkan untuk selalu menentukan header ini. Agen pengguna harus berupa string yang sama dengan yang akan dikirim oleh browser yang umum digunakan. Untuk mengetahui informasi tentang agen pengguna, lihat RFC 2616.
- client_id
- str
Bing menggunakan header ini untuk memberi perilaku yang konsisten kepada pengguna di seluruh panggilan Bing API. Bing sering kali menerbangkan fitur dan peningkatan baru, dan menggunakan ID klien sebagai kunci untuk menetapkan lalu lintas pada penerbangan yang berbeda. Jika Anda tidak menggunakan ID klien yang sama untuk pengguna di beberapa permintaan, Bing dapat menetapkan pengguna ke beberapa penerbangan yang bertentangan. Ditetapkan ke beberapa penerbangan yang bertentangan dapat menyebabkan pengalaman pengguna yang tidak konsisten. Misalnya, jika permintaan kedua memiliki penetapan penerbangan yang berbeda dengan yang pertama, pengalaman tersebut mungkin tidak diharapkan. Selain itu, Bing dapat menggunakan ID klien untuk menyesuaikan hasil web dengan riwayat pencarian ID klien tersebut, memberikan pengalaman yang lebih kaya bagi pengguna. Bing juga menggunakan header ini untuk membantu meningkatkan peringkat hasil dengan menganalisis aktivitas yang dibuat oleh ID klien. Peningkatan relevansi membantu terkait kualitas hasil yang lebih baik yang disampaikan oleh Bing API dan pada gilirannya memungkinkan rasio klik-tayang yang lebih tinggi untuk konsumen API. PENTING: Meskipun opsional, Anda harus menganggap header ini diperlukan. Mempertahankan ID klien di beberapa permintaan untuk kombinasi pengguna akhir dan perangkat yang sama memungkinkan 1) konsumen API menerima pengalaman pengguna yang konsisten, dan 2) rasio klik-tayang yang lebih tinggi melalui kualitas hasil yang lebih baik dari Bing API. Setiap pengguna yang menggunakan aplikasi Anda pada perangkat harus memiliki ID klien buatan Bing yang unik. Jika Anda tidak menyertakan header ini dalam permintaan, Bing membuat ID dan menampilkannya di header respons X-MSEdge-ClientID. Satu-satunya waktu yang TIDAK diizinkan untuk menyertakan header ini dalam permintaan adalah pertama kalinya pengguna menggunakan aplikasi Anda di perangkat tersebut. Gunakan ID klien untuk setiap permintaan Bing API yang dibuat aplikasi Anda untuk pengguna ini di perangkat. Pertahankan ID klien. Untuk mempertahankan ID di aplikasi browser, gunakan cookie HTTP persisten untuk memastikan ID digunakan di semua sesi. Jangan gunakan cookie sesi. Untuk aplikasi lain seperti aplikasi seluler, gunakan penyimpanan persisten perangkat untuk mempertahankan ID. Lain kali pengguna menggunakan aplikasi Anda di perangkat tersebut, dapatkan ID klien yang Anda pertahankan. Respons Bing mungkin atau mungkin tidak menyertakan header ini. Jika respons menyertakan header ini, tangkap ID klien dan gunakan untuk semua permintaan Bing berikutnya untuk pengguna di perangkat tersebut. Jika Anda menyertakan X-MSEdge-ClientID, Anda tidak boleh menyertakan cookie dalam permintaan.
- client_ip
- str
Alamat IPv4 atau IPv6 perangkat klien. Alamat IP digunakan untuk menemukan lokasi pengguna. Bing menggunakan informasi lokasi untuk menentukan perilaku pencarian yang aman. Meskipun opsional, Anda dianjurkan untuk selalu menentukan header ini dan header X-Search-Location. Jangan mengaburkan alamat (misalnya, dengan mengubah oktet terakhir menjadi 0). Mengaburkan alamat mengakibatkan lokasi tidak berada di dekat lokasi aktual perangkat, yang dapat mengakibatkan Bing memberikan hasil yang salah.
- location
- str
Daftar pasangan kunci/nilai yang dibatasi titik koma yang menjelaskan lokasi geografis klien. Bing menggunakan informasi lokasi untuk menentukan perilaku pencarian yang aman dan menampilkan konten lokal yang relevan. Tentukan pasangan kunci/nilai sebagai :. Berikut adalah kunci yang Anda gunakan untuk menentukan lokasi pengguna. lat (wajib): Garis lintang lokasi klien, dalam derajat. Garis lintang harus lebih besar dari atau sama dengan -90.0 dan kurang dari atau sama dengan +90.0. Nilai negatif menunjukkan garis lintang selatan dan nilai positif menunjukkan garis lintang utara. panjang (diperlukan): Garis bujur lokasi klien, dalam derajat. Bujur harus lebih besar dari atau sama dengan -180.0 dan kurang dari atau sama dengan +180.0. Nilai negatif menunjukkan bujur barat dan nilai positif menunjukkan bujur timur. re (wajib): Radius, dalam meter, yang menentukan akurasi horizontal koordinat. Berikan nilai yang ditampilkan oleh layanan lokasi perangkat. Nilai umum mungkin 22m untuk GPS/Wi-Fi, 380m untuk triangulasi menara sel, dan 18.000m untuk pencarian IP terbalik. ts (opsional): Tanda waktu UTC UNIX saat klien berada di lokasi tersebut. (Tanda waktu UNIX adalah jumlah detik sejak 1 Januari 1970.) head (opsional): Judul atau arah perjalanan relatif klien. Tentukan arah perjalanan sebagai derajat dari 0 hingga 360, menghitung searah jarum jam relatif terhadap utara sejati. Tentukan kunci ini hanya jika kunci sp bukan nol. sp (opsional): Kecepatan horizontal (kecepatan), dalam meter per detik, yang dilalui perangkat klien. alt (opsional): Ketinggian perangkat klien, dalam meter. adalah (opsional): Radius, dalam meter, yang menentukan akurasi vertikal koordinat. Tentukan kunci ini hanya jika Anda menentukan kunci alt. Meskipun banyak kunci bersifat opsional, semakin banyak informasi yang Anda berikan, semakin akurat hasil lokasinya. Meskipun opsional, Anda dianjurkan untuk selalu menentukan lokasi geografis pengguna. Menyediakan lokasi sangat penting jika alamat IP klien tidak secara akurat mencerminkan lokasi fisik pengguna (misalnya, jika klien menggunakan VPN). Untuk hasil yang optimal, Anda harus menyertakan header ini dan header X-MSEdge-ClientIP, tetapi minimal, Anda harus menyertakan header ini.
- answer_count
- int
Jumlah jawaban yang Anda inginkan untuk disertakan respons. Jawaban yang dikembalikan Bing didasarkan pada peringkat. Misalnya, jika Bing mengembalikan halaman web, gambar, video, dan relatedSearches untuk permintaan dan Anda mengatur parameter ini ke dua (2), respons mencakup halaman web dan gambar. Jika Anda menyertakan parameter kueri responseFilter dalam permintaan yang sama dan mengaturnya ke halaman web dan berita, respons hanya akan menyertakan halaman web.
- country_code
- str
Kode negara 2 karakter negara tempat hasilnya berasal. API ini hanya mendukung pasar Amerika Serikat. Jika Anda menentukan parameter kueri ini, parameter tersebut harus diatur ke kami. Jika Anda mengatur parameter ini, Anda juga harus menentukan header Accept-Language. Bing menggunakan bahasa pertama yang didukung yang ditemukannya dari daftar bahasa, dan menggabungkan bahasa tersebut dengan kode negara yang Anda tentukan untuk menentukan pasar untuk mengembalikan hasil. Jika daftar bahasa tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan, atau mungkin menggunakan pasar agregat atau default untuk hasil, bukan yang ditentukan. Anda harus menggunakan parameter kueri ini dan parameter kueri Accept-Language hanya jika Anda menentukan beberapa bahasa; jika tidak, Anda harus menggunakan parameter kueri mkt dan setLang. Parameter ini dan parameter kueri mkt saling eksklusif—jangan tentukan keduanya.
- count
- int
Jumlah hasil yang akan dikembalikan dalam respons. Defaultnya adalah 10 dan nilai maksimumnya adalah 50. Jumlah aktual yang dikirimkan mungkin kurang dari yang diminta. Gunakan parameter ini bersama dengan parameter offset ke hasil halaman. Misalnya, jika antarmuka pengguna Anda menampilkan 10 hasil pencarian per halaman, atur jumlah ke 10 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, kenaikan offset sebesar 10 (misalnya, 0, 10, 20). Dimungkinkan bagi beberapa halaman untuk menyertakan beberapa tumpang tindih dalam hasil.
Memfilter hasil pencarian menurut nilai usia berikut: Hari—Mengembalikan halaman web yang ditemukan Bing dalam 24 jam terakhir. Minggu—Mengembalikan halaman web yang ditemukan Bing dalam 7 hari terakhir. Bulan—Mengembalikan halaman web yang ditemukan dalam 30 hari terakhir. Filter ini hanya berlaku untuk hasil halaman web dan bukan ke hasil lain seperti berita dan gambar. Nilai yang mungkin termasuk: 'Hari', 'Minggu', 'Bulan'
- market
- str
Pasar tempat hasilnya berasal. Biasanya, mkt adalah negara tempat pengguna membuat permintaan. Namun, itu bisa menjadi negara yang berbeda jika pengguna tidak berada di negara tempat Bing memberikan hasil. Pasar harus dalam bentuk -. Misalnya, en-US. String tidak peka huruf besar/kecil. Jika diketahui, Anda dianjurkan untuk selalu menentukan pasar. Menentukan pasar membantu Bing merutekan permintaan dan menampilkan respons yang sesuai dan optimal. Jika Anda menentukan pasar yang tidak tercantum dalam Kode Pasar, Bing menggunakan kode pasar yang paling sesuai berdasarkan pemetaan internal yang dapat berubah. Parameter ini dan parameter kueri cc saling eksklusif—jangan tentukan keduanya.
- offset
- int
Offset berbasis nol yang menunjukkan jumlah hasil pencarian yang akan dilewati sebelum mengembalikan hasil. Defaultnya adalah 0. Offset harus kurang dari (totalEstimatedMatches - count). Gunakan parameter ini bersama dengan parameter hitungan ke hasil halaman. Misalnya, jika antarmuka pengguna Anda menampilkan 10 hasil pencarian per halaman, atur jumlah ke 10 dan offset ke 0 untuk mendapatkan halaman pertama hasil. Untuk setiap halaman berikutnya, kenaikan offset sebesar 10 (misalnya, 0, 10, 20). dimungkinkan bagi beberapa halaman untuk menyertakan beberapa tumpang tindih dalam hasil.
- promote
- list[str atau AnswerType]
Daftar jawaban yang dibatasi koma yang Anda inginkan untuk disertakan respons terlepas dari peringkatnya. Misalnya, jika Anda mengatur answerCount) ke dua (2) sehingga Bing mengembalikan dua jawaban peringkat teratas, tetapi Anda juga ingin respons menyertakan berita, Anda akan mengatur promosi ke berita. Jika jawaban peringkat teratas adalah halaman web, gambar, video, dan relatedSearches, respons mencakup halaman web dan gambar karena berita bukan jawaban berpangkat. Tetapi jika Anda mengatur promosi ke video, Bing akan mempromosikan jawaban video ke dalam respons dan mengembalikan halaman web, gambar, dan video. Jawaban yang ingin Anda promosikan tidak dihitung terhadap batas answerCount. Misalnya, jika jawaban berperingkat adalah berita, gambar, dan video, dan Anda mengatur answerCount ke 1 dan mempromosikan ke berita, respons berisi berita dan gambar. Atau, jika jawaban pangkat adalah video, gambar, dan berita, respons berisi video dan berita. Nilai yang mungkin adalah Komputasi, Gambar, Berita, RelatedSearches, SpellSuggestions, TimeZone, Video, Halaman Web. Gunakan hanya jika Anda menentukan answerCount.
- response_filter
- list[str atau AnswerType]
Daftar jawaban yang dibatasi koma untuk disertakan dalam respons. Jika Anda tidak menentukan parameter ini, respons menyertakan semua jawaban pencarian yang datanya relevan. Nilai filter yang mungkin adalah Komputasi, Gambar, Berita, RelatedSearches, SpellSuggestions, TimeZone, Video, Halaman Web. Meskipun Anda dapat menggunakan filter ini untuk mendapatkan satu jawaban, Anda harus menggunakan titik akhir khusus jawaban untuk mendapatkan hasil yang lebih kaya. Misalnya, untuk hanya menerima gambar, kirim permintaan ke salah satu titik akhir IMAGE Search API. Jawaban RelatedSearches dan SpellSuggestions tidak mendukung titik akhir terpisah seperti yang dilakukan API Pencarian Gambar (hanya API Pencarian Web yang mengembalikannya). Untuk menyertakan jawaban yang sebaliknya akan dikecualikan karena peringkat, lihat parameter kueri promosi.
- safe_search
- str atau SafeSearch
Filter yang digunakan untuk memfilter konten dewasa. Nonaktif: Mengembalikan halaman web dengan teks, gambar, atau video dewasa. Sedang: Mengembalikan halaman web dengan teks dewasa, tetapi bukan gambar atau video dewasa. Ketat: Jangan mengembalikan halaman web dengan teks, gambar, atau video dewasa. Defaultnya adalah Moderate. Jika permintaan berasal dari pasar bahwa kebijakan dewasa Bing mengharuskan safeSearch diatur ke Ketat, Bing mengabaikan nilai safeSearch dan menggunakan Strict. Jika Anda menggunakan situs: operator kueri, ada kemungkinan respons mungkin berisi konten dewasa terlepas dari apa parameter kueri safeSearch diatur ke. Gunakan situs: hanya jika Anda mengetahui konten di situs dan skenario Anda mendukung kemungkinan konten dewasa. Nilai yang mungkin termasuk: 'Off', 'Moderate', 'Strict'
- set_lang
- str
Bahasa yang digunakan untuk string antarmuka pengguna. Tentukan bahasa menggunakan kode bahasa ISO 639-1 2 huruf. Misalnya, kode bahasa untuk bahasa Inggris adalah EN. Defaultnya adalah EN (Inggris). Meskipun opsional, Anda harus selalu menentukan bahasa. Biasanya, Anda mengatur Setlang ke bahasa yang sama yang ditentukan oleh mkt kecuali pengguna ingin string antarmuka pengguna ditampilkan dalam bahasa yang berbeda. Parameter ini dan header Accept-Language saling eksklusif; jangan tentukan keduanya. String antarmuka pengguna adalah string yang digunakan sebagai label di antarmuka pengguna. Ada beberapa string antarmuka pengguna di objek respons JSON. Selain itu, setiap tautan ke properti Bing.com dalam objek respons menerapkan bahasa yang ditentukan.
- text_decorations
- bool
Nilai Boolean yang menentukan apakah string tampilan harus berisi penanda dekorasi seperti karakter penyorotan hit. Jika true, string dapat menyertakan penanda. Defaultnya adalah false (salah). Untuk menentukan apakah akan menggunakan karakter Unicode atau tag HTML sebagai penanda, lihat parameter kueri textFormat.
- text_format
- str atau TextFormat
Jenis penanda yang akan digunakan untuk dekorasi teks (lihat parameter kueri textDecorations). Nilai yang mungkin adalah Mentah—Gunakan karakter Unicode untuk menandai konten yang memerlukan pemformatan khusus. Karakter Unicode berada dalam rentang E000 hingga E019. Misalnya, Bing menggunakan E000 dan E001 untuk menandai awal dan akhir istilah kueri untuk penyorotan klik. HTML—Gunakan tag HTML untuk menandai konten yang memerlukan pemformatan khusus. Misalnya, gunakan tag untuk menyorot istilah kueri dalam string tampilan. Defaultnya adalah Raw. Untuk string tampilan yang berisi karakter HTML yang dapat dilepaskan seperti <, , >dan &, jika textFormat diatur ke HTML, Bing lolos dari karakter yang sesuai (misalnya, < diloloskan ke <). Nilai yang mungkin termasuk: 'Mentah', 'Html'
- operation_config
Pengabaian konfigurasi operasi.
Mengembalikan
SearchResponse atau ClientRawResponse jika raw=true
Tipe hasil
Pengecualian
Atribut
models
models = <module 'azure.cognitiveservices.search.websearch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\search\\websearch\\models\\__init__.py'>
Azure SDK for Python
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk