Referenční informace k rozhraní API pro kontrolu pravopisu v7

Upozornění

Rozhraní API pro vyhledávání Bingu se přesouvají ze služeb Cognitive Services na Vyhledávací služby Bingu. Od 30. října 2020 je potřeba zřídit všechny nové instance vyhledávání Bingu podle postupu popsaného tady. Rozhraní API vyhledávání Bingu zřízená pomocí služeb Cognitive Services budou podporována po dobu následujících tří let nebo do konce smlouva Enterprise, podle toho, co nastane dříve. Pokyny k migraci najdete v tématu Vyhledávací služby Bingu.

Rozhraní API pro kontrolu pravopisu umožňuje zkontrolovat pravopisné a gramatické chyby v textovém řetězci. Tato část obsahuje technické podrobnosti o parametrech a hlavičkách dotazů, které použijete k vyžádání kontroly pravopisu, a objektech odpovědi JSON, které obsahují výsledky. Příklady, které ukazují, jak vytvářet požadavky, najdete v tématu Kontrola pravopisu v textovém řetězci.

Informace o hlavičkách, které by měly požadavky obsahovat, najdete v tématu Hlavičky požadavků.

Informace o parametrech dotazu, které by měly požadavky obsahovat, najdete v tématu Parametry dotazu.

Informace o objektech JSON, které může odpověď obsahovat, najdete v tématu Objekty odpovědi.

Informace o povoleném použití a zobrazení výsledků najdete v tématu Požadavky na použití a zobrazení rozhraní API Bingu pro vyhledávání.

Poznámka

Vzhledem k tomu, že formáty a parametry adres URL se můžou změnit bez upozornění, použijte všechny adresy URL tak, jak jsou. Neměli byste přijímat závislosti na formátu nebo parametrech adresy URL, pokud není uvedeno.

Koncové body

Pokud chcete zkontrolovat pravopis a gramatiku bloku textu, odešlete požadavek GET nebo POST na adresu:

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

Tento požadavek musí používat protokol HTTPS.

Kvůli limitu délky řetězce dotazu se obvykle používá požadavek POST, pokud nekontrolujete jenom krátké řetězce.

U předplatných s více službami musíte v adrese URL zahrnout oblast. Příklad: westus.api.cognitive.microsoft.com. Viz Podporované oblasti.

Poznámka

Maximální délka adresy URL je 2 048 znaků. Aby se zajistilo, že délka adresy URL nepřekročí limit, musí být maximální délka parametrů dotazu menší než 1 500 znaků. Pokud adresa URL přesahuje 2 048 znaků, server vrátí 404 Nenalezena.

Hlavičky požadavku

Níže jsou uvedené hlavičky, které může požadavek a odpověď obsahovat.

Hlavička Description
Přijmout Nepovinná hlavička požadavku.

Výchozí typ média je application/json. Pokud chcete určit, že odpověď bude používat JSON-LD, nastavte hlavičku Accept na application/ld+json.
Accept-Language Nepovinná hlavička požadavku.

Čárkami oddělený seznam jazyků pro řetězce uživatelského rozhraní. Seznam je v sestupném pořadí podle priority. Další informace včetně očekávaného formátu najdete v RFC2616.

Tato hlavička a parametr dotazu setLang se vzájemně vylučují – nezadávejte obojí.

Pokud tuto hlavičku nastavíte, musíte zadat také parametr dotazu cc. K určení trhu, pro který se mají vracet výsledky, Bing použije první podporovaný jazyk, který najde v seznamu, a zkombinuje ho s hodnotou parametru cc. Pokud seznam jazyků podporovaný jazyk neobsahuje, Bing najde nejbližší jazyk a trh, který požadavek podporuje, nebo pro výsledky použije agregovaný nebo výchozí trh. Pokud chcete zjistit, který trh Bing použil, podívejte se do hlavičky BingAPIs-Market.

Tuto hlavičku a parametr dotazu cc použijte jenom v případě, že zadáte více jazyků. Jinak použijte parametry dotazu mkt a setLang.

Řetězec uživatelského rozhraní je řetězec, který se používá jako popisek v uživatelském rozhraní. V objektech odpovědí JSON je několik řetězců uživatelského rozhraní. Zadaný jazyk použijí všechny odkazy na vlastnosti Bing.com v objektech odpovědi.
BingAPIs-Market Hlavička odpovědi.

Trh používaný požadavkem. Formulář je <languageCode-countryCode<>>. Například cs-CZ.

