WebSearchOptionalParams interface

Balíček:

@azure/cognitiveservices-websearch

Volitelné parametry.

Extends

RequestOptionsBase

Vlastnosti

acceptLanguage	Seznam jednoho nebo více jazyků oddělených čárkami, který se má použít 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 tématu 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. Bing použije první podporovaný jazyk, který najde v seznamu, a zkombinuje ho s hodnotou parametru cc, aby určil trh, pro který se mají vrátit výsledky. Pokud seznam neobsahuje podporovaný jazyk, Bing najde nejbližší jazyk a trh, který požadavek podporuje, a může pro výsledky místo zadaného trhu použít agregovaný nebo výchozí trh. Tuto hlavičku a parametr dotazu cc byste měli použít pouze v případě, že zadáte více jazyků. jinak byste měli použít 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 velmi málo řetězců uživatelského rozhraní. Všechny odkazy v objektech odpovědi na vlastnosti Bing.com použijí zadaný jazyk.
answerCount	Počet odpovědí, které chcete zahrnout do odpovědi. Odpovědi, které Bing vrátí, jsou založené na pořadí. Pokud například Bing vrátí webové stránky, obrázky, videa a související hledání pro požadavek a nastavíte tento parametr na dva (2), odpověď bude zahrnovat webové stránky a obrázky. Pokud jste do stejného požadavku zahrnuli parametr dotazu responseFilter a nastavili jste ho na webové stránky a zprávy, odpověď by obsahovala pouze webové stránky.
clientId	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 také může ID klienta použít pro přizpůsobení webových výsledků historii hledání daného ID klienta. Uživatel tak získá 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. 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é. 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. Odpovědi Bingu můžou nebo nemusí obsahovat tuto hlavičku. 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í. Pokud zahrnete X-MSEdge-ClientID, nesmíte do žádosti zahrnout soubory cookie.
clientIp	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í. I když je to volitelné, doporučujeme vždy zadat tuto hlavičku a 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.
count	Počet výsledků hledání, které se mají vrátit v odpovědi. Výchozí hodnota je 10 a maximální hodnota je 50. Skutečné doručované číslo může být menší, než je požadováno. Tento parametr použijte společně s parametrem posunu k výsledkům stránky. Pokud například vaše uživatelské rozhraní zobrazí 10 výsledků hledání na stránku, nastavte počet na 10 a posun na 0, abyste získali první stránku výsledků. Pro každou další stránku se zvýší posun o 10 (například 0, 10, 20). Je možné, že více stránek obsahuje určité překrývající se výsledky.
countryCode	Dva znaky kódu země, odkud výsledky pochází. Toto rozhraní API podporuje pouze trh USA. Pokud zadáte tento parametr dotazu, musí být nastavený na nás. Pokud tento parametr nastavíte, musíte zadat také hlavičku Accept-Language. Bing používá první podporovaný jazyk, který najde v seznamu jazyků, a zkombinuje ho s kódem země, který určíte, pro který trh se má vrátit výsledky. Pokud seznam jazyků neobsahuje podporovaný jazyk, bing vyhledá nejbližší jazyk a trh, který podporuje požadavek, nebo může pro výsledky místo zadaného trhu použít agregovaný nebo výchozí trh. Tento parametr dotazu a parametr Accept-Language dotazu byste měli použít pouze v případě, že zadáte více jazyků. jinak byste měli použít parametry dotazu mkt a setLang. Tento parametr a parametr dotazu mkt se vzájemně vylučují – nezadávejte oba parametry.
freshness	Výsledky hledání můžete filtrovat podle následujících věkových hodnot: Den – vrátí webové stránky, které Bing zjistil během posledních 24 hodin. Týden – vrátí webové stránky, které Bing zjistil během posledních 7 dnů. Měsíc – vrátí webové stránky zjištěné během posledních 30 dnů. Tento filtr se vztahuje pouze na výsledky webové stránky, nikoli na ostatní výsledky, jako jsou zprávy a obrázky. Mezi možné hodnoty patří: "Den", "Týden", "Měsíc"
location	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. Zadejte dvojici klíč/hodnota jako :. Následují klíče, které se používají k určení polohy uživatele. lat (povinné): zeměpisná šířka umístění 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 umístění 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 unixu, kdy byl klient v umístění. (Časové razítko systému UNIX je počet sekund od 1. ledna 1970.) head (volitelné): Relativní směr nebo směr jízdy 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 pouze v případě, že klíč sp není nenulový. sp (volitelné): Vodorovná rychlost (rychlost) v metrech za sekundu, kterou klientské zařízení cestuje. 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 pouze v případě, že zadáte klávesu ALT. I když je mnoho klíčů nepovinných, čím více informací zadáte, tím přesnější jsou výsledky umístění. I když je to volitelné, doporučujeme vždy zadat zeměpisnou polohu uživatele. 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 dosažení optimálních výsledků byste měli zahrnout tuto hlavičku i hlavičku X-MSEdge ClientIP, minimálně ale aspoň tuto hlavičku.
market	Trh, odkud pochází výsledky. Mkt je obvykle země, 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 tvaru -. Například cs-CZ. Řetězec nerozlišuje velká a velká písmena. 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. Výchozí hodnota: en-us.
offset	Posun založený na nule, který označuje počet výsledků hledání, které se mají přeskočit před vrácením výsledků. Výchozí hodnota je 0. Posun by měl být menší než (totalEstimatedMatches – count). Tento parametr použijte spolu s parametrem count pro výsledky stránky. Pokud například vaše uživatelské rozhraní zobrazí 10 výsledků hledání na stránku, nastavte počet na 10 a posun na 0, abyste získali první stránku výsledků. Pro každou další stránku se zvýší posun o 10 (například 0, 10, 20). je možné, že několik stránek obsahuje určité překrývající se výsledky.
pragma	Ve výchozím nastavení Bing vrátí obsah uložený v mezipaměti, pokud je k dispozici. Abyste Bingu zabránili ve vrácení obsahu uloženého v mezipaměti, hlavičku Pragma nastavte na hodnotu no-cache (například Pragma: no-cache).
promote	Seznam odpovědí oddělených čárkami, které má odpověď obsahovat bez ohledu na jejich pořadí. Pokud například nastavíte answerCount) na dvě (2), aby Bing vrátil dvě první seřazené odpovědi, ale chcete, aby odpověď obsahovala také novinky, nastavili byste zvýšení úrovně na zprávy. Pokud jsou nejčastějšími odpověďmi webové stránky, obrázky, videa a související hledání, odpověď zahrnuje webové stránky a obrázky, protože zprávy nejsou seřazenou odpovědí. Pokud ale nastavíte zvýšení úrovně na video, Bing zvýší úroveň odpovědi na video do odpovědi a vrátí webové stránky, obrázky a videa. Odpovědi, které chcete zvýšit, se nezapočítávají do limitu answerCount. Pokud jsou například seřazené odpovědi zprávy, obrázky a videa a vy nastavíte answerCount na hodnotu 1 a povyšte na novinky, bude odpověď obsahovat zprávy a obrázky. Nebo pokud jsou seřazené odpovědi videa, obrázky a zprávy, odpověď obsahuje videa a zprávy. Možné hodnoty jsou Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webové stránky. Použijte pouze v případě, že zadáte answerCount.
responseFilter	Seznam odpovědí oddělených čárkami, které se mají zahrnout do odpovědi. Pokud tento parametr nezadáte, bude odpověď obsahovat všechny vyhledávací odpovědi, pro které jsou k dispozici relevantní data. Možné hodnoty filtru jsou Výpočet, Obrázky, Zprávy, RelatedSearches, SpellSuggestions, TimeZone, Videa, Webové stránky. I když tento filtr můžete použít k získání jedné odpovědi, měli byste místo toho použít koncový bod specifický pro odpověď, abyste získali bohatší výsledky. Pokud například chcete přijímat jenom obrázky, odešlete požadavek do jednoho z koncových bodů rozhraní API pro vyhledávání obrázků. Odpovědi RelatedSearches a SpellSuggestions nepodporují samostatný koncový bod jako rozhraní API pro vyhledávání obrázků (vrací je pouze rozhraní API pro vyhledávání na webu). Pokud chcete zahrnout odpovědi, které by jinak byly vyloučeny z důvodu řazení, projděte si parametr dotazu pro zvýšení úrovně.
safeSearch	Filtr, který slouží k filtrování obsahu pro dospělé. Vypnuto: Vrátí webové stránky s textem, obrázky nebo videi pro dospělé. Střední: Vrátí webové stránky s textem pro dospělé, ale ne obrázky nebo videa pro dospělé. Striktní: Nevracejte webové stránky s textem, obrázky nebo videi pro dospělé. Výchozí hodnota je Moderate. Pokud žádost pochází z trhu, na který zásady Pro dospělé bingu vyžadují, aby bezpečné hledání bylo nastaveno na Striktní, Bing ignoruje hodnotu safeSearch a použije Strict. Pokud použijete operátor dotazu site:, je možné, že odpověď může obsahovat obsah pro dospělé bez ohledu na to, na co je parametr dotazu safeSearch nastavený. Používejte web: Pouze v případě, že znáte obsah na webu a váš scénář podporuje možnost obsahu pro dospělé. Mezi možné hodnoty patří: Vypnuto, Střední, Striktní.
setLang	Jazyk, který se má použít pro řetězce uživatelského rozhraní. Jazyk zadejte pomocí dvoupísmenného kódu jazyka ISO 639-1. Například kód jazyka pro češtinu je CS. Výchozí hodnota je EN (angličtina). I když je jazyk volitelný, měli byste ho vždy zadat. Obvykle nastavíte setLang na stejný jazyk určený mkt, pokud uživatel nechce, aby se řetězce uživatelského rozhraní zobrazovaly 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.
textDecorations	Logická hodnota, která určuje, jestli mají zobrazované řetězce obsahovat značky dekorací, jako je například zvýrazňování znaků. Pokud je hodnota true, mohou řetězce obsahovat značky. Výchozí hodnotou je hodnota false. Pokud chcete určit, jestli se mají jako značky používat znaky Unicode nebo značky HTML, projděte si parametr dotazu textFormat.
textFormat	Typ značek, které se mají použít pro dekoraci textu (viz parametr dotazu textDecorations). Možné hodnoty jsou Raw – Pomocí znaků Unicode můžete označit obsah, který vyžaduje speciální formátování. Znaky Unicode jsou v rozsahu E000 až E019. Bing například používá E000 a E001 k označení začátku a konce termínů dotazu pro zvýraznění přístupů. HTML – značky HTML slouží k označení obsahu, který vyžaduje speciální formátování. Značky můžete například použít ke zvýraznění výrazů dotazu v zobrazovaných řetězcích. Výchozí hodnota je Raw. U zobrazovaných řetězců, které obsahují znaky HTML, jako <jsou , >a &, pokud je textFormat nastavený na HTML, Bing tyto znaky podle potřeby uvozuje (například < je uvozován do <). Mezi možné hodnoty patří: Raw, Html.
userAgent	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 volitelná, důrazně doporučujeme tuto hlavičku zadat vždy. Uživatelský agent by měl být stejný řetězec, který by odesílal jakýkoli běžně používaný prohlížeč. Informace o uživatelských agentech najdete v RFC 2616.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
customHeaders	Uživatelem definované vlastní hlavičky požadavků, které se použijí před odesláním požadavku.
onDownloadProgress	Zpětné volání, které se aktivuje při průběhu stahování.
onUploadProgress	Zpětné volání, které se aktivuje při průběhu nahrávání.
timeout	Počet milisekund, které může požadavek trvat před automatickým ukončením.

