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-documents>`_ |
`Package (PyPI) <https://pypi.org/project/azure-search-documents/>`_ |
`API reference documentation <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/index.html>`_ |
`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/93c10270978f1d8c9d3728609866a8408c437630/sdk/search/azure-search-documents/samples>`_

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

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-documents --pre

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://docs.microsoft.com/azure/search/search-create-service-portal>`_\ , `Azure PowerShell <https://docs.microsoft.com/azure/search/search-manage-powershell#create-or-delete-a-service>`_\ , or the `Azure CLI <https://docs.microsoft.com/cli/azure/search/service?view=azure-cli-latest#az-search-service-create>`_.

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 Standard

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.

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

In order to interact with the Cognitive Search service you'll need to create an instance of the Search Client class.
To make this possible you will need an `api-key of the Cognitive Search service <https://docs.microsoft.com/en-us/azure/search/search-security-api-keys>`_.

The SDK provides three clients.


#. SearchClient for all document operations.
#. SearchIndexClient for all CRUD operations on index resources.
#. SearchIndexerClient for all CRUD operations on indexer resources.

Create a SearchClient
~~~~~~~~~~~~~~~~~~~~~

To create a SearchClient, you will need an existing index name as well as the values of the Cognitive Search Service
`service endpoint <https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint>`_ and
`api key <https://docs.microsoft.com/en-us/azure/search/search-security-api-keys>`_.
Note that you will need an admin key to index documents (query keys only work for queries).

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient

   credential = AzureKeyCredential("<api key>")

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

Create a SearchIndexClient
~~~~~~~~~~~~~~~~~~~~~~~~~~

Once you have the values of the Cognitive Search Service `service endpoint <https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint>`_
and `api key <https://docs.microsoft.com/en-us/azure/search/search-security-api-keys>`_ you can create the Search Index client:

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes import SearchIndexClient

   credential = AzureKeyCredential("<api key>")

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

Create a SearchIndexerClient
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Once you have the values of the Cognitive Search Service `service endpoint <https://docs.microsoft.com/en-us/azure/search/search-create-service-portal#get-a-key-and-url-endpoint>`_
and `api key <https://docs.microsoft.com/en-us/azure/search/search-security-api-keys>`_ you can create the Search Indexer client:

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes import SearchIndexerClient

   credential = AzureKeyCredential("<api key>")

   client = SearchIndexerClient(endpoint="<service endpoint>",
                                credential=credential)

Send your first search request
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can use the ``SearchClient`` you created in the first section above to make a basic search request:

.. code-block:: python

   results = client.search(search_text="spa")

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

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

Azure Cognitive Search has the concepts of search services and indexes and documents, where a search service contains
one or more indexes that provides persistent storage of searchable data, and data is loaded in the form of JSON documents.
Data can be pushed to an index from an external data source, but if you use an indexer, it's possible to crawl a data
source to extract and load data into an index.

There are several types of operations that can be executed against the service:


* **Index management operations** Create, delete, update, or configure a search index. (\ `API Reference <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/azure.search.documents.html#azure.search.documents.SearchIndexesClient>`_\ , `Service Docs <https://docs.microsoft.com/en-us/rest/api/searchservice/index-operations>`_\ )
* **Document operations** Add, update, or delete documents in the index, query the index, or look up specific documents by ID. (\ `API Reference <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/azure.search.documents.html#azure.search.documents.SearchClient>`_\ , `Service Docs <https://docs.microsoft.com/en-us/rest/api/searchservice/document-operations>`_\ )
* **Datasource operations** Create, delete, update, or configure data sources for Search Indexers (\ `API Reference <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/azure.search.documents.html#azure.search.documents.SearchDataSourcesClient>`_\ , `Service Docs <https://docs.microsoft.com/en-us/rest/api/searchservice/indexer-operations>`_\ )
* **Indexer operations** Automate aspects of an indexing operation by configuring a data source and an indexer that you can schedule or run on demand. This feature is supported for a limited number of data source types. (\ `API Reference <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/azure.search.documents.html#azure.search.documents.SearchIndexersClient>`_\ , `Service Docs <https://docs.microsoft.com/en-us/rest/api/searchservice/indexer-operations>`_\ )
* **Skillset operations** Part of a cognitive search workload, a skillset defines a series of a series of enrichment processing steps. A skillset is consumed by an indexer. (\ `API Reference <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/azure.search.documents.html#azure.search.documents.SearchSkillsetsClient>`_\ , `Service Docs <https://docs.microsoft.com/en-us/rest/api/searchservice/skillset-operations>`_\ )
* **Synonym map operations** A synonym map is a service-level resource that contains user-defined synonyms. This resource is maintained independently from search indexes. Once uploaded, you can point any searchable field to the synonym map (one per field). (\ `API Reference <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-search-documents/latest/azure.search.documents.html#azure.search.documents.SearchSynonymMapsClient>`_\ , `Service Docs <https://docs.microsoft.com/en-us/rest/api/searchservice/synonym-map-operations>`_\ )

Examples
--------

The following sections contain snippets for some common operations:


* `Perform a simple text search <#perform-a-simple-text-search-on-documents>`_
* `Retrieve a specific document <#retrieve-a-specific-document-from-an-index>`_
* `Get search suggestions <#get-search-suggestions>`_
* `Create an index <#create-an-index>`_
* `Upload documents to an index <#upload-documents-to-an-index>`_

More examples, covering topics such as indexers, skillets, and synonym maps can be found in the `Samples directory <https://github.com/Azure/azure-sdk-for-python/tree/93c10270978f1d8c9d3728609866a8408c437630/sdk/search/azure-search-documents/samples>`_.

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.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient
   client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("<api key>"))

   results = client.search(search_text="spa")

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

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.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient
   client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("<api key>"))

   result = 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"]))

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

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

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient
   client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("<api key>"))

   results = client.suggest(search_text="coffee", suggester_name="sg")

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

Create an index
^^^^^^^^^^^^^^^

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes import SearchIndexClient, CorsOptions, SearchIndex, ScoringProfile
   client = SearchIndexClient("<service endpoint>", AzureKeyCredential("<api key>"))
   name = "hotels"
   fields = [
           SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True),
           SimpleField(name="baseRate", type=SearchFieldDataType.Double),
           SearchableField(name="description", type=SearchFieldDataType.String),
           ComplexField(name="address", fields=[
               SimpleField(name="streetAddress", type=SearchFieldDataType.String),
               SimpleField(name="city", type=SearchFieldDataType.String),
           ])
       ]
   cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60)
   scoring_profiles = []

   index = SearchIndex(
       name=name,
       fields=fields,
       scoring_profiles=scoring_profiles,
       cors_options=cors_options)

   result = client.create_index(index)

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.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient
   client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("<api key>"))

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

   result = 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/93c10270978f1d8c9d3728609866a8408c437630/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.

Detailed 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.core.credentials import AzureKeyCredential
   from azure.search.documents import SearchClient

   # 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
   client = SearchClient("<service endpoint>", "<index_name>", AzureKeyCredential("<api 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 =  client.search(search_text="spa", logging_enable=True)

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

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-documents%2FREADME.png
   :target: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fsearch%2Fazure-search-documents%2FREADME.png
   :alt: Impressions



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

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

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

  azure.search.documents.rst