Referensi API Pemeriksaan Ejaan v7

Peringatan

API Pencarian Bing berpindah dari Cognitive Services ke Layanan Pencarian Bing. Mulai 30 Oktober 2020, setiap instans baru Bing Search perlu diprovisikan dengan mengikuti proses yang didokumentasikan di sini. Bing Search API yang diprovisikan menggunakan Cognitive Services akan didukung selama tiga tahun ke depan atau hingga akhir Perjanjian Enterprise Anda, mana saja yang lebih dulu. Untuk instruksi migrasi, lihat Layanan Pencarian Bing.

API Pemeriksaan Ejaan memungkinkan Anda memeriksa string teks untuk kesalahan ejaan dan tata bahasa. Bagian ini menyediakan detail teknis tentang parameter dan header kueri yang Anda gunakan untuk meminta pemeriksaan ejaan, dan objek respons JSON yang berisi hasilnya. Untuk contoh yang memperlihatkan cara membuat permintaan, lihat Memeriksa ejaan string teks.

Untuk informasi tentang header yang harus disertakan permintaan, lihat Header Permintaan.

Untuk informasi tentang parameter kueri yang harus disertakan permintaan, lihat Parameter Kueri.

Untuk informasi tentang objek JSON yang mungkin disertakan respons, lihat Objek Respons.

Untuk informasi tentang penggunaan dan tampilan hasil yang diizinkan, lihat persyaratan Penggunaan dan Tampilan SEARCH API Bing.

Catatan

Karena format dan parameter URL dapat berubah tanpa pemberitahuan, gunakan semua URL apa adanya. Anda tidak boleh mengambil dependensi pada format atau parameter URL kecuali jika dicatat.

Titik akhir

Untuk memeriksa ejaan dan tata bahasa blok teks, kirim permintaan GET atau POST ke:

https://api.cognitive.microsoft.com/bing/v7.0/SpellCheck

Permintaan harus menggunakan protokol HTTPS.

Karena batas panjang string kueri, Anda biasanya menggunakan permintaan POST kecuali Anda hanya memeriksa string pendek.

Untuk langganan multi-layanan, Anda harus menyertakan wilayah dalam URL. Misalnya: westus.api.cognitive.microsoft.com. Lihat Wilayah yang Didukung.

Catatan

Panjang URL maksimum adalah 2.048 karakter. Untuk memastikan bahwa panjang URL Anda tidak melebihi batas, panjang maksimum parameter kueri Anda harus kurang dari 1.500 karakter. Jika URL melebihi 2.048 karakter, server menampilkan 404 Tidak ditemukan.

Header permintaan

Berikut adalah header yang mungkin disertakan oleh permintaan dan respons.

Header Deskripsi
Terima Header permintaan opsional.

Jenis media default adalah aplikasi/json. Untuk menentukan bahwa respons menggunakan JSON-LD, atur header Terima ke application/ld+json.
Accept-Language Header permintaan opsional.

Daftar bahasa yang dibatasi koma untuk digunakan untuk string antarmuka pengguna. Daftar ini dalam urutan preferensi yang menurun. Untuk mengetahui informasi selengkapnya, termasuk format yang diharapkan, lihat RFC2616.

Header ini dan parameter kueri setLang saling eksklusif jangan tentukan keduanya.

Jika Anda mengatur header ini, Anda juga harus menentukan parameter kueri cc. Untuk menentukan pasar guna menampilkan hasil, Bing menggunakan bahasa pertama yang didukung yang ditemukannya dari daftar dan menggabungkannya dengan nilai parameter cc. Jika daftar tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan atau menggunakan pasar agregat atau default untuk hasilnya. Untuk menentukan pasar yang digunakan Bing, lihat header BingAPIs-Market.

Gunakan header ini dan parameter kueri cc hanya jika Anda menentukan beberapa bahasa. Jika tidak, gunakan parameter kueri mkt dan setLang.

