Module symantotextanalytics
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
symantotextanalytics: Client
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, ClientConfiguration clientConfig, string serviceUrl)- apiKeyConfig ApiKeysConfig - API keys for authorization
- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.symanto.net" - URL of the target service
getCommunicationStyle
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
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
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
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
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
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
function getLanguageDetection(LanguageDetectionRequest payload) returns LanguageDetectionResponse|errorLanguage Detection
Parameters
- payload LanguageDetectionRequest - Request Details
Return Type
- LanguageDetectionResponse|error - Successful Response
Records
symantotextanalytics: ApiKeysConfig
Provides API key configurations needed when communicating with a remote HTTP endpoint.
Fields
- xApiKey string - Represents API Key
x-api-key
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: Sentiment
Fields
- 'start int? -
- end int? -
- text string? -
- positive boolean? -
- scale float? -
- category string? -
- parentCategory string? -
- negationTerm string? -
symantotextanalytics: Topic
Fields
- 'start int? -
- end int? -
- topic string? -
- text string? -
- category string? -
- polarity float? -
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[]? -