symantotextanalytics
Module symantotextanalytics
API
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_symantotextanalytics_1.4.0.png)
ballerinax/symantotextanalytics Ballerina library
Overview
This is a generated connector from Symanto Psycholinguistic Text Analytics API v1.5.0 OpenAPI Specification. Symanto psycholinguistic text analytics API provides capability to access operations related to the deepest understanding of people through psychology & AI
Prerequisites
Before using this connector in your Ballerina application, complete the following:
Clients![](/images/permalink.svg)
symantotextanalytics: Client![](/images/permalink.svg)
This is a generated connector from Symanto Psycholinguistic Text Analytics version 1.5.0 OpenAPI Specification. Symanto psycholinguistic text analytics API provides capability to access operations related to the deepest understanding of people through psychology & AI
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Symanto account and obtain OAuth tokens following this guide
init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
- apiKeyConfig ApiKeysConfig - API keys for authorization
- config ConnectionConfig {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.symanto.net" - URL of the target service
getCommunicationStyle![](/images/permalink.svg)
Communication & Tonality
Parameters
- payload PostRequest - Request Details
- all boolean (default false) - Returns all predictions, not only the most probable one
Return Type
- PredictionResults|error - Successful Response
getEmotion![](/images/permalink.svg)
Emotion Analysis
Parameters
- payload PostRequest - Request Details
- all boolean (default false) - Returns all predictions, not only the most probable one
Return Type
- PredictionResults|error - Successful Response
getEkmanEmotion![](/images/permalink.svg)
Emotion Analysis
Parameters
- payload PostRequest - Request Details
- all boolean (default false) - Returns all predictions, not only the most probable one
Return Type
- PredictionResults|error - Successful Response
getPersonality![](/images/permalink.svg)
Personality Traits
Parameters
- payload PostRequest - Request Details
- all boolean (default false) - Returns all predictions, not only the most probable one
Return Type
- PredictionResults|error - Successful Response
getSentiment![](/images/permalink.svg)
Sentiment Analysis
Parameters
- payload PostRequest - Request Details
- all boolean (default false) - Returns all predictions, not only the most probable one
Return Type
- PredictionResults|error - Successful Response
getTopicSentiment![](/images/permalink.svg)
function getTopicSentiment(PostRequest payload, string? domain) returns TopicSentimentResponse|error
Extracts topics and sentiments and relates them.
Parameters
- payload PostRequest - Request Details
- domain string? (default ()) - Provide analysis domain for better extraction (optional)
Return Type
- TopicSentimentResponse|error - Successful Response
getLanguageDetection![](/images/permalink.svg)
function getLanguageDetection(LanguageDetectionRequest payload) returns LanguageDetectionResponse|error
Language Detection
Parameters
- payload LanguageDetectionRequest - Request Details
Return Type
- LanguageDetectionResponse|error - Successful Response
Records![](/images/permalink.svg)
symantotextanalytics: ApiKeysConfig![](/images/permalink.svg)
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
x-api-key
symantotextanalytics: ClientHttp1Settings![](/images/permalink.svg)
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
- proxy ProxyConfig? - Proxy server related options
symantotextanalytics: ConnectionConfig![](/images/permalink.svg)
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
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- 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
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- 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
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
symantotextanalytics: LanguageDetection![](/images/permalink.svg)
Fields
- id string? - id of the text.
- text string - the text itself.
symantotextanalytics: LanguagePredicted![](/images/permalink.svg)
Fields
- id string? - id of the post.
- detected_language string - the detected language_code corresponding to the input text.
symantotextanalytics: Post![](/images/permalink.svg)
Fields
- id string? - id of the post.
- text string - the text to be analysed.
- language string - language_code of the text.
symantotextanalytics: PostPredicted![](/images/permalink.svg)
Fields
- id string? - id of the post.
- predictions Prediction[] - the list of predictions.
symantotextanalytics: Prediction![](/images/permalink.svg)
Fields
- prediction string - the predicted label.
- probability decimal - the probability of the predicted label.
symantotextanalytics: ProxyConfig![](/images/permalink.svg)
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
symantotextanalytics: Sentiment![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- text string? -
- positive boolean? -
- scale decimal? -
- category string? -
- parentCategory string? -
- negationTerm string? -
symantotextanalytics: Topic![](/images/permalink.svg)
Fields
- 'start int? -
- end int? -
- topic string? -
- text string? -
- category string? -
- polarity decimal? -
symantotextanalytics: TopicSentiment![](/images/permalink.svg)
Fields
- topic Topic? -
- sentiment Sentiment? -
- sentence string? -
symantotextanalytics: TopicSentimentOutput![](/images/permalink.svg)
Fields
- id string? -
- text string? -
- language string? -
- topicSentiments TopicSentiment[]? -
- sentiments Sentiment[]? -
- topics Topic[]? -
symantotextanalytics: ValidationError![](/images/permalink.svg)
Fields
- loc string[] -
- msg string -
- 'type string -
symantotextanalytics: ValidationErrors![](/images/permalink.svg)
Fields
- detail ValidationError[]? -
Import
import ballerinax/symantotextanalytics;
Metadata
Released date: almost 2 years ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
IT Operations/Cloud Services
Cost/Paid
Contributors