349 строки
28 KiB
YAML
349 строки
28 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.search.documents.indexes.models.CustomEntity"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity"
|
|
name: "CustomEntity"
|
|
nameWithType: "CustomEntity"
|
|
summary: "An object that contains information about the matches that were found, and related metadata."
|
|
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 **CustomEntity**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.CustomEntity(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.CustomEntity(String name)"
|
|
name: "CustomEntity(String name)"
|
|
nameWithType: "CustomEntity.CustomEntity(String name)"
|
|
summary: "Creates an instance of Custom<wbr>Entity class."
|
|
parameters:
|
|
- description: "the name value to set."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CustomEntity(String name)"
|
|
desc: "Creates an instance of CustomEntity class."
|
|
methods:
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "CustomEntity.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Custom<wbr>Entity from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static CustomEntity fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of CustomEntity from the JsonReader."
|
|
returns:
|
|
description: "An instance of CustomEntity if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.getAliases()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getAliases()"
|
|
name: "getAliases()"
|
|
nameWithType: "CustomEntity.getAliases()"
|
|
summary: "Get the aliases property: An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name."
|
|
syntax: "public List<CustomEntityAlias> getAliases()"
|
|
desc: "Get the aliases property: An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name."
|
|
returns:
|
|
description: "the aliases value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.getDefaultFuzzyEditDistance()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getDefaultFuzzyEditDistance()"
|
|
name: "getDefaultFuzzyEditDistance()"
|
|
nameWithType: "CustomEntity.getDefaultFuzzyEditDistance()"
|
|
summary: "Get the default<wbr>Fuzzy<wbr>Edit<wbr>Distance property: Changes the default fuzzy edit distance value for this entity."
|
|
syntax: "public Integer getDefaultFuzzyEditDistance()"
|
|
desc: "Get the defaultFuzzyEditDistance property: Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values."
|
|
returns:
|
|
description: "the defaultFuzzyEditDistance value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.getDescription()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getDescription()"
|
|
name: "getDescription()"
|
|
nameWithType: "CustomEntity.getDescription()"
|
|
summary: "Get the description property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
syntax: "public String getDescription()"
|
|
desc: "Get the description property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the description 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.CustomEntity.getFuzzyEditDistance()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getFuzzyEditDistance()"
|
|
name: "getFuzzyEditDistance()"
|
|
nameWithType: "CustomEntity.getFuzzyEditDistance()"
|
|
summary: "Get the fuzzy<wbr>Edit<wbr>Distance property: Defaults to 0."
|
|
syntax: "public Integer getFuzzyEditDistance()"
|
|
desc: "Get the fuzzyEditDistance property: Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do."
|
|
returns:
|
|
description: "the fuzzyEditDistance value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.getId()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getId()"
|
|
name: "getId()"
|
|
nameWithType: "CustomEntity.getId()"
|
|
summary: "Get the id property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
syntax: "public String getId()"
|
|
desc: "Get the id property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the id 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.CustomEntity.getName()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getName()"
|
|
name: "getName()"
|
|
nameWithType: "CustomEntity.getName()"
|
|
summary: "Get the name property: The top-level entity descriptor."
|
|
syntax: "public String getName()"
|
|
desc: "Get the name property: The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found."
|
|
returns:
|
|
description: "the name 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.CustomEntity.getSubtype()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getSubtype()"
|
|
name: "getSubtype()"
|
|
nameWithType: "CustomEntity.getSubtype()"
|
|
summary: "Get the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
syntax: "public String getSubtype()"
|
|
desc: "Get the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the subtype 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.CustomEntity.getType()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.getType()"
|
|
name: "getType()"
|
|
nameWithType: "CustomEntity.getType()"
|
|
summary: "Get the type property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
syntax: "public String getType()"
|
|
desc: "Get the type property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the type 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.CustomEntity.isAccentSensitive()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.isAccentSensitive()"
|
|
name: "isAccentSensitive()"
|
|
nameWithType: "CustomEntity.isAccentSensitive()"
|
|
summary: "Get the accent<wbr>Sensitive property: Defaults to false."
|
|
syntax: "public Boolean isAccentSensitive()"
|
|
desc: "Get the accentSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent."
|
|
returns:
|
|
description: "the accentSensitive 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.CustomEntity.isCaseSensitive()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.isCaseSensitive()"
|
|
name: "isCaseSensitive()"
|
|
nameWithType: "CustomEntity.isCaseSensitive()"
|
|
summary: "Get the case<wbr>Sensitive property: Defaults to false."
|
|
syntax: "public Boolean isCaseSensitive()"
|
|
desc: "Get the caseSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT."
|
|
returns:
|
|
description: "the caseSensitive 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.CustomEntity.isDefaultAccentSensitive()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.isDefaultAccentSensitive()"
|
|
name: "isDefaultAccentSensitive()"
|
|
nameWithType: "CustomEntity.isDefaultAccentSensitive()"
|
|
summary: "Get the default<wbr>Accent<wbr>Sensitive property: Changes the default accent sensitivity value for this entity."
|
|
syntax: "public Boolean isDefaultAccentSensitive()"
|
|
desc: "Get the defaultAccentSensitive property: Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values."
|
|
returns:
|
|
description: "the defaultAccentSensitive 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.CustomEntity.isDefaultCaseSensitive()"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.isDefaultCaseSensitive()"
|
|
name: "isDefaultCaseSensitive()"
|
|
nameWithType: "CustomEntity.isDefaultCaseSensitive()"
|
|
summary: "Get the default<wbr>Case<wbr>Sensitive property: Changes the default case sensitivity value for this entity."
|
|
syntax: "public Boolean isDefaultCaseSensitive()"
|
|
desc: "Get the defaultCaseSensitive property: Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values."
|
|
returns:
|
|
description: "the defaultCaseSensitive 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.CustomEntity.setAccentSensitive(java.lang.Boolean)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setAccentSensitive(Boolean accentSensitive)"
|
|
name: "setAccentSensitive(Boolean accentSensitive)"
|
|
nameWithType: "CustomEntity.setAccentSensitive(Boolean accentSensitive)"
|
|
summary: "Set the accent<wbr>Sensitive property: Defaults to false."
|
|
parameters:
|
|
- description: "the accentSensitive value to set."
|
|
name: "accentSensitive"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CustomEntity setAccentSensitive(Boolean accentSensitive)"
|
|
desc: "Set the accentSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setAliases(java.util.List<com.azure.search.documents.indexes.models.CustomEntityAlias>)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setAliases(List<CustomEntityAlias> aliases)"
|
|
name: "setAliases(List<CustomEntityAlias> aliases)"
|
|
nameWithType: "CustomEntity.setAliases(List<CustomEntityAlias> aliases)"
|
|
summary: "Set the aliases property: An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name."
|
|
parameters:
|
|
- description: "the aliases value to set."
|
|
name: "aliases"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.search.documents.indexes.models.CustomEntityAlias?alt=com.azure.search.documents.indexes.models.CustomEntityAlias&text=CustomEntityAlias\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public CustomEntity setAliases(List<CustomEntityAlias> aliases)"
|
|
desc: "Set the aliases property: An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setCaseSensitive(java.lang.Boolean)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setCaseSensitive(Boolean caseSensitive)"
|
|
name: "setCaseSensitive(Boolean caseSensitive)"
|
|
nameWithType: "CustomEntity.setCaseSensitive(Boolean caseSensitive)"
|
|
summary: "Set the case<wbr>Sensitive property: Defaults to false."
|
|
parameters:
|
|
- description: "the caseSensitive value to set."
|
|
name: "caseSensitive"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CustomEntity setCaseSensitive(Boolean caseSensitive)"
|
|
desc: "Set the caseSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setDefaultAccentSensitive(java.lang.Boolean)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setDefaultAccentSensitive(Boolean defaultAccentSensitive)"
|
|
name: "setDefaultAccentSensitive(Boolean defaultAccentSensitive)"
|
|
nameWithType: "CustomEntity.setDefaultAccentSensitive(Boolean defaultAccentSensitive)"
|
|
summary: "Set the default<wbr>Accent<wbr>Sensitive property: Changes the default accent sensitivity value for this entity."
|
|
parameters:
|
|
- description: "the defaultAccentSensitive value to set."
|
|
name: "defaultAccentSensitive"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CustomEntity setDefaultAccentSensitive(Boolean defaultAccentSensitive)"
|
|
desc: "Set the defaultAccentSensitive property: Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setDefaultCaseSensitive(java.lang.Boolean)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setDefaultCaseSensitive(Boolean defaultCaseSensitive)"
|
|
name: "setDefaultCaseSensitive(Boolean defaultCaseSensitive)"
|
|
nameWithType: "CustomEntity.setDefaultCaseSensitive(Boolean defaultCaseSensitive)"
|
|
summary: "Set the default<wbr>Case<wbr>Sensitive property: Changes the default case sensitivity value for this entity."
|
|
parameters:
|
|
- description: "the defaultCaseSensitive value to set."
|
|
name: "defaultCaseSensitive"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public CustomEntity setDefaultCaseSensitive(Boolean defaultCaseSensitive)"
|
|
desc: "Set the defaultCaseSensitive property: Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setDefaultFuzzyEditDistance(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setDefaultFuzzyEditDistance(Integer defaultFuzzyEditDistance)"
|
|
name: "setDefaultFuzzyEditDistance(Integer defaultFuzzyEditDistance)"
|
|
nameWithType: "CustomEntity.setDefaultFuzzyEditDistance(Integer defaultFuzzyEditDistance)"
|
|
summary: "Set the default<wbr>Fuzzy<wbr>Edit<wbr>Distance property: Changes the default fuzzy edit distance value for this entity."
|
|
parameters:
|
|
- description: "the defaultFuzzyEditDistance value to set."
|
|
name: "defaultFuzzyEditDistance"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CustomEntity setDefaultFuzzyEditDistance(Integer defaultFuzzyEditDistance)"
|
|
desc: "Set the defaultFuzzyEditDistance property: Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setDescription(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setDescription(String description)"
|
|
name: "setDescription(String description)"
|
|
nameWithType: "CustomEntity.setDescription(String description)"
|
|
summary: "Set the description property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
parameters:
|
|
- description: "the description value to set."
|
|
name: "description"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CustomEntity setDescription(String description)"
|
|
desc: "Set the description property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setFuzzyEditDistance(java.lang.Integer)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setFuzzyEditDistance(Integer fuzzyEditDistance)"
|
|
name: "setFuzzyEditDistance(Integer fuzzyEditDistance)"
|
|
nameWithType: "CustomEntity.setFuzzyEditDistance(Integer fuzzyEditDistance)"
|
|
summary: "Set the fuzzy<wbr>Edit<wbr>Distance property: Defaults to 0."
|
|
parameters:
|
|
- description: "the fuzzyEditDistance value to set."
|
|
name: "fuzzyEditDistance"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public CustomEntity setFuzzyEditDistance(Integer fuzzyEditDistance)"
|
|
desc: "Set the fuzzyEditDistance property: Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setId(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setId(String id)"
|
|
name: "setId(String id)"
|
|
nameWithType: "CustomEntity.setId(String id)"
|
|
summary: "Set the id property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
parameters:
|
|
- description: "the id value to set."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CustomEntity setId(String id)"
|
|
desc: "Set the id property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setSubtype(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setSubtype(String subtype)"
|
|
name: "setSubtype(String subtype)"
|
|
nameWithType: "CustomEntity.setSubtype(String subtype)"
|
|
summary: "Set the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
parameters:
|
|
- description: "the subtype value to set."
|
|
name: "subtype"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CustomEntity setSubtype(String subtype)"
|
|
desc: "Set the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.setType(java.lang.String)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.setType(String type)"
|
|
name: "setType(String type)"
|
|
nameWithType: "CustomEntity.setType(String type)"
|
|
summary: "Set the type property: This field can be used as a passthrough for custom metadata about the matched text(s)."
|
|
parameters:
|
|
- description: "the type value to set."
|
|
name: "type"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CustomEntity setType(String type)"
|
|
desc: "Set the type property: This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output."
|
|
returns:
|
|
description: "the CustomEntity object itself."
|
|
type: "<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.search.documents.indexes.models.CustomEntity.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.search.documents.indexes.models.CustomEntity.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "CustomEntity.toJson(JsonWriter 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: "An object that contains information about the matches that were found, and related metadata."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.search.documents.indexes.models.CustomEntity?alt=com.azure.search.documents.indexes.models.CustomEntity&text=CustomEntity\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.search.documents.indexes.models"
|
|
artifact: com.azure:azure-search-documents:11.7.3
|