Package: fds.sdk.NaturalLanguageProcessing
Natural Language Processing client library for PythonAPIs that leverage Natural Language Processing to help extract meaningful data from unstructured textThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.3.0Package version: 0.23.1Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.NaturalLanguageProcessing==0.23.1pippipinstallfds.sdk.utilsfds.sdk.NaturalLanguageProcessing==0.23.1UsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.NaturalLanguageProcessingfromfds.sdk.NaturalLanguageProcessing.apiimportai_text_summarization_apifromfds.sdk.NaturalLanguageProcessing.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# See configuration.py for a list of all supported configuration parameters.# Examples for each supported authentication method are below,# choose one that satisfies your use case.# (Preferred) OAuth 2.0: FactSetOAuth2# See https://github.com/FactSet/enterprise-sdk#oauth-20# for information on how to create the app-config.json file## The confidential client instance should be reused in production environments.# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication# for more information on using the ConfidentialClient classconfiguration=fds.sdk.NaturalLanguageProcessing.Configuration(fds_oauth_client=ConfidentialClient('/path/to/app-config.json'))# Basic authentication: FactSetApiKey# See https://github.com/FactSet/enterprise-sdk#api-key# for information how to create an API key# configuration = fds.sdk.NaturalLanguageProcessing.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.NaturalLanguageProcessing.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=ai_text_summarization_api.AITextSummarizationApi(api_client)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.summarization_request=SummarizationRequest(text="Advanced Energy Transforms Indoor Farming With Intelligent New Lighting Power and Control System Friday, December 11, 2020 01:00:00 PM (GMT)Innovative technology breaks down barriers to indoor, vertical and greenhouse farming by reducing power consumption, cutting costs and increasing crop yield Advanced Energy (Nasdaq: AEIS) – a global leader in highly engineered, precision power conversion, measurement, and control solutions – today unveiled its newest lighting and power control system for indoor, vertical and greenhouse farming. This press release features multimedia. Advanced Energy's new Artesyn iTS provides the industry's first solution for switching or sharing a single power source between two different rooms. This reduces installation costs by cutting the number of iHP power supplies needed in half and it substantially reduces ongoing utility costs. (Photo: Business Wire)AE's new lighting and power system transforms the use of LED technology in horticultural lighting systems, which plays a fundamental role in cutting-edge farming practices that can address production challenges in food, pharmaceutical ingredients, plants and flowers. Utilizing AE's system, customers reduce their power conversion costs by as much as 50 percent, significantly lower installation and operating costs, and increase the quality of crop yield. "Ourgroundbreakinglighting,powerandcontrolsystemdeliverssignificantimprovementsoverconventionallightingsolutionsandopensupnewopportunitiesfortheindustry," said Joe Voyles, vice president, industrial marketing, at Advanced Energy. "Wearetransformingourcustomers' operations by both reducing the amount of needed equipment and improving the efficiency of the lighting systems, thereby reducing cost and energy spend. Not only do these innovative new products increase the efficiency and quality of fruit and vegetable production, but they also open the door to establishing indoor farming facilities in harsh environments anywhere in the world." The new system consists of the patented Artesyn iTS (intelligent Transfer Switch) and iHPS configurable power supply. Alongside Artesyn'scompactnew12kW300VDCmodule,AEdeliversacost-effectiveplatformforthemostadvancedindoorfarmingapplications.Thesystemisestimatedtoproducea38percentsavingstolightingpowerandcontrolinstallationcost,whileeliminatingsubstantialamountsofwastedenergy.ThenewiHPSisa"short"versionofAE's market-leading iHP power supply. The shorter design allows for more space within the lighting and power cabinet for other crucial components, reduces the weight and cost, and increases the life of the system. The new iTS provides the industry'sfirstsolutionforswitchingorsharingasinglepowersourcebetweentwodifferentrooms.ThisreducesinstallationcostsbycuttingthenumberofiHPpowersuppliesneededinhalfanditsubstantiallyreducesongoingutilitycosts.",)# SummarizationRequest |  (optional)try:# Endpoint to generate a headline from text# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.summarization_headline(summarization_request=summarization_request)pprint(api_response)exceptfds.sdk.NaturalLanguageProcessing.ApiExceptionase:print("Exception when calling AITextSummarizationApi->summarization_headline:%s\n"%e)# # Get response, http status code and response headers# try:#     # Endpoint to generate a headline from text#     api_response, http_status_code, response_headers = api_instance.summarization_headline_with_http_info(summarization_request=summarization_request)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.NaturalLanguageProcessing.ApiException as e:#     print("Exception when calling AITextSummarizationApi->summarization_headline: %s\n" % e)# # Get response asynchronous# try:#     # Endpoint to generate a headline from text#     async_result = api_instance.summarization_headline_async(summarization_request=summarization_request)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.NaturalLanguageProcessing.ApiException as e:#     print("Exception when calling AITextSummarizationApi->summarization_headline: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Endpoint to generate a headline from text#     async_result = api_instance.summarization_headline_with_http_info_async(summarization_request=summarization_request)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.NaturalLanguageProcessing.ApiException as e:#     print("Exception when calling AITextSummarizationApi->summarization_headline: %s\n" % e)Using PandasTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.importpandasaspdresponse_dict=api_response.to_dict()['data']simple_json_response=pd.DataFrame(response_dict)nested_json_response=pd.json_normalize(response_dict)DebuggingThe SDK uses the standard libraryloggingmodule.SettingdebugtoTrueon an instance of theConfigurationclass sets the log-level of related packages toDEBUGand enables additional logging in PythonsHTTP Client.Note: This prints out sensitive information (e.g. the full request and response). Use with care.importloggingimportfds.sdk.NaturalLanguageProcessinglogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.NaturalLanguageProcessing.Configuration(...)configuration.debug=TrueConfigure a ProxyYou can pass proxy settings to the Configuration class:proxy: The URL of the proxy to use.proxy_headers: a dictionary to pass additional headers to the proxy (e.g.Proxy-Authorization).importfds.sdk.NaturalLanguageProcessingconfiguration=fds.sdk.NaturalLanguageProcessing.Configuration(# ...proxy="http://secret:password@localhost:5050",proxy_headers={"Custom-Proxy-Header":"Custom-Proxy-Header-Value"})Custom SSL CertificateTLS/SSL certificate verification can be configured with the following Configuration parameters:ssl_ca_cert: a path to the certificate to use for verification inPEMformat.verify_ssl: setting this toFalsedisables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.importfds.sdk.NaturalLanguageProcessingconfiguration=fds.sdk.NaturalLanguageProcessing.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/cognitive/nlp/v1ClassMethodHTTP requestDescriptionAITextSummarizationApisummarization_headlinePOST/summarization/headlineEndpoint to generate a headline from textAITextSummarizationApisummarization_headline_and_summaryPOST/summarization/headline-and-summaryEndpoint to summarize and generate a headline from textAITextSummarizationApisummarization_resultGET/summarization/result/{resultId}Endpoint to obtain result of a particular summarization jobAITextSummarizationApisummarization_summaryPOST/summarization/summaryEndpoint to summarize textAIThemesApithemes_extract_themesPOST/themesEndpoint to begin theme extraction jobAIThemesApithemes_get_statusGET/themes/{id}/statusEndpoint to get the completion status of a themes jobAIThemesApithemes_get_themesGET/themes/{id}Endpoint to get a theme (and sentiments if requested) job resultNamedEntityRecognitionApiner_entitiesPOST/ner/entitiesEndpoint to detect entities from textQuestionAnswerApiqna_get_answersGET/qna/answers/{id}Endpoint to get the answer(s)QuestionAnswerApiqna_get_statusGET/qna/answers/{id}/statusEndpoint to get the completion status for a Q&A requestQuestionAnswerApiqna_post_questionPOST/qna/answersEndpoint to submit a question for answer(s)Documentation For ModelsErrorErrorSourceHTTPErrorHTTPErrorRootNEREntityNEREntityListNERInputDataSchemaNERInputSchemaNEROrganizationNERResponseSchemaQnAAnswerQnAAnswerParametersQnAAnswerParametersRootQnAAnswerRootSummarizationHTTPErrorSummarizationRequestSummarizationResultSummarizationResultIDTaskTaskRootThemeSentimentThemeSentimentsRootThemesParametersThemesParametersRootValidationErrorValidationErrorDetailValidationErrorDetailLocationDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.NaturalLanguageProcessing.apis and fds.sdk.NaturalLanguageProcessing.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:Solution 1:
Use specific imports for apis and models like:from fds.sdk.NaturalLanguageProcessing.api.default_api import DefaultApifrom fds.sdk.NaturalLanguageProcessing.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import fds.sdk.NaturalLanguageProcessing
from fds.sdk.NaturalLanguageProcessing.apis import *
from fds.sdk.NaturalLanguageProcessing.models import *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.