Package com.oracle.bmc.ailanguage.model

Class SentimentDocumentResult

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.ailanguage.model.SentimentDocumentResult

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20221001")
public final class SentimentDocumentResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

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 SentimentDocumentResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SentimentDocumentResult.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	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	Description
static SentimentDocumentResult.Builder	builder()	Create a new builder.
boolean	equals(Object o)
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 defined by the user.
String	getLanguageCode()	Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew
List<SentimentSentence>	getSentences()	List of detected sentences sentiment.
int	hashCode()
SentimentDocumentResult.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SentimentDocumentResult

@Deprecated
@ConstructorProperties({"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 defined by the user.

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 supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel