Package com.chatmotorapi.api.functional

Class MotorSentiment

java.lang.Object

com.chatmotorapi.api.functional.MotorSentiment

public class MotorSentiment
extends Object

This class models the sentiment analysis results. It includes the overall sentiment, confidence scores across different sentiment categories, and the key phrases that significantly contributed to the sentiment determination.

Since:

1.2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MotorSentiment.ConfidenceScores	Inner class to encapsulate confidence scores for various sentiment categories.

Constructor Summary

Constructors

Constructor	Description
MotorSentiment()

Method Summary

Modifier and Type	Method	Description
MotorSentiment.ConfidenceScores	getConfidenceScores()	Retrieves the confidence scores for each sentiment category.
List<String>	getKeyPhrases()	Retrieves the list of key phrases that contributed to the sentiment analysis.
SentimentType	sentiment()	Retrieves the overall sentiment result of the analysis.
String	toString()	Provides a string representation of the sentiment analysis result.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

MotorSentiment

public MotorSentiment()

Method Details

sentiment

public SentimentType sentiment()

Retrieves the overall sentiment result of the analysis.

Returns:

an enum representing the sentiment type (POSITIVE, NEGATIVE, NEUTRAL).

getConfidenceScores

public MotorSentiment.ConfidenceScores getConfidenceScores()

Retrieves the confidence scores for each sentiment category.

Returns:

An instance of MotorSentiment.ConfidenceScores containing the scores.

getKeyPhrases

public List<String> getKeyPhrases()

Retrieves the list of key phrases that contributed to the sentiment analysis.

Returns:

A list of strings, each representing a key phrase.

toString

public String toString()

Provides a string representation of the sentiment analysis result.

Overrides:

toString in class Object

Returns:

A string that summarizes the sentiment, confidence scores, and key phrases.