Search

  • Reference
Service:
Maps
API Version:
1.0

Operations

Get Search Address

Adresa geografického kódování

Platí pro: cenové úrovně S0 a S1.

V mnoha případech může být kompletní služba vyhledávání příliš velká, například pokud zajímáte pouze tradiční geografické kódování. Vyhledávání se dá také otevřít jenom pro vyhledání adresy. Geografické kódování je provedeno tím, že zasáhne koncový bod kódu pouze v případě, že se jedná o konkrétní adresu nebo částečnou adresu. Index hledání geografického kódování bude dotazován na vše nad daty úrovně ulice. Nevrátí se žádná zájmu. Všimněte si, že pro kocode je velmi odolný proti překlepům a neúplným adresám. Bude také zpracovávat vše od konkrétních poštovních adres, ulici nebo průniků a také geografických oblastí vyšší úrovně, jako jsou centra měst, okresy, stavy atd.
Get Search Address Reverse

Obrátit INCODE na adresu

Platí pro: cenové úrovně S0 a S1.

Může nastat situace, kdy potřebujete přeložit souřadnici (příklad: 37,786505,-122,3862) na adresu, která je člověkově srozumitelná. Nejčastěji to je potřeba ve sledovacích aplikacích, kde obdržíte informační kanál GPS ze zařízení nebo assetu a chcete znát adresu, kde se nachází souřadnice. Tento koncový bod vrátí informace o adrese pro danou souřadnici.
Get Search Address Reverse Cross Street

Obrátit INCODE na meziulici

Platí pro: cenové úrovně S0 a S1.

Může nastat situace, kdy potřebujete přeložit souřadnici (například: 37,786505,-122,3862) do srozumitelnější křížové čárky. Nejčastěji to je potřeba ve sledovacích aplikacích, kde obdržíte informační kanál GPS ze zařízení nebo assetu a chcete znát adresu, kde se nachází souřadnice. Tento koncový bod vrátí pro danou souřadnici informace o více ulici.
Get Search Address Structured

Geografické kódování strukturovaných adres

Platí pro: cenové úrovně S0 a S1.

K geografickému kódování adres Azure se dá také přihlížet pro strukturované adresy. Index hledání geografického kódování bude dotazován na vše nad daty úrovně ulice. Nevrátí se žádná zájmu. Všimněte si, že pro kocode je velmi odolný proti překlepům a neúplným adresám. Bude také zpracovávat vše od konkrétních poštovních adres, ulici nebo průniků a také geografických oblastí vyšší úrovně, jako jsou centra měst, okresy, stavy atd.
Get Search Fuzzy

Hledání bezplatného formuláře

Platí pro: cenové úrovně S0 a S1.

Základní výchozí rozhraní API je bezplatné hledání ve formě volného místa, které zpracovává nejvíce přibližných vstupů, které zpracovávají jakoukoli kombinaci adres nebo tokenů POI. Toto rozhraní API pro hledání je kanonické jednoduché hledání na jednom řádku. Rozhraní API pro bezplatné vyhledávání formulářů je Bezproblémová kombinace POI a geografického kódování. Rozhraní API může být také vážené s kontextovou polohou (lat./lon. párové) nebo plně omezené souřadnicemi a poloměry, nebo je lze provádět obecněji bez jakéhokoli bodu ukotvení posunu.

Důrazně doporučujeme, abyste pomocí parametru countrySet určili jenom země, pro které vaše aplikace potřebuje pokrytí, protože výchozí chování bude prohledávat celý svět, což může vracet zbytečné výsledky.

Např.: countrySet = US, fr

Úplný seznam všech podporovaných zemí najdete v pokrytí hledání .

Většina vyhledávacích dotazů je ve výchozím nastavení na hodnotu maxFuzzyLevel = 2 pro získání výkonu a také pro omezení neobvyklých výsledků. Tato nová výchozí hodnota se dá přepsat podle potřeby na žádost předáním parametru dotazu maxFuzzyLevel = 3 nebo 4.
Get Search Nearby

Okolní hledání

Platí pro: cenové úrovně S0 a S1.