Pokud zadáte trh, který není uvedený v kódech trhu, může se tato hodnota lišit od trhu, který jste zadali v parametru dotazu mkt . Totéž platí, pokud zadáte hodnoty cc a Accept-Language , které se nedají sloučit.
BingAPIs-TraceId Hlavička odpovědi.

ID položky protokolu obsahující podrobnosti požadavku. Pokud dojde k chybě, toto ID zachyťte. Pokud problém nedokážete určit a vyřešit, uveďte toto ID spolu s dalšími informacemi, které poskytnete týmu podpory.
Ocp-Apim-Subscription-Key Povinná hlavička požadavku.

Klíč předplatného, který jste dostali při registraci k této službě v Cognitive Services.
Pragma Nepovinná hlavička požadavku

Ve výchozím nastavení Bing vrátí obsah uložený v mezipaměti, pokud je k dispozici. Pokud chcete zabránit ukládání obsahu do mezipaměti, nastavte hlavičku Pragma na no-cache (například Pragma: no-cache).
Opakovat po Hlavička odpovědi.

Odpověď obsahuje tuto hlavičku, pokud překročíte počet povolených dotazů za sekundu (QPS) nebo za měsíc (QPM). Hlavička obsahuje počet sekund, které musíte počkat před odesláním dalšího požadavku.
User-Agent Nepovinná hlavička požadavku.

Uživatelský agent, ze kterého požadavek pochází. Bing používá uživatelského agenta k poskytnutí optimalizovaného prostředí pro mobilní uživatele. I když je tato hlavička nepovinná, doporučujeme ji vždy zadat.

Uživatelský agent by měl být stejný řetězec, který odesílá kterýkoli běžně používaný prohlížeč. Informace o uživatelských agentech najdete v RFC 2616.

Následují příklady řetězců uživatelského agenta.
  • Windows Phone –Mozilla/5.0 (kompatibilní; MSIE 10.0; Windows Phone 8.0; Trident/6.0; IEMobile/10.0; RAMENO; Touch; NOKIA; Lumia 822)

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

  • iPhone –Mozilla/5.0 (iPhone; CPU iPhone OS 6_1 like Mac OS X) AppleWebKit/536.26 (KHTML; like 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) like Gecko

  • iPad – Mozilla/5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A465 Safari/9537.53
X-MSEdge-ClientID Nepovinná hlavička požadavku a odpovědi

Bing tuto hlavičku používá k tomu, aby uživatelům poskytoval konzistentní chování napříč voláními rozhraní API Bingu. Bing často testuje nové funkce a vylepšení a ID klienta používá jako klíč pro přiřazení provozu v různých testovacích verzích. Pokud nepoužíváte stejné ID klienta pro uživatele napříč více požadavky, pak může Bing uživatele přiřadit k více konfliktním testovacím verzím. Přiřazení k více konfliktním testovacím verzím může vést k nekonzistentnímu prostředí pro uživatele. Pokud třeba druhý požadavek má jiné přiřazení k testovací verzi než prví, může být prostředí neočekávané. Bing může také použít ID klienta k přizpůsobení webových výsledků historii hledání daného ID klienta, což uživateli poskytuje bohatší prostředí.

Bing také tuto hlavičku používá ke zlepšování hodnocení výsledků díky analýze aktivity generované tímto ID klienta. Zlepšení relevance pomáhá zlepšit kvalitu výsledků poskytovaných rozhraním API Bingu a stejně tak umožňuje vyšší míru prokliků uživatele rozhraní API.

DŮLEŽITÉ: I když je tato hlavička nepovinná, měli byste ji považovat za povinnou. Zachování ID klienta mezi více požadavky pro stejnou kombinaci koncového uživatele a zařízení umožňuje 1) aby uživatel rozhraní API získával konzistentní uživatelské prostředí a 2) vyšší míry prokliků díky kvalitnějším výsledkům z rozhraní API Bingu.

Následují základní pravidla používání, která se na tuto hlavičku vztahují.
  • Každý uživatel, který používá vaši aplikaci na zařízení, musí mít jedinečné ID klienta vygenerované Bingem.

    Pokud tuto hlavičku do požadavku nezahrnete, Bing vygeneruje ID a vrátí ho v hlavičce odpovědi X-MSEdge ClientID. Tuto hlavičku byste v požadavku zahrnout NEMĚLI jenom v případě, kdy uživatel aplikaci na zařízení používá poprvé.

  • POZORNOST: Musíte zajistit, aby toto ID klienta nebylo možné propojit s žádnými ověřovacími informacemi o uživatelských účtech.

  • Použijte ID klienta pro každý požadavek rozhraní API Bingu, který vaše aplikace provede pro tohoto uživatele na zařízení.

  • ID klienta zachovejte. Pokud chcete zachovat ID v aplikaci prohlížeče, použijte trvalý soubor cookie HTTP, aby se zaručilo, že se ID použije ve všech relacích. Nepoužívejte soubor cookie relace. Pro jiné aplikace, jako jsou mobilní aplikace, použijte k zachování ID trvalé úložiště zařízení.

    Když uživatel aplikaci na zařízení příště použije, získejte ID klienta, které jste zachovali.

