Python client for Infermedica API
$ pip install infermedica-api
$ easy_install infermedica-api
First of all register for a developer account and obtain your app_id and app_key at Infermedica Developer Portal.
Configure a global API object to easily use it everywhere:
import infermedica_api infermedica_api.configure(app_id='YOUR_APP_ID', app_key='YOUR_APP_KEY')
... and then in any module just import infermedica module and get configured API object:
import infermedica_api api = infermedica_api.get_api()
Configure through a non-global API object:
import infermedica_api api = infermedica_api.API(app_id='YOUR_APP_ID', app_key='YOUR_APP_KEY') print(api.info())
Both of the above options to configure API object take an optional parameter
api_version, which determines the version of Infermedica API to be used. For the current version the default API version is set automatically to
v2 and this is the recommended version to use.
Here is an example of how to use the API to get a list of patient's likely diagnoses.
import infermedica_api api = infermedica_api.get_api() # Create diagnosis object with initial patient information. # Note that time argument is optional here as well as in the add_symptom function request = infermedica_api.Diagnosis(sex='male', age=35) request.add_symptom('s_21', 'present') request.add_symptom('s_98', 'present') request.add_symptom('s_107', 'absent') # call diagnosis request = api.diagnosis(request) # Access question asked by API print(request.question) print(request.question.text) # actual text of the question print(request.question.items) # list of related evidences with possible answers print(request.question.items['id']) print(request.question.items['name']) print(request.question.items['choices']) # list of possible answers print(request.question.items['choices']['id']) # answer id print(request.question.items['choices']['label']) # answer label # Access list of conditions with probabilities print(request.conditions) print(request.conditions['id']) print(request.conditions['name']) print(request.conditions['probability']) # Next update the request and get next question: # Just example, the id and answer shall be taken from the real user answer request.add_symptom(request.question.items['id'], request.question.items['choices']['id']) # call diagnosis method again request = api.diagnosis(request) # ... and so on, until you decide to stop the diagnostic interview.
Note that after each diagnosis call, the request object gets updated and you can obtain a diagnostic question to ask. You can also update the request object with new observations or risk factors to get even more precise diagnostic insights and new questions to verify.
For more take a look at provided examples.
The library provide it's own set of exceptions, which may be raised on any of the API calls. The following methods
risk_factor_list may raise one of the following exceptions:
infermedica_api.exceptions.BadRequest infermedica_api.exceptions.UnauthorizedAccess infermedica_api.exceptions.ForbiddenAccess infermedica_api.exceptions.ResourceNotFound infermedica_api.exceptions.MethodNotAllowed infermedica_api.exceptions.ServerError infermedica_api.exceptions.ConnectionError
There are also three additional exception that may occur:
MissingConfiguration is raised during the
get_api call if the API for given alias was not configured or the default API has not been configured, while calling
get_api without alias parameter.
MethodNotAvailableInAPIVersion is raised if one try to use method from different API version.
InvalidSearchFilter is raised when wrong filters are applied to the
search API call.
To easily run examples edit
examples/config.py file and enter your account credentials.
Then go to
examples folder and just run the following:
$ python search.py
$ python parse.py
$ python symptoms.py
$ python risk_factors.py
$ python conditions.py
$ python lab_tests.py
$ python diagnosis.py
$ python explain.py
$ python triage.py
$ python suggest.py
$ python rationale.py
$ python red_flags.py
Pull requests are always welcome. Before submitting a pull request, please ensure that your coding style follows PEP 8 and rules form
Copyright 2017 by Infermedica.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at