TableQA changes

Author: subalalithafl

.gitignore

@@ -0,0 +1 @@
+*.pyc

example_Stemmer.py

@@ -0,0 +1,29 @@
+from firstlanguage_python.firstlanguage_client import Client
+from firstlanguage_python.configuration import Environment
+import jsonpickle
+
+
+client = Client(
+    apikey='63af276e-34fe-4fd5-a474-0c69847f25e1',
+    environment=Environment.PRODUCTION,)
+
+reqbody='{"input":{"text":"அவள் வேகமாக ஓடினாள்","lang":"ta"} }'
+
+body = jsonpickle.decode(reqbody)
+basic_api_controller = client.basic_api
+
+advanced_api_controller = client.advanced_api
+
+result = basic_api_controller.get_stemmer(body)
+
+for res in result:
+  print("Original Text passed: "+res.orginal_text)
+  print("Stemmed result: "+res.stem)
+
+reqbody='{"input":{"text":"Welcome to Google and FirstLanguage","lang":"en"} }'
+
+body = jsonpickle.decode(reqbody)
+
+result = advanced_api_controller.get_translate(body)
+
+print(result)

examples/example_Stemmer.py

@@ -12,8 +12,18 @@
 body = jsonpickle.decode(reqbody)
 basic_api_controller = client.basic_api
 
+advanced_api_controller = client.advanced_api
+
 result = basic_api_controller.get_stemmer(body)
 
 for res in result:
   print("Original Text passed: "+res.orginal_text)
   print("Stemmed result: "+res.stem)
+
+reqbody='{"input":{"text":"Welcome to Google and FirstLanguage","lang":"ta"} }'
+
+body = jsonpickle.decode(reqbody)
+
+result = advanced_api_controller.get_translate(body)
+
+print(result)