POZNÁMKA: Odpovědi Bingu tuto hlavičku mohou nebo nemusí obsahovat. Pokud odpověď tuto hlavičku obsahuje, ID klienta zachyťte a použijte pro všechny následné požadavky Bingu pro uživatele na tomto zařízení.

POZNÁMKA: Pokud zahrnete X-MSEdge-ClientID, nesmíte do požadavku zahrnout soubory cookie.
X-MSEdge-ClientIP Nepovinná hlavička požadavku.

Adresa IPv4 nebo IPv6 klientského zařízení. IP adresa se používá ke zjištění polohy uživatele. Bing informace o poloze používá k určení chování bezpečného hledání.

POZNÁMKA: I když je tato hlavička nepovinná, doporučujeme ji vždy zadat, stejně jako hlavičku X-Search-Location.

Neprovádějte obfuskaci adresy (například změnou posledního oktetu na 0). Obfuskace adresy vede k tomu, že poloha nebude blízko skutečné polohy zařízení. Bing pak může dodávat chybné výsledky.
X-Search-Location Nepovinná hlavička požadavku.

Středníky oddělený seznam párů klíč/hodnota, které popisují zeměpisnou polohu klienta. Bing informace o poloze používá k určení chování bezpečného hledání a vracení relevantního místního obsahu. Pár klíč/hodnota zadejte jako <klíč>:<hodnota>. Následují klíče, které se používají k určení polohy uživatele.

  • lat – povinné. Zeměpisná šířka polohy klienta ve stupních. Zeměpisná šířka musí být větší nebo rovná -90,0 a menší nebo rovná +90,0. Záporné hodnoty značí jižní šířku a kladné hodnoty značí severní šířku.

  • long – povinné. Zeměpisná délka polohy klienta ve stupních. Zeměpisná délka musí být větší nebo rovná -180,0 a menší nebo rovná +180,0. Záporné hodnoty značí západní délku a kladné hodnoty značí východní délku.

  • re– Povinné. Poloměr v metrech, který určuje vodorovnou přesnost souřadnic. Předejte hodnotu vrácenou službou zjišťování polohy zařízení. Typické hodnoty můžou být 22 m pro GPS/Wi-Fi, 380 m pro triangulaci mobilních vysílačů a 18 000 m pro reverzní vyhledávání IP adresy.

  • ts – volitelné. Časové razítko UTC UNIX, kdy se klient na daném místě nacházel. (Časové razítko UNIX je počet sekund od 1. ledna 1970.)

  • head – volitelné. Relativní směr pohybu klienta. Zadejte směr pohybu ve stupních od 0 do 360 ve směru hodinových ručiček vzhledem k severu. Tento klíč zadejte jenom tehdy, když je klíč sp nenulový.

  • sp – volitelné. Vodorovná rychlost v metrech za sekundu, kterou se klientské zařízení pohybuje.

  • alt – volitelné. Nadmořská výška klientského zařízení v metrech.

  • are — Volitelné. Poloměr v metrech, který určuje svislou přesnost souřadnic. Tento klíč zadejte jenom tehdy, když zadáte klíč alt.

  • disp – Volitelné. Zeměpisné umístění uživatele ve formuláři, disp:<City, State>. Například disp:Seattle, Washington. Toto je zobrazená textová verze umístění uživatele, kterou jste zadali pomocí kláves lat/long. Pokud je tato hodnota v konfliktu se souřadnicemi lat/long, Bing použije hodnotu disp jako polohu uživatele.

POZNÁMKA: Bing tuto hlavičku ignoruje, pokud dotaz obsahuje umístění. Pokud například tato hlavička odráží polohu uživatele jako San Francisco, ale dotaz je restaurace seattle, Bing vrátí restaurace v Seattlu ve státě Washington.

POZNÁMKA: I když jsou mnohé klíče nepovinné, čím více informací zadáte, tím přesnější budou výsledky určení polohy.

