Package: azure-maps-search
Azure Maps Search Package client library for PythonThis package contains a Python SDK for Azure Maps Services for Search.
Read more about Azure Maps ServiceshereSource code|API reference documentation|Product documentationDisclaimerAzure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer tohttps://github.com/Azure/azure-sdk-for-python/issues/20691Getting startedPrerequisitesPython 3.6 or later is required to use this package.AnAzure subscriptionand anAzure Maps account.A deployed Maps Services resource. You can create the resource viaAzure PortalorAzure CLI.If you use Azure CLI, replace<resource-group-name>and<account-name>of your choice, and select a properpricing tierbased on your needs via the<sku-name>parameter. Please refer tothis pagefor more details.azmapsaccountcreate--resource-group<resource-group-name>--account-name<account-name>--sku<sku-name>Install the packageInstall the Azure Maps Service Search SDK.pipinstallazure-maps-searchCreate and Authenticate the MapsSearchClientTo create a client object to access the Azure Maps Search API, you will need acredentialobject. Azure Maps Search client also support two ways to authenticate.1. Authenticate with a Subscription Key CredentialYou can authenticate with your Azure Maps Subscription Key.
Once the Azure Maps Subscription Key is created, set the value of the key as environment variable:AZURE_SUBSCRIPTION_KEY.
Then pass anAZURE_SUBSCRIPTION_KEYas thecredentialparameter into an instance ofAzureKeyCredential.fromazure.core.credentialsimportAzureKeyCredentialfromazure.maps.searchimportMapsSearchClientcredential=AzureKeyCredential(os.environ.get("AZURE_SUBSCRIPTION_KEY"))search_client=MapsSearchClient(credential=credential,)2. Authenticate with an Azure Active Directory credentialYou can authenticate withAzure Active Directory (AAD) token credentialusing theAzure Identity library.
Authentication by using AAD requires some initial setup:Installazure-identityRegister anew AAD applicationGrant access to Azure Maps by assigning the suitable role to your service principal. Please refer to theManage authentication page.After setup, you can choose which type ofcredentialfromazure.identityto use.
As an example,DefaultAzureCredentialcan be used to authenticate the client:Next, set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:AZURE_CLIENT_ID,AZURE_TENANT_ID,AZURE_CLIENT_SECRETYou will also need to specify the Azure Maps resource you intend to use by specifying theclientIdin the client options. The Azure Maps resource client id can be found in the Authentication sections in the Azure Maps resource. Please refer to thedocumentationon how to find it.fromazure.maps.searchimportMapsSearchClientfromazure.identityimportDefaultAzureCredentialcredential=DefaultAzureCredential()search_client=MapsSearchClient(credential=credential)Key conceptsThe Azure Maps Search client library for Python allows you to interact with each of the components through the use of a dedicated client object.Sync ClientsMapsSearchClientis the primary client for developers using the Azure Maps Search client library for Python.
Once you initialized aMapsSearchClientclass, you can explore the methods on this client object to understand the different features of the Azure Maps Search service that you can access.Async ClientsThis library includes a complete async API supported on Python 3.5+. To use it, you must first install an async transport, such asaiohttp.
Seeazure-core documentationfor more information.Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define asyncclosemethods.ExamplesThe following sections provide several code snippets covering some of the most common Azure Maps Search tasks, including:Request latitude and longitude coordinates for an addressSearch for an address or Point of InterestMake a Reverse Address Search to translate coordinate location to street addressTranslate coordinate location into a human understandable cross streetGet async fuzzy search batch with param and batchidFail to get fuzzy search batch syncSearch inside GeometryWorking with exist library for SearchRequest latitude and longitude coordinates for an addressYou can use an authenticated client to convert an address into latitude and longitude coordinates. This process is also called geocoding. In addition to returning the coordinates, the response will also return detailed address properties such as street, postal code, municipality, and country/region information.fromazure.maps.searchimportMapsSearchClientsearch_result=client.search_address("400 Broad, Seattle");Search for an address or Point of InterestYou can use Fuzzy Search to search an address or a point of interest (POI). The following examples demostrate how to search forpizzaover the scope of a specific country (France, in this example).fromazure.maps.searchimportMapsSearchClientfuzzy_search_result=client.fuzzy_search(query:"pizza",country_filter:"fr");result_address=fuzzy_search_result.results[0].addressMake a Reverse Address Search to translate coordinate location to street addressYou can translate coordinates into human readable street addresses. This process is also called reverse geocoding.
This is often used for applications that consume GPS feeds and want to discover addresses at specific coordinate points.fromazure.maps.searchimportMapsSearchClientcoordinates=(47.60323,-122.33028)reverse_search_result=client.reverse_search_address(coordinates=coordinates);result_summary=reverse_search_result.summaryTranslate coordinate location into a human understandable cross streetTranslate coordinate location into a human understandable cross street by using Search Address Reverse Cross Street API. Most often, this is needed in tracking applications that receive a GPS feed from a device or asset, and wish to know where the coordinate is located.fromazure.maps.searchimportMapsSearchClientcoordinates=(47.60323,-122.33028)reverse_search_result=client.reverse_search_cross_street_address(coordinates=coordinates);result_address=reverse_search_result.results[0].addressGet async fuzzy search batch with param and batchidThis sample demonstrates how to perform fuzzy search by location and lat/lon with async batch method. This function is accepting bothsearch_queriesandbatch_idand returning anAsyncLROobject. Thebatch_idhere can be use to retrieve the LRO object later which last 14 days.maps_search_client=MapsSearchClient(credential=AzureKeyCredential(subscription_key))asyncwithmaps_search_client:result=awaitmaps_search_client.begin_fuzzy_search_batch(search_queries=["350 5th Ave, New York, NY 10118&limit=1","400 Broad St, Seattle, WA 98109&limit=6"])batch_id=result.batch_idThe methodbegin_fuzzy_search_batch()also acceptsbatch_idas the parameter. Thebatch_idhere can be use to retrieve the LRO object later which last 14 days.maps_search_client=MapsSearchClient(credential=AzureKeyCredential(subscription_key))asyncwithmaps_search_client:result=awaitmaps_search_client.begin_fuzzy_search_batch(batch_id=batch_id)result=result.responseFail to get fuzzy search batch syncThis sample demonstrates how to check if there are failures in search of fuzzy_search_batch.maps_search_client=MapsSearchClient(credential=AzureKeyCredential(subscription_key))result=maps_search_client.fuzzy_search_batch(search_queries=["350 5th Ave, New York, NY 10118&limit=1","400 Broad St, Seattle, WA 98109&lim"])foriteminresult.items:count=0ifitem.response.errorisnotNone:count=count+1print(f"Error:{item.response.error.message}")print(f"There are total of{count}search queries failed.")Search inside GeometryThis sample demonstrates how to perform search inside geometry by given target such aspizzaand multiple different geometry as input with GeoJson object.maps_search_client=MapsSearchClient(credential=AzureKeyCredential(subscription_key))geo_json_obj1={"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-122.143035,47.653536],[-122.187164,47.617556],[-122.114981,47.570599],[-122.132756,47.654009],[-122.143035,47.653536]]]},"properties":{}},{"type":"Feature","geometry":{"type":"Point","coordinates":[-122.126986,47.639754]},"properties":{"subType":"Circle","radius":100}}]}result1=maps_search_client.search_inside_geometry(query="pizza",geometry=geo_json_obj1)print("Search inside geometry with standard GeoJson object as input, FeatureCollection:")print(result1)Working with exist library for SearchThis sample demonstrates how to working with other existing packages such asshapelyto perform search inside geometry by given target such aspizza.maps_search_client=MapsSearchClient(credential=AzureKeyCredential(subscription_key))fromshapely.geometryimportPolygongeo_interface_obj=Polygon([[-122.43576049804686,37.7524152343544],[-122.43301391601562,37.70660472542312],[-122.36434936523438,37.712059855877314],[-122.43576049804686,37.7524152343544]])result3=maps_search_client.search_inside_geometry(query="pizza",geometry=geo_interface_obj)print("Search inside geometry with Polygon from third party library `shapely` with geo_interface as result 3:")print(result2)TroubleshootingGeneralMaps Search clients raise exceptions defined inAzure Core.This list can be used for reference to catch thrown exceptions. To get the specific error code of the exception, use theerror_codeattribute, i.e,exception.error_code.LoggingThis library uses the standardlogginglibrary for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO level.Detailed DEBUG level logging, including request/response bodies and unredacted headers, can be enabled on a client with thelogging_enableargument:importsysimportloggingfromazure.maps.searchimportMapsSearchClient# Create a logger for the 'azure.maps.search' SDKlogger=logging.getLogger('azure.maps.search')logger.setLevel(logging.DEBUG)# Configure a console outputhandler=logging.StreamHandler(stream=sys.stdout)logger.addHandler(handler)Similarly,logging_enablecan enable detailed logging for a single operation,
even when it isn't enabled for the client:service_client.get_service_stats(logging_enable=True)AdditionalStill running into issues? If you encounter any bugs or have suggestions, please file an issue in theIssuessection of the project.Next stepsMore sample codeGet started with ourMaps Search samples(Async Version samples).Several Azure Maps Search Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Maps SearchsetAZURE_SUBSCRIPTION_KEY="<RealSubscriptionKey>"pipinstallazure-maps-search--pre

pythonsamples/sample_authentication.py
pythonsample/sample_fuzzy_search.py
pythonsamples/sample_get_point_of_interest_categories.py
pythonsamples/sample_reverse_search_address.py
pythonsamples/sample_reverse_search_cross_street_address.py
pythonsamples/sample_search_nearby_point_of_interest.py
pythonsamples/sample_search_point_of_interest_category.py
pythonsamples/sample_search_point_of_interest.py
pythonsamples/sample_search_structured_address.pyNotes:--preflag can be optionally added, it is to include pre-release and development versions forpip install. By default,piponly finds stable versions.Further detail please refer toSamples IntroductionAdditional documentationFor more extensive documentation on Azure Maps Search, see theAzure Maps Search documentationon docs.microsoft.com.ContributingThis project welcomes contributions and suggestions.  Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visithttps://cla.microsoft.com.When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.This project has adopted theMicrosoft Open Source Code of Conduct. For more information see theCode of Conduct FAQor contactopencode@microsoft.comwith any additional questions or comments.Release History1.0.0b2 (2022-10-11)Other ChangesUpdate the tests using new test proxyUpdate Doc strings1.0.0b1 (2022-09-06)Initial Release