Newer
Older
Arkindex API Client
===================
:ref:`genindex` - :ref:`modindex` - :ref:`search` - `API documentation <apistar/index.html>`_
``arkindex-client`` provides an API client to interact with Arkindex servers.
Setup
-----
Install the client using ``pip``::
pip install arkindex-client
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
Usage
-----
To create a client and login using an email/password combo,
use the :meth:`ArkindexClient.login` helper method:
.. code:: python
from arkindex import ArkindexClient
cli = ArkindexClient()
cli.login('EMAIL', 'PASSWORD')
This helper method will save the authentication token in your API client, so
that it is reused in later API requests.
If you already have an API token, you can create your client like so:
.. code:: python
from arkindex import ArkindexClient
cli = ArkindexClient('YOUR_TOKEN')
To perform a simple API request, you can use the ``request()`` method. The method
takes an operation ID as a name and the operation's parameters as keyword arguments:
Making requests
^^^^^^^^^^^^^^^
.. code:: python
corpus = cli.request('RetrieveCorpus', id='...')
The result will be a Python ``dict`` containing the result of the API request.
If the request returns an error, an ``apistar.exceptions.ErrorResponse`` will
be raised.
Dealing with pagination
^^^^^^^^^^^^^^^^^^^^^^^
The Arkindex client adds another helper method for paginated endpoints that
deals with pagination for you: :meth:`ArkindexClient.paginate`. This method
returns a :class:`ResponsePaginator` instance, which is a classic Python
iterator that does not perform any actual requests until absolutely needed:
that is, until the next page must be loaded.
.. code:: python
for page in cli.paginate('ListCorpusPages', id=corpus['id']):
print(page['display_name'])
.. warning:
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
Using the ``list`` method on a :class:`ResponsePaginator` may load dozens
of pages at once and cause a big load on the server. You can use ``len`` to
get the total item count before spamming a server.
Using another server
^^^^^^^^^^^^^^^^^^^^
By default, the API client is set to point to the main Arkindex server at
https://arkindex.teklia.com. If you need or want to use this API client on
another server, you can use the ``base_url`` keyword argument when setting up
your API client:
.. code:: python
cli = ArkindexClient(base_url='https://somewhere')
Examples
--------
Print all volumes
^^^^^^^^^^^^^^^^^
.. code:: python
for volume in cli.paginate('ListElements'):
print(volume['name'])
Create transcriptions in bulk
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
payload = {
"parent": "ELEMENT_ID",
"recognizer": "ML_TOOL_SLUG",
"transcriptions": [
{
# A polygon, as a list of at least 3 [x, y] points
"polygon": [
[100, 100],
[100, 300],
[200, 300],
[200, 100],
],
# The confidence score
"score": 0.8,
# Recognized text
"text": "Blah",
# Transcription type: page, paragraph, line, word, character
"type": "word",
},
# ...
]
}
cli.request('CreateTranscriptions', body=payload)
Download full logs for each Ponos task in a workflow
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. code:: python
workflow = cli.request('RetrieveWorkflow', id='...')
for task in workflow['tasks']:
with open(task['id'] + '.txt', 'w') as f:
f.write(cli.request('RetrieveTaskLog', id=task['id']))
Package reference
-----------------
The Arkindex client subclasses the `APIStar client`_ to add helper functions
on top of an `OpenAPI`_ schema found at ``arkindex/schema.yml``.
.. _APIStar client: http://docs.apistar.com/client-library/
.. _OpenAPI: https://www.openapis.org/
:members:
Helper classes
^^^^^^^^^^^^^^