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


Azure Personalizer client library for Python
============================================

`Azure Personalizer <https://docs.microsoft.com/azure/cognitive-services/personalizer/>`_
is a cloud-based service that helps your applications choose the best content item to show your users. You can use the Personalizer service to determine what product to suggest to shoppers or to figure out the optimal position for an advertisement. After the content is shown to the user, your application monitors the user's reaction and reports a reward score back to the Personalizer service. This ensures continuous improvement of the machine learning model, and Personalizer's ability to select the best content item based on the contextual information it receives.

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

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


* Python 3.7 or later is required to use this package.
* You must have an `Azure subscription <https://azure.microsoft.com/free>`_ and a
  `Personalizer resource <https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account?tabs=multiservice%2Cwindows>`_ to use this package.

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

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

.. code-block:: bash

   pip install azure-ai-personalizer

..

   Note: This version of the client library defaults to the ``2022-09-01-preview`` version of the service.


This table shows the relationship between SDK versions and supported API versions of the service:

.. list-table::
   :header-rows: 1

   * - SDK version
     - Supported API version of service
   * - 1.0.0b1
     - 2022-09-01-preview


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

PersonalizerClient
^^^^^^^^^^^^^^^^^^

The `synchronous PersonalizerClient <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/_client.py>`_ and
`asynchronous PersonalizerClient <https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/aio/_client.py>`_ provide synchronous and asynchronous operations to:


* Manage the machine learning model and learning settings for the Personalizer service.
* Manage the properties of the Personalizer service such as the `learning mode <https://docs.microsoft.com/azure/cognitive-services/personalizer/what-is-personalizer#learning-modes>`_\ , `exploration percentage <https://docs.microsoft.com/azure/cognitive-services/personalizer/concepts-exploration>`_.
* Run counterfactual evaluations on prior historical event data.
* Rank a set of actions, then activate and reward the event. 
* Use `multi-slot personalization <https://docs.microsoft.com/azure/cognitive-services/personalizer/concept-multi-slot-personalization>`_ when there are more than one slots.
* Manage the properties of the Personalizer service.
* Run counterfactual evaluations on prior historical event data.

Examples
--------

The following examples outline the main scenarios when using personalizer in single-slot and multi-slot configurations.


* :raw-html-m2r:`<a href="#send-rank-and-reward" title="Send rank and reward">Send rank and reward when using a single slot</a>`
* :raw-html-m2r:`<a href="#send-multi-slot-rank-and-reward" title="Send multi-slot rank and reward">Send rank and reward when using multiple slots</a>`

Send rank and reward
^^^^^^^^^^^^^^^^^^^^

.. code-block:: python

   from azure.ai.personalizer import PersonalizerClient
   from azure.core.credentials import AzureKeyCredential

   endpoint = "https://<my-personalizer-instance>.cognitiveservices.azure.com/"
   credential = AzureKeyCredential("<api_key>")

   client = PersonalizerClient(endpoint, credential)

   # The list of actions to be ranked with metadata associated for each action.
   actions = [
       {
           "id": "Video1",
           "features": [
               {"videoType": "documentary", "videoLength": 35, "director": "CarlSagan"},
               {"mostWatchedByAge": "50-55"},
           ],
       },
       {
           "id": "Video2",
           "features": [
               {"videoType": "movie", "videoLength": 120, "director": "StevenSpielberg"},
               {"mostWatchedByAge": "40-45"},
           ],
       },
   ]

   # Context of the user to which the action must be presented.
   context_features = [
       {"currentContext": {"day": "tuesday", "time": "night", "weather": "rainy"}},
       {
           "userContext": {
               "payingUser": True,
               "favoriteGenre": "documentary",
               "hoursOnSite": 0.12,
               "lastWatchedType": "movie",
           },
       },
   ]

   request = {
       "actions": actions,
       "contextFeatures": context_features,
   }

   rank_response = client.rank(request)
   print("Sending reward event")
   client.reward(rank_response.get("eventId"), {"value": 1.0})

Send multi-slot rank and reward
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: python

   from azure.ai.personalizer import PersonalizerClient
   from azure.core.credentials import AzureKeyCredential

   endpoint = "https://<my-personalizer-instance>.cognitiveservices.azure.com/"
   credential = AzureKeyCredential("<api_key>")

   client = PersonalizerClient(endpoint, credential)

   # We want to rank the actions for two slots.
   slots = [
       {
           "id": "Main Article",
           "baselineAction": "NewsArticle",
           "positionFeatures": [{"Size": "Large", "Position": "Top Middle"}],
       },
       {
           "id": "Side Bar",
           "baselineAction": "SportsArticle",
           "positionFeatures": [{"Size": "Small", "Position": "Bottom Right"}],
       },
   ]

   # The list of actions to be ranked with metadata associated for each action.
   actions = [
       {"id": "NewsArticle", "features": [{"type": "News"}]},
       {"id": "SportsArticle", "features": [{"type": "Sports"}]},
       {"id": "EntertainmentArticle", "features": [{"type": "Entertainment"}]},
   ]

   # Context of the user to which the action must be presented.
   context_features = [
       {"user": {"profileType": "AnonymousUser", "latLong": "47.6,-122.1"}},
       {"environment": {"dayOfMonth": "28", "monthOfYear": "8", "weather": "Sunny"}},
       {"device": {"mobile": True, "windows": True}},
       {"recentActivity": {"itemsInCart": 3}},
   ]

   request = {
       "slots": slots,
       "actions": actions,
       "contextFeatures": context_features,
   }
   rank_response = client.rank_multi_slot(request)
   print("Sending reward event for Main Article slot")
   client.reward_multi_slot(
       rank_response.get("eventId"),
       {"reward": [{"slotId": "Main Article", "value": 1.0}]})

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

General
^^^^^^^

Personalizer client library will raise exceptions defined in `Azure Core <https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions>`_.

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 the client or per-operation with the ``logging_enable`` keyword argument.

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

Optional Configuration
^^^^^^^^^^^^^^^^^^^^^^

Optional keyword arguments can be passed in at the client and per-operation level.
The azure-core `reference documentation <https://aka.ms/azsdk/python/core/docs>`_
describes available configurations for retries, logging, transport protocols, and more.

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

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.

:raw-html-m2r:`<!-- LINKS -->`


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

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

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

  azure.ai.personalizer.rst