String antarmuka pengguna adalah string yang digunakan sebagai label di antarmuka pengguna. Ada beberapa string antarmuka pengguna di objek respons JSON. Setiap tautan ke properti Bing.com dalam objek respons menerapkan bahasa yang ditentukan.
BingAPIs-Market Header respons.

Pasar yang digunakan oleh permintaan. Bentuknya adalah <languageCode>-<countryCode>. Misalnya, en-US.

Jika Anda menentukan pasar yang tidak tercantum dalam Kode Pasar, nilai ini mungkin berbeda dari pasar yang Anda tentukan dalam parameter kueri mkt . Hal yang sama berlaku jika Anda menentukan nilai untuk cc dan Accept-Language yang tidak dapat direkonsiliasi.
BingAPIs-TraceId Header respons.

ID entri log yang berisi detail permintaan. Saat terjadi kesalahan, ambil ID ini. Jika Anda tidak dapat menentukan dan mengatasi masalah tersebut, sertakan ID ini bersama dengan informasi lain yang Anda berikan kepada tim Dukungan.
Ocp-Apim-Subscription-Key Header permintaan yang diperlukan.

Kunci langganan yang Anda terima saat mendaftar untuk layanan ini di Cognitive Services.
Pragma Header permintaan opsional

Secara default, Bing menampilkan konten yang di-cache, jika tersedia. Untuk mencegah konten yang di-cache, atur header Pragma ke no-cache (misalnya, Pragma: no-cache).
Retry-After Header respons.

Respons mencakup header ini jika Anda melebihi jumlah kueri yang diizinkan per detik (QPS) atau per bulan (QPM). Header berisi jumlah detik yang harus Anda tunggu sebelum mengirim permintaan lain.
User-Agent Header permintaan opsional.

Agen pengguna yang berasal dari permintaan. Bing menggunakan agen pengguna untuk memberikan pengalaman yang dioptimalkan kepada pengguna seluler. Meskipun opsional, Anda dianjurkan untuk selalu menentukan header ini.

User-agent harus berupa string yang sama dengan yang dikirim oleh browser yang umum digunakan. Untuk mengetahui informasi tentang agen pengguna, lihat RFC 2616.