Podrobnosti vlastnosti

acceptLanguage

Seznam jednoho nebo více jazyků oddělených čárkami, který se má použít 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 tématu 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. Bing použije první podporovaný jazyk, který najde v seznamu, a zkombinuje ho s hodnotou parametru cc, aby určil trh, pro který se mají vrátit výsledky. Pokud seznam neobsahuje podporovaný jazyk, Bing najde nejbližší jazyk a trh, který požadavek podporuje, a může pro výsledky místo zadaného trhu použít agregovaný nebo výchozí trh. Tuto hlavičku a parametr dotazu cc byste měli použít pouze v případě, že zadáte více jazyků. jinak byste měli použít 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 velmi málo řetězců uživatelského rozhraní. Všechny odkazy v objektech odpovědi na vlastnosti Bing.com použijí zadaný jazyk.

acceptLanguage?: string

Hodnota vlastnosti

string

answerCount

Počet odpovědí, které chcete zahrnout do odpovědi. Odpovědi, které Bing vrátí, jsou založené na pořadí. Pokud například Bing vrátí webové stránky, obrázky, videa a související hledání pro požadavek a nastavíte tento parametr na dva (2), odpověď bude zahrnovat webové stránky a obrázky. Pokud jste do stejného požadavku zahrnuli parametr dotazu responseFilter a nastavili jste ho na webové stránky a zprávy, odpověď by obsahovala pouze webové stránky.

