108 строки
8.0 KiB
YAML
108 строки
8.0 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.textanalytics.models.SentenceSentiment"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment"
|
|
name: "SentenceSentiment"
|
|
nameWithType: "SentenceSentiment"
|
|
summary: "The `SentenceSentiment` model that contains a sentiment label of a sentence, confidence scores of the sentiment label, sentence opinions, and offset of sentence within a document."
|
|
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 **SentenceSentiment**"
|
|
constructors:
|
|
- uid: "com.azure.ai.textanalytics.models.SentenceSentiment.SentenceSentiment(java.lang.String,com.azure.ai.textanalytics.models.TextSentiment,com.azure.ai.textanalytics.models.SentimentConfidenceScores)"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.SentenceSentiment(String text, TextSentiment sentiment, SentimentConfidenceScores confidenceScores)"
|
|
name: "SentenceSentiment(String text, TextSentiment sentiment, SentimentConfidenceScores confidenceScores)"
|
|
nameWithType: "SentenceSentiment.SentenceSentiment(String text, TextSentiment sentiment, SentimentConfidenceScores confidenceScores)"
|
|
summary: "Creates a `SentenceSentiment` model that describes the sentiment analysis of sentence."
|
|
parameters:
|
|
- description: "The sentence text."
|
|
name: "text"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The sentiment label of the sentence."
|
|
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\" />"
|
|
syntax: "public SentenceSentiment(String text, TextSentiment sentiment, SentimentConfidenceScores confidenceScores)"
|
|
desc: "Creates a `SentenceSentiment` model that describes the sentiment analysis of sentence."
|
|
methods:
|
|
- uid: "com.azure.ai.textanalytics.models.SentenceSentiment.getConfidenceScores()"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.getConfidenceScores()"
|
|
name: "getConfidenceScores()"
|
|
nameWithType: "SentenceSentiment.getConfidenceScores()"
|
|
summary: "Gets the confidence score of the sentiment label."
|
|
syntax: "public SentimentConfidenceScores getConfidenceScores()"
|
|
desc: "Gets the confidence score of the sentiment label. All score values sum up to 1, the higher the score, the higher the confidence in the sentiment."
|
|
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.SentenceSentiment.getLength()"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.getLength()"
|
|
name: "getLength()"
|
|
nameWithType: "SentenceSentiment.getLength()"
|
|
summary: "Gets the length of sentence."
|
|
syntax: "public int getLength()"
|
|
desc: "Gets the length of sentence."
|
|
returns:
|
|
description: "The length of sentence."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.SentenceSentiment.getOffset()"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.getOffset()"
|
|
name: "getOffset()"
|
|
nameWithType: "SentenceSentiment.getOffset()"
|
|
summary: "Gets the offset of sentence."
|
|
syntax: "public int getOffset()"
|
|
desc: "Gets the offset of sentence. The start position for the sentence in a document."
|
|
returns:
|
|
description: "The offset of sentence."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.textanalytics.models.SentenceSentiment.getOpinions()"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.getOpinions()"
|
|
name: "getOpinions()"
|
|
nameWithType: "SentenceSentiment.getOpinions()"
|
|
summary: "Gets the sentence opinions of sentence sentiment."
|
|
syntax: "public IterableStream<SentenceOpinion> getOpinions()"
|
|
desc: "Gets the sentence opinions of sentence sentiment. This is only returned if you pass the opinion mining parameter to the analyze sentiment APIs."
|
|
returns:
|
|
description: "The sentence opinions of sentence sentiment."
|
|
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.SentenceOpinion?alt=com.azure.ai.textanalytics.models.SentenceOpinion&text=SentenceOpinion\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.textanalytics.models.SentenceSentiment.getSentiment()"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.getSentiment()"
|
|
name: "getSentiment()"
|
|
nameWithType: "SentenceSentiment.getSentiment()"
|
|
summary: "Gets the text sentiment label: POSITIVE, NEGATIVE, or NEUTRAL."
|
|
syntax: "public TextSentiment getSentiment()"
|
|
desc: "Gets the text sentiment label: POSITIVE, NEGATIVE, or NEUTRAL."
|
|
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.SentenceSentiment.getText()"
|
|
fullName: "com.azure.ai.textanalytics.models.SentenceSentiment.getText()"
|
|
name: "getText()"
|
|
nameWithType: "SentenceSentiment.getText()"
|
|
summary: "Gets the sentence text property."
|
|
syntax: "public String getText()"
|
|
desc: "Gets the sentence text property."
|
|
returns:
|
|
description: "The text property value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
type: "class"
|
|
desc: "The `SentenceSentiment` model that contains a sentiment label of a sentence, confidence scores of the sentiment label, sentence opinions, and offset of sentence within a document."
|
|
metadata: {}
|
|
package: "com.azure.ai.textanalytics.models"
|
|
artifact: com.azure:azure-ai-textanalytics:5.5.1
|