Berikut adalah contoh string user-agent.
  • Windows Phone—Mozilla/5.0 (kompatibel; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822)

  • Android—Mozilla/5.0 (Linux; U; Android 2.3.5; en-us; SCH-I500 Build/GINGERBREAD) AppleWebKit/533.1 (KHTML; seperti Gecko) Version/4.0 Mobile Safari/533.1

  • iPhone—Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 seperti Mac OS X) AppleWebKit/536.26 (KHTML; seperti Gecko) Mobile/10B142 iPhone4;1 BingWeb/3.03.1428.20120423

  • PC—Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; Touch; rv:11.0) seperti Gecko

  • iPad—Mozilla/5.0 (iPad; CPU OS 7_0 seperti Mac OS X) AppleWebKit/537.51.1 (KHTML, seperti Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID Permintaan dan header respons opsional.

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.

Berikut adalah aturan dasar penggunaan yang berlaku untuk header ini.
  • 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.

  • PERHATIAN: Anda harus memastikan bahwa ID Klien ini tidak dapat ditautkan ke informasi akun pengguna yang dapat diautentikasi.

  • 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.

CATATAN: 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.

CATATAN: Jika Anda menyertakan X-MSEdge-ClientID, Anda tidak boleh menyertakan cookie dalam permintaan.
X-MSEdge-ClientIP Header permintaan opsional.

Alamat IPv4 atau IPv6 perangkat klien. Alamat IP digunakan untuk menemukan lokasi pengguna. Bing menggunakan informasi lokasi untuk menentukan perilaku pencarian yang aman.

CATATAN: 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.
X-Search-Location Header permintaan opsional.

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 <kunci>:<nilai>. Berikut adalah kunci yang Anda gunakan untuk menentukan lokasi pengguna.

  • lat—Diperlukan. 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.

  • long—Diperlukan. 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—Diperlukan. 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 relatif atau arah perjalanan 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, perangkat klien bepergian.

  • alt—Opsional. Ketinggian perangkat klien, dalam meter.

  • —bersifat Opsional. Radius, dalam meter, yang menentukan akurasi vertikal koordinat. Tentukan kunci ini hanya jika Anda menentukan kunci alt.

  • disp—Opsional. Lokasi geografis pengguna dalam formulir, disp:<City, State>. Misalnya, disp:Seattle, Washington. Ini adalah versi teks tampilan lokasi pengguna yang Anda tentukan menggunakan kunci lat/long. Jika nilai ini bertentangan dengan koordinat lat/long, Bing menggunakan nilai disp sebagai lokasi pengguna.

CATATAN: Bing mengabaikan header ini jika kueri menyertakan lokasi. Misalnya, jika header ini mencerminkan lokasi pengguna sebagai San Francisco, tetapi kuerinya adalah restoran seattle, Bing mengembalikan restoran yang terletak di Seattle, Washington.

CATATAN: Meskipun banyak kunci bersifat opsional, semakin banyak informasi yang Anda berikan, semakin akurat hasil lokasinya.

CATATAN: 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-Search-ClientIP, tetapi minimal, Anda harus menyertakan header ini.

Catatan

Ingatlah bahwa Ketentuan Penggunaan memerlukan kepatuhan terhadap semua hukum yang berlaku, termasuk mengenai penggunaan header ini. Misalnya, di wilayah hukum tertentu, seperti Eropa, ada persyaratan untuk mendapatkan persetujuan pengguna sebelum menempatkan perangkat pelacakan tertentu pada perangkat pengguna.

Parameter kueri

Berikut adalah parameter kueri yang dapat disertakan dalam permintaan. Kolom Wajib diisi menunjukkan bahwa Anda harus menentukan parameter. Anda harus mengodekan nilai parameter kueri ke dalam URL.

Nama Nilai Jenis Diperlukan
actionType String yang digunakan oleh pengelogan untuk menentukan apakah permintaan berasal dari sesi interaktif atau pemuatan halaman. Berikut ini adalah nilai yang mungkin.
  • Edit—Permintaan berasal dari sesi interaktif
  • Muat—Permintaan berasal dari pemuatan halaman
String Tidak
appName Nama unik aplikasi Anda.

Nama harus diketahui oleh Bing. Jangan sertakan parameter ini kecuali sebelumnya Anda telah menghubungi Bing untuk mendapatkan nama aplikasi yang unik. Untuk mendapatkan nama yang unik, hubungi manajer pengembangan bisnis Bing Anda.
String Tidak
cc Kode negara 2 karakter negara tempat hasilnya berasal. Untuk daftar nilai yang mungkin, lihat Kode Pasar.

Jika Anda mengatur parameter ini, Anda juga harus menentukan header Accept-Language. Bing menggunakan bahasa pertama yang didukung yang ditemukannya dalam bahasa yang ditentukan dan menggabungkannya dengan kode negara untuk menentukan pasar untuk mengembalikan hasil. Jika daftar bahasa tidak menyertakan bahasa yang didukung, Bing menemukan bahasa dan pasar terdekat yang mendukung permintaan tersebut. Atau, Bing dapat menggunakan pasar agregat atau default untuk hasilnya.

Gunakan parameter kueri ini dan Accept-Language header hanya jika Anda menentukan beberapa bahasa. Jika tidak, Anda harus menggunakan mkt parameter kueri dan setLang .

Parameter ini dan parameter kueri mkt saling eksklusif—jangan tentukan keduanya.
String Tidak
clientMachineName Nama unik perangkat tempat permintaan dibuat. Hasilkan nilai unik untuk setiap perangkat (nilainya tidak penting).

Layanan ini menggunakan ID untuk membantu men-debug masalah dan meningkatkan kualitas koreksi.
String Tidak
docId ID unik yang mengidentifikasi dokumen tempat teks berada. Hasilkan nilai unik untuk setiap dokumen (nilainya tidak penting).

Layanan ini menggunakan ID untuk membantu men-debug masalah dan meningkatkan kualitas koreksi.
String Tidak
mkt 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 <kode> negara kode>< bahasa. Misalnya, en-US. String tidak peka huruf besar/kecil. Untuk daftar nilai pasar yang mungkin, lihat Kode Pasar.

CATATAN: Jika diketahui, Anda didorong 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.
String Tidak
Mode Jenis pemeriksaan ejaan dan tata bahasa yang akan dilakukan. Berikut ini adalah nilai yang mungkin (nilainya tidak peka huruf besar/kecil). Defaultnya adalah Proof.
  • Bukti - untuk skenario dokumen—
    • Mode ejaan Proof menyediakan pemeriksaan paling komprehensif, menambahkan kapitalisasi, tanda baca dasar, dan fitur lainnya untuk membantu pembuatan dokumen. tetapi hanya tersedia di pasar en-US (Inggris-Amerika Serikat), es-ES(Spanyol), pt-BR (Portugis) (Catatan: hanya versi beta untuk Spanyol dan Portugis). Untuk semua pasar lainnya, atur parameter kueri mode ke Spell.

      CATATAN: Jika panjang teks kueri melebihi 4096, teks tersebut akan dipotok menjadi 4096 karakter, lalu diproses.


  • Spell - untuk skenario pencarian/kueri web—
    • 'Spell' lebih agresif untuk mengembalikan hasil pencarian yang lebih baik. Mode Ejaan menemukan sebagian besar kesalahan ejaan tetapi tidak menemukan beberapa kesalahan tata bahasa yang ditangkap Oleh Bukti, misalnya, kapitalisasi dan kata berulang.

      CATATAN: Panjang kueri maks yang didukung adalah seperti di bawah ini. Jika kueri melebihi batas, hasilnya muncul bahwa kueri tidak diubah.
      • 65 karakter untuk kode bahasa en, de, es, fr, pl, pt, sv, ru, nl, nb, tr-tr, it, zh, ko.
      • 65 karakter untuk orang lain
String Tidak
preContextText String yang memberikan konteks ke string teks . Misalnya, kelopaktext string valid. Namun, jika Anda mengatur preContextText ke sepeda, konteks berubah dan string teks menjadi tidak valid. Dalam hal ini, API menyarankan agar Anda mengubah kelopak menjadi pedal (seperti dalam pedal sepeda).

Teks ini tidak diperiksa untuk kesalahan tata bahasa atau ejaan.

Panjang text gabungan string, preContextText string, dan postContextText string tidak boleh melebihi 10.000 karakter.

Anda dapat menentukan parameter ini dalam string kueri permintaan GET atau dalam isi permintaan POST.
String Tidak
postContextText String yang memberikan konteks ke string teks . Misalnya, textstring yang dibaca valid. Namun, jika Anda mengatur postContextText ke karpet, konteks berubah dan string teks menjadi tidak valid. Dalam hal ini, API menyarankan agar Anda mengubah baca menjadi merah (seperti dalam karpet merah).

Teks ini tidak diperiksa untuk kesalahan tata bahasa atau ejaan.

Panjang text gabungan string, preContextText string, dan postContextText string tidak boleh melebihi 10.000 karakter.

Anda dapat menentukan parameter ini dalam string kueri permintaan GET atau dalam isi permintaan POST.
String Tidak
sessionId ID unik yang mengidentifikasi sesi pengguna ini. Hasilkan nilai unik untuk setiap sesi pengguna (nilainya tidak penting).

Layanan ini menggunakan ID untuk membantu men-debug masalah dan meningkatkan kualitas koreksi.
String Tidak
setLang Bahasa yang digunakan untuk string antarmuka pengguna. Anda dapat menentukan bahasa menggunakan kode 2 huruf atau 4 huruf. Menggunakan kode 4 huruf lebih disukai.

Untuk daftar kode bahasa yang didukung, lihat Bing bahasa dan pasar yang didukung.

Bing memuat string yang dilokalkan jika setlang berisi kode kultur netral 2 huruf (fr) yang valid atau kode budaya khusus 4 huruf (fr-ca) yang valid. Misalnya, untuk fr-ca, Bing memuat string kode kultur netral fr.

Jika setlang tidak valid (misalnya, zh) atau Bing tidak mendukung bahasa (misalnya, af, af-na), Bing default ke en (Inggris).

Untuk menentukan kode 2 huruf, atur parameter ini ke kode bahasa ISO 639-1.

Untuk menentukan kode 4 huruf, gunakan formulir bahasa negara/wilayah> di mana <bahasa> adalah kode bahasa ISO 639-1 (budaya netral) dan <negara/wilayah> adalah kode negara/wilayah ISO 3166 (budaya tertentu).<>< Misalnya, gunakan en-US untuk bahasa Inggris Amerika Serikat.

Meskipun opsional, Anda harus selalu menentukan bahasa. Biasanya, Anda mengatur setLang ke bahasa yang sama dengan yang ditentukan oleh mkt kecuali pengguna ingin string antarmuka pengguna ditampilkan dalam bahasa yang berbeda.

Parameter dan header Accept-Language ini 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.
String Tidak
Teks String teks untuk memeriksa kesalahan ejaan dan tata bahasa.

Panjang text gabungan string, preContextText string, dan postContextText string tidak boleh melebihi 10.000 karakter.

Anda dapat menentukan parameter ini dalam string kueri permintaan GET atau dalam isi permintaan POST. Karena batas panjang string kueri, Anda biasanya akan menggunakan permintaan POST kecuali Anda hanya memeriksa string pendek.
String Ya
Userid ID unik yang mengidentifikasi pengguna. Hasilkan nilai unik untuk setiap pengguna (nilainya tidak penting).

Layanan ini menggunakan ID untuk membantu men-debug masalah dan meningkatkan kualitas koreksi.
String Tidak

Objek respons

Berikut adalah objek respons JSON yang mungkin disertakan oleh respons. Jika permintaan berhasil, objek tingkat atas dalam respons adalah objek SpellCheck . Jika permintaan gagal, objek tingkat atas adalah ErrorResponse.

Objek Deskripsi
Kesalahan Kesalahan yang terjadi.
ErrorResponse Objek tingkat atas yang disertakan respons saat permintaan gagal.
FlaggedToken Kata yang mungkin salah secara tata bahasa atau tidak dieja dengan benar.
Pemeriksaan Ejaan Objek tingkat atas yang disertakan respons saat permintaan berhasil.
TokenSuggestion Koreksi ejaan atau tata bahasa yang disarankan.

Kesalahan

Mendefinisikan kesalahan yang terjadi.

Elemen Deskripsi Jenis
code Kode kesalahan yang mengidentifikasi kategori kesalahan. Untuk daftar kode yang mungkin, lihat Kode Kesalahan. String
message Deskripsi kesalahan. String
moreDetails Deskripsi yang menyediakan informasi tambahan tentang kesalahan tersebut. String
parameter Parameter kueri dalam permintaan yang menyebabkan kesalahan. String
subCode Kode kesalahan yang mengidentifikasi kesalahan. Misalnya, jika code InvalidRequest, subCode mungkin berupa ParameterInvalid atau ParameterInvalidValue. String
value Nilai parameter kueri yang tidak valid. String

ErrorResponse

Objek tingkat atas yang disertakan respons saat permintaan gagal.

Nama Nilai Jenis
_type Ketik petunjuk. String
errors Daftar kesalahan yang menjelaskan alasan permintaan gagal. Error[]

FlaggedToken

Kata yang tidak dieja dengan benar atau salah secara tata bahasa.

Nama Nilai Jenis
offset Offset berbasis nol dari awal string kueri teks ke kata yang ditandai. Bilangan bulat
Saran Daftar kata yang memperbaiki kesalahan ejaan atau tata bahasa. Daftar ini dalam urutan preferensi yang menurun. TokenSuggestion[]
token Kata dalam text string kueri yang tidak dieja dengan benar atau salah secara tata bahasa. String
Jenis Jenis kesalahan yang menyebabkan kata ditandai. Berikut ini adalah nilai yang mungkin.
  • RepeatedToken—Kata ini diulang berturut-turut (misalnya, cuaca hangat )

  • UnknownToken—Semua kesalahan ejaan atau tata bahasa lainnya
String

Pemeriksaan Ejaan

Objek tingkat atas yang disertakan respons saat permintaan berhasil.

Jika layanan mencurigai penolakan serangan layanan, permintaan berhasil (kode status HTTP adalah 200 OK), tetapi isi respons kosong.

Nama Nilai Jenis
_type Petunjuk jenis, yang diatur ke SpellCheck. String
flaggedTokens Daftar kata dalam teks yang ditandai sebagai tidak dieja dengan benar atau salah secara tata bahasa.

Jika tidak ada kesalahan ejaan atau tata bahasa yang ditemukan, atau pasar yang ditentukan tidak didukung, array kosong.
FlaggedToken[]

TokenSuggestion

Koreksi ejaan atau tata bahasa yang disarankan.

Nama Nilai Jenis
Skor Nilai yang menunjukkan tingkat keyakinan bahwa koreksi yang disarankan sudah benar. modeJika parameter kueri diatur ke Spell, bidang ini diatur ke 1.0. Double
Saran Kata yang disarankan untuk mengganti kata yang ditandai.

Jika kata yang ditandai adalah kata berulang (lihat jenis), string ini kosong.
String

Kode kesalahan

Berikut adalah kemungkinan kode status HTTP yang ditampilkan permintaan.

Kode Status Deskripsi
200 Berhasil.
400 Salah satu parameter kueri hilang atau tidak valid.
401 Kunci langganan hilang atau tidak valid.
403 Pengguna diautentikasi (misalnya, mereka menggunakan kunci langganan yang valid) tetapi tidak memiliki izin ke sumber daya yang diminta.

Bing juga dapat menampilkan status ini jika penelepon melebihi kuota kueri per bulan.
410 Permintaan yang digunakan HTTP, bukan protokol HTTPS. HTTPS adalah satu-satunya protokol yang didukung.
429 Penelepon melebihi kueri mereka per kuota kedua.
500 Kesalahan server tidak terduga.

Jika permintaan gagal, respons berisi objek ErrorResponse, yang berisi daftar objek Kesalahan yang menjelaskan apa yang menyebabkan kesalahan. Jika kesalahan terkait dengan parameter, bidang parameter mengidentifikasi parameter yang menjadi masalah. Dan jika kesalahan terkait dengan nilai parameter, bidang value mengidentifikasi nilai yang tidak valid.

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidRequest", 
      "subCode": "ParameterMissing", 
      "message": "Required parameter is missing.", 
      "parameter": "q" 
    }
  ]
}