POZNÁMKA: I když je geografická poloha uživatele nepovinná, doporučujeme ji vždy zadat. Poskytnutí polohy je zvlášť důležité, pokud IP adresa klienta přesně neodráží fyzickou polohu uživatele (třeba pokud klient používá síť VPN). Pro optimální výsledky byste měli zahrnout tuto hlavičku a hlavičku X-Search-ClientIP, ale minimálně tuto hlavičku.

Poznámka

Nezapomínejte, že podmínky použití vyžadují dodržování příslušných zákonů, včetně těch týkajících se použití těchto hlaviček. Například v určitých jurisdikcích, třeba v Evropě, se před umístěním určitých sledovacích zařízení do zařízení uživatelů požaduje získání souhlasu uživatele.

Parametry dotazů

Níže jsou uvedené parametry dotazu, které tento požadavek může zahrnovat. Sloupec Vyžadováno určuje, jestli je příslušný parametr nutné zadat. Hodnoty parametrů dotazů musíte zakódovat s použitím kódování URL.

Name Hodnota Typ Vyžadováno
actionType Řetězec, který se používá při protokolování k určení, jestli požadavek pochází z interaktivní relace nebo načtení stránky. Níže jsou uvedené možné hodnoty.
  • Upravit – požadavek pochází z interaktivní relace.
  • Načíst – požadavek pochází z načtení stránky.
Řetězec No
Appname Jedinečný název vaší aplikace.

Bing musí znát název. Tento parametr nezahrnujte, pokud jste předtím nekontaktovali Bing s žádostí o jedinečný název aplikace. Pokud chcete získat jedinečné jméno, obraťte se na svého manažera pro obchodní vývoj bingu.
Řetězec No
cc Dva znaky kódu země, odkud výsledky pochází. Seznam možných hodnot najdete v tématu Kódy trhu.

Pokud tento parametr nastavíte, musíte zadat také hlavičku Accept-Language. Bing použije první podporovaný jazyk, který najde v zadaných jazycích, a zkombinuje ho s kódem země, aby určil trh, pro který se mají vracet výsledky. Pokud seznam jazyků podporovaný jazyk neobsahuje, najde Bing nejbližší jazyk a trh, který požadavek podporuje. Nebo bing může pro výsledky použít agregovaný nebo výchozí trh.

Tento parametr dotazu a hlavičku použijte pouze v Accept-Language případě, že zadáte více jazyků. Jinak byste měli použít mkt parametry dotazu a setLang .

Tento parametr a parametr dotazu mkt se vzájemně vylučují – nezadávejte obojí.
Řetězec Ne
clientMachineName Jedinečný název zařízení, ze kterého se žádost provádí. Vygenerujte pro každé zařízení jedinečnou hodnotu (hodnota není důležitá).

Služba používá ID k ladění problémů a ke zlepšení kvality oprav.
Řetězec Ne
Docid Jedinečné ID, které identifikuje dokument, do kterého text patří. Vygenerujte pro každý dokument jedinečnou hodnotu (hodnota není důležitá).

Služba používá ID k ladění problémů a ke zlepšení kvality oprav.
Řetězec Ne
mkt Trh, odkud pochází výsledky. Obvykle se jedná o zemi, mkt ze které uživatel vytváří požadavek. Pokud se však uživatel nenachází v zemi, ve které Bing doručuje výsledky, může to být jiná země. Trh musí být ve formátu <kódové>> kódy< země jazyka. Například cs-CZ. Řetězec nerozlišuje velká a velká písmena. Seznam možných hodnot trhu najdete v tématu Kódy trhu.

POZNÁMKA: Pokud ho znáte, doporučujeme vždy zadat trh. Určení trhu pomáhá Bingu směrovat požadavek a vrátit odpovídající a optimální odpověď. Pokud zadáte trh, který není uvedený v kódech trhu, použije Bing kód trhu, který nejlépe vyhovuje, na základě interního mapování, které se může změnit.