Pokud máte případ použití jenom pro načtení výsledků POI kolem konkrétního umístění, může se jednat o správnou volbu v blízkosti metody hledání. Tento koncový bod vrátí pouze výsledky POI a nebere v parametru vyhledávacího dotazu.
Get Search POI

Získat POI podle názvu

Platí pro: cenové úrovně S0 a S1.

Hledání bodů zájmu (POI) umožňuje vyžádat si výsledky POI podle názvu. Hledání podporuje další parametry dotazů, jako je například jazyk a filtrování výsledků podle oblasti zájmu, kterou řídí země nebo ohraničovací rámeček. Koncový bod vrátí jenom POI výsledky, které odpovídají řetězci dotazu. Odpověď zahrnuje POI podrobnosti, jako je adresa, umístění souřadnic a kategorie.
Get Search POI Category

Získat POI podle kategorie

Platí pro: cenové úrovně S0 a S1.

Hledání kategorií bodů zájmu (POI) umožňuje vyžádat si výsledky POI z dané kategorie. Při hledání je možné zadávat dotazy zájmu z jedné kategorie. Koncový bod vrátí pouze výsledky POI, které jsou zařazeny do kategorií podle určení. Odpověď zahrnuje POI podrobnosti, jako je adresa, umístění souřadnic a klasifikace.
Get Search POI Category Tree Preview

Získat strom kategorií POI

Platí pro: cenové úrovně S0 a S1.

Rozhraní POI kategorie API poskytuje úplný seznam podporovaných kategorií (POI) bodů zájmu a podkategorií spolu s jejich překlady a synonymy. Vrácený obsah lze použít k poskytnutí smysluplných výsledků prostřednictvím jiných rozhraní API Search Service, jako je například POI hledání.
Get Search Polygon

Získat mnohoúhelník

Platí pro: cenová úroveň S1.

Služba Get mnohoúhelník umožňuje požádat o data geometrie, jako je například město města nebo země pro sadu entit, dříve získanou z online žádosti o vyhledávání ve formátu. ID geometrie se vrátí v objektu DataSources pod "Geometry" a "ID" buď v hledané adrese, nebo ve vyhledávacím volání přibližné.

Upozorňujeme, že jakékoli ID geometrie načtené z koncového bodu online vyhledávání má omezené trvání. Klient by neměl ukládat ID geometrie v trvalém úložišti pro pozdější odkaz, protože stabilita těchto identifikátorů není zaručena po dlouhou dobu. Očekává se, že požadavek na metodu mnohoúhelníku se vytvoří během několika minut od žádosti do online metody hledání, která poskytuje ID. Služba umožňuje dávkové zpracování požadavků až na 20 identifikátorů.
Post Search Address Batch

Hledat adresu rozhraní API pro Batch

Platí pro: cenová úroveň S1.

Rozhraní API pro vyhledávání v dávce odesílá dávky dotazů do rozhraní API pro hledání adres pomocí jediného volání rozhraní API. Můžete zavolat rozhraní API pro dávkové vyhledávání, které se spustí asynchronně (Async) nebo synchronně (Sync). Asynchronní rozhraní API umožňuje volajícímu dávkování až 10 000 dotazů a synchronizaci rozhraní API až do 100 dotazů.

Odeslat synchronní požadavek dávky

Pro odlehčené požadavky Batch se doporučuje synchronní rozhraní API. Když služba obdrží požadavek, odpoví hned po výpočtu položek dávky a nebude možné výsledky načíst později. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet položek dávky je pro toto rozhraní API omezený na 100 .

POST https://atlas.microsoft.com/search/address/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Odeslat asynchronní požadavek dávky

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů poměrně složitých žádostí o vyhledávání.

  • Umožňuje načtení výsledků v samostatném volání (více souborů ke stažení je možné).
  • Asynchronní rozhraní API je optimalizováno pro spolehlivost a neočekává se, že bude spuštěno v časovém limitu.
  • Počet položek dávky je pro toto rozhraní API omezený na 10 000 .

Když vytvoříte požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL pro přesměrování v poli umístění v hlavičce odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Asynchronní odpovědi jsou uloženy po dobu 14 dnů. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po období vypršení platnosti.

