SimpleField interface

Paquet:

@azure/search-documents

Représente un champ dans une définition d’index, qui décrit le nom, le type de données et le comportement de recherche d’un champ.

Propriétés

analyzerName	Nom de l’analyseur à utiliser pour le champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche et ne peut pas être définie avec searchAnalyzer ou indexAnalyzer. Une fois l’analyseur choisi, il ne peut pas être modifié pour le champ.
facetable	Valeur indiquant s’il faut permettre au champ d’être référencé dans les requêtes de facettes. Généralement utilisé dans une présentation des résultats de recherche qui inclut le nombre d’accès par catégorie (par exemple, recherchez des caméras numériques et voyez les hits par marque, par millisecondes, par prix, etc.). Les champs de type Edm.GeographyPoint ou Collection (Edm.GeographyPoint) ne peuvent pas être facetables. La valeur par défaut est false.
filterable	Valeur indiquant si le champ doit être référencé dans $filter requêtes. filtrable diffère de l’élément pouvant faire l’objet d’une recherche dans la façon dont les chaînes sont gérées. Les champs de type Edm.String ou Collection(Edm.String) qui sont filtrables ne subissent pas de rupture de mot, de sorte que les comparaisons ne concernent que les correspondances exactes. Par exemple, si vous définissez un tel champ f sur « jour ensoleillé », $filter=f eq 'sunny' ne trouvera aucune correspondance, mais $filter=f eq 'sunny day' sera. La valeur par défaut est false.
hidden	Valeur indiquant si le champ peut être retourné dans un résultat de recherche. Vous pouvez désactiver cette option si vous souhaitez utiliser un champ (par exemple, marge) comme mécanisme de filtrage, de tri ou de scoring, mais ne souhaitez pas que le champ soit visible pour l’utilisateur final. Cette propriété doit être false pour les champs clés. Cette propriété peut être modifiée sur les champs existants. L’activation de cette propriété n’entraîne aucune augmentation des exigences de stockage d’index. La valeur par défaut est true pour les champs vectoriels, false sinon.
indexAnalyzerName	Nom de l’analyseur utilisé au moment de l’indexation pour le champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche. Elle doit être définie avec searchAnalyzer et elle ne peut pas être définie avec l’option analyseur. Cette propriété ne peut pas être définie sur le nom d’un analyseur de langage ; utilisez plutôt la propriété de l’analyseur si vous avez besoin d’un analyseur de langage. Une fois l’analyseur choisi, il ne peut pas être modifié pour le champ.
key	Valeur indiquant si le champ identifie de manière unique les documents dans l’index. Un champ de niveau supérieur exactement dans chaque index doit être choisi comme champ de clé et doit être de type Edm.String. Les champs clés peuvent être utilisés pour rechercher des documents directement et mettre à jour ou supprimer des documents spécifiques. La valeur par défaut est false.
name	Nom du champ, qui doit être unique dans la collection de champs du champ index ou parent.
searchable	Valeur indiquant si le champ peut faire l’objet d’une recherche en texte intégral. Cela signifie qu’il subira une analyse telle que la rupture de mots lors de l’indexation. Si vous définissez un champ pouvant faire l’objet d’une recherche sur une valeur telle que « jour ensoleillé », il sera divisé en interne en jetons individuels « ensoleillé » et « jour ». Cela permet de rechercher en texte intégral ces termes. Les champs de type Edm.String ou Collection(Edm.String) peuvent faire l’objet d’une recherche par défaut. Cette propriété doit être false pour les champs simples d’autres types de données autres que des chaînes. Remarque : les champs pouvant faire l’objet d’une recherche consomment de l’espace supplémentaire dans votre index pour prendre en charge des versions tokenisées supplémentaires de la valeur de champ pour les recherches en texte intégral. Si vous souhaitez économiser de l’espace dans votre index et que vous n’avez pas besoin d’un champ à inclure dans les recherches, définissez la valeur false dans la recherche. La valeur par défaut est false.
searchAnalyzerName	Nom de l’analyseur utilisé au moment de la recherche du champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche. Elle doit être définie avec indexAnalyzerName et elle ne peut pas être définie avec l’option analyzerName. Cette propriété ne peut pas être définie sur le nom d’un analyseur de langage ; utilisez plutôt la propriété analyzerName si vous avez besoin d’un analyseur de langage. Cet analyseur peut être mis à jour sur un champ existant.
sortable	Valeur indiquant si le champ doit être référencé dans $orderby expressions. Par défaut, le moteur de recherche trie les résultats par score, mais dans de nombreuses expériences, les utilisateurs souhaitent trier par champs dans les documents. Un champ simple peut être triable uniquement s’il est à valeur unique (il a une valeur unique dans l’étendue du document parent). Les champs de collection simples ne peuvent pas être triables, car ils sont à valeurs multiples. Les sous-champs simples des collections complexes sont également à valeurs multiples et ne peuvent donc pas être triables. C’est vrai, qu’il s’agisse d’un champ parent immédiat ou d’un champ ancêtre, c’est la collection complexe. La valeur par défaut est false.
stored	Valeur immuable indiquant si le champ sera conservé séparément sur le disque à retourner dans un résultat de recherche. Vous pouvez désactiver cette option si vous ne prévoyez pas de renvoyer le contenu du champ dans une réponse de recherche pour économiser sur la surcharge de stockage. Cela ne peut être défini que lors de la création d’index et uniquement pour les champs vectoriels. Cette propriété ne peut pas être modifiée pour les champs existants ou définie comme false pour les nouveaux champs. Si cette propriété est définie comme false, la propriété 'hidden' doit être définie sur 'true'. Cette propriété doit être false ou non définie pour les champs clés, pour les nouveaux champs et pour les champs non vectoriels. La désactivation de cette propriété réduit les exigences de stockage d’index.
synonymMapNames	Liste des noms des mappages de synonymes à associer à ce champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche. Actuellement, une seule carte de synonymes par champ est prise en charge. L’affectation d’un mappage de synonymes à un champ garantit que les termes de requête ciblant ce champ sont développés au moment de la requête à l’aide des règles de la carte de synonymes. Cet attribut peut être modifié sur les champs existants.
type	Type de données du champ.
vectorEncodingFormat	Format d’encodage pour interpréter le contenu du champ.
vectorSearchDimensions	Dimensionnalité du champ vectoriel.
vectorSearchProfileName	Nom du profil de recherche vectorielle qui spécifie l’algorithme et le vectoriseur à utiliser lors de la recherche dans le champ vectoriel.