{
  "_type": "ErrorResponse", 
  "errors": [
    {
      "code": "InvalidAuthorization", 
      "subCode": "AuthorizationMissing", 
      "message": "Authorization is required.", 
      "moreDetails": "Subscription key is not recognized."
    }
  ]
}

Berikut adalah kemungkinan nilai kode kesalahan dan kode sub-kesalahan.

Kode SubCode Deskripsi
ServerError UnexpectedError
ResourceError
NotImplemented
Kode status HTTP adalah 500.
InvalidRequest ParameterMissing
ParameterInvalidValue
HttpNotAllowed
Diblokir
Bing menampilkan InvalidRequest setiap kali bagian mana pun dari permintaan tidak valid. Misalnya, parameter yang diperlukan hilang atau nilai parameter tidak valid.

Jika kesalahannya adalah ParameterMissing atau ParameterInvalidValue, kode status HTTP adalah 400.

Jika Anda menggunakan protokol HTTP alih-alih HTTPS, Bing menampilkan HttpNotAllowed, dan kode status HTTP adalah 410.
RateLimitExceeded Tidak ada sub-kode Bing menampilkan RateLimitExceed setiap kali Anda melebihi kuota kueri per detik (QPS) atau kueri per bulan (QPM) Anda.

Jika Anda melebihi QPS, Bing menampilkan kode status HTTP 429, dan jika Anda melebihi QPM, Bing menampilkan 403.
InvalidAuthorization AuthorizationMissing
AuthorizationRedundancy
Bing menampilkan InvalidAuthorization saat Bing tidak dapat mengautentikasi pemanggil. Misalnya, header Ocp-Apim-Subscription-Key hilang atau kunci langganan tidak valid.

