cortical.io

Welcome to the cortical.io Retina Python client source code page.

Release Version: 2.1.0

This page contains

• Introduction
• Dependencies
• How to use
• Change Log
• License

Introduction

cortical.io's Python client - a simple Python http client which simplifies the communication with the Retina server using the Retina's REST API. The source code is split into the following:

• / Endpoint files - One for each endpoint group.
• /models - The return object classes.
• /tests - Unit tests of all endpoints and examples of their usage.

Dependencies

cortical.io's Retina Python client has been tested with Python version 2.7 and with all 2.x.x versions of cortical.io's api.

To use the API you will need to obtain an api key.

How to use/build

• You will need Python (version 2.7 has been tested).
• Install the Requests library, for example using pip install requests.
• Clone all the sources from our Github repository.
• Add the location of the cloned repository to your PYTHONPATH

You should now be able to use the client in the following way (obtaining a sementic representation of the term apple):

    from swagger import ApiClient
    from termsApi import TermsApi

    client = ApiClient(apiKey="your_api_key", apiServer="http://api.cortical.io/rest")
    api = TermsApi(client)
    terms = api.getTerm("en_associative", term="apple", get_fingerprint=True)
    print terms[0].fingerprint.positions

For further documentation about the Retina-API and information on cortical.io's 'Retina' technology please see: http://www.cortical.io/developers_tutorials.html. Also the tests folder contains more examples of how to use client.

If you have any questions or problems please visit our forum: http://www.cortical.io/developers_forum.html

Change Log

v 2.1.0

• Initial release version.

License

Copyright 2014 cortical.io GmbH.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.