Tento parametr a parametr dotazu cc se vzájemně vylučují – nezadávejte oba parametry.
Řetězec Ne
Režimu Typ kontroly pravopisu a gramatiky, které se mají provést. Níže jsou uvedené možné hodnoty (hodnoty nerozlišují malá a velká písmena). Výchozí formát je Proof.
  • Testování – scénář pro dokumenty–
    • Režim Proof pravopisu poskytuje nejkomplexnější kontroly, přidání velkých písmen, základní interpunkce a další funkce, které pomáhají při vytváření dokumentu. je ale k dispozici pouze na trzích en-US (angličtina-USA), es-ES (španělština) a pt-BR(portugalština) (poznámka: pouze beta verze pro španělštinu a portugalštinu). Pro všechny ostatní trhy nastavte parametr režimu na Spell.

      POZNÁMKA: Pokud délka textu dotazu překročí 4096, zkrátí se na 4096 znaků a pak se zpracuje.


  • Spell – pro scénář vyhledávání na webu nebo dotazů–
    • "Spell" je agresivnější, aby se vrátily lepší výsledky hledání. Režim pravopisu najde většinu pravopisných chyb, ale nenajde některé gramatické chyby, které funkce Proof zachytí, například velká písmena a opakovaná slova.

      Poznámka: Maximální podporovaná délka dotazu je následující. Pokud dotaz překročí mez, výsledek bude vypadat, že se dotaz nezměnil.
      • 65 znaků pro kód jazyka en, de, es, fr, pl, pt, sv, ru, nl, nb, tr-tr, it, zh, ko.
      • 65 znaků pro ostatní
Řetězec Ne
preContextText Řetězec, který dává kontextu textovému řetězci. Například textokvětní lístek řetězce je platný. Pokud ale nastavíte preContextText hodnotu bike, kontext se změní a textový řetězec nebude platný. V tomto případě rozhraní API navrhuje, abyste změnili okvětní lístek na pedál (jako u pedálu na kole).

V tomto textu se nekontrolují gramatické nebo pravopisné chyby.

Celková délka text řetězce, preContextText řetězce a postContextText řetězce nesmí překročit 10 000 znaků.

Tento parametr můžete zadat v řetězci dotazu požadavku GET nebo v textu požadavku POST.
Řetězec Ne
postContextText Řetězec, který dává kontextu textovému řetězci. Například textčtení řetězce je platné. Pokud ale nastavíte postContextTextna koberec, kontext se změní a textový řetězec nebude platný. V tomto případě rozhraní API navrhuje, abyste změnili čtení na červenou (jako v červeném koberci).

V tomto textu se nekontrolují gramatické nebo pravopisné chyby.

Celková délka text řetězce, preContextText řetězce a postContextText řetězce nesmí překročit 10 000 znaků.

Tento parametr můžete zadat v řetězci dotazu požadavku GET nebo v textu požadavku POST.
Řetězec Ne
Sessionid Jedinečné ID, které identifikuje tuto relaci uživatele. Vygenerujte jedinečnou hodnotu pro každou relaci uživatele (hodnota není důležitá).

Služba používá ID k ladění problémů a ke zlepšení kvality oprav.
Řetězec Ne
setLang Jazyk, který se má použít pro řetězce uživatelského rozhraní. Jazyk můžete zadat pomocí 2 nebo 4mísílového kódu. Upřednostňují se 4mísídkové kódy.

Seznam podporovaných kódů jazyků najdete v tématu Jazyky a trhy podporované Bingem.

Bing načte lokalizované řetězce, pokud setlang obsahuje platný kód neutrální jazykové verze (fr) o délce 2 písmen nebo platný kód jazykové verze specifické pro 4 písmena (fr-ca). Například pro fr-ca Bing načte řetězce kódu neutrální jazykové verze fr .

Pokud setlang není platná (například zh) nebo Bing nepodporuje jazyk (například af, af-na), Bing ve výchozím nastavení nastaví en (angličtina).

Pokud chcete zadat kód 2 písmen, nastavte tento parametr na kód jazyka ISO 639-1.

Pokud chcete zadat kód se 4 písmeny, použijte formulář <language-country<>/region>, kde <jazyk> je kód jazyka ISO 639-1 (neutrální jazyková verze) a <země/oblast> je kód iso 3166 země/oblast (specifická jazyková verze). Například pro USA angličtinu použijte en-US.

I když je jazyk volitelný, měli byste ho vždy zadat. Obvykle se setLang nastavuje na stejný jazyk, jaký určuje parametr mkt, pokud uživatel nechce řetězce uživatelského rozhraní zobrazené v jiném jazyce.

Tento parametr a hlavička Accept-Language se vzájemně vylučují – nezadávejte obojí.

Řetězec uživatelského rozhraní je řetězec, který se používá jako popisek v uživatelském rozhraní. V objektech odpovědí JSON je několik řetězců uživatelského rozhraní. Zadaný jazyk použijí také všechny odkazy na vlastnosti Bing.com v objektech odpovědi.
Řetězec Ne
Text Textový řetězec pro kontrolu pravopisu a gramatických chyb.

Celková délka text řetězce, preContextText řetězce a postContextText řetězce nesmí překročit 10 000 znaků.