Všimněte si, že asynchronní požadavek Batch je dlouhotrvající požadavek. Tady je typická posloupnost operací:

  1. Klient pošle požadavek dávkového vyhledávání POST na adresu Azure Maps

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat.

    HTTP Error – při zpracování žádosti dávky došlo k chybě. Může to být buď 400 Bad Request nebo jakýkoli jiný Error stavový kód.

  3. Pokud byl požadavek dávky úspěšně přijat, Location Hlavička v odpovědi obsahuje adresu URL pro stažení výsledků žádosti o dávku. Tento identifikátor URI stavu vypadá takto:

    GET https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient vydá GET požadavek na adresu URL pro stažení získanou v kroku 3 ke stažení výsledků dávky.

Tělo příspěvku pro požadavek Batch

K odeslání dotazů na adresu hledání budete používat žádost, POST kde text žádosti bude obsahovat batchItems pole ve json formátu a Content-Type záhlaví bude nastaveno na application/json . Tady je ukázkový text požadavku, který obsahuje 5 dotazů na adresu hledání :

{
    "batchItems": [
        {"query": "?query=400 Broad St, Seattle, WA 98109&limit=3"},
        {"query": "?query=One, Microsoft Way, Redmond, WA 98052&limit=3"},
        {"query": "?query=350 5th Ave, New York, NY 10118&limit=1"},
        {"query": "?query=Pike Pl, Seattle, WA 98101&lat=47.610970&lon=-122.342469&radius=1000"},
        {"query": "?query=Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France&limit=1"}
    ]
}

Dotaz na adresu hledání v dávce je jenom částečná adresa URL bez protokolu, základní adresy URL, cesty, verze rozhraní API a klíč předplatného. Může přijmout jakýkoli z podporovaných parametrů identifikátoru URI hledané adresy . Hodnoty řetězce v dotazu na adresu hledání musí být správně uvozeny (např. "znak by měl být uvozen" \ ) a musí být také správně zakódována pomocí adresy URL.

Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizaci rozhraní API až do 100 dotazů a dávka by měla obsahovat alespoň 1 dotaz.

Stáhnout asynchronní výsledky dávky

Pro stažení výsledků asynchronní dávky budete vydávat GET požadavek na koncový bod stažení služby Batch. Tuto adresu URL pro stažení lze získat z Location hlavičky úspěšného POST požadavku dávky a vypadá takto:

https://atlas.microsoft.com/search/address/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Toto je typická posloupnost operací pro stažení výsledků dávky:

  1. Klient odešle GET požadavek pomocí adresy URL pro stažení.

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat, ale stále probíhá jeho zpracování. Zkuste to prosím znovu za chvíli.

    200 OKPožadavek HTTP-Batch byl úspěšně zpracován. Tělo odpovědi obsahuje všechny výsledky dávky.

Model dávkové odezvy

Vrácený obsah dat je podobný jako u požadavků na asynchronní a synchronní synchronizaci. Při stahování výsledků asynchronního požadavku dávky, pokud dávka dokončila zpracování, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje summary komponentu, která indikuje, totalRequests které byly součástí původní žádosti dávky, a to znamená, že successfulRequests dotazy byly úspěšně provedeny. Tato odpověď zahrnuje také batchItems pole, které obsahuje odpověď pro každý dotaz v dávkové žádosti a všechny dotazy. batchItemsBude obsahovat výsledky v přesném pořadí, v jakém byly původní dotazy odeslány v dávce požadavku. Každá položka v batchItems statusCode poli obsahuje a response . Každý response z batchItems těchto typů je jeden z následujících typů:

  • SearchAddressResponse – Pokud se dotaz úspěšně dokončil.

  • Error – Pokud se dotaz nezdařil. codeV tomto případě bude odpověď obsahovat a a message .

