Share via


SentimentActionResult Class

Definition

Sentiment analysis per document.

public class SentimentActionResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.Language.Text.SentimentActionResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Language.Text.SentimentActionResult>
type SentimentActionResult = class
    interface IJsonModel<SentimentActionResult>
    interface IPersistableModel<SentimentActionResult>
Public Class SentimentActionResult
Implements IJsonModel(Of SentimentActionResult), IPersistableModel(Of SentimentActionResult)
Inheritance
SentimentActionResult
Implements

Properties

Name Description
ConfidenceScores

The sentiment confidence score between 0 and 1 for the sentence for all classes.

DetectedLanguage

If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document.

Id

Unique, non-empty document identifier.

Sentences

The document's sentences sentiment.

Sentiment

Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).

Statistics

if showStats=true was specified in the request this field will contain information about the document payload.

Warnings

Warnings encountered while processing document.

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SentimentActionResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SentimentActionResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SentimentActionResult>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SentimentActionResult>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SentimentActionResult>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to