Tento parametr můžete zadat v řetězci dotazu požadavku GET nebo v textu požadavku POST. Vzhledem k limitu délky řetězce dotazu obvykle použijete požadavek POST, pokud nekontrolujete jenom krátké řetězce.
Řetězec Yes
Userid Jedinečné ID, které identifikuje uživatele. Vygenerujte jedinečnou hodnotu pro každého uživatele (hodnota není důležitá).

Služba používá ID k ladění problémů a ke zlepšení kvality oprav.
Řetězec Ne

Objekty odpovědí

Níže jsou uvedené objekty odpovědi JSON, které může odpověď obsahovat. Pokud je požadavek úspěšný, objekt nejvyšší úrovně v odpovědi je SpellCheck objekt. Pokud požadavek selže, objekt nejvyšší úrovně je ErrorResponse.

Objekt Description
Chyba Došlo k chybě.
ChybaResponse Objekt nejvyšší úrovně, který odpověď zahrnuje, když požadavek selže.
FlaggedToken Slovo, které může být gramaticky nesprávné nebo nesprávně napsané.
Spellcheck Objekt nejvyšší úrovně, který odpověď zahrnuje, když je požadavek úspěšný.
TokenSuggestion Navrhovaná oprava pravopisu nebo gramatiky

Chyba

Definuje chybu, ke které došlo.

Element Popis Typ
Kód Kód chyby, který identifikuje kategorii chyby. Seznam možných kódů najdete v tématu Kódy chyb. Řetězec
Zprávu Popis chyby. Řetězec
dalšípodrobné informace Popis, který poskytuje další informace o chybě. Řetězec
Parametr Parametr dotazu v požadavku, který způsobil chybu. Řetězec
podkód Kód chyby, který chybu identifikuje. Například pokud code je InvalidRequest, subCode může být ParameterInvalid nebo ParameterInvalidValue. Řetězec
Hodnotu Neplatná hodnota parametru dotazu. Řetězec

ChybaResponse

Objekt nejvyšší úrovně, který odpověď zahrnuje, když požadavek selže.

Name Hodnota Typ
_Typ Napište nápovědu. Řetězec
Chyby Seznam chyb, které popisují důvody, proč požadavek selhal. Chyba[]

FlaggedToken

Slovo, které není správně napsané nebo je gramaticky nesprávné.

Name Hodnota Typ
Posun Posun od nuly od začátku řetězce textového dotazu na slovo, které bylo označeno příznakem. Integer
Návrhy Seznam slov, která opraví pravopisnou nebo gramatickou chybu. Seznam je v sestupném pořadí podle priority. TokenSuggestion[]
token Slovo v řetězci text dotazu, které není správně napsané nebo je gramaticky nesprávné. Řetězec
Typ Typ chyby, která způsobila označení slova příznakem. Níže jsou uvedené možné hodnoty.
  • RepeatedToken – slovo se opakovalo po sobě (například teplé teplé počasí).

  • UnknownToken – všechny ostatní pravopisné nebo gramatické chyby.
Řetězec

Spellcheck

Objekt nejvyšší úrovně, který odpověď zahrnuje, když je požadavek úspěšný.

Pokud má služba podezření na útok dos, požadavek bude úspěšný (stavový kód HTTP je 200 OK), ale text odpovědi je prázdný.

Name Hodnota Typ
_Typ Nápověda pro typ, která je nastavená na SpellCheck. Řetězec
flaggedTokens Seznam slov v textu , která byla označena příznakem, že nejsou správně napsaná nebo jsou gramaticky nesprávná.

Pokud nebyly nalezeny žádné pravopisné nebo gramatické chyby nebo pokud zadaný trh není podporován, pole je prázdné.
FlaggedToken[]

TokenSuggestion

Navrhovaná oprava pravopisu nebo gramatiky

Name Hodnota Typ
Skóre Hodnota, která označuje úroveň spolehlivosti, že navrhovaná oprava je správná. modePokud je parametr dotazu nastavený na Spell, je toto pole nastaveno na hodnotu 1.0. dvojité
Návrh Navrhované slovo, které nahradí slovo označené příznakem.

Pokud je slovo s příznakem opakované slovo (viz typ), je tento řetězec prázdný.
Řetězec

Kódy chyb

Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.

Stavový kód Description
200 Úspěch.
400 Jeden z parametrů dotazu chybí nebo je neplatný.
401 Klíč předplatného chybí nebo není platný.
403 Uživatel je ověřený (například použil platný klíč předplatného), ale nemá oprávnění k požadovanému prostředku.