answerCount?: number

Hodnota vlastnosti

number

clientId

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 také může ID klienta použít pro přizpůsobení webových výsledků historii hledání daného ID klienta. Uživatel tak získá 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. 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é. 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. Odpovědi Bingu můžou nebo nemusí obsahovat tuto hlavičku. 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í. Pokud zahrnete X-MSEdge-ClientID, nesmíte do žádosti zahrnout soubory cookie.

clientId?: string

Hodnota vlastnosti

string

clientIp

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í. I když je to volitelné, doporučujeme vždy zadat tuto hlavičku a 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.

clientIp?: string

Hodnota vlastnosti

string

count

Počet výsledků hledání, které se mají vrátit v odpovědi. Výchozí hodnota je 10 a maximální hodnota je 50. Skutečné doručované číslo může být menší, než je požadováno. Tento parametr použijte společně s parametrem posunu k výsledkům stránky. Pokud například vaše uživatelské rozhraní zobrazí 10 výsledků hledání na stránku, nastavte počet na 10 a posun na 0, abyste získali první stránku výsledků. Pro každou další stránku se zvýší posun o 10 (například 0, 10, 20). Je možné, že více stránek obsahuje určité překrývající se výsledky.

count?: number

Hodnota vlastnosti

number

countryCode

Dva znaky kódu země, odkud výsledky pochází. Toto rozhraní API podporuje pouze trh USA. Pokud zadáte tento parametr dotazu, musí být nastavený na nás. Pokud tento parametr nastavíte, musíte zadat také hlavičku Accept-Language. Bing používá první podporovaný jazyk, který najde v seznamu jazyků, a zkombinuje ho s kódem země, který určíte, pro který trh se má vrátit výsledky. Pokud seznam jazyků neobsahuje podporovaný jazyk, bing vyhledá nejbližší jazyk a trh, který podporuje požadavek, nebo může pro výsledky místo zadaného trhu použít agregovaný nebo výchozí trh. Tento parametr dotazu a parametr Accept-Language dotazu byste měli použít pouze v případě, že zadáte více jazyků. jinak byste měli použít parametry dotazu mkt a setLang. Tento parametr a parametr dotazu mkt se vzájemně vylučují – nezadávejte oba parametry.

