TmApi - the C# library for the Megaputer Text Mining API

Megaputer Text Mining API

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• SDK version: 1.0.0
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using TmApi.Api;
using TmApi.Client;
using TmApi.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out TmApi.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System;
using System.Diagnostics;
using TmApi.Api;
using TmApi.Client;
using TmApi.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure HTTP basic authorization: BasicAuth
            Configuration.Default.Username = "YOUR_USERNAME";
            Configuration.Default.Password = "YOUR_PASSWORD";

            var apiInstance = new LimitsApi();

            try
            {
                // Limits information
                Object result = apiInstance.GetLimits();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LimitsApi.GetLimits: " + e.Message );
            }

        }
    }
}

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

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

Documentation for Authorization

BasicAuth

• Type: HTTP basic authentication