.. role:: raw-html-m2r(raw)
   :format: html


Azure Cognitive Search client library for Python
================================================

Azure Cognitive Search is a fully managed cloud search service that provides a rich search experience to custom applications.

`Source code <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search>`_ |
`Package (PyPI) <https://pypi.org/project/azure-search/>`_ |
`API reference documentation <https://aka.ms/azsdk-python-search-ref-docs>`_ |
`Product documentation <https://docs.microsoft.com/en-us/azure/search/search-what-is-azure-search>`_ |
`Samples <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples>`_

Getting started
---------------

Prerequisites
^^^^^^^^^^^^^


* Python 2.7, or 3.5 or later is required to use this package.
* You must have an `Azure subscription <https://azure.microsoft.com/free/>`_ and an existing.
  `Azure Cognitive Search service <https://docs.microsoft.com/en-us/azure/search/search-create-service-portal>`_ to use this package.

If you need to create the resource, you can use the `Azure Portal <https://portal.azure.com>`_ or `Azure CLI <https://docs.microsoft.com/cli/azure>`_.

If you use the Azure CLI, replace ``<your-resource-group-name>`` and ``<your-resource-name>`` with your own unique names:

.. code-block:: PowerShell

   az search service create --resource-group <your-resource-group-name> --name <your-resource-name> --sku S

The above creates a resource with the "Standard" pricing tier. See `choosing a pricing tier <https://docs.microsoft.com/en-us/azure/search/search-sku-tier>`_ for more information.

Install the package
^^^^^^^^^^^^^^^^^^^

Install the Azure Cognitive Search client library for Python with `pip <https://pypi.org/project/pip/>`_\ :

.. code-block:: bash

   pip install azure-search --pre

Create an Azure Cognitive Search service
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Using an API Key
^^^^^^^^^^^^^^^^

You can get the Query Keys or Admin Key from the resource information in the
`Azure Portal <https://portal.azure.com>`_.

Alternatively, youcan se the `Azure CLI <https://docs.microsoft.com/cli/azure>`_ snippet below to get the
Admin Key from the Cognitive Search resource.

.. code-block:: PowerShell

   az search admin-key show --resource-group <your-resource-group-name> --service-name <your-resource-name>

Authenticate the client
^^^^^^^^^^^^^^^^^^^^^^^

Interaction with this service begins with an instance of a :raw-html-m2r:`<a href="#client" title="search-client">client</a>`.
To create a client object, you will need the ``endpoint`` for your search service
and a ``credential`` that allows you access:

.. code-block:: python

   from azure.search import SearchApiKeyCredential, SearchIndexClient

   credential = SearchApiKeyCredential("<api key>")

   client = SearchIndexClient(endpoint="<service endpoint>",
                              index_name="<index name>",
                              credential=credential)

Key concepts
------------

Client
^^^^^^

The `Cognitive Search client library <http://azure.github.io/azure-sdk-for-python/ref/Search.html>`_ provides a ``SearchIndexClient`` to perform search operations on :raw-html-m2r:`<a href="#Examples" title="examples">batches of documents</a>`.
It provides both synchronous and asynchronous operations to access a specific use of Cognitive Search indexes, such as querying, suggestions or autocompletion.

Examples
--------

Retrieve a specific document from an index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Get a specific document from the index, e.f. obtain the document for hotel "23":

.. code-block:: python

   from azure.search import SearchApiKeyCredential, SearchIndexClient
   search_client = SearchIndexClient(service_endpoint, index_name, SearchApiKeyCredential(key))

   result = search_client.get_document(key="23")

   print("Details for hotel '23' are:")
   print("        Name: {}".format(result["HotelName"]))
   print("      Rating: {}".format(result["Rating"]))
   print("    Category: {}".format(result["Category"]))

Perform a simple text search on documents
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Search the entire index or documents matching a simple search text, e.g. find
hotels with the text "spa":

.. code-block:: python

   from azure.search import SearchApiKeyCredential, SearchIndexClient
   search_client = SearchIndexClient(service_endpoint, index_name, SearchApiKeyCredential(key))

   results = search_client.search(query="spa")

   print("Hotels containing 'spa' in the name (or other fields):")
   for result in results:
       print("    Name: {} (rating {})".format(result["HotelName"], result["Rating"]))

Get search suggestions
^^^^^^^^^^^^^^^^^^^^^^

Get search suggestions for related terms, e.g. find search suggestions for
the term "coffee":