Détails de la propriété

analyzerName

Nom de l’analyseur à utiliser pour le champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche et ne peut pas être définie avec searchAnalyzer ou indexAnalyzer. Une fois l’analyseur choisi, il ne peut pas être modifié pour le champ.

analyzerName?: string

Valeur de propriété

string

facetable

Valeur indiquant s’il faut permettre au champ d’être référencé dans les requêtes de facettes. Généralement utilisé dans une présentation des résultats de recherche qui inclut le nombre d’accès par catégorie (par exemple, recherchez des caméras numériques et voyez les hits par marque, par millisecondes, par prix, etc.). Les champs de type Edm.GeographyPoint ou Collection (Edm.GeographyPoint) ne peuvent pas être facetables. La valeur par défaut est false.

facetable?: boolean

Valeur de propriété

boolean

filterable

Valeur indiquant si le champ doit être référencé dans $filter requêtes. filtrable diffère de l’élément pouvant faire l’objet d’une recherche dans la façon dont les chaînes sont gérées. Les champs de type Edm.String ou Collection(Edm.String) qui sont filtrables ne subissent pas de rupture de mot, de sorte que les comparaisons ne concernent que les correspondances exactes. Par exemple, si vous définissez un tel champ f sur « jour ensoleillé », $filter=f eq 'sunny' ne trouvera aucune correspondance, mais $filter=f eq 'sunny day' sera. La valeur par défaut est false.

filterable?: boolean

Valeur de propriété

boolean

hidden

Valeur indiquant si le champ peut être retourné dans un résultat de recherche. Vous pouvez désactiver cette option si vous souhaitez utiliser un champ (par exemple, marge) comme mécanisme de filtrage, de tri ou de scoring, mais ne souhaitez pas que le champ soit visible pour l’utilisateur final. Cette propriété doit être false pour les champs clés. Cette propriété peut être modifiée sur les champs existants. L’activation de cette propriété n’entraîne aucune augmentation des exigences de stockage d’index. La valeur par défaut est true pour les champs vectoriels, false sinon.

hidden?: boolean

Valeur de propriété

boolean

indexAnalyzerName

Nom de l’analyseur utilisé au moment de l’indexation pour le champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche. Elle doit être définie avec searchAnalyzer et elle ne peut pas être définie avec l’option analyseur. Cette propriété ne peut pas être définie sur le nom d’un analyseur de langage ; utilisez plutôt la propriété de l’analyseur si vous avez besoin d’un analyseur de langage. Une fois l’analyseur choisi, il ne peut pas être modifié pour le champ.

indexAnalyzerName?: string

Valeur de propriété

string

key

