Show / Hide Table of Contents

Class SentimentDocumentResult

The document response for sentiment detect call.

Inheritance
object
SentimentDocumentResult
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.AilanguageService.Models
Assembly: OCI.DotNetSDK.Ailanguage.dll
Syntax
public class SentimentDocumentResult

Properties

Aspects

Declaration
[Required(ErrorMessage = "Aspects is required.")]
[JsonProperty(PropertyName = "aspects")]
public List<SentimentAspect> Aspects { get; set; }
Property Value
Type Description
List<SentimentAspect>

List of detected aspects sentiment.

Remarks

Required

DocumentScores

Declaration
[JsonProperty(PropertyName = "documentScores")]
public Dictionary<string, double> DocumentScores { get; set; }
Property Value
Type Description
Dictionary<string, double>

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

DocumentSentiment

Declaration
[JsonProperty(PropertyName = "documentSentiment")]
public string DocumentSentiment { get; set; }
Property Value
Type Description
string

Document level sentiment.

Key

Declaration
[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }
Property Value
Type Description
string

Document unique identifier defined by the user.

Remarks

Required

LanguageCode

Declaration
[Required(ErrorMessage = "LanguageCode is required.")]
[JsonProperty(PropertyName = "languageCode")]
public string LanguageCode { get; set; }
Property Value
Type Description
string

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
Remarks

Required

Sentences

Declaration
[JsonProperty(PropertyName = "sentences")]
public List<SentimentSentence> Sentences { get; set; }
Property Value
Type Description
List<SentimentSentence>

List of detected sentences sentiment.

In this article
Back to top