91 строка
9.7 KiB
YAML
91 строка
9.7 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.textanalytics.models.DocumentSentiment"
|
|
fullName: "com.azure.ai.textanalytics.models.DocumentSentiment"
|
|
name: "DocumentSentiment"
|
|
nameWithType: "DocumentSentiment"
|
|
summary: "The `DocumentSentiment` model that contains sentiment label of a document, confidence score of the sentiment label, and a list of <xref uid=\"com.azure.ai.textanalytics.models.SentenceSentiment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentenceSentiment\"></xref>."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **DocumentSentiment**"
|
|
constructors:
|
|
- uid: "com.azure.ai.textanalytics.models.DocumentSentiment.DocumentSentiment(com.azure.ai.textanalytics.models.TextSentiment,com.azure.ai.textanalytics.models.SentimentConfidenceScores,com.azure.core.util.IterableStream<com.azure.ai.textanalytics.models.SentenceSentiment>,com.azure.core.util.IterableStream<com.azure.ai.textanalytics.models.TextAnalyticsWarning>)"
|
|
fullName: "com.azure.ai.textanalytics.models.DocumentSentiment.DocumentSentiment(TextSentiment sentiment, SentimentConfidenceScores confidenceScores, IterableStream<SentenceSentiment> sentences, IterableStream<TextAnalyticsWarning> warnings)"
|
|
name: "DocumentSentiment(TextSentiment sentiment, SentimentConfidenceScores confidenceScores, IterableStream<SentenceSentiment> sentences, IterableStream<TextAnalyticsWarning> warnings)"
|
|
nameWithType: "DocumentSentiment.DocumentSentiment(TextSentiment sentiment, SentimentConfidenceScores confidenceScores, IterableStream<SentenceSentiment> sentences, IterableStream<TextAnalyticsWarning> warnings)"
|
|
summary: "Creates a `DocumentSentiment` model that describes the sentiment of the document."
|
|
parameters:
|
|
- description: "The sentiment label of the document."
|
|
name: "sentiment"
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.TextSentiment?alt=com.azure.ai.textanalytics.models.TextSentiment&text=TextSentiment\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The sentiment confidence score (Softmax score) between 0 and 1, for each sentiment label.\n Higher values signify higher confidence."
|
|
name: "confidenceScores"
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.SentimentConfidenceScores?alt=com.azure.ai.textanalytics.models.SentimentConfidenceScores&text=SentimentConfidenceScores\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of sentence sentiments."
|
|
name: "sentences"
|
|
type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.textanalytics.models.SentenceSentiment?alt=com.azure.ai.textanalytics.models.SentenceSentiment&text=SentenceSentiment\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "An <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of <xref uid=\"com.azure.ai.textanalytics.models.TextAnalyticsWarning\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextAnalyticsWarning\"></xref>."
|
|
name: "warnings"
|
|
type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsWarning?alt=com.azure.ai.textanalytics.models.TextAnalyticsWarning&text=TextAnalyticsWarning\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public DocumentSentiment(TextSentiment sentiment, SentimentConfidenceScores confidenceScores, IterableStream<SentenceSentiment> sentences, IterableStream<TextAnalyticsWarning> warnings)"
|
|
desc: "Creates a `DocumentSentiment` model that describes the sentiment of the document."
|
|
methods:
|
|
- uid: "com.azure.ai.textanalytics.models.DocumentSentiment.getConfidenceScores()"
|
|
fullName: "com.azure.ai.textanalytics.models.DocumentSentiment.getConfidenceScores()"
|
|
name: "getConfidenceScores()"
|
|
nameWithType: "DocumentSentiment.getConfidenceScores()"
|
|
summary: "Gets the sentiment confidence score (Softmax score) between 0 and 1, for each sentiment label."
|
|
syntax: "public SentimentConfidenceScores getConfidenceScores()"
|
|
desc: "Gets the sentiment confidence score (Softmax score) between 0 and 1, for each sentiment label. Higher values signify higher confidence."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.ai.textanalytics.models.SentimentConfidenceScores\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentimentConfidenceScores\"></xref>."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.SentimentConfidenceScores?alt=com.azure.ai.textanalytics.models.SentimentConfidenceScores&text=SentimentConfidenceScores\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.DocumentSentiment.getSentences()"
|
|
fullName: "com.azure.ai.textanalytics.models.DocumentSentiment.getSentences()"
|
|
name: "getSentences()"
|
|
nameWithType: "DocumentSentiment.getSentences()"
|
|
summary: "Gets a list of sentence sentiments."
|
|
syntax: "public IterableStream<SentenceSentiment> getSentences()"
|
|
desc: "Gets a list of sentence sentiments."
|
|
returns:
|
|
description: "A list of sentence sentiments."
|
|
type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.textanalytics.models.SentenceSentiment?alt=com.azure.ai.textanalytics.models.SentenceSentiment&text=SentenceSentiment\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.textanalytics.models.DocumentSentiment.getSentiment()"
|
|
fullName: "com.azure.ai.textanalytics.models.DocumentSentiment.getSentiment()"
|
|
name: "getSentiment()"
|
|
nameWithType: "DocumentSentiment.getSentiment()"
|
|
summary: "Gets the text sentiment label: POSITIVE, NEGATIVE, NEUTRAL, or MIXED."
|
|
syntax: "public TextSentiment getSentiment()"
|
|
desc: "Gets the text sentiment label: POSITIVE, NEGATIVE, NEUTRAL, or MIXED."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.ai.textanalytics.models.TextSentiment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextSentiment\"></xref>."
|
|
type: "<xref href=\"com.azure.ai.textanalytics.models.TextSentiment?alt=com.azure.ai.textanalytics.models.TextSentiment&text=TextSentiment\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.DocumentSentiment.getWarnings()"
|
|
fullName: "com.azure.ai.textanalytics.models.DocumentSentiment.getWarnings()"
|
|
name: "getWarnings()"
|
|
nameWithType: "DocumentSentiment.getWarnings()"
|
|
summary: "Gets the <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of <xref uid=\"com.azure.ai.textanalytics.models.TextAnalyticsWarning\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Text Analytics warnings\"></xref>."
|
|
syntax: "public IterableStream<TextAnalyticsWarning> getWarnings()"
|
|
desc: "Gets the <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of <xref uid=\"com.azure.ai.textanalytics.models.TextAnalyticsWarning\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Text Analytics warnings\"></xref>."
|
|
returns:
|
|
description: "An <xref uid=\"com.azure.core.util.IterableStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"IterableStream\"></xref> of <xref uid=\"com.azure.ai.textanalytics.models.TextAnalyticsWarning\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TextAnalyticsWarning\"></xref>."
|
|
type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.ai.textanalytics.models.TextAnalyticsWarning?alt=com.azure.ai.textanalytics.models.TextAnalyticsWarning&text=TextAnalyticsWarning\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "The `DocumentSentiment` model that contains sentiment label of a document, confidence score of the sentiment label, and a list of <xref uid=\"com.azure.ai.textanalytics.models.SentenceSentiment\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentenceSentiment\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.ai.textanalytics.models"
|
|
artifact: com.azure:azure-ai-textanalytics:5.5.1
|