com.oracle.bmc.ailanguage.model

Class SentimentDocumentResult

java.lang.Object

com.oracle.bmc.ailanguage.model.SentimentDocumentResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210101")
public final class SentimentDocumentResult
extends Object

The document response for sentiment detect call.
Note: Objects should always be created or deserialized using the SentimentDocumentResult.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SentimentDocumentResult.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SentimentDocumentResult.Builder

Constructor Summary

Constructors

Constructor and Description
SentimentDocumentResult(String key, String documentSentiment, Map<String,Double> documentScores, List<SentimentAspect> aspects, List<SentimentSentence> sentences, String languageCode) Deprecated.

Method Summary

Modifier and Type	Method and Description
static SentimentDocumentResult.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
List<SentimentAspect>	getAspects() List of detected aspects sentiment.
Map<String,Double>	getDocumentScores() Scores for each sentiment.
String	getDocumentSentiment() Document level sentiment.
String	getKey() Document Unique Identifier.
String	getLanguageCode() Language code as per ISO 639-1 standard.
List<SentimentSentence>	getSentences() List of detected sentences sentiment.
int	hashCode()
SentimentDocumentResult.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SentimentDocumentResult

@Deprecated
 @ConstructorProperties(value={"key","documentSentiment","documentScores","aspects","sentences","languageCode"})
public SentimentDocumentResult(String key,
                                                                                                                                                            String documentSentiment,
                                                                                                                                                            Map<String,Double> documentScores,
                                                                                                                                                            List<SentimentAspect> aspects,
                                                                                                                                                            List<SentimentSentence> sentences,
                                                                                                                                                            String languageCode)

Deprecated.

Method Detail

builder

public static SentimentDocumentResult.Builder builder()

Create a new builder.

toBuilder

public SentimentDocumentResult.Builder toBuilder()

getKey

public String getKey()

Document Unique Identifier.

Returns:

the value

getDocumentSentiment

public String getDocumentSentiment()

Document level sentiment.

Returns:

the value

getDocumentScores

public Map<String,Double> getDocumentScores()

Scores for each sentiment. Example: {“positive”: 1.0, “negative”: 0.0}

Returns:

the value

getAspects

public List<SentimentAspect> getAspects()

List of detected aspects sentiment.

Returns:

the value

getSentences

public List<SentimentSentence> getSentences()

List of detected sentences sentiment.

Returns:

the value

getLanguageCode

public String getLanguageCode()

Language code as per ISO 639-1 standard.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get__explicitlySet__

public Set<String> get__explicitlySet__()