Redundansi terjadi jika Anda menentukan lebih dari satu metode autentikasi.

Jika kesalahannya adalah InvalidAuthorization, kode status HTTP adalah 401.
InsufficientAuthorization AuthorizationDisabled
AuthorizationExpired
Bing menampilkan InsufficientAuthorization saat pemanggil tidak memiliki izin untuk mengakses sumber daya. Ini dapat terjadi jika kunci langganan telah dinonaktifkan atau telah kedaluwarsa.

Jika kesalahannya adalah InsufficientAuthorization, kode status HTTP adalah 403.

Kode pasar

Tabel berikut mencantumkan nilai kode pasar yang dapat Anda gunakan untuk menentukan mkt parameter kueri. Bing hanya akan menampilkan konten untuk pasar ini. Daftar ini dapat berubah.

Untuk daftar kode negara yang mungkin Anda tentukan dalam cc parameter kueri, lihat Kode negara.

Negara/Wilayah Bahasa Kode pasar
Argentina Spanyol es-AR
Australia Inggris en-AU
Austria Jerman de-AT
Belgia Belanda nl-BE
Belgia Prancis fr-BE
Brasil Portugis pt-BR
Kanada Inggris en-CA
Kanada Prancis fr-CA
Cile Spanyol es-CL
Denmark Dansk da-DK
Finlandia Suomi fi-FI
Prancis Prancis fr-FR
Jerman Jerman de-DE
Hong Kong SAR Mandarin Tradisional zh-HK
India Inggris en-IN
Indonesia Inggris en-ID
Italia Italia it-IT
Jepang Jepang ja-JP
Korea Korea ko-KR
Malaysia Inggris en-MY
Meksiko Spanyol es-MX
Belanda Belanda nl-NL
Selandia Baru Inggris en-NZ
Norwegia Norwegia no-NO
Republik Rakyat Tiongkok Mandarin zh-CN
Polandia Polski pl-PL
Republik Filipina Inggris en-PH
Rusia Rusia ru-RU
Afrika Selatan Inggris en-ZA
Spanyol Spanyol es-ES
Swedia Swedia sv-SE
Swiss Prancis fr-CH
Swiss Jerman de-CH
Taiwan Mandarin Tradisional zh-TW
Turki Turki tr-TR
Inggris Raya Inggris en-GB
Amerika Serikat Inggris en-US
Amerika Serikat Spanyol es-US