Tady je ukázková odpověď dávky se 2 úspěšnými a 1 výsledkem selhání :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "one microsoft way redmond wa 98052"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.63989,
                            "lon": -122.12509
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "pike pl seattle wa 98101"
                },
                "results": [
                    {
                        "position": {
                            "lat": 47.60963,
                            "lon": -122.34215
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Post Search Address Reverse Batch

Hledat adresu reverzního rozhraní API v dávce

Platí pro: cenová úroveň S1.

Rozhraní API pro vyhledávání v dávce odesílá dávky dotazů, aby vyhledalo reverzní rozhraní API pomocí jediného volání rozhraní API. Můžete zavolat rozhraní API pro vrácení zpět dávky pro spuštění asynchronně (Async) nebo synchronně (Sync). Asynchronní rozhraní API umožňuje volajícímu dávkování až 10 000 dotazů a synchronizaci rozhraní API až do 100 dotazů.

Odeslat synchronní požadavek dávky

Pro odlehčené požadavky Batch se doporučuje synchronní rozhraní API. Když služba obdrží požadavek, odpoví hned po výpočtu položek dávky a nebude možné výsledky načíst později. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet položek dávky je pro toto rozhraní API omezený na 100 .

POST https://atlas.microsoft.com/search/address/reverse/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Odeslat asynchronní požadavek dávky

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů poměrně složitých žádostí o vyhledávání.

  • Umožňuje načtení výsledků v samostatném volání (více souborů ke stažení je možné).
  • Asynchronní rozhraní API je optimalizováno pro spolehlivost a neočekává se, že bude spuštěno v časovém limitu.
  • Počet položek dávky je pro toto rozhraní API omezený na 10 000 .

Když vytvoříte požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL pro přesměrování v poli umístění v hlavičce odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Asynchronní odpovědi jsou uloženy po dobu 14 dnů. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po období vypršení platnosti.

Všimněte si, že asynchronní požadavek Batch je dlouhotrvající požadavek. Tady je typická posloupnost operací:

  1. Klient pošle požadavek dávkového vyhledávání POST na adresu Azure Maps

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat.

    HTTP Error – při zpracování žádosti dávky došlo k chybě. Může to být buď 400 Bad Request nebo jakýkoli jiný Error stavový kód.

  3. Pokud byl požadavek dávky úspěšně přijat, Location Hlavička v odpovědi obsahuje adresu URL pro stažení výsledků žádosti o dávku. Tento identifikátor URI stavu vypadá takto:

    GET https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient vydá GET požadavek na adresu URL pro stažení získanou v kroku 3 ke stažení výsledků dávky.

Tělo příspěvku pro požadavek Batch

Chcete-li odeslat vyhledávané dotazy, budete používat POST žádost, kde text žádosti bude obsahovat batchItems pole ve json formátu a Content-Type záhlaví bude nastaveno na application/json . Tady je ukázkový text požadavku, který obsahuje 5 vyhledávacích dotazů na adresu:

{
    "batchItems": [
        {"query": "?query=48.858561,2.294911"},
        {"query": "?query=47.639765,-122.127896&radius=5000&limit=2"},
        {"query": "?query=47.621028,-122.348170"},
        {"query": "?query=43.722990,10.396695"},
        {"query": "?query=40.750958,-73.982336"}
    ]
}

Dotaz na adresu zpětného vyhledávání v dávce je jenom částečná adresa URL bez protokolu, základní adresy URL, cesty, rozhraní API-Version a klíč předplatného. Může přijmout některý z podporovaných parametrů zpětného identifikátoru URIpro adresu hledání. Řetězcové hodnoty v obráceném dotazu na adrese hledání musí být správně uvozeny (např. "znak by měl být uvozen" \ ) a musí být také správně ZAKÓDOVANÝ na adrese URL.

Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizaci rozhraní API až do 100 dotazů a dávka by měla obsahovat alespoň 1 dotaz.

Stáhnout asynchronní výsledky dávky

Pro stažení výsledků asynchronní dávky budete vydávat GET požadavek na koncový bod stažení služby Batch. Tuto adresu URL pro stažení lze získat z Location hlavičky úspěšného POST požadavku dávky a vypadá takto:

https://atlas.microsoft.com/search/address/reverse/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Toto je typická posloupnost operací pro stažení výsledků dávky:

  1. Klient odešle GET požadavek pomocí adresy URL pro stažení.

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat, ale stále probíhá jeho zpracování. Zkuste to prosím znovu za chvíli.

    200 OKPožadavek HTTP-Batch byl úspěšně zpracován. Tělo odpovědi obsahuje všechny výsledky dávky.

Model dávkové odezvy

Vrácený obsah dat je podobný jako u požadavků na asynchronní a synchronní synchronizaci. Při stahování výsledků asynchronního požadavku dávky, pokud dávka dokončila zpracování, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje summary komponentu, která indikuje, totalRequests které byly součástí původní žádosti dávky, a to znamená, že successfulRequests dotazy byly úspěšně provedeny. Tato odpověď zahrnuje také batchItems pole, které obsahuje odpověď pro každý dotaz v dávkové žádosti a všechny dotazy. batchItemsBude obsahovat výsledky v přesném pořadí, v jakém byly původní dotazy odeslány v dávce požadavku. Každá položka v batchItems statusCode poli obsahuje a response . Každý response z batchItems těchto typů je jeden z následujících typů:

  • SearchAddressReverseResponse – Pokud se dotaz úspěšně dokončil.

  • Error – Pokud se dotaz nezdařil. codeV tomto případě bude odpověď obsahovat a a message .

Tady je ukázková odpověď dávky se 2 úspěšnými a 1 výsledkem selhání :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 11
                },
                "addresses": [
                    {
                        "address": {
                            "country": "France",
                            "freeformAddress": "Avenue Anatole France, 75007 Paris"
                        },
                        "position": "48.858490,2.294820"
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "queryTime": 1
                },
                "addresses": [
                    {
                        "address": {
                            "country": "United States of America",
                            "freeformAddress": "157th Pl NE, Redmond WA 98052"
                        },
                        "position": "47.640470,-122.129430"
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Post Search Along Route

Platí pro: cenové úrovně S0 a S1.

Hledání v rámci koncového bodu směrování umožňuje provádět přibližné hledání zájmu podél zadané trasy. Toto hledání je omezené zadáním maxDetourTime omezující míry.

Chcete-li odeslat body trasy, budete používat POST žádost, kde text žádosti bude obsahovat route objekt reprezentovaný jako GeoJSON LineString typ a Content-Type záhlaví bude nastaveno na application/json . Každý bod trasy v route je reprezentován jako typ, GeoJSON Position tj. pole, ve kterém je hodnota délky následována hodnotou zeměpisné šířky a hodnota nadmořského nadmnožiny je ignorována. routeMěl by obsahovat alespoň 2 body směrování.

Je možné, že se původní trasa změní, některé z jejích bodů se můžou přeskočit. Pokud je trasa, která prochází nalezeným bodem, rychlejší než ta původní, detourTime hodnota v odpovědi je záporná.
Post Search Fuzzy Batch

Prohledat nepřibližné dávkové rozhraní API

Platí pro: cenová úroveň S1.

Rozhraní API pro vyhledávání v dávce odesílá dávky dotazů pro hledání přibližných rozhraní API pomocí jediného volání rozhraní API. Můžete zavolat rozhraní API pro přibližné zpracování adres hledání, které se spustí asynchronně (Async) nebo synchronně (Sync). Asynchronní rozhraní API umožňuje volajícímu dávkování až 10 000 dotazů a synchronizaci rozhraní API až do 100 dotazů.

Odeslat synchronní požadavek dávky

Pro odlehčené požadavky Batch se doporučuje synchronní rozhraní API. Když služba obdrží požadavek, odpoví hned po výpočtu položek dávky a nebude možné výsledky načíst později. Synchronní rozhraní API vrátí chybu časového limitu (odpověď 408), pokud požadavek trvá déle než 60 sekund. Počet položek dávky je pro toto rozhraní API omezený na 100 .

POST https://atlas.microsoft.com/search/fuzzy/batch/sync/json?api-version=1.0&subscription-key={subscription-key}

Odeslat asynchronní požadavek dávky

Asynchronní rozhraní API je vhodné pro zpracování velkých objemů poměrně složitých žádostí o vyhledávání.

  • Umožňuje načtení výsledků v samostatném volání (více souborů ke stažení je možné).
  • Asynchronní rozhraní API je optimalizováno pro spolehlivost a neočekává se, že bude spuštěno v časovém limitu.
  • Počet položek dávky je pro toto rozhraní API omezený na 10 000 .

Když vytvoříte požadavek pomocí asynchronního požadavku, služba ve výchozím nastavení vrátí kód odpovědi 202 podél adresy URL pro přesměrování v poli umístění v hlavičce odpovědi. Tato adresa URL by měla být pravidelně kontrolována, dokud nebudou k dispozici data odpovědi nebo informace o chybě. Asynchronní odpovědi jsou uloženy po dobu 14 dnů. Adresa URL pro přesměrování vrátí odpověď 404, pokud se použije po období vypršení platnosti.

Všimněte si, že asynchronní požadavek Batch je dlouhotrvající požadavek. Tady je typická posloupnost operací:

  1. Klient pošle požadavek dávkového vyhledávání POST na adresu Azure Maps

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat.

    HTTP Error – při zpracování žádosti dávky došlo k chybě. Může to být buď 400 Bad Request nebo jakýkoli jiný Error stavový kód.

  3. Pokud byl požadavek dávky úspěšně přijat, Location Hlavička v odpovědi obsahuje adresu URL pro stažení výsledků žádosti o dávku. Tento identifikátor URI stavu vypadá takto:

    GET https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
  1. Klient vydá GET požadavek na adresu URL pro stažení získanou v kroku 3 ke stažení výsledků dávky.

Tělo příspěvku pro požadavek Batch

Chcete-li odeslat dotazy hledání s přibližnými výsledky hledání , budete používat POST požadavek, který bude obsahovat text žádosti o batchItems pole ve json formátu a Content-Type záhlaví bude nastaveno na application/json . Tady je ukázkový text požadavku obsahující 5 nepřibližné dotazy pro hledání:

{
    "batchItems": [
        {"query": "?query=atm&lat=47.639769&lon=-122.128362&radius=5000&limit=5"},
        {"query": "?query=Statue Of Liberty&limit=2"},
        {"query": "?query=Starbucks&lat=47.639769&lon=-122.128362&radius=5000"},
        {"query": "?query=Space Needle"},
        {"query": "?query=pizza&limit=10"}
    ]
}

Dotaz na nepřibližné vyhledávání v dávce je jenom částečná adresa URL bez protokolu, základní adresy URL, cesty, rozhraní API-Version a klíč předplatného. Může přijmout jakýkoli z podporovaných parametrů hledání přibližných identifikátorů URI. Řetězcové hodnoty v dotazech hledání přibližných hodnot musí být správně uvozeny (např. "znak by měl být uvozen" \ ) a musí být také správně KÓDOVÁNA pomocí adresy URL.

Asynchronní rozhraní API umožňuje volajícímu dávkovat až 10 000 dotazů a synchronizaci rozhraní API až do 100 dotazů a dávka by měla obsahovat alespoň 1 dotaz.

Stáhnout asynchronní výsledky dávky

Pro stažení výsledků asynchronní dávky budete vydávat GET požadavek na koncový bod stažení služby Batch. Tuto adresu URL pro stažení lze získat z Location hlavičky úspěšného POST požadavku dávky a vypadá takto:

https://atlas.microsoft.com/search/fuzzy/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

Toto je typická posloupnost operací pro stažení výsledků dávky:

  1. Klient odešle GET požadavek pomocí adresy URL pro stažení.

  2. Server bude reagovat s jedním z následujících způsobů:

    202 AcceptedPožadavek HTTP-Batch byl přijat, ale stále probíhá jeho zpracování. Zkuste to prosím znovu za chvíli.

    200 OKPožadavek HTTP-Batch byl úspěšně zpracován. Tělo odpovědi obsahuje všechny výsledky dávky.

Model dávkové odezvy

Vrácený obsah dat je podobný jako u požadavků na asynchronní a synchronní synchronizaci. Při stahování výsledků asynchronního požadavku dávky, pokud dávka dokončila zpracování, tělo odpovědi obsahuje dávkovou odpověď. Tato dávková odpověď obsahuje summary komponentu, která indikuje, totalRequests které byly součástí původní žádosti dávky, a to znamená, že successfulRequests dotazy byly úspěšně provedeny. Tato odpověď zahrnuje také batchItems pole, které obsahuje odpověď pro každý dotaz v dávkové žádosti a všechny dotazy. batchItemsBude obsahovat výsledky v přesném pořadí, v jakém byly původní dotazy odeslány v dávce požadavku. Každá položka v batchItems statusCode poli obsahuje a response . Každý response z batchItems těchto typů je jeden z následujících typů:

  • SearchFuzzyResponse – Pokud se dotaz úspěšně dokončil.

  • Error – Pokud se dotaz nezdařil. codeV tomto případě bude odpověď obsahovat a a message .

Tady je ukázková odpověď dávky se 2 úspěšnými a 1 výsledkem selhání :

{
    "summary": {
        "successfulRequests": 2,
        "totalRequests": 3
    },
    "batchItems": [
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "atm"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "ATM at Wells Fargo"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "3240 157th Ave NE, Redmond, WA 98052"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 200,
            "response":
            {
                "summary": {
                    "query": "statue of liberty"
                },
                "results": [
                    {
                        "type": "POI",
                        "poi": {
                            "name": "Statue of Liberty"
                        },
                        "address": {
                            "country": "United States Of America",
                            "freeformAddress": "New York, NY 10004"
                        }
                    }
                ]
            }
        },
        {
            "statusCode": 400,
            "response":
            {
                "error":
                {
                    "code": "400 BadRequest",
                    "message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
                }
            }
        }
    ]
}
Post Search Inside Geometry

Platí pro: cenové úrovně S0 a S1.

Koncový bod geometrie hledání umožňuje provádět bezplatné hledání ve formě v rámci jedné geometrie nebo mnoha z nich. Vrátí se výsledky hledání, které spadají do geometrie/geometrií.

Chcete-li odeslat geometrii, budete používat POST žádost, kde text žádosti bude obsahovat geometry objekt reprezentovaný jako GeoJSON typ a Content-Type záhlaví bude nastaveno na application/json . Zeměpisné funkce, které mají být prohledány, lze modelovat jako mnohoúhelníky nebo kruhy geometrií reprezentované pomocí některého z následujících GeoJSON typů:

  • Funkce pro injsoning
    geometryLze reprezentovat jako GeoJSON FeatureCollection objekt. Tato možnost se doporučuje, pokud geometrie obsahuje mnohoúhelníky i kruhy. FeatureCollectionMůže obsahovat maximálně 50 GeoJSON Feature objektů. Každý Feature objekt by měl představovat mnohoúhelník nebo kroužek s následujícími podmínkami:
    • FeatureObjekt pro geometrii mnohoúhelníku může mít maximálně 50 souřadnic a jeho vlastnosti musí být prázdné.
    • FeatureObjekt pro geometrii kruhu se skládá z centra reprezentovaného pomocí GeoJSON Point typu a hodnoty poloměru (v metrech), které musí být zadány ve vlastnostech objektu společně s vlastností podtypu , jejichž hodnota by měla být Circle.

    Ukázkovou prezentaci najdete níže v části s příklady FeatureCollection .

  • Geometrická pro injson
    geometryLze reprezentovat jako GeoJSON GeometryCollection objekt. Tato možnost se doporučuje, pokud geometrie obsahuje jenom seznam mnohoúhelníků. GeometryCollectionMůže obsahovat maximálně 50 GeoJSON Polygon objektů. Každý Polygon objekt může mít maximálně 50 souřadnic. Ukázkovou prezentaci najdete níže v části s příklady GeometryCollection .

  • Mnohoúhelník pro injson
    geometryLze reprezentovat jako GeoJSON Polygon objekt. Tato možnost se doporučuje, pokud geometrie obsahuje jeden mnohoúhelník. PolygonObjekt může mít maximálně 50 souřadnic. Ukázkovou prezentaci najdete níže v části s příklady Polygon .

.