.. code-block:: python

   from azure.search import SearchApiKeyCredential, SearchIndexClient, SuggestQuery
   search_client = SearchIndexClient(service_endpoint, index_name, SearchApiKeyCredential(key))

   query = SuggestQuery(search_text="coffee", suggester_name="sg")

   results = search_client.suggest(query=query)

   print("Search suggestions for 'coffee'")
   for result in results:
       hotel = search_client.get_document(key=result["HotelId"])
       print("    Text: {} for Hotel: {}".format(repr(result["text"]), hotel["HotelName"]))

Upload documents to an index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Add documents (or update existing ones), e.g add a new document for a new hotel:

.. code-block:: python

   from azure.search import SearchApiKeyCredential, SearchIndexClient
   search_client = SearchIndexClient(service_endpoint, index_name, SearchApiKeyCredential(key))

   DOCUMENT = {
       'Category': 'Hotel',
       'HotelId': '1000',
       'Rating': 4.0,
       'Rooms': [],
       'HotelName': 'Azure Inn',
   }

   result = search_client.upload_documents(documents=[DOCUMENT])

   print("Upload of new document succeeded: {}".format(result[0].succeeded))

Troubleshooting
---------------

General
^^^^^^^

The Azure Cognitive Search client will raise exceptions defined in `Azure Core <https://github.com/Azure/azure-sdk-for-python/tree/e1fb463304139b1baf274d2d6f124f955080cd52/sdk/core/azure-core/README.md>`_.

Logging
^^^^^^^

This library uses the standard `logging <https://docs.python.org/3.5/library/logging.html>`_ library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.

etailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the ``logging_enable`` keyword argument:

.. code-block:: python

   import sys
   import logging
   from azure.search import SearchApiKeyCredential, SearchIndexClient

   # Create a logger for the 'azure' SDK
   logger = logging.getLogger('azure')
   logger.setLevel(logging.DEBUG)

   # Configure a console output
   handler = logging.StreamHandler(stream=sys.stdout)
   logger.addHandler(handler)

   # This client will log detailed information about its HTTP sessions, at DEBUG level
   search_client = SearchIndexClient(service_endpoint, index_name, SearchApiKeyCredential(key), logging_enable=True)

Similarly, ``logging_enable`` can enable detailed logging for a single operation,
even when it isn't enabled for the client:

.. code-block:: python

   result =  search_client.search(query="spa", logging_enable=True)

Next steps
----------

More sample code
^^^^^^^^^^^^^^^^

Authenticate the client with a Azure Cognitive Search `API Key Credential <https://docs.microsoft.com/en-us/azure/search/search-security-api-keys>`_\ :

`sample_authentication.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_authentication.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_authentication_async.py>`_\ )

Then for common search index operations:


* 
  Get a document by key: `sample_get_document.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_get_document.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_get_document_async.py>`_\ )

* 
  Perform a simple text query: `sample_simple_query.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_simple_query.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_simple_query_async.py>`_\ )

* 
  Perform a filtered query: `sample_filter_query.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_filter_query.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_filter_query_async.py>`_\ )

* 
  Perform a faceted query: `sample_facet_query.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_facet_query.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_facet_query_async.py>`_\ )

* 
  Get auto-completions: `sample_autocomplete.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_autocomplete.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_autocomplete_async.py>`_\ )

* 
  Get search suggestions: `sample_suggestions.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_suggestions.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_suggestions_async.py>`_\ )

* 
  Perform basic document updates: `sample_crud_operations.py <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/sample_crud_operations.py>`_ (\ `async version <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/search/azure-search/samples/async_samples/sample_crud_operations_async.py>`_\ )

Additional documentation
^^^^^^^^^^^^^^^^^^^^^^^^

For more extensive documentation on Cognitive Search, see the `Azure Cognitive Search documentation <https://docs.microsoft.com/en-us/azure/search/>`_ on docs.microsoft.com.

Contributing
------------

This 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, visit `cla.microsoft.com <https://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 the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`_. For more information see the `Code of Conduct FAQ <https://opensource.microsoft.com/codeofconduct/faq/>`_ or contact `opencode@microsoft.com <mailto:opencode@microsoft.com>`_ with any additional questions or comments.

Related projects
----------------


* `Microsoft Azure SDK for Python <https://github.com/Azure/azure-sdk-for-python>`_


.. raw:: html

   <!-- LINKS -->




.. image:: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fsearch%2Fazure-search%2FREADME.png
   :target: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fsearch%2Fazure-search%2FREADME.png
   :alt: Impressions



Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
  :maxdepth: 5
  :glob:
  :caption: Developer Documentation

  azure.search.rst