firstlanguage-python 2.5.1

Python client library for FirstLanguage API

Getting Started with FirstLanguage API

Introduction

Collection of NLP APIs to help developers. We have grouped the APIs under Basic and Advanced. Basic APIs cover all basic text operations like POSTag, Stemmer etc and Advanced cover all the APIs like QA, translation etc.

OpenAPI Specification

This API is documented in OpenAPI v3.0 format. In addition to standard OpenAPI syntax we use a few vendor extensions.

Building

You must have Python 3 >=3.7, <= 3.9 installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.

Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.

• Using command line, navigate to the directory containing the generated files (including requirements.txt) for the SDK.
• Run the command pip install -r requirements.txt. This should install all the required dependencies.

Installation

The following section explains how to use the firstlanguage_python library in a new project.

1. Open Project in an IDE

Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

The project files will be displayed in the side bar as follows:

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test".

Add a python file to this project.

Name it "testSDK".

In your python file you will be required to import the generated python library using the following code lines

from firstlanguage_python.firstlanguage_python_client import FirstlanguageapiClient

After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.

3. Run the Test Project

To run the file within your test project, right click on your Python file inside your Test project and click on Run

Test the SDK

You can test the generated SDK and the server with test cases. unittest is used as the testing framework and nose is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands

pip install -r test-requirements.txt
nosetests

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
apikey	string

The API client can be initialized as follows:

from firstlanguage_python.firstlanguage_python_client import FirstlanguageapiClient
from firstlanguage_python.configuration import Environment

client = FirstlanguageapiClient(
    apikey='apikey',
    environment=Environment.PRODUCTION,)

Authorization

This API uses Custom Header Signature.

List of APIs

• Basic AP Is
• Advanced AP Is
• Enterprise Only

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest