SearchModelFactory.CustomEntity Method

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Source:
SearchModelFactory.cs

An object that contains information about the matches that were found, and related metadata.

public static Azure.Search.Documents.Indexes.Models.CustomEntity CustomEntity(string name = default, string description = default, string type = default, string subtype = default, string id = default, bool? caseSensitive = default, bool? accentSensitive = default, int? fuzzyEditDistance = default, bool? defaultCaseSensitive = default, bool? defaultAccentSensitive = default, int? defaultFuzzyEditDistance = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.CustomEntityAlias> aliases = default);
static member CustomEntity : string * string * string * string * string * Nullable<bool> * Nullable<bool> * Nullable<int> * Nullable<bool> * Nullable<bool> * Nullable<int> * seq<Azure.Search.Documents.Indexes.Models.CustomEntityAlias> -> Azure.Search.Documents.Indexes.Models.CustomEntity
Public Shared Function CustomEntity (Optional name As String = Nothing, Optional description As String = Nothing, Optional type As String = Nothing, Optional subtype As String = Nothing, Optional id As String = Nothing, Optional caseSensitive As Nullable(Of Boolean) = Nothing, Optional accentSensitive As Nullable(Of Boolean) = Nothing, Optional fuzzyEditDistance As Nullable(Of Integer) = Nothing, Optional defaultCaseSensitive As Nullable(Of Boolean) = Nothing, Optional defaultAccentSensitive As Nullable(Of Boolean) = Nothing, Optional defaultFuzzyEditDistance As Nullable(Of Integer) = Nothing, Optional aliases As IEnumerable(Of CustomEntityAlias) = Nothing) As CustomEntity

Parameters

name
String

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.

description
String

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.

type
String

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.

subtype
String

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.

id
String

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.

caseSensitive
Nullable<Boolean>

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.

accentSensitive
Nullable<Boolean>

Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent.

fuzzyEditDistance
Nullable<Int32>

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.

defaultCaseSensitive
Nullable<Boolean>

Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values.

defaultAccentSensitive
Nullable<Boolean>

Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values.

defaultFuzzyEditDistance
Nullable<Int32>

Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values.

aliases
IEnumerable<CustomEntityAlias>

An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name.

Returns

CustomEntity

A new CustomEntity instance for mocking.

Applies to