.. image:: https://dev.azure.com/azure-sdk/public/_apis/build/status/azure-sdk-for-python.client?branchName=main
   :target: https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=46?branchName=main
   :alt: Build Status


Azure Cognitive Language Services Question Answering client library for Python
==============================================================================

Question Answering is a cloud-based API service that lets you create a conversational question-and-answer layer over your existing data. Use it to build a knowledge base by extracting questions and answers from your semi-structured content, including FAQ, manuals, and documents. Answer users’ questions with the best answers from the QnAs in your knowledge base—automatically. Your knowledge base gets smarter, too, as it continually learns from users' behavior.

`Source code <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering/>`_ | `Package (PyPI) <https://pypi.org/project/azure-ai-language-questionanswering/>`_ | `API reference documentation <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-questionanswering/latest/azure.ai.language.questionanswering.html>`_ | `Product documentation <https://azure.microsoft.com/services/cognitive-services/qna-maker/>`_ | `Samples <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering/samples/README.md>`_

*Disclaimer*
----------------

*Azure SDK Python packages support for Python 2.7 is ending 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691*

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

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


* Python 2.7, or 3.6 or later is required to use this package.
* An `Azure subscription <https://azure.microsoft.com/free/>`_
* An existing Question Answering resource

..

   Note: the new unified Cognitive Language Services are not currently available for deployment.


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

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

.. code-block:: bash

   pip install azure-ai-language-questionanswering

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

In order to interact with the Question Answering service, you'll need to create an instance of the `QuestionAnsweringClient <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-questionanswering/latest/azure.ai.language.questionanswering.html#azure.ai.language.questionanswering.QuestionAnsweringClient>`_ class or an instance of the `QuestionAnsweringProjectsClient <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering/azure/ai/language/questionanswering/projects/_question_answering_projects_client.py>`_ for managing projects within your resource. You will need an **endpoint**\ , and an **API key** to instantiate a client object. For more information regarding authenticating with Cognitive Services, see `Authenticate requests to Azure Cognitive Services <https://docs.microsoft.com/azure/cognitive-services/authentication/>`_.

Get an API key
~~~~~~~~~~~~~~

You can get the **endpoint** and an **API key** from the Cognitive Services resource or Question Answering resource in the `Azure Portal <https://portal.azure.com/>`_.

Alternatively, use the `Azure CLI <https://docs.microsoft.com/cli/azure/>`_ command shown below to get the API key from the Question Answering resource.

.. code-block:: powershell

   az cognitiveservices account keys list --resource-group <resource-group-name> --name <resource-name>

Create QuestionAnsweringClient
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Once you've determined your **endpoint** and **API key** you can instantiate a ``QuestionAnsweringClient``\ :

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.language.questionanswering import QuestionAnsweringClient

   endpoint = "https://{myaccount}.api.cognitive.microsoft.com"
   credential = AzureKeyCredential("{api-key}")

   client = QuestionAnsweringClient(endpoint, credential)

Create QuestionAnsweringProjectsClient
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

With your endpoint and API key, you can instantiate a `QuestionAnsweringProjectsClient <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering/azure/ai/language/questionanswering/projects/_question_answering_projects_client.py>`_\ :

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.language.questionanswering.projects import QuestionAnsweringProjectsClient

   endpoint = "https://{myaccount}.api.cognitive.microsoft.com"
   credential = AzureKeyCredential("{api-key}")

   client = QuestionAnsweringProjectsClient(endpoint, credential)

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

QuestionAnsweringClient
^^^^^^^^^^^^^^^^^^^^^^^

The `QuestionAnsweringClient <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-questionanswering/latest/azure.ai.language.questionanswering.html#azure.ai.language.questionanswering.QuestionAnsweringClient>`_ is the primary interface for asking questions using a knowledge base with your own information, or text input using pre-trained models.
For asynchronous operations, an async ``QuestionAnsweringClient`` is in the ``azure.ai.language.questionanswering.aio`` namespace.

QuestionAnsweringProjectsClient
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The `QuestionAnsweringProjectsClient <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering/azure/ai/language/questionanswering/projects/_question_answering_projects_client.py>`_ provides an interface for managing Question Answering projects. Examples of the available operations include creating and deploying projects, updating your knowledge sources, and updating question and answer pairs. It provides both synchronous and asynchronous APIs.

Examples
--------

QuestionAnsweringClient
^^^^^^^^^^^^^^^^^^^^^^^

The ``azure-ai-language-questionanswering`` client library provides both synchronous and asynchronous APIs.

The following examples show common scenarios using the ``client`` `created above <#create-questionansweringclient>`_.


* `Ask a question <#ask-a-question>`_
* `Ask a follow-up question <#ask-a-follow-up-question>`_
* `Asynchronous operations <#asynchronous-operations>`_

Ask a question
~~~~~~~~~~~~~~

The only input required to ask a question using a knowledge base is just the question itself:

.. code-block:: python

   output = client.get_answers(
       question="How long should my Surface battery last?",
       project_name="FAQ",
       deployment_name="test"
   )
   for candidate in output.answers:
       print("({}) {}".format(candidate.confidence, candidate.answer))
       print("Source: {}".format(candidate.source))

You can set additional keyword options to limit the number of answers, specify a minimum confidence score, and more.

Ask a follow-up question
~~~~~~~~~~~~~~~~~~~~~~~~

