Ballerina library

text2data

Module text2data

OverviewPrerequisites

API

Client

Definitions

ApiConfig
ApiKeysConfig
Category
ClientHttp1Settings
ConnectionConfig
Document
DocumentResult
PartOfSpeech
ProxyConfig
Sentence
SentencePart
SlangWord
StorageInfo

ballerinax/text2data Ballerina library

1.5.1

Overview

This is a generated connector for Text Analytics & Sentiment Analysis API v3.4 OpenAPI specification.

This API provides Text Analytics Platform that uses NLP (Natural Language Processing) and Machine Learning to your work environment. Extract essential information from your text documents and let Artificial Intelligence save your time. Get detailed and agile reports on your unstructured data.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Clients

text2data: Client

Isolated

This is a generated connector for Text Analytics & Sentiment Analysis API v3.4 OpenAPI specification. The current api version is v3.4



The api methods listed below can be called directly from this page to test the output. You might set the api_key to pre-authenticate all requests on this page (this will work if your secret is blank).



API endpoint URL: http://{apiName}.text2data.com/v3/ {method}

The api can be consumed directly or using our SDK. Our Excel Add-In and Google Sheets Add-on are also using this api to process the data.'

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an Interzoid Account and obtain tokens by log into Interzoid Account.

init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "http://api.text2data.org/" - URL of the target service

analyzeGet

Isolated FunctionRemote Function
function analyzeGet() returns DocumentResult|error

Test api response without api key

Return Type

analyzePost

Isolated FunctionRemote Function
function analyzePost(Document payload) returns DocumentResult|error

Sentiment analysis service

Parameters
  • payload Document - Document payload in form of text, json or xml.
Return Type

categorizeGet

Isolated FunctionRemote Function
function categorizeGet() returns DocumentResult|error

Test api response without api key

Return Type

categorizePost

Isolated FunctionRemote Function
function categorizePost(Document payload) returns DocumentResult|error

Document categorization service

Parameters
  • payload Document - Document payload in form of text, json or xml.
Return Type

extractGet

Isolated FunctionRemote Function
function extractGet() returns DocumentResult|error

Test api response without api key

Return Type

extractPost

Isolated FunctionRemote Function
function extractPost(Document payload) returns DocumentResult|error

Document extraction service

Parameters
  • payload Document - Document payload in form of text, json or xml.
Return Type

Records

text2data: ApiConfig

Fields

text2data: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields
  • privateKey string - All requests on this API needs to include an API key. The API key can be provided as part of the query string or as a request header. The name of the API key needs to be PrivateKey.

text2data: Category

Fields

text2data: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

text2data: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

text2data: Document

Fields
  • SerializeFormat int? -
  • UserCategoryModelName string? -

text2data: DocumentResult

Fields
  • DocSentimentPolarity string? -
  • DocSentimentResultString string? -
  • Timestamp int? -
  • TransactionCurrentDay int? -
  • TransactionDailyLimit int? -
  • TransactionTotalCreditsLeft int? -
  • TransactionUseByDate string? -

text2data: PartOfSpeech

Fields
  • ObjectSentimentPolarity string? -
  • ObjectSentimentResultString string? -

text2data: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

text2data: Sentence

Fields
  • SentenceNumber int? -
  • SentimentResultString string? -

text2data: SentencePart

Fields
  • Mentions int? -

text2data: SlangWord

Fields
  • SlangWordTranslation string? -

text2data: StorageInfo

Fields
  • UserCategoryModelName string? -

Import

import ballerinax/text2data;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Business Intelligence/Analytics

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC