@factset/sdk-naturallanguageprocessing NPM

Natural Language Processing client library for JavaScript

APIs that leverage Natural Language Processing to help extract meaningful data from unstructured text

This TypeScript/JavaScript package is automatically generated by the OpenAPI Generator project:

API version: 1.3.0
Package version: 0.23.1
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

Node.js >= 14

Installation

npm

npm install @factset/sdk-utils @factset/sdk-naturallanguageprocessing@0.23.1

yarn

yarn add @factset/sdk-utils @factset/sdk-naturallanguageprocessing@0.23.1

Usage

Generate authentication credentials.
Setup Node.js environment
1. Install and activate Node.js >=14. If you're using nvm:
```
nvm install 16
nvm use 16
```
2. (optional) Install yarn.
Install dependencies.
Run the following:

const { ApiClient, AITextSummarizationApi } = require('@factset/sdk-naturallanguageprocessing');
const { ConfidentialClient } = require('@factset/sdk-utils');

const apiClient = ApiClient.instance;

// 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-typescript#authentication
// for more information on using the ConfidentialClient class
apiClient.factsetOauth2Client = new 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
// const FactSetApiKey = apiClient.authentications['FactSetApiKey'];
// FactSetApiKey.username = 'USERNAME-SERIAL';
// FactSetApiKey.password = 'API-KEY';

const apiInstance = new AITextSummarizationApi();
const opts = {
  'summarizationRequest': new naturallanguageprocessing.SummarizationRequest() // SummarizationRequest | 
};

// Call api endpoint
apiInstance.summarizationHeadline(opts).then(
  data => {

    console.log('API called successfully. Returned data:');
    console.log(data);
  },
  error => {
    console.error(error);
  },
);

Documentation for API Endpoints

All URIs are relative to https://api.factset.com/cognitive/nlp/v1

Class	Method	HTTP request	Description
naturallanguageprocessing.AITextSummarizationApi	summarizationHeadline	POST /summarization/headline	Endpoint to generate a headline from text
naturallanguageprocessing.AITextSummarizationApi	summarizationHeadlineAndSummary	POST /summarization/headline-and-summary	Endpoint to summarize and generate a headline from text
naturallanguageprocessing.AITextSummarizationApi	summarizationResult	GET /summarization/result/{resultId}	Endpoint to obtain result of a particular summarization job
naturallanguageprocessing.AITextSummarizationApi	summarizationSummary	POST /summarization/summary	Endpoint to summarize text
naturallanguageprocessing.AIThemesApi	themesExtractThemes	POST /themes	Endpoint to begin theme extraction job
naturallanguageprocessing.AIThemesApi	themesGetStatus	GET /themes/{id}/status	Endpoint to get the completion status of a themes job
naturallanguageprocessing.AIThemesApi	themesGetThemes	GET /themes/{id}	Endpoint to get a theme (and sentiments if requested) job result
naturallanguageprocessing.NamedEntityRecognitionApi	nerEntities	POST /ner/entities	Endpoint to detect entities from text
naturallanguageprocessing.QuestionAnswerApi	qnaGetAnswers	GET /qna/answers/{id}	Endpoint to get the answer(s)
naturallanguageprocessing.QuestionAnswerApi	qnaGetStatus	GET /qna/answers/{id}/status	Endpoint to get the completion status for a Q&A request
naturallanguageprocessing.QuestionAnswerApi	qnaPostQuestion	POST /qna/answers	Endpoint to submit a question for answer(s)

Documentation for Models

Documentation for Authorization

FactSetApiKey

Type: HTTP basic authentication

FactSetOAuth2

Type: OAuth
Flow: application
Authorization URL:
Scopes: N/A

Contributing

Please refer to the contributing guide.

Copyright

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

http://www.apache.org/licenses/LICENSE-2.0

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.

FactSet API SDK

@factset/sdk-utils superagent

@everything-registry/sub-chunk-312

7 months ago

8 months ago

8 months ago

11 months ago