If your knowledge base is configured for `chit-chat <https://docs.microsoft.com/azure/cognitive-services/qnamaker/how-to/chit-chat-knowledge-base>`_\ , the answers from the knowledge base may include suggested `prompts for follow-up questions <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-language-questionanswering/latest/azure.ai.language.questionanswering.models.html#azure.ai.language.questionanswering.models.KnowledgeBaseAnswerDialog>`_ to initiate a conversation. You can ask a follow-up question by providing the ID of your chosen answer as the context for the continued conversation:

.. code-block:: python

   from azure.ai.language.questionanswering import models

   output = client.get_answers(
       question="How long should charging take?",
       answer_context=models.KnowledgeBaseAnswerContext(
           previous_qna_id=previous_answer.qna_id
       ),
       project_name="FAQ",
       deployment_name="live"
   )
   for candidate in output.answers:
       print("({}) {}".format(candidate.confidence, candidate.answer))
       print("Source: {}".format(candidate.source))

Asynchronous operations
~~~~~~~~~~~~~~~~~~~~~~~

The above examples can also be run asynchronously using the client in the ``aio`` namespace:

.. code-block:: python

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.language.questionanswering.aio import QuestionAnsweringClient

   client = QuestionAnsweringClient(endpoint, credential)

   output = await client.get_answers(
       question="How long should my Surface battery last?",
       project_name="FAQ",
       deployment_name="production"
   )

QuestionAnsweringProjectsClient
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create a new project
~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

   import os
   from azure.core.credentials import AzureKeyCredential
   from azure.ai.language.questionanswering.projects import QuestionAnsweringProjectsClient

   # get service secrets
   endpoint = os.environ["AZURE_QUESTIONANSWERING_ENDPOINT"]
   key = os.environ["AZURE_QUESTIONANSWERING_KEY"]

   # create client
   client = QuestionAnsweringProjectsClient(endpoint, AzureKeyCredential(key))
   with client:

       # create project
       project_name = "IssacNewton"
       project = client.create_project(
           project_name=project_name,
           options={
               "description": "biography of Sir Issac Newton",
               "language": "en",
               "multilingualResource": True,
               "settings": {
                   "defaultAnswer": "no answer"
               }
           })

       print("view created project info:")
       print("\tname: {}".format(project["projectName"]))
       print("\tlanguage: {}".format(project["language"]))
       print("\tdescription: {}".format(project["description"]))

Add a knowledge source
~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

   update_sources_poller = client.begin_update_sources(
       project_name=project_name,
       sources=[
           {
               "op": "add",
               "value": {
                   "displayName": "Issac Newton Bio",
                   "sourceUri": "https://wikipedia.org/wiki/Isaac_Newton",
                   "sourceKind": "url"
               }
           }
       ]
   )
   update_sources_poller.result()

   # list sources
   print("list project sources")
   sources = client.list_sources(
       project_name=project_name
   )
   for source in sources:
       print("project: {}".format(source["displayName"]))
       print("\tsource: {}".format(source["source"]))
       print("\tsource Uri: {}".format(source["sourceUri"]))
       print("\tsource kind: {}".format(source["sourceKind"]))

Deploy your project
~~~~~~~~~~~~~~~~~~~

.. code-block:: python

   # deploy project
   deployment_poller = client.begin_deploy_project(
       project_name=project_name,
       deployment_name="production"
   )
   deployment_poller.result()

   # list all deployments
   deployments = client.list_deployments(
       project_name=project_name
   )

   print("view project deployments")
   for d in deployments:
       print(d)

Optional Configuration
----------------------

Optional keyword arguments can be passed in at the client and per-operation level. The azure-core `reference documentation <https://azuresdkdocs.blob.core.windows.net/$web/python/azure-core/latest/azure.core.html>`_ describes available configurations for retries, logging, transport protocols, and more.

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

General
^^^^^^^

Azure QuestionAnswering clients raise exceptions defined in `Azure Core <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/core/azure-core/README.md>`_.
When you interact with the Cognitive Language Services Question Answering client library using the Python SDK, errors returned by the service correspond to the same HTTP status codes returned for `REST API <https://docs.microsoft.com/rest/api/cognitiveservices-qnamaker/>`_ requests.

For example, if you submit a question to a non-existant knowledge base, a ``400`` error is returned indicating "Bad Request".

.. code-block:: python

   from azure.core.exceptions import HttpResponseError

   try:
       client.get_answers(
           question="Why?",
           project_name="invalid-knowledge-base",
           deployment_name="test"
       )
   except HttpResponseError as error:
       print("Query failed: {}".format(error.message))

Logging
^^^^^^^

This library uses the standard
`logging <https://docs.python.org/3/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`` argument.

See full SDK logging documentation with examples `here <https://docs.microsoft.com/azure/developer/python/azure-sdk-logging>`_.

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


* View our `samples <https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/cognitivelanguage/azure-ai-language-questionanswering/samples/README.md>`_.
* Read about the different `features <https://azure.microsoft.com/services/cognitive-services/qna-maker/#features>`_ of the Question Answering service.
* Try our service `demos <https://azure.microsoft.com/services/cognitive-services/qna-maker/#demo>`_.

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

See the `CONTRIBUTING.md <https://github.com/Azure/azure-sdk-for-python/blob/main/CONTRIBUTING.md>`_ for details on building, testing, and contributing to this library.

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.


.. raw:: html

   <!-- LINKS -->




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



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

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

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

  azure.ai.language.questionanswering.rst