@topoos/textanalytics

Text Analytics SDK

TextAnalytics - JavaScript client for text_analytics This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1
• Package version: 2.0.2
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @topoos/textanalytics --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your text_analytics from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

import TextAnalytics from '@topoos/textanalytics';// if using on premise
let apiInstance = new TextAnalytics.MessagesApi({ 
  serverUrl: "https://localhost:44346", 
  provider: "sdkTest_node", 
});
// if using saas
/*
let apiInstance = new TextAnalytics.MessagesApi({ 
  gatewayToken: {       
    value: "TODO: SET VALUE IN GATEWAYTOKEN_VALUE ENV VARIABLE" 
  }
});
*/
let page = 0;
const pageSize = 5;
let filter = {
  "author": "1111-1111-11111-111111",
  "language": "es",
  "geo": { "coordinates": [-3.7055, 40.4168], "radius": 100 },
  "sort": { "field": "id", "order": "Ascending" },
  "createdAt": {
    "start": new Date("2013-10-20T19:20:30+01:00"),
    "end": new Date("2013-10-20T19:20:30+01:00"),
  }
};
let messages;
try {
  messages = await apiInstance.getMany(filter, page, pageSize);
}
catch (err) {
  console.log("error getting messages", err);
}

Documentation for API Endpoints

Class	Method	HTTP request	Description
TextAnalytics.AnalyticsApi	count	GET /analytics/count	Permite obtener la lista de recursos junto al conteo de ocurrencias
TextAnalytics.AnalyticsApi	timeSerie	GET /analytics/timeserie	Permite obtener una serie temporal con la evolución del recurso solicitado en el tiempo
TextAnalytics.AnalyticsApi	trends	GET /analytics/trends	Permite obtener la lista de tendencias de un recurso
TextAnalytics.MessagesApi	callDelete	DELETE /messages/{id}	Permite eliminar un mensaje previamente almacenado, a partir de su id
TextAnalytics.MessagesApi	getMany	GET /messages	Permite recuperar los insights de mensajes previamente almacenados
TextAnalytics.MessagesApi	getSingle	GET /messages/{id}	Permite recuperar los insights de un mensaje previamente almacenado a partir de su identificador
TextAnalytics.MessagesApi	post	POST /messages	Permite enviar un texto y su idioma para obtener información extraída del mismo como el sentimiento, entidades, topics...
TextAnalytics.MessagesApi	put	PUT /messages/{id}	Permite enviar un texto y su idioma para actualizar un mensaje con información extraída del mismo como el sentimiento, entidades, topics...

Documentation for Models

• TextAnalytics.AnalyticsResource
• TextAnalytics.BinCount
• TextAnalytics.BinCountBaseResponse
• TextAnalytics.BinCountData
• TextAnalytics.DetailError
• TextAnalytics.DetectedLanguage
• TextAnalytics.Entity
• TextAnalytics.ErrorResponse
• TextAnalytics.GeoJsonTypes
• TextAnalytics.GeoPoint
• TextAnalytics.InsightsResponse
• TextAnalytics.KeyCount
• TextAnalytics.KeyCountBaseResponse
• TextAnalytics.KeyCountData
• TextAnalytics.MessageRequest
• TextAnalytics.MessageResponse
• TextAnalytics.MessageResponseBaseResponse
• TextAnalytics.MessageResponseData
• TextAnalytics.SentimentConfidenceScores
• TextAnalytics.SentimentInsightResponse
• TextAnalytics.SentimentType
• TextAnalytics.SortField
• TextAnalytics.SortOrder
• TextAnalytics.StringBaseResponse
• TextAnalytics.StringData
• TextAnalytics.TimeUnit
• TextAnalytics.TrendCount
• TextAnalytics.TrendsResult
• TextAnalytics.TrendsResultBaseResponse
• TextAnalytics.TrendsResultData

Documentation for Authorization

headerkey

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header