Bing může tento stav vrátit také v případě, že volající překročil svou měsíční kvótu dotazů.
410 Požadavek použil místo protokolu HTTPS protokol HTTP. HTTPS je jediný podporovaný protokol.
429 Volající překročil kvótu dotazů za sekundu.
500 Neočekávaná chyba serveru.

Pokud požadavek selže, odpověď obsahuje objekt ErrorResponse, který obsahuje seznam objektů Error, které popisují příčinu chyby. Pokud chyba souvisí s parametrem, parameter toto pole identifikuje parametr, u kterého se problém týká. A pokud chyba souvisí s hodnotou parametru value , pole identifikuje hodnotu, která není platná.

{
  "_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."
    }
  ]
}

Níže jsou uvedené možné hodnoty kódu chyby a kódu dílčí chyby.

Kód Dílčí kód Description
Chyba serveru UnexpectedError
Chyba prostředku
NotImplemented
Stavový kód HTTP je 500.
InvalidRequest ParameterMissing
ParametrInvalidValue
HttpNotAllowed
Blokované
Bing vrátí InvalidRequest vždy, když některá část požadavku není platná. Například chybí požadovaný parametr nebo hodnota parametru není platná.

Pokud je chyba ParameterMissing nebo ParameterInvalidValue, stavový kód HTTP je 400.

Pokud místo HTTPS použijete protokol HTTP, vrátí Bing httpNotAllowed a stavový kód HTTP je 410.
RateLimitExceeded Žádné podprogramy Bing vrátí hodnotu RateLimitExceeded pokaždé, když překročíte kvótu dotazů za sekundu (QPS) nebo dotazů za měsíc (QPM).

Pokud překročíte QPS, Bing vrátí stavový kód HTTP 429, a pokud překročíte QPM, vrátí Bing 403.
Neplatná autorizace AuthorizationMissing
AuthorizationRedundancy
Bing vrátí invalidAuthorization, když Bing nemůže ověřit volajícího. Například chybí hlavička Ocp-Apim-Subscription-Key nebo klíč předplatného není platný.

K redundanci dochází, pokud zadáte více než jednu metodu ověřování.

Pokud je chyba InvalidAuthorization, stavový kód HTTP je 401.
Nedostatečná autorizace AuthorizationDisabled
AuthorizationExpired
Bing vrátí InsufficientAuthorization, pokud volající nemá oprávnění pro přístup k prostředku. K tomu může dojít v případě, že je klíč předplatného zakázaný nebo vypršela jeho platnost.

Pokud je chyba InsufficientAuthorization, stavový kód HTTP je 403.

Kódy trhu

Následující tabulka uvádí hodnoty kódu trhu, které můžete použít k zadání parametru mkt dotazu. Bing vrací obsah jenom pro tyto trhy. Seznam se může změnit.

Seznam kódů zemí, které můžete zadat v parametru cc dotazu, najdete v tématu Kódy zemí.

Země/oblast Jazyk Kód trhu
Argentina Španělština es-AR
Austrálie Angličtina en-AU
Rakousko Němčina de-AT
Belgie Nizozemština nl-BE
Belgie Francouzština fr-BE
Brazílie Portugalština pt-BR
Kanada Angličtina en-CA
Kanada Francouzština fr-CA
Chile Španělština es-CL
Dánsko Dánština da-DK
Finsko Finština fi-FI
Francie Francouzština fr-FR
Německo Němčina de-DE
Hongkong – zvláštní administrativní oblast Tradiční čínština zh-HK
Indie Angličtina en-IN
Indonésie Angličtina en-ID
Itálie Italština it-IT
Japonsko Japonština ja-JP
Jižní Korea Korejština ko-KR
Malajsie Angličtina en-MY
Mexiko Španělština es-MX
Nizozemsko Nizozemština nl-NL
Nový Zéland Angličtina en-NZ
Norsko Norština no-NO
Lidé Čínská republika Čínština zh-CN
Polsko Polština pl-PL
Filipínská republika Angličtina cs-PH
Rusko Ruština ru-RU
Jižní Afrika Angličtina en-ZA
Španělsko Španělština es-ES
Švédsko Švédština sv-SE
Švýcarsko Francouzština fr-CH
Švýcarsko Němčina de-CH
Tchaj-wan Tradiční čínština zh-TW
Turecko Turečtina tr-TR
Spojené království Angličtina cs-CZ
USA Angličtina en-US
USA Španělština es-US

Kódy zemí

Níže jsou uvedené kódy zemí, které můžete zadat v parametru cc dotazu. Seznam se může změnit.