Kode negara

Berikut ini adalah kode negara yang dapat Anda tentukan dalam cc parameter kueri. Daftar ini dapat berubah.

Negara/Wilayah Kode Negara
Argentina AR
Australia AU
Austria AT
Belgia BE
Brasil BR
Kanada CA
Cile CL
Denmark DK
Finlandia FI
Prancis FR
Jerman DE
Hong Kong SAR HK
India IN
Indonesia ID
Italia IT
Jepang JP
Korea KR
Malaysia MY
Meksiko MX
Belanda NL
Selandia Baru NZ
Norwegia NO
Republik Rakyat Tiongkok CN
Polandia PL
Portugal PT
Republik Filipina PH
Rusia RU
Arab Saudi SA
Afrika Selatan ZA
Spanyol ES
Swedia SE
Swiss CH
Taiwan TW
Turki TR
Inggris Raya GB
Amerika Serikat US

Bing bahasa dan pasar yang didukung

Tabel berikut ini mencantumkan Bing bahasa yang didukung yang dapat Anda tentukan dalam setLang parameter kueri, kode negara yang dapat Anda tentukan dalam cc parameter kueri, dan nilai kode pasar yang mungkin Anda gunakan untuk menentukan mkt parameter kueri. Demo Text dan Demo Excepted Correction dapat digunakan untuk menguji apakah api berfungsi dengan benar.

