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

274 строки
29 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill"
name: "EntityRecognitionSkill"
nameWithType: "EntityRecognitionSkill"
summary: "Text analytics entity recognition."
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 **EntityRecognitionSkill**</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.EntityRecognitionSkill.EntityRecognitionSkill(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.EntityRecognitionSkill.EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
name: "EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
nameWithType: "EntityRecognitionSkill.EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
summary: "Creates an instance of Entity<wbr>Recognition<wbr>Skill class."
deprecatedTag: "Use <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill.EntityRecognitionSkill(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.EntityRecognitionSkillVersion)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#EntityRecognitionSkill(List, List, EntityRecognitionSkillVersion)\"></xref> as <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkillVersion.V1\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EntityRecognitionSkillVersion#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 EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)"
desc: "Creates an instance of EntityRecognitionSkill class.\n\nThe instance of SentimentSkill uses <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkillVersion.V1\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EntityRecognitionSkillVersion#V1\"></xref>, to set the specific version of the skill use <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill.EntityRecognitionSkill(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.EntityRecognitionSkillVersion)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#EntityRecognitionSkill(List, List, EntityRecognitionSkillVersion)\"></xref>."
hasDeprecatedTag: true
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.EntityRecognitionSkill(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.EntityRecognitionSkillVersion)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, EntityRecognitionSkillVersion version)"
name: "EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, EntityRecognitionSkillVersion version)"
nameWithType: "EntityRecognitionSkill.EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, EntityRecognitionSkillVersion version)"
summary: "Creates an instance of Entity<wbr>Recognition<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 EntityRecognitionSkillVersion value to set."
name: "version"
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkillVersion?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkillVersion&text=EntityRecognitionSkillVersion\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, EntityRecognitionSkillVersion version)"
desc: "Creates an instance of EntityRecognitionSkill class."
methods:
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.areTypelessEntitiesIncluded()"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.areTypelessEntitiesIncluded()"
name: "areTypelessEntitiesIncluded()"
nameWithType: "EntityRecognitionSkill.areTypelessEntitiesIncluded()"
summary: "Get the include<wbr>Typeless<wbr>Entities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type."
syntax: "public Boolean areTypelessEntitiesIncluded()"
desc: "Get the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced."
returns:
description: "the includeTypelessEntities 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.EntityRecognitionSkill.getCategories()"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getCategories()"
name: "getCategories()"
nameWithType: "EntityRecognitionSkill.getCategories()"
summary: "Get the categories property: A list of entity categories that should be extracted."
syntax: "public List<EntityCategory> getCategories()"
desc: "Get the categories property: A list of entity categories that should be extracted."
returns:
description: "the categories value."
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.EntityCategory?alt=com.azure.search.documents.indexes.models.EntityCategory&text=EntityCategory\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getDefaultLanguageCode()"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getDefaultLanguageCode()"
name: "getDefaultLanguageCode()"
nameWithType: "EntityRecognitionSkill.getDefaultLanguageCode()"
summary: "Get the default<wbr>Language<wbr>Code property: A value indicating which language code to use."
syntax: "public EntityRecognitionSkillLanguage 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.EntityRecognitionSkillLanguage?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkillLanguage&text=EntityRecognitionSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getMinimumPrecision()"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getMinimumPrecision()"
name: "getMinimumPrecision()"
nameWithType: "EntityRecognitionSkill.getMinimumPrecision()"
summary: "Get the minimum<wbr>Precision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified."
syntax: "public Double getMinimumPrecision()"
desc: "Get the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included."
returns:
description: "the minimumPrecision value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getModelVersion()"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getModelVersion()"
name: "getModelVersion()"
nameWithType: "EntityRecognitionSkill.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.EntityRecognitionSkill.getSkillVersion()"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.getSkillVersion()"
name: "getSkillVersion()"
nameWithType: "EntityRecognitionSkill.getSkillVersion()"
summary: "Gets the version of the <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EntityRecognitionSkill\"></xref>."
syntax: "public EntityRecognitionSkillVersion getSkillVersion()"
desc: "Gets the version of the <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EntityRecognitionSkill\"></xref>."
returns:
description: "The version of the <xref uid=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EntityRecognitionSkill\"></xref>."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkillVersion?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkillVersion&text=EntityRecognitionSkillVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setCategories(com.azure.search.documents.indexes.models.EntityCategory...)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setCategories(EntityCategory[] categories)"
name: "setCategories(EntityCategory[] categories)"
nameWithType: "EntityRecognitionSkill.setCategories(EntityCategory[] categories)"
summary: "Set the categories property: A list of entity categories that should be extracted."
parameters:
- description: "the categories value to set."
name: "categories"
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityCategory?alt=com.azure.search.documents.indexes.models.EntityCategory&text=EntityCategory\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public EntityRecognitionSkill setCategories(EntityCategory[] categories)"
desc: "Set the categories property: A list of entity categories that should be extracted."
returns:
description: "the EntityRecognitionSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setCategories(java.util.List<com.azure.search.documents.indexes.models.EntityCategory>)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setCategories(List<EntityCategory> categories)"
name: "setCategories(List<EntityCategory> categories)"
nameWithType: "EntityRecognitionSkill.setCategories(List<EntityCategory> categories)"
summary: "Set the categories property: A list of entity categories that should be extracted."
parameters:
- description: "the categories value to set."
name: "categories"
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.EntityCategory?alt=com.azure.search.documents.indexes.models.EntityCategory&text=EntityCategory\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public EntityRecognitionSkill setCategories(List<EntityCategory> categories)"
desc: "Set the categories property: A list of entity categories that should be extracted."
returns:
description: "the EntityRecognitionSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setContext(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setContext(String context)"
name: "setContext(String context)"
nameWithType: "EntityRecognitionSkill.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 EntityRecognitionSkill 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.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setDefaultLanguageCode(com.azure.search.documents.indexes.models.EntityRecognitionSkillLanguage)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode)"
name: "setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode)"
nameWithType: "EntityRecognitionSkill.setDefaultLanguageCode(EntityRecognitionSkillLanguage 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.EntityRecognitionSkillLanguage?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkillLanguage&text=EntityRecognitionSkillLanguage\" data-throw-if-not-resolved=\"False\" />"
syntax: "public EntityRecognitionSkill setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode)"
desc: "Set the defaultLanguageCode property: A value indicating which language code to use. Default is en."
returns:
description: "the EntityRecognitionSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setDescription(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setDescription(String description)"
name: "setDescription(String description)"
nameWithType: "EntityRecognitionSkill.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 EntityRecognitionSkill 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.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setMinimumPrecision(java.lang.Double)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setMinimumPrecision(Double minimumPrecision)"
name: "setMinimumPrecision(Double minimumPrecision)"
nameWithType: "EntityRecognitionSkill.setMinimumPrecision(Double minimumPrecision)"
summary: "Set the minimum<wbr>Precision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified."
parameters:
- description: "the minimumPrecision value to set."
name: "minimumPrecision"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
syntax: "public EntityRecognitionSkill setMinimumPrecision(Double minimumPrecision)"
desc: "Set the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included."
returns:
description: "the EntityRecognitionSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setModelVersion(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setModelVersion(String modelVersion)"
name: "setModelVersion(String modelVersion)"
nameWithType: "EntityRecognitionSkill.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 EntityRecognitionSkill 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 EntityRecognitionSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setName(java.lang.String)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setName(String name)"
name: "setName(String name)"
nameWithType: "EntityRecognitionSkill.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 EntityRecognitionSkill 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.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setTypelessEntitiesIncluded(java.lang.Boolean)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.setTypelessEntitiesIncluded(Boolean includeTypelessEntities)"
name: "setTypelessEntitiesIncluded(Boolean includeTypelessEntities)"
nameWithType: "EntityRecognitionSkill.setTypelessEntitiesIncluded(Boolean includeTypelessEntities)"
summary: "Set the include<wbr>Typeless<wbr>Entities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type."
parameters:
- description: "the includeTypelessEntities value to set."
name: "includeTypelessEntities"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public EntityRecognitionSkill setTypelessEntitiesIncluded(Boolean includeTypelessEntities)"
desc: "Set the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced."
returns:
description: "the EntityRecognitionSkill object itself."
type: "<xref href=\"com.azure.search.documents.indexes.models.EntityRecognitionSkill?alt=com.azure.search.documents.indexes.models.EntityRecognitionSkill&text=EntityRecognitionSkill\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.search.documents.indexes.models.EntityRecognitionSkill.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "EntityRecognitionSkill.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 entity recognition."
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.3