Share via


CustomSentimentAnalysisResultDocument Class

Definition

Custom Sentiment analysis result for a specific document.

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

Properties

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.

Explicit Interface Implementations

IJsonModel<CustomSentimentAnalysisResultDocument>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<CustomSentimentAnalysisResultDocument>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<CustomSentimentAnalysisResultDocument>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CustomSentimentAnalysisResultDocument>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CustomSentimentAnalysisResultDocument>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to