Module symantotextanalytics
ballerinax/symantotextanalytics Ballerina library
1.5.2
Overview
The Symanto Psycholinguistic Text Analytics API v1.5.0 connector(https://api.symanto.net/docs) OpenAPI Specification. Symanto psycholinguistic text analytics API provides capability to access operations related to the deepest understanding of people through psychology & AI
Key Features
- Programmatic access to create and manage resources via REST API
- Access analytics, reports, and performance metrics
- Manage user accounts and profiles
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
Clients
symantotextanalytics: Client
Isolated
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
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
Isolated FunctionRemote Function
function getCommunicationStyle(PostRequest payload, boolean all) returns PredictionResults|errorCommunication & 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
Isolated FunctionRemote Function
function getEmotion(PostRequest payload, boolean all) returns PredictionResults|errorEmotion 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
Isolated FunctionRemote Function
function getEkmanEmotion(PostRequest payload, boolean all) returns PredictionResults|errorEmotion 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
Isolated FunctionRemote Function
function getPersonality(PostRequest payload, boolean all) returns PredictionResults|errorPersonality 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
Isolated FunctionRemote Function
function getSentiment(PostRequest payload, boolean all) returns PredictionResults|errorSentiment 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
Isolated FunctionRemote Function
function getTopicSentiment(PostRequest payload, string? domain) returns TopicSentimentResponse|errorExtracts 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
Isolated FunctionRemote Function
function getLanguageDetection(LanguageDetectionRequest payload) returns LanguageDetectionResponse|errorLanguage Detection
Parameters
- payload LanguageDetectionRequest - Request Details
Return Type
- LanguageDetectionResponse|error - Successful Response
Records
symantotextanalytics: ApiKeysConfig
Closed record
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
x-api-key
symantotextanalytics: 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
- proxy? ProxyConfig - Proxy server related options
symantotextanalytics: 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
- 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-forwardedheader
- 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
Fields
- id? string - id of the text.
- text string - the text itself.
symantotextanalytics: LanguagePredicted
Fields
- id? string - id of the post.
- detected_language string - the detected language_code corresponding to the input text.
symantotextanalytics: Post
Fields
- id? string - id of the post.
- text string - the text to be analysed.
- language string - language_code of the text.
symantotextanalytics: PostPredicted
Fields
- id? string - id of the post.
- predictions Prediction[] - the list of predictions.
symantotextanalytics: Prediction
Fields
- prediction string - the predicted label.
- probability decimal - the probability of the predicted label.
symantotextanalytics: 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
symantotextanalytics: Sentiment
Fields
- 'start? int -
- end? int -
- text? string -
- positive? boolean -
- scale? decimal -
- category? string -
- parentCategory? string -
- negationTerm? string -
symantotextanalytics: Topic
Fields
- 'start? int -
- end? int -
- topic? string -
- text? string -
- category? string -
- polarity? decimal -
symantotextanalytics: TopicSentiment
Fields
- topic? Topic -
- sentiment? Sentiment -
- sentence? string -
symantotextanalytics: TopicSentimentOutput
Fields
- id? string -
- text? string -
- language? string -
- topicSentiments? TopicSentiment[] -
- sentiments? Sentiment[] -
- topics? Topic[] -
symantotextanalytics: ValidationError
Fields
- loc string[] -
- msg string -
- 'type string -
symantotextanalytics: ValidationErrors
Fields
- detail? ValidationError[] -
Array types
symantotextanalytics: PredictionResults
PredictionResults
symantotextanalytics: LanguageDetectionRequest
LanguageDetectionRequest
symantotextanalytics: LanguageDetectionResponse
LanguageDetectionResponse
symantotextanalytics: PostRequest
PostRequest
symantotextanalytics: TopicSentimentResponse
TopicSentimentResponse