firstlanguage_python/__pycache__/api_helper.cpython-39.pyc

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-firstlanguage
+firstlanguage_python
 
 This file was automatically generated by APIMATIC v3.0 (
  https://www.apimatic.io ).
@@ -142,13 +142,14 @@ def get_schema_path(path):
         return path
 
     @staticmethod
-    def serialize_array(key, array, formatting="indexed"):
+    def serialize_array(key, array, formatting="indexed", is_query=False):
         """Converts an array parameter to a list of key value tuples.
 
         Args:
             key (str): The name of the parameter.
             array (list): The value of the parameter.
             formatting (str): The type of key formatting expected.
+            is_query (bool): Decides if the parameters are for query or form.
 
         Returns:
             list: A list with key value tuples for the array elements.
@@ -168,6 +169,16 @@ def serialize_array(key, array, formatting="indexed"):
                 tuples += [("{0}[{1}]".format(key, index), element) for index, element in enumerate(array)]
             elif formatting == "plain":
                 tuples += [(key, element) for element in array]
+            elif is_query:
+                if formatting == "csv":
+                    tuples += [(key, ",".join(str(x) for x in array))]
+
+                elif formatting == "psv":
+                    tuples += [(key, "|".join(str(x) for x in array))]
+
+                elif formatting == "tsv":
+                    tuples += [(key, "\t".join(str(x) for x in array))]
+
             else:
                 raise ValueError("Invalid format provided.")
         else:
@@ -231,41 +242,25 @@ def append_url_with_query_parameters(url,
             raise ValueError("URL is None.")
         if parameters is None:
             return url
-
-        for key, value in parameters.items():
+        parameters = APIHelper.process_complex_types_parameters(parameters, array_serialization)
+        for index, value in enumerate(parameters):
+            key = value[0]
+            val = value[1]
             seperator = '&' if '?' in url else '?'
             if value is not None:
-                if isinstance(value, list):
-                    value = [element for element in value if element]
-                    if array_serialization == "csv":
-                        url += "{0}{1}={2}".format(
-                            seperator,
-                            key,
-                            ",".join(quote(str(x), safe='') for x in value)
-                        )
-                    elif array_serialization == "psv":
-                        url += "{0}{1}={2}".format(
-                            seperator,
-                            key,
-                            "|".join(quote(str(x), safe='') for x in value)
-                        )
-                    elif array_serialization == "tsv":
-                        url += "{0}{1}={2}".format(
-                            seperator,
-                            key,
-                            "\t".join(quote(str(x), safe='') for x in value)
-                        )
-                    else:
-                        url += "{0}{1}".format(
-                            seperator,
-                            "&".join(("{0}={1}".format(k, quote(str(v), safe='')))
-                                     for k, v in APIHelper.serialize_array(key, value, array_serialization))
-                        )
-                else:
-                    url += "{0}{1}={2}".format(seperator, key, quote(str(value), safe=''))
+                url += "{0}{1}={2}".format(seperator, key, quote(str(val), safe=''))
 
         return url
 
+    @staticmethod
+    def process_complex_types_parameters(query_parameters, array_serialization):
+        processed_params = []
+        for key, value in query_parameters.items():
+            processed_params.extend(
+                APIHelper.form_encode(value, key, array_serialization=array_serialization, is_query=True))
+        return processed_params
+
+
     @staticmethod
     def clean_url(url):
         """Validates and processes the given query Url to clean empty slashes.
@@ -315,14 +310,15 @@ def form_encode_parameters(form_parameters,
     @staticmethod
     def form_encode(obj,
                     instance_name,
-                    array_serialization="indexed"):
+                    array_serialization="indexed", is_query=False):
         """Encodes a model in a form-encoded manner such as person[Name]
 
         Args:
             obj (object): The given Object to form encode.
             instance_name (string): The base name to appear before each entry
                 for this object.
             array_serialization (string): The format of array parameter serialization.
+            is_query (bool): Decides if the parameters are for query or form.
 
         Returns:
             dict: A dictionary of form encoded properties of the model.
@@ -336,11 +332,11 @@ def form_encode(obj,
         if obj is None:
             return []
         elif isinstance(obj, list):
-            for element in APIHelper.serialize_array(instance_name, obj, array_serialization):
-                retval += APIHelper.form_encode(element[1], element[0], array_serialization)
+            for element in APIHelper.serialize_array(instance_name, obj, array_serialization, is_query):
+                retval += APIHelper.form_encode(element[1], element[0], array_serialization, is_query)
         elif isinstance(obj, dict):
             for item in obj:
-                retval += APIHelper.form_encode(obj[item], instance_name + "[" + item + "]", array_serialization)
+                retval += APIHelper.form_encode(obj[item], instance_name + "[" + item + "]", array_serialization, is_query)
         else:
             retval.append((instance_name, obj))
 

firstlanguage_python/__pycache__/configuration.cpython-39.pyc

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 """
-firstlanguage
+firstlanguage_python
 
 This file was automatically generated by APIMATIC v3.0 (
  https://www.apimatic.io ).
@@ -72,7 +72,7 @@ def __init__(
         backoff_factor=2,
         retry_statuses=[408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
         retry_methods=['GET', 'PUT'], environment=Environment.PRODUCTION,
-        apikey='BHbLvTKeT4y9PACVomcGBF3GrCv1OUOc'
+        apikey='TODO: Replace'
     ):
         # The Http Client passed from the sdk user for making requests
         self._http_client_instance = http_client_instance
@@ -100,7 +100,7 @@ def __init__(
         # Current API environment
         self._environment = environment
 
-        # API Key can be copied from your dashboard
+        # TODO: Replace
         self._apikey = apikey
 
         # The Http Client to use for making requests.

firstlanguage_python/__pycache__/decorators.cpython-39.pyc

@@ -2,4 +2,5 @@
     'base_controller',
     'basic_ap_is_controller',
     'advanced_ap_is_controller',
+    'enterprise_only_controller',
 ]

firstlanguage_python/__pycache__/firstlanguage_client.cpython-39.pyc

@@ -1,18 +1,18 @@
 # -*- coding: utf-8 -*-
 
 """
-firstlanguage
+firstlanguage_python
 
 This file was automatically generated by APIMATIC v3.0 (
  https://www.apimatic.io ).
 """
 
 from firstlanguage_python.api_helper import APIHelper
 from firstlanguage_python.configuration import Server
-from firstlanguage_python.controllers.base_controller import BaseController 
-from firstlanguage_python.http.auth.custom_header_auth import CustomHeaderAuth
+from firstlanguage_python.controllers.base_controller import BaseController
 from firstlanguage_python.models.responseclassify import Responseclassify
 from firstlanguage_python.models.api_qa_response import ApiQaResponse
+from firstlanguage_python.models.api_tableqa_response import ApiTableqaResponse
 from firstlanguage_python.models.api_ner_response import ApiNerResponse
 from firstlanguage_python.models.api_summary_response import ApiSummaryResponse
 from firstlanguage_python.models.api_translate_response import ApiTranslateResponse
@@ -24,10 +24,9 @@
 
 class AdvancedAPIsController(BaseController):
 
-    """A Controller to access Endpoints in the firstlanguage API."""
-
-    def __init__(self, config, call_back=None):
-        super(AdvancedAPIsController, self).__init__(config, call_back)
+    """A Controller to access Endpoints in the firstlanguage_python API."""
+    def __init__(self, config, auth_managers, call_back=None):
+        super(AdvancedAPIsController, self).__init__(config, auth_managers, call_back)
 
     def get_classification(self,
                            body):
@@ -86,7 +85,9 @@ def get_classification(self,
 
         # Prepare and execute request
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
-        CustomHeaderAuth.apply(self.config, _request)
+        # Apply authentication scheme on request
+        self.apply_auth_schemes(_request, 'global')
+
         _response = self.execute_request(_request)
 
         # Endpoint and global error handling using HTTP status codes.
@@ -147,7 +148,9 @@ def get_qa(self,
 
         # Prepare and execute request
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
-        CustomHeaderAuth.apply(self.config, _request)
+        # Apply authentication scheme on request
+        self.apply_auth_schemes(_request, 'global')
+
         _response = self.execute_request(_request)
 
         # Endpoint and global error handling using HTTP status codes.
@@ -163,6 +166,91 @@ def get_qa(self,
 
         return decoded
 
+    def get_table_qa(self,
+                     body=None):
+        """Does a POST request to /api/tableqa.
+
+        # TableQA : Defintion and it's usage
+        Table QA uses TAPAS based model to get answers from table input. The
+        table can be parsed into a JSON object or it can be a link to a CSV
+        file. Currently only Plain CSV file is supported. 
+        This API works only for English language currently
+        Example for flattend table in JSON Format:<br/>
+        {"Cities": ["Paris, France", "London, England", "Lyon, France"],
+        "Inhabitants": ["2.161", "8.982", "0.513"]}
+        The API can return the original table rows from which the answer was
+        extracted based on the flag 'sendBackRows'
+
+        Args:
+            body (object, optional): Add a JSON Input as per the schema
+                defined below. For URL input, if you are providing Google
+                drive or Google Spreadsheet url ensure that you provide a link
+                which can download the file directly and not the share link. 
+                Example: For Google Spreadsheet, the url format will be like
+                below:
+                https://docs.google.com/spreadsheets/d/1TtzPAHqpaTB7Ltdq0zwZ8Fa
+                mF7O9aC4KH4EpmwI/export?format=csv&gid=151344200  Or for
+                Google Drive, it will be like below:
+                https://drive.google.com/uc?id=idofthefile  For Flat table
+                input check the example out.
+
+        Returns:
+            list of ApiTableqaResponse: Response from the API. Answers for the
+                questions posted along with the original rows if the flag is
+                true.
+
+The anwer will be of format:
+
+AGGREGRATE >
+                answer
+
+Aggregrate can be one of the
+                following:
+NONE,
+SUM,
+COUNT,
+AVERAGE
+
+        Raises:
+            APIException: When an error occurs while fetching the data from
+                the remote API. This exception includes the HTTP Response
+                code, an error message, and the HTTP body that was received in
+                the request.
+
+        """
+
+        # Prepare query URL
+        _url_path = '/api/tableqa'
+        _query_builder = self.config.get_base_uri()
+        _query_builder += _url_path
+        _query_url = APIHelper.clean_url(_query_builder)
+
+        # Prepare headers
+        _headers = {
+            'accept': 'application/json',
+            'Content-Type': 'application/json'
+        }
+
+        # Prepare and execute request
+        _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
+        # Apply authentication scheme on request
+        self.apply_auth_schemes(_request, 'global')
+
+        _response = self.execute_request(_request)
+
+        # Endpoint and global error handling using HTTP status codes.
+        if _response.status_code == 400:
+            raise ErrorsException('Bad Request', _response)
+        elif _response.status_code == 426:
+            raise M426ErrorException('Please use HTTPS protocol', _response)
+        elif _response.status_code == 429:
+            raise APIException('Too Many Requests', _response)
+        self.validate_response(_response)
+
+        decoded = APIHelper.json_deserialize(_response.text, ApiTableqaResponse.from_dictionary)
+
+        return decoded
+
     def get_ner(self,
                 body=None):
         """Does a POST request to /api/ner.
@@ -221,7 +309,9 @@ def get_ner(self,
 
         # Prepare and execute request
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
-        CustomHeaderAuth.apply(self.config, _request)
+        # Apply authentication scheme on request
+        self.apply_auth_schemes(_request, 'global')
+
         _response = self.execute_request(_request)
 
         # Endpoint and global error handling using HTTP status codes.
@@ -319,7 +409,9 @@ def get_summary(self,
 
         # Prepare and execute request
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
-        CustomHeaderAuth.apply(self.config, _request)
+        # Apply authentication scheme on request
+        self.apply_auth_schemes(_request, 'global')
+
         _response = self.execute_request(_request)
 
         # Endpoint and global error handling using HTTP status codes.
@@ -432,7 +524,9 @@ def get_translate(self,
 
         # Prepare and execute request
         _request = self.config.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(body))
-        CustomHeaderAuth.apply(self.config, _request)
+        # Apply authentication scheme on request
+        self.apply_auth_schemes(_request, 'global')
+
         _response = self.execute_request(_request)
 
         # Endpoint and global error handling using HTTP status codes.