azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents....

212 строки
22 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.SentimentSkill"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill"
name: "SentimentSkill"
nameWithType: "SentimentSkill"
summary: "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson(com.azure.json.JsonReader)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.fromJson&text=fromJson\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getContext&text=getContext\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getDescription&text=getDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getInputs&text=getInputs\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getName()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getName&text=getName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOdataType&text=getOdataType\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs()?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.getOutputs&text=getOutputs\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext&text=setContext\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription&text=setDescription\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.setName&text=setName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson&text=toJson\" data-throw-if-not-resolved=\"False\" />"
- 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 **SentimentSkill**</br> extends <xref href=\"com.azure.search.documents.indexes.models.SearchIndexerSkill?alt=com.azure.search.documents.indexes.models.SearchIndexerSkill&text=SearchIndexerSkill\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.SentimentSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
name: "SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
nameWithType: "SentimentSkill.SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
summary: "Creates an instance of Sentiment<wbr>Skill class."
deprecatedTag: "Use <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkill.SentimentSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>,com.azure.search.documents.indexes.models.SentimentSkillVersion)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#SentimentSkill(List, List, SentimentSkillVersion)\"></xref> as <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkillVersion.V1\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentimentSkillVersion#V1\"></xref> is deprecated. See [skill deprecation][] for more information.\n\n\n[skill deprecation]: https://learn.microsoft.com/azure/search/cognitive-search-skill-deprecated"
parameters:
- description: "the inputs value to set."
name: "inputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.InputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.InputFieldMappingEntry&text=InputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "the outputs value to set."
name: "outputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.OutputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.OutputFieldMappingEntry&text=OutputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
desc: "Creates an instance of SentimentSkill class.\n\nThe instance of SentimentSkill uses <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkillVersion.V1\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentimentSkillVersion#V1\"></xref>, to set the specific version of the skill use <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkill.SentimentSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>,com.azure.search.documents.indexes.models.SentimentSkillVersion)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#SentimentSkill(List, List, SentimentSkillVersion)\"></xref>."
hasDeprecatedTag: true
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.SentimentSkill(java.util.List<com.azure.search.documents.indexes.models.InputFieldMappingEntry>,java.util.List<com.azure.search.documents.indexes.models.OutputFieldMappingEntry>,com.azure.search.documents.indexes.models.SentimentSkillVersion)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)"
name: "SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)"
nameWithType: "SentimentSkill.SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)"
summary: "Creates an instance of Sentiment<wbr>Skill class."
parameters:
- description: "the inputs value to set."
name: "inputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.InputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.InputFieldMappingEntry&text=InputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "the outputs value to set."
name: "outputs"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.search.documents.indexes.models.OutputFieldMappingEntry?alt=com.azure.search.documents.indexes.models.OutputFieldMappingEntry&text=OutputFieldMappingEntry\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "the SentimentSkillVersion value to set."
name: "version"
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkillVersion?alt=com.azure.search.documents.indexes.models.SentimentSkillVersion&text=SentimentSkillVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)"
desc: "Creates an instance of SentimentSkill class."
methods:
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.getDefaultLanguageCode()"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.getDefaultLanguageCode()"
name: "getDefaultLanguageCode()"
nameWithType: "SentimentSkill.getDefaultLanguageCode()"
summary: "Get the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
syntax: "public SentimentSkillLanguage getDefaultLanguageCode()"
desc: "Get the defaultLanguageCode property: A value indicating which language code to use. Default is en."
returns:
description: "the defaultLanguageCode value."
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkillLanguage?alt=com.azure.search.documents.indexes.models.SentimentSkillLanguage&text=SentimentSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.getModelVersion()"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.getModelVersion()"
name: "getModelVersion()"
nameWithType: "SentimentSkill.getModelVersion()"
summary: "Get the model<wbr>Version property: The version of the model to use when calling the Text Analytics service."
syntax: "public String getModelVersion()"
desc: "Get the modelVersion property: The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary."
returns:
description: "the modelVersion value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.getSkillVersion()"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.getSkillVersion()"
name: "getSkillVersion()"
nameWithType: "SentimentSkill.getSkillVersion()"
summary: "Gets the version of the <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkill\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentimentSkill\"></xref>."
syntax: "public SentimentSkillVersion getSkillVersion()"
desc: "Gets the version of the <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkill\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentimentSkill\"></xref>."
returns:
description: "The version of the <xref uid=\"com.azure.search.documents.indexes.models.SentimentSkill\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SentimentSkill\"></xref>."
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkillVersion?alt=com.azure.search.documents.indexes.models.SentimentSkillVersion&text=SentimentSkillVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.isOpinionMiningIncluded()"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.isOpinionMiningIncluded()"
name: "isOpinionMiningIncluded()"
nameWithType: "SentimentSkill.isOpinionMiningIncluded()"
summary: "Get the include<wbr>Opinion<wbr>Mining property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text."
syntax: "public Boolean isOpinionMiningIncluded()"
desc: "Get the includeOpinionMining property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false."
returns:
description: "the includeOpinionMining value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.setContext(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.setContext(String context)"
name: "setContext(String context)"
nameWithType: "SentimentSkill.setContext(String context)"
summary: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content)."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setContext(java.lang.String)"
parameters:
- name: "context"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SentimentSkill setContext(String context)"
desc: "Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkill?alt=com.azure.search.documents.indexes.models.SentimentSkill&text=SentimentSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.setDefaultLanguageCode(com.azure.search.documents.indexes.models.SentimentSkillLanguage)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.setDefaultLanguageCode(SentimentSkillLanguage defaultLanguageCode)"
name: "setDefaultLanguageCode(SentimentSkillLanguage defaultLanguageCode)"
nameWithType: "SentimentSkill.setDefaultLanguageCode(SentimentSkillLanguage defaultLanguageCode)"
summary: "Set the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
parameters:
- description: "the defaultLanguageCode value to set."
name: "defaultLanguageCode"
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkillLanguage?alt=com.azure.search.documents.indexes.models.SentimentSkillLanguage&text=SentimentSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
syntax: "public SentimentSkill setDefaultLanguageCode(SentimentSkillLanguage defaultLanguageCode)"
desc: "Set the defaultLanguageCode property: A value indicating which language code to use. Default is en."
returns:
description: "the SentimentSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkill?alt=com.azure.search.documents.indexes.models.SentimentSkill&text=SentimentSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.setDescription(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "SentimentSkill.setDescription(String description)"
summary: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setDescription(java.lang.String)"
parameters:
- name: "description"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SentimentSkill setDescription(String description)"
desc: "Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkill?alt=com.azure.search.documents.indexes.models.SentimentSkill&text=SentimentSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.setModelVersion(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.setModelVersion(String modelVersion)"
name: "setModelVersion(String modelVersion)"
nameWithType: "SentimentSkill.setModelVersion(String modelVersion)"
summary: "Set the model<wbr>Version property: The version of the model to use when calling the Text Analytics service."
parameters:
- description: "the modelVersion value to set."
name: "modelVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SentimentSkill setModelVersion(String modelVersion)"
desc: "Set the modelVersion property: The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary."
returns:
description: "the SentimentSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkill?alt=com.azure.search.documents.indexes.models.SentimentSkill&text=SentimentSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.setName(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.setName(String name)"
name: "setName(String name)"
nameWithType: "SentimentSkill.setName(String name)"
summary: "Set the name property: The name of the skill which uniquely identifies it within the skillset."
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.setName(java.lang.String)"
parameters:
- name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SentimentSkill setName(String name)"
desc: "Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '\\#'."
returns:
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkill?alt=com.azure.search.documents.indexes.models.SentimentSkill&text=SentimentSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.setOpinionMiningIncluded(java.lang.Boolean)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.setOpinionMiningIncluded(Boolean opinionMiningIncluded)"
name: "setOpinionMiningIncluded(Boolean opinionMiningIncluded)"
nameWithType: "SentimentSkill.setOpinionMiningIncluded(Boolean opinionMiningIncluded)"
summary: "Set the opinion<wbr>Mining<wbr>Included property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text."
parameters:
- description: "the opinionMiningIncluded value to set."
name: "opinionMiningIncluded"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public SentimentSkill setOpinionMiningIncluded(Boolean opinionMiningIncluded)"
desc: "Set the opinionMiningIncluded property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false."
returns:
description: "the SentimentSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.SentimentSkill?alt=com.azure.search.documents.indexes.models.SentimentSkill&text=SentimentSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.SentimentSkill.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.search.documents.indexes.models.SentimentSkill.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "SentimentSkill.toJson(JsonWriter jsonWriter)"
overridden: "com.azure.search.documents.indexes.models.SearchIndexerSkill.toJson(com.azure.json.JsonWriter)"
parameters:
- name: "jsonWriter"
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
returns:
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1."
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.1