Bahasa yang Didukung Negara/Wilayah Kode Pasar Teks Demo Demo Terkecuali Koreksi
Arab Uni Emirat Arab ar-AE مرحبا , يوم عسيد لك مرحبا , يوم سعيد لك
Bahasa ulgaria Bulgaria bg-BG Българсик език Български език
Katalan Spanyol ca-ES Claudi riera claudia riera
Cheska Cheska cs-CZ Bahasa Češtian Čeština
Dansk Denmark da-DK Welokm Welkom
Jerman Jerman de-DE zdf fussballspiel zdf fußballspiel
Inggris Australia en-AU poption sempurna ramuan sempurna
Inggris Kanada en-CA dekafenasi decaffeination
Inggris Inggris Raya en-GB makna topograpical makna topografis
Inggris India en-IN dainik jagaran dainik jagran
Inggris Amerika Serikat en-US pertempuran aisiago pertempuran asiago
Spanyol Spanyol es-ES cordillera de lows cárpatos cordillera de los cárpatos
Spanyol Meksiko es-MX carsel de cananea cárcel de cananea
Spanyol Amerika Serikat es-US carsel de cananea cárcel de cananea
Suomi Finlandia fi-FI hälyt yskeskuks hälytyskeskus
Prancis Kanada fr-CA les meilleuresadditif les meilleures additif
Prancis Prancis fr-FR letre en fromage lettre en fromage
Ibrani Israel he-IL ברךו הבא ברוך הבא
Kroasia Kroasia hr-HR suze svetog lovra suze svetog lovre
Italia Italia it-IT orologio svarowsky orologio swarovski
Jepang Jepang ja-JP ありがととう ありがとう
Korea Korea ko-KR 미안니합다 미안합니다
Latvi Latvia lv-LV lielie izmeri.lv lielieizmeri.lv
Melayu Malaysia ms-MY Mesir Bahesa mesir bahasa
Norwegia (Bokmål) Norwegia nb-NO næpe suppe nepesuppe
Belanda Belgia nl-BE elektriteid elektriteit
Belanda Belanda nl-NL elektriteid elektriteit
Polski Polandia pl-PL naduzywaniie alkoholu naduzywanie alkoholu
Portugis Brasil pt-BR curso de serralheiro prensisal curso de serralheiro presencial
Portugis (Portugal) Portugis pt-PT suzy quatro suzi quatro
Rumania Rumania ro-RO T3xt despre dulciuri teks despre dulciuri
Rusia Rusia ru-RU Превет. Как дела? Какии планны на выхадные? привет. как дела? какие планы на выходные?
Slovak Slovak sk-SK slúchadlá mediatech mt3589 slúchadlá media tech mt3589
Sloven Sierra Leone sl-SI ogresnovads ogres novads
Swedia Swedia sv-SE förjuden frukt förbjuden frukt
Thailand Thailand th-TH สวัสดีะค สวัสดีค
Turki Turki tr-TR atatürk foto lari atatürk fotoları
Ukraina Ukraina uk-UA юьуб ютуб
Vietnam Vietnam vi-VN Hoan nhgênh hoan nghênh
Tionghoa (Aksara Sederhana) Republik Rakyat Tiongkok zh-CN 南京长江大乔 南京长江大桥
Tionghoa (Aksara Tradisional) Hong Kong SAR zh-HK 維利多亞港 維多利亞港