Valeur indiquant si le champ identifie de manière unique les documents dans l’index. Un champ de niveau supérieur exactement dans chaque index doit être choisi comme champ de clé et doit être de type Edm.String. Les champs clés peuvent être utilisés pour rechercher des documents directement et mettre à jour ou supprimer des documents spécifiques. La valeur par défaut est false.

key?: boolean

Valeur de propriété

boolean

name

Nom du champ, qui doit être unique dans la collection de champs du champ index ou parent.

name: string

Valeur de propriété

string

searchable

Valeur indiquant si le champ peut faire l’objet d’une recherche en texte intégral. Cela signifie qu’il subira une analyse telle que la rupture de mots lors de l’indexation. Si vous définissez un champ pouvant faire l’objet d’une recherche sur une valeur telle que « jour ensoleillé », il sera divisé en interne en jetons individuels « ensoleillé » et « jour ». Cela permet de rechercher en texte intégral ces termes. Les champs de type Edm.String ou Collection(Edm.String) peuvent faire l’objet d’une recherche par défaut. Cette propriété doit être false pour les champs simples d’autres types de données autres que des chaînes. Remarque : les champs pouvant faire l’objet d’une recherche consomment de l’espace supplémentaire dans votre index pour prendre en charge des versions tokenisées supplémentaires de la valeur de champ pour les recherches en texte intégral. Si vous souhaitez économiser de l’espace dans votre index et que vous n’avez pas besoin d’un champ à inclure dans les recherches, définissez la valeur false dans la recherche. La valeur par défaut est false.

searchable?: boolean

Valeur de propriété

boolean

searchAnalyzerName

Nom de l’analyseur utilisé au moment de la recherche du champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche. Elle doit être définie avec indexAnalyzerName et elle ne peut pas être définie avec l’option analyzerName. Cette propriété ne peut pas être définie sur le nom d’un analyseur de langage ; utilisez plutôt la propriété analyzerName si vous avez besoin d’un analyseur de langage. Cet analyseur peut être mis à jour sur un champ existant.

searchAnalyzerName?: string

Valeur de propriété

string

sortable

Valeur indiquant si le champ doit être référencé dans $orderby expressions. Par défaut, le moteur de recherche trie les résultats par score, mais dans de nombreuses expériences, les utilisateurs souhaitent trier par champs dans les documents. Un champ simple peut être triable uniquement s’il est à valeur unique (il a une valeur unique dans l’étendue du document parent). Les champs de collection simples ne peuvent pas être triables, car ils sont à valeurs multiples. Les sous-champs simples des collections complexes sont également à valeurs multiples et ne peuvent donc pas être triables. C’est vrai, qu’il s’agisse d’un champ parent immédiat ou d’un champ ancêtre, c’est la collection complexe. La valeur par défaut est false.

sortable?: boolean

Valeur de propriété

boolean

stored

Valeur immuable indiquant si le champ sera conservé séparément sur le disque à retourner dans un résultat de recherche. Vous pouvez désactiver cette option si vous ne prévoyez pas de renvoyer le contenu du champ dans une réponse de recherche pour économiser sur la surcharge de stockage. Cela ne peut être défini que lors de la création d’index et uniquement pour les champs vectoriels. Cette propriété ne peut pas être modifiée pour les champs existants ou définie comme false pour les nouveaux champs. Si cette propriété est définie comme false, la propriété 'hidden' doit être définie sur 'true'. Cette propriété doit être false ou non définie pour les champs clés, pour les nouveaux champs et pour les champs non vectoriels. La désactivation de cette propriété réduit les exigences de stockage d’index.

stored?: boolean

Valeur de propriété

boolean

synonymMapNames

Liste des noms des mappages de synonymes à associer à ce champ. Cette option peut être utilisée uniquement avec des champs pouvant faire l’objet d’une recherche. Actuellement, une seule carte de synonymes par champ est prise en charge. L’affectation d’un mappage de synonymes à un champ garantit que les termes de requête ciblant ce champ sont développés au moment de la requête à l’aide des règles de la carte de synonymes. Cet attribut peut être modifié sur les champs existants.

synonymMapNames?: string[]

Valeur de propriété

string[]

type

Type de données du champ.

type: SearchFieldDataType

Valeur de propriété

SearchFieldDataType

vectorEncodingFormat

Format d’encodage pour interpréter le contenu du champ.

vectorEncodingFormat?: string

Valeur de propriété

string

vectorSearchDimensions

Dimensionnalité du champ vectoriel.

vectorSearchDimensions?: number

Valeur de propriété

number

vectorSearchProfileName

Nom du profil de recherche vectorielle qui spécifie l’algorithme et le vectoriseur à utiliser lors de la recherche dans le champ vectoriel.

vectorSearchProfileName?: string

Valeur de propriété

string