Arkindex API Client =================== **API documentation available at https://arkindex.gitlab.io/api-client/** ``arkindex-client`` provides an API client to interact with Arkindex servers. .. contents:: :depth: 2 :local: :backlinks: none Setup ----- Install the client using ``pip``:: pip install arkindex-client Usage ----- To create a client and login using an email/password combo, use the ``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: ``ArkindexClient.paginate``. This method returns a ``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:** Using ``list`` on a ``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') Uploading a file ^^^^^^^^^^^^^^^^ The underlying API client we use does not currently handle sending anything other than JSON; therefore, the client adds a helper method to upload files to a corpus using the ``UploadDataFile`` endpoint: ``ArkindexClient.upload``. .. code:: python # Any readable file-like object is supported with open('cat.jpg', 'rb') as f: cli.upload('CORPUS_ID', f) # You can also use a path directly cli.upload('CORPUS_ID', 'cat.jpg') 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']))