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


Azure Ink Recognizer client library for Python
==============================================

Azure Ink Recognizer SDK is an SDK for developers to work with Azure Ink Recognizer Service. The service recognize a collection of ink strokes and return a tree hierarchy of the recognized units, such as lines, words, shapes, as well as the handwriting recognition result of the words.

Features:


* Connect to Azure Ink Recognizer Service
* Convert collections of ink strokes into HTTP requests
* Parse HTTP response into ink recognition units

`Source code <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cognitiveservices/azure-cognitiveservices-inkrecognizer>`_ | `Package (PyPi) <https://pypi.org/project/azure-cosmos/>`_ | `API reference documentation <https://>`_ | `Product documentation <https://docs.microsoft.com/azure/cognitive-services/ink-recognizer/>`_ | `Samples <https://github.com/Azure-Samples/cognitive-services-python-sdk-samples/tree/master/samples/vision>`_

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

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

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

.. code-block:: Bash

   pip install azure-cognitiveservices-inkrecognizer

**Prerequisites**\ : You must have an `Azure subscription <https://azure.microsoft.com/free/>`_. You must have `Python 2.7 <https://www.python.org/downloads/>`_ or `Python 3.5.3+ <https://www.python.org/downloads/>`_ to use this package. Asynchronous features supports Python 3.5.3+ only.

Get URL
~~~~~~~

Please find the URL at `Ink Recognizer Rest API documentation <https://docs.microsoft.com/rest/api/cognitiveservices/inkrecognizer/inkrecognizer/recognize>`_

Get credentials
~~~~~~~~~~~~~~~

Please follow the instructions on `Ink Recognizer <https://azure.microsoft.com/services/cognitive-services/ink-recognizer/>`_.

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

Implement ink stroke
^^^^^^^^^^^^^^^^^^^^

If you don't have any pre-defined ink point or ink stroke classes, you can either follow the `Ink Stroke Interfaces <https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/cognitiveservices/azure-cognitiveservices-inkrecognizer/azure/cognitiveservices/inkrecognizer/_ink_stroke.py>`_ to build your stroke, or build your own class that has all required fields. If you already defined ink strokes yourself, you should feed attributes in your class according to the interfaces.

.. code-block:: Python

   from azure.cognitiveservices.inkrecognizer import InkStrokeKind

   InkPoint = namedtuple("InkPoint", "x y")

   class InkStroke():
       def __init__(self,
                    ink_stroke_id,
                    ink_points,
                    stroke_kind=InkStrokeKind.UNKNOWN,
                    stroke_language=""):
           self.id = ink_stroke_id
           self.points = ink_points
           self.kind = stroke_kind
           self.language = stroke_language

You can then create a list (or any iterable object) of ink strokes for recognition.

Create a client
^^^^^^^^^^^^^^^

Once you got the url for ink recognizer service and an Azure credential instance, you can create an InkRecognizerClient

.. code-block:: Python

   from azure.cognitiveservices.inkrecognizer import InkRecognizerClient
   client = InkRecognizerClient(url, api_key)  # api_key is your key as string

Or use Async version (Python 3.5.3+ only)

.. code-block:: Python

   from azure.cognitiveservices.inkrecognizer.aio import InkRecognizerClient
   client = InkRecognizerClient(url, api_key)  # api_key is your key as string

Send a request
^^^^^^^^^^^^^^

You can then send stroke list to Ink Recognizer Service and get the root of all ink recognition results.

.. code-block:: Python

   # Sync version
   recognition_root = client.recognize_ink(ink_stroke_list)
   # Async version
   recognition_root = await client.recognize_ink(ink_stroke_list)

Get recognition units from results
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can get all the recognition units either by InkRecognitionUnitKind or by hierarchy, then visit support properties of the units. `API reference documentation <https://>`_

.. code-block:: Python

   lines = recognition_root.lines
   for line in lines:
       foo_show_bounding_box(line.bounding_box)
       for word in line.words:
           print(word.recognized_text)

Examples
--------

The `Samples <https://github.com/Azure-Samples/cognitive-services-python-sdk-samples/tree/master/samples/vision>`_ provide several code snippets covering some of the most common Ink Recognizer SDK tasks, including:


* Implement InkPoint and InkStroke classes
* Convert stroke unit from pixel to mm
* Set language recognition locale
* Indexing a key word from recognition results
* Set application kind if user know expected type of ink content

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

General
^^^^^^^

Ink Recognizer clients raise exceptions defined in azure-core. For example, if you try to reach an invalid URL, InkRecognizerClient raises ResourceNotFoundError:

.. code-block:: Python

   from azure.core.exceptions import ResourceNotFoundError
   client = InkRecognizerClient("invalid_url", credential)

   try:
       client.recognize_ink(ink_strokes)
   except ResourceNotFoundError as e:
       print(e.message)

Logging
^^^^^^^

Network trace logging is disabled by default for this library. When enabled, HTTP requests will be logged at DEBUG level using the logging library. You can configure logging to print debugging information to stdout or write it to a file:

.. code-block:: Python

   import sys
   import logging

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

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

   # Configure a file output
   file_handler = logging.FileHandler(filename)
   logger.addHandler(file_handler)

   # Enable network trace logging. Each HTTP request will be logged at DEBUG level.
   client = InkRecognizerClient(url=url, credential=credential, logging_enable=True)

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

Please find interactive inking samples at `tkinter sample <https://github.com/Azure-Samples/cognitive-services-python-sdk-samples/tree/master/samples/vision/inkrecognizer_tkinter_sample.py>`_ and `wxpython sample <https://github.com/Azure-Samples/cognitive-services-python-sdk-samples/tree/master/samples/vision/inkrecognizer_tkinter_sample.py>`_.

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

For more extensive documentation on the Ink Recognizer Service, see the `Ink Recognizer Service Documentation <https://docs.microsoft.com/azure/cognitive-services/ink-recognizer/>`_.

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 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.cognitiveservices.inkrecognizer.rst