countryCode?: string

Hodnota vlastnosti

string

freshness

Výsledky hledání můžete filtrovat podle následujících věkových hodnot: Den – vrátí webové stránky, které Bing zjistil během posledních 24 hodin. Týden – vrátí webové stránky, které Bing zjistil během posledních 7 dnů. Měsíc – vrátí webové stránky zjištěné během posledních 30 dnů. Tento filtr se vztahuje pouze na výsledky webové stránky, nikoli na ostatní výsledky, jako jsou zprávy a obrázky. Mezi možné hodnoty patří: "Den", "Týden", "Měsíc"

freshness?: Freshness

Hodnota vlastnosti

Freshness

location

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. Zadejte dvojici klíč/hodnota jako :. Následují klíče, které se používají k určení polohy uživatele. lat (povinné): zeměpisná šířka umístění 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 umístění 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 unixu, kdy byl klient v umístění. (Časové razítko systému UNIX je počet sekund od 1. ledna 1970.) head (volitelné): Relativní směr nebo směr jízdy 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 pouze v případě, že klíč sp není nenulový. sp (volitelné): Vodorovná rychlost (rychlost) v metrech za sekundu, kterou klientské zařízení cestuje. 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 pouze v případě, že zadáte klávesu ALT. I když je mnoho klíčů nepovinných, čím více informací zadáte, tím přesnější jsou výsledky umístění. I když je to volitelné, doporučujeme vždy zadat zeměpisnou polohu uživatele. 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 dosažení optimálních výsledků byste měli zahrnout tuto hlavičku i hlavičku X-MSEdge ClientIP, minimálně ale aspoň tuto hlavičku.

location?: string

Hodnota vlastnosti

string

market

Trh, odkud pochází výsledky. Mkt je obvykle země, 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 tvaru -. Například cs-CZ. Řetězec nerozlišuje velká a velká písmena. 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. Výchozí hodnota: en-us.

market?: string

Hodnota vlastnosti

string

offset

Posun založený na nule, který označuje počet výsledků hledání, které se mají přeskočit před vrácením výsledků. Výchozí hodnota je 0. Posun by měl být menší než (totalEstimatedMatches – count). Tento parametr použijte spolu s parametrem count pro výsledky stránky. Pokud například vaše uživatelské rozhraní zobrazí 10 výsledků hledání na stránku, nastavte počet na 10 a posun na 0, abyste získali první stránku výsledků. Pro každou další stránku se zvýší posun o 10 (například 0, 10, 20). je možné, že několik stránek obsahuje určité překrývající se výsledky.

offset?: number

Hodnota vlastnosti

number

pragma

Ve výchozím nastavení Bing vrátí obsah uložený v mezipaměti, pokud je k dispozici. Abyste Bingu zabránili ve vrácení obsahu uloženého v mezipaměti, hlavičku Pragma nastavte na hodnotu no-cache (například Pragma: no-cache).

pragma?: string

Hodnota vlastnosti

string

promote

Seznam odpovědí oddělených čárkami, které má odpověď obsahovat bez ohledu na jejich pořadí. Pokud například nastavíte answerCount) na dvě (2), aby Bing vrátil dvě první seřazené odpovědi, ale chcete, aby odpověď obsahovala také novinky, nastavili byste zvýšení úrovně na zprávy. Pokud jsou nejčastějšími odpověďmi webové stránky, obrázky, videa a související hledání, odpověď zahrnuje webové stránky a obrázky, protože zprávy nejsou seřazenou odpovědí. Pokud ale nastavíte zvýšení úrovně na video, Bing zvýší úroveň odpovědi na video do odpovědi a vrátí webové stránky, obrázky a videa. Odpovědi, které chcete zvýšit, se nezapočítávají do limitu answerCount. Pokud jsou například seřazené odpovědi zprávy, obrázky a videa a vy nastavíte answerCount na hodnotu 1 a povyšte na novinky, bude odpověď obsahovat zprávy a obrázky. Nebo pokud jsou seřazené odpovědi videa, obrázky a zprávy, odpověď obsahuje videa a zprávy. Možné hodnoty jsou Computation, Images, News, RelatedSearches, SpellSuggestions, TimeZone, Videos, Webové stránky. Použijte pouze v případě, že zadáte answerCount.

promote?: AnswerType[]

Hodnota vlastnosti

AnswerType[]

responseFilter

Seznam odpovědí oddělených čárkami, které se mají zahrnout do odpovědi. Pokud tento parametr nezadáte, bude odpověď obsahovat všechny vyhledávací odpovědi, pro které jsou k dispozici relevantní data. Možné hodnoty filtru jsou Výpočet, Obrázky, Zprávy, RelatedSearches, SpellSuggestions, TimeZone, Videa, Webové stránky. I když tento filtr můžete použít k získání jedné odpovědi, měli byste místo toho použít koncový bod specifický pro odpověď, abyste získali bohatší výsledky. Pokud například chcete přijímat jenom obrázky, odešlete požadavek do jednoho z koncových bodů rozhraní API pro vyhledávání obrázků. Odpovědi RelatedSearches a SpellSuggestions nepodporují samostatný koncový bod jako rozhraní API pro vyhledávání obrázků (vrací je pouze rozhraní API pro vyhledávání na webu). Pokud chcete zahrnout odpovědi, které by jinak byly vyloučeny z důvodu řazení, projděte si parametr dotazu pro zvýšení úrovně.

responseFilter?: AnswerType[]

Hodnota vlastnosti

