tmapi

Megaputer Text Mining API

• API version: 1.0
  • Build date: 2019-12-20T13:29:48.384+03:00[Europe/Moscow]

Megaputer Text Mining API

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.megaputer.tmapi</groupId>
  <artifactId>tmapi</artifactId>
  <version>1.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.megaputer.tmapi:tmapi:1.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/tmapi-1.0.jar
• target/lib/*.jar

Getting Started

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

import tmapi.*;
import tmapi.auth.*;
import tmapi.model.*;
import tmapi.api.LimitsApi;

import java.io.File;
import java.util.*;

public class LimitsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure HTTP basic authorization: BasicAuth
        HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
        BasicAuth.setUsername("YOUR USERNAME");
        BasicAuth.setPassword("YOUR PASSWORD");

        LimitsApi apiInstance = new LimitsApi();
        try {
            Object result = apiInstance.getLimits();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LimitsApi#getLimits");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost:7008/tmapi/v1

Class	Method	HTTP request	Description
LimitsApi	getLimits	GET /limits	Limits information
OperationsApi	extractDocumentsEntities	POST /operations/entities	Entities extraction
OperationsApi	extractDocumentsFacts	POST /operations/facts	Facts extraction
OperationsApi	extractDocumentsKeywords	POST /operations/keywords	Keywords extraction
OperationsApi	extractDocumentsSentiments	POST /operations/sentiments	Sentiments analysis
OperationsApi	extractDocumentsTokens	POST /operations/tokens	Text parsing
OperationsApi	extractEntities	GET /operations/entities	Entities extraction
OperationsApi	extractFacts	GET /operations/facts	Facts extraction
OperationsApi	extractKeywords	GET /operations/keywords	Keywords extraction
OperationsApi	extractSentiments	GET /operations/sentiments	Sentiments analysis
OperationsApi	extractTokens	GET /operations/tokens	Text parsing
OperationsApi	getDocumentsLanguages	POST /operations/languages	Language detection
OperationsApi	getLanguages	GET /operations/languages	Language detection
ServerApi	changePassword	POST /change-password	Change password
ServerApi	getServerInfo	GET /server	Server information
TasksApi	createTask	POST /tasks	Create task
TasksApi	deleteTasks	DELETE /tasks	Delete tasks
TasksApi	getTaskResult	GET /tasks/result	Task result
TasksApi	getTasksInfo	GET /tasks	Tasks information

Documentation for Models

• AsyncTaskResponse
• AuthenticationError
• AuthenticationErrorError
• ChangePasswordError
• ChangePasswordErrorError
• ChangePasswordRequest
• DeleteTasksError
• DeleteTasksSuccess
• Document
• Documents
• EntitiesResponse
• EntitiesResponseDocuments
• EntitiesResponseEntities
• EntitiesResponsePositions
• FactsResponse
• FactsResponseDocuments
• FactsResponseFacts
• FactsResponsePositions
• GetTaskResultError
• GetTaskResultSuccess
• InternalServerError
• InternalServerErrorError
• InvalidRequestParamsError
• InvalidRequestParamsErrorError
• KeywordsResponse
• KeywordsResponseDocuments
• KeywordsResponseKeywords
• KeywordsResponsePositions
• LanguagesResponse
• LanguagesResponseDocuments
• NotEnoughResourcesError
• NotEnoughResourcesErrorError
• PerOperationLimitConstantResponse
• PerOperationLimitPeriodic1Response
• PerOperationLimitPeriodic2Response
• PerOperationLimitResponse
• SentimentsResponse
• SentimentsResponseAttributes
• SentimentsResponseDocuments
• SentimentsResponsePositions
• SentimentsResponseSentiments
• ServerInfo
• SyncTaskResponse
• TaskInfo
• TaskInfoTasks
• TokensResponse
• TokensResponseDocuments
• TokensResponsePosition
• TokensResponseSentences
• TokensResponseTokens
• TotalLimitConstantResponse
• TotalLimitPeriodic1Response
• TotalLimitPeriodic2Response
• TotalLimitResponse

Documentation for Authorization

Authentication schemes defined for the API:

BasicAuth

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author