Země/oblast Kód země
Argentina AR
Austrálie AU
Rakousko AT
Belgie BE
Brazílie BR
Kanada CA
Chile CL
Dánsko DK
Finsko FI
Francie FR
Německo DE
Hongkong – zvláštní administrativní oblast HK
Indie IN
Indonésie ID
Itálie IT
Japonsko JP
Jižní Korea KR
Malajsie MY
Mexiko MX
Nizozemsko NL
Nový Zéland NZ
Norsko NO
Čínská lidová republika CN
Polsko PL
Portugalsko PT
Filipínská republika PH
Rusko RU
Saúdská Arábie SA
Jižní Afrika ZA
Španělsko ES
Švédsko SE
Švýcarsko CH
Tchaj-wan TW
Turecko TR
Spojené království GB
USA USA

Jazyky a trhy podporované Bingem

Následující tabulka uvádí jazyky podporované Službou Bing, které můžete zadat v parametru setLang dotazu, kódy zemí, které můžete zadat v parametru cc dotazu, a hodnoty kódu trhu, které můžete použít k zadání parametru mkt dotazu. Pomocí ukázkového textu a ukázkové opravy s výjimkou je možné otestovat, jestli rozhraní API funguje správně.

Podporovaný jazyk Země/oblast Kód trhu Ukázkový text Ukázka opravy s výjimkou
Arabština Spojené arabské emiráty ar-AE مرحبا , يوم عسيد لك مرحبا , يوم سعيد لك
ulgarian Bulharsko bg-BG Българсик език Български език
Katalánština Španělsko ca-ES Claudi riera Claudia riera
Čeština Čeština cs-CZ Češtian Čeština
Dánština Dánsko da-DK Welokm Welkom
Němčina Německo de-DE zdf fussballspiel zdf fußballspiel
Angličtina Austrálie en-AU perfektní poption dokonalý lektvar
Angličtina Kanada en-CA dekafenace dekaffeination
Angličtina Spojené království cs-CZ topograpical význam topografický význam
Angličtina Indie en-IN dainik jagaran dainik Jagran
Angličtina USA en-US bitva o aisiago bitva o Asiago
Španělština Španělsko es-ES cordillera de lows cárpatos cordillera de los cárpatos
Španělština Mexiko es-MX carsel de cananea cárcel de cananea
Španělština USA es-US carsel de cananea cárcel de cananea
Finština Finsko fi-FI hälyt yskeskuks Housska
Francouzština Kanada fr-CA les meilleuresadditif les meilleures additif
Francouzština Francie fr-FR letre en fromage lettre en fromage
Hebrejština Izrael he-IL ברךו הבא ברוך הבא
Chorvatština Chorvatsko hr-HR suze svetog lovra suze svetog lovre
Italština Itálie it-IT orologio svarowsky orologio swarovski
Japonština Japonsko ja-JP ありがととう ありがとう
Korejština Jižní Korea ko-KR 미안니합다 미안합니다
Lotyština Lotyšsko lv-LV lielie izmeri.lv lielieizmeri.lv
Malajština Malajsie ms-MY Mesir Bahesa Mesir bahasa
Norština (Bokmål) Norsko nb-NO næpe suppe nepesuppe
Nizozemština Belgie nl-BE elektriteidní elektriteit
Nizozemština Nizozemsko nl-NL electriteid electriteit
Polština Polsko pl-PL naduzywaniie alkoholu naduzywanie alkoholu
Portugalština Brazílie pt-BR curso de serralheiro prensisal curso de serralheiro presencial
portugalština (Portugalsko) Portugalština pt-PT suzy quatro suzi quatro
Rumunština Rumunsko ro-RO T3xt despre dulciuri text despre dulciuri
Ruština Rusko ru-RU Превет. Как дела? Какии планны на выхадные? привет. как дела? какие планы на выходные?
Slovenština Slovenština sk-SK slúchadlá mediatech mt3589 slúchadlá media tech mt3589
Slovinština Sierra Leone sl-SI ogresnovads ogres novads
Švédština Švédsko sv-SE förjuden frukt förbjuden frukt
Thajština Thajsko th-TH สวัสดีะค สวัสดีค
Turečtina Turecko tr-TR atatürk foto lari atatürk fotoları
Ukrajinština Ukrajina uk-UA юьуб ютуб
Vietnamština Vietnam vi-VN Hoan nhgênh hoan nghênh
Čínština (zjednodušená) Lidé Čínská republika zh-CN 南京长江大乔 南京长江大桥
Čínština (tradiční) Hongkong – zvláštní administrativní oblast zh-HK 維利多亞港 維多利亞港