AnswerType[]

safeSearch

Filtr, který slouží k filtrování obsahu pro dospělé. Vypnuto: Vrátí webové stránky s textem, obrázky nebo videi pro dospělé. Střední: Vrátí webové stránky s textem pro dospělé, ale ne obrázky nebo videa pro dospělé. Striktní: Nevracejte webové stránky s textem, obrázky nebo videi pro dospělé. Výchozí hodnota je Moderate. Pokud žádost pochází z trhu, na který zásady Pro dospělé bingu vyžadují, aby bezpečné hledání bylo nastaveno na Striktní, Bing ignoruje hodnotu safeSearch a použije Strict. Pokud použijete operátor dotazu site:, je možné, že odpověď může obsahovat obsah pro dospělé bez ohledu na to, na co je parametr dotazu safeSearch nastavený. Používejte web: Pouze v případě, že znáte obsah na webu a váš scénář podporuje možnost obsahu pro dospělé. Mezi možné hodnoty patří: Vypnuto, Střední, Striktní.

safeSearch?: SafeSearch

Hodnota vlastnosti

SafeSearch

setLang

Jazyk, který se má použít pro řetězce uživatelského rozhraní. Jazyk zadejte pomocí dvoupísmenného kódu jazyka ISO 639-1. Například kód jazyka pro češtinu je CS. Výchozí hodnota je EN (angličtina). I když je jazyk volitelný, měli byste ho vždy zadat. Obvykle nastavíte setLang na stejný jazyk určený mkt, pokud uživatel nechce, aby se řetězce uživatelského rozhraní zobrazovaly 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.

setLang?: string

Hodnota vlastnosti

string

textDecorations

Logická hodnota, která určuje, jestli mají zobrazované řetězce obsahovat značky dekorací, jako je například zvýrazňování znaků. Pokud je hodnota true, mohou řetězce obsahovat značky. Výchozí hodnotou je hodnota false. Pokud chcete určit, jestli se mají jako značky používat znaky Unicode nebo značky HTML, projděte si parametr dotazu textFormat.

textDecorations?: boolean

Hodnota vlastnosti

boolean

textFormat

Typ značek, které se mají použít pro dekoraci textu (viz parametr dotazu textDecorations). Možné hodnoty jsou Raw – Pomocí znaků Unicode můžete označit obsah, který vyžaduje speciální formátování. Znaky Unicode jsou v rozsahu E000 až E019. Bing například používá E000 a E001 k označení začátku a konce termínů dotazu pro zvýraznění přístupů. HTML – značky HTML slouží k označení obsahu, který vyžaduje speciální formátování. Značky můžete například použít ke zvýraznění výrazů dotazu v zobrazovaných řetězcích. Výchozí hodnota je Raw. U zobrazovaných řetězců, které obsahují znaky HTML, jako <jsou , >a &, pokud je textFormat nastavený na HTML, Bing tyto znaky podle potřeby uvozuje (například < je uvozován do <). Mezi možné hodnoty patří: Raw, Html.

textFormat?: TextFormat

Hodnota vlastnosti

TextFormat

userAgent

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 volitelná, důrazně doporučujeme tuto hlavičku zadat vždy. Uživatelský agent by měl být stejný řetězec, který by odesílal jakýkoli běžně používaný prohlížeč. Informace o uživatelských agentech najdete v RFC 2616.

userAgent?: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

Zděděno z msRest.RequestOptionsBase.abortSignal

customHeaders

Uživatelem definované vlastní hlavičky požadavků, které se použijí před odesláním požadavku.

customHeaders?: {[key: string]: string}

Hodnota vlastnosti

{[key: string]: string}

Zděděno z msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Zpětné volání, které se aktivuje při průběhu stahování.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Zpětné volání, které se aktivuje při průběhu nahrávání.

onUploadProgress?: (progress: TransferProgressEvent) => void

Hodnota vlastnosti

(progress: TransferProgressEvent) => void

Zděděno z msRest.RequestOptionsBase.onUploadProgress

timeout

Počet milisekund, které může požadavek trvat před automatickým ukončením.

timeout?: number

Hodnota vlastnosti

number

Zděděno z msRest.RequestOptionsBase.timeout