Schema

Définition du schéma d'une source de données.

Représentation JSON
{
  "objectDefinitions": [
    {
      object (ObjectDefinition)
    }
  ],
  "operationIds": [
    string
  ]
}
Champs
objectDefinitions[]

object (ObjectDefinition)

Liste des objets de premier niveau de la source de données. Le nombre maximal d'éléments est de 10.

operationIds[]

string

ID des opérations de longue durée (LRO) actuellement exécutées pour ce schéma. Après avoir modifié le schéma, attendez que les opérations soient terminées avant d'indexer du contenu supplémentaire.

ObjectDefinition

Définition d'un objet dans une source de données.

Représentation JSON
{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}
Champs
name

string

Nom de l'objet, qui définit ensuite son type. Les requêtes d'indexation des articles doivent définir le champ objectType sur cette valeur. Par exemple, si name est Document, les requêtes d'indexation pour les éléments de type Document doivent définir objectType sur Document. Chaque définition d'objet doit porter un nom unique dans un schéma. Le nom doit commencer par une lettre et ne peut contenir que des lettres (A-Z, a-z) ou des chiffres (0-9). La longueur maximale est de 256 caractères.

options

object (ObjectOptions)

Options facultatives spécifiques à l'objet.

propertyDefinitions[]

object (PropertyDefinition)

Définitions des propriétés de l'objet. Le nombre maximal d'éléments est de 1 000.

ObjectOptions

Options d'un objet.

Représentation JSON
{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}
Champs
freshnessOptions

object (ObjectOptions.FreshnessOptions)

Options d'actualisation d'un objet.

displayOptions

object (ObjectDisplayOptions)

Options qui déterminent la façon dont l'objet s'affiche sur la page des résultats de Cloud Search.

suggestionFilteringOperators[]

string

Opérateurs pouvant être utilisés pour filtrer les suggestions. Pour l'API query.suggest, seuls les opérateurs mentionnés ici seront acceptés dans FilterOptions. Seuls les opérateurs TEXT et ENUM sont acceptés.

REMARQUE: "objecttype", "type" et "mimetype" sont déjà acceptés. Cette propriété permet de configurer des opérateurs spécifiques au schéma.

Même s'il s'agit d'un tableau, vous ne pouvez spécifier qu'un seul opérateur. Il s'agit d'un tableau permettant une extension future.

Les opérateurs mappant plusieurs propriétés dans le même objet ne sont pas acceptés. Si l'opérateur s'applique à différents types d'objets, cette option doit être définie une fois pour chaque définition d'objet.

ObjectOptions.FreshnessOptions

Indique la propriété de fraîcheur à utiliser lors de l'ajustement du classement des recherches d'un article. Plus les dates sont récentes, plus la qualité est élevée. Utilisez la propriété d'option de fraîcheur la mieux adaptée à vos données. Pour les documents partagés, la date et l'heure de la dernière modification sont les plus pertinentes. Pour les données d'événements d'agenda, l'heure à laquelle l'événement se produit est un indicateur de fraîcheur plus pertinent. Ainsi, les événements du calendrier qui se produisent plus près de l'heure de la requête de recherche sont considérés comme de meilleure qualité et sont classés en conséquence.

Représentation JSON
{
  "freshnessProperty": string,
  "freshnessDuration": string
}
Champs
freshnessProperty

string

Cette propriété indique le niveau de fraîcheur de l'objet dans l'index. Si elle est définie, cette propriété doit être une propriété de niveau supérieur dans property definitions et doit être un timestamp type ou un date type. Sinon, l'API d'indexation utilise updateTime comme indicateur de fraîcheur. La longueur maximale est de 256 caractères.

Lorsqu'une propriété est utilisée pour calculer la fraîcheur, la valeur par défaut est de deux ans à compter de l'heure actuelle.

freshnessDuration

string (Duration format)

Durée au terme de laquelle un objet doit être considéré comme obsolète. La valeur par défaut est de 180 jours (en secondes).

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

ObjectDisplayOptions

Options d'affichage d'un objet.

Représentation JSON
{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}
Champs
objectDisplayLabel

string

Libellé convivial à afficher dans les résultats de recherche pour indiquer le type de l'élément. Ce champ est FACULTATIF. Si vous ne le renseignez pas, aucun libellé d'objet ne s'affiche dans la ligne de contexte des résultats de recherche. La longueur maximale est de 64 caractères.

metalines[]

object (ObjectDisplayOptions.Metaline)

Définit les propriétés qui s'affichent dans les métalignes des résultats de recherche. Les valeurs de la propriété sont affichées dans l'ordre indiqué ici. Si une propriété contient plusieurs valeurs, toutes les valeurs sont affichées avant les propriétés suivantes. Pour cette raison, il est recommandé de spécifier les propriétés uniques avant les propriétés répétées dans cette liste. Toutes les propriétés doivent définir isReturnable sur "true". Le nombre maximal de métalignes est de trois.

ObjectDisplayOptions.Metaline

Une métaligne est une liste de propriétés qui s'affiche avec le résultat de recherche pour fournir du contexte.

Représentation JSON
{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}
Champs
properties[]

object (ObjectDisplayOptions.DisplayedProperty)

Liste des propriétés affichées pour la métaligne. Le nombre maximal de propriétés est de cinq.

ObjectDisplayOptions.DisplayedProperty

Référence à une propriété de niveau supérieur dans l'objet qui doit s'afficher dans les résultats de recherche. Les valeurs des propriétés choisies s'affichent dans les résultats de recherche, ainsi que l'display label de cette propriété, le cas échéant. Si aucun libellé d'affichage n'est spécifié, seules les valeurs sont affichées.

Représentation JSON
{
  "propertyName": string
}
Champs
propertyName

string

Nom de la propriété de niveau supérieur, tel que défini dans une définition de propriété pour l'objet. Si le nom n'est pas une propriété définie dans le schéma, une erreur s'affiche lorsque vous tentez de mettre à jour le schéma.

PropertyDefinition

Définition d'une propriété dans un objet.

Représentation JSON
{
  "name": string,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isSuggestable": boolean,
  "isWildcardSearchable": boolean,
  "displayOptions": {
    object (PropertyDisplayOptions)
  },

  // Union field property_options can be only one of the following:
  "integerPropertyOptions": {
    object (IntegerPropertyOptions)
  },
  "doublePropertyOptions": {
    object (DoublePropertyOptions)
  },
  "timestampPropertyOptions": {
    object (TimestampPropertyOptions)
  },
  "booleanPropertyOptions": {
    object (BooleanPropertyOptions)
  },
  "objectPropertyOptions": {
    object (ObjectPropertyOptions)
  },
  "enumPropertyOptions": {
    object (EnumPropertyOptions)
  },
  "datePropertyOptions": {
    object (DatePropertyOptions)
  },
  "textPropertyOptions": {
    object (TextPropertyOptions)
  },
  "htmlPropertyOptions": {
    object (HtmlPropertyOptions)
  }
  // End of list of possible types for union field property_options.
}
Champs
name

string

Nom de l'établissement. Les requêtes d'indexation des articles envoyées à l'API d'indexation doivent définir property name sur cette valeur. Par exemple, si le nom est subject_line, les requêtes d'indexation des éléments de document avec des champs d'objet doivent définir la valeur name de ce champ sur subject_line. Utilisez le nom comme identifiant de la propriété de l'objet. Une fois enregistré en tant que propriété d'un objet, ce nom ne peut plus être réutilisé pour une autre propriété de cet objet. Le nom doit commencer par une lettre et ne peut contenir que des lettres (A-Z, a-z) ou des chiffres (0-9). La longueur maximale est de 256 caractères.

isReturnable

boolean

Indique que la propriété identifie les données à renvoyer dans les résultats de recherche via l'API Query. Si cette valeur est définie sur true, cela signifie que les utilisateurs de l'API Query peuvent utiliser les champs de propriété correspondants dans les résultats. Toutefois, le stockage de champs nécessite une allocation d'espace plus importante et utilise davantage de bande passante pour les requêtes de recherche, ce qui affecte les performances sur de grands ensembles de données. Définissez cette valeur sur true uniquement si le champ est nécessaire pour les résultats de recherche. Ne peut pas être défini sur "true" pour les propriétés dont le type est un objet.

isRepeatable

boolean

Indique que plusieurs valeurs sont autorisées pour la propriété. Par exemple, un document ne comporte qu'une seule description, mais peut avoir plusieurs commentaires. Ne peut pas être défini sur "true" pour les propriétés dont le type est booléen. Si cette valeur est définie sur "false", les propriétés contenant plusieurs valeurs entraînent le rejet de la requête d'indexation de cet élément.

isSortable

boolean

Indique que la propriété peut être utilisée pour le tri. Cette option ne peut pas être associée à la valeur "true" pour les propriétés qui sont reproductibles. Ne peut pas être associé à la valeur "true" pour les propriétés dont le type est "object". Pour définir cette option, la valeur de "IsReturnable" doit être "true". Compatible uniquement avec les propriétés booléennes, de date, doubles, entières et d'horodatage.

isFacetable

boolean

Indique que la propriété peut être utilisée pour générer des attributs. Ne peut pas être associé à la valeur "true" pour les propriétés dont le type est "object". Pour définir cette option, la valeur de "IsReturnable" doit être "true". Disponible uniquement pour les propriétés booléennes, énumérées, entières et textuelles.

isSuggestable

boolean

Indique que la propriété peut être utilisée pour générer des suggestions de requêtes.

isWildcardSearchable

boolean

Indique que les utilisateurs peuvent effectuer une recherche avec caractères génériques pour cette propriété. Compatible uniquement avec les propriétés de texte. La valeur "true" doit être attribuée à "IsReturnable" pour définir cette option. Dans une source de données donnée, vous ne pouvez marquer qu'un maximum de cinq propriétés comme "isWildcardSearchable". Pour en savoir plus, consultez Définir les propriétés d'un objet.

displayOptions

object (PropertyDisplayOptions)

Options qui déterminent la manière dont la propriété est affichée sur la page des résultats de recherche dans le cloud si elle est spécifiée pour être affichée dans le display options de l'objet.

Champ d'union property_options. Options spécifiques au type qui déterminent la manière dont la propriété est indexée et utilisée. Si les options doivent être les options par défaut d'un type, ce champ doit toujours être défini sur l'un des types. Si ce champ n'est pas défini, les mises à jour de schéma sont refusées. property_options ne peut être qu'un des éléments suivants :
integerPropertyOptions

object (IntegerPropertyOptions)

doublePropertyOptions

object (DoublePropertyOptions)

timestampPropertyOptions

object (TimestampPropertyOptions)

booleanPropertyOptions

object (BooleanPropertyOptions)

objectPropertyOptions

object (ObjectPropertyOptions)

enumPropertyOptions

object (EnumPropertyOptions)

datePropertyOptions

object (DatePropertyOptions)

textPropertyOptions

object (TextPropertyOptions)

htmlPropertyOptions

object (HtmlPropertyOptions)

IntegerPropertyOptions

Options pour les propriétés de nombre entier.

Représentation JSON
{
  "orderedRanking": enum (IntegerPropertyOptions.OrderedRanking),
  "minimumValue": string,
  "maximumValue": string,
  "operatorOptions": {
    object (IntegerPropertyOptions.IntegerOperatorOptions)
  },
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Champs
orderedRanking

enum (IntegerPropertyOptions.OrderedRanking)

Permet de spécifier le classement ordonné de l'entier. Ne peut être utilisé que si la valeur de isRepeatable est "false".

minimumValue

string (Int64Value format)

Valeur minimale de la propriété. Les valeurs minimale et maximale de la propriété sont utilisées pour classer les résultats en fonction de l'ordered ranking. Les requêtes d'indexation dont la valeur est inférieure à la valeur minimale sont acceptées et classées avec le même poids que les éléments indexés avec la valeur minimale.

maximumValue

string (Int64Value format)

Valeur maximale de la propriété. Les valeurs minimale et maximale de la propriété sont utilisées pour classer les résultats en fonction de l'ordered ranking. Les requêtes d'indexation avec des valeurs supérieures à la valeur maximale sont acceptées et classées avec la même pondération que les éléments indexés avec la valeur maximale.

operatorOptions

object (IntegerPropertyOptions.IntegerOperatorOptions)

Si défini, décrit comment l'entier doit être utilisé en tant qu'opérateur de recherche.

integerFacetingOptions

object (IntegerFacetingOptions)

Si défini, décrit les options de facettage des entiers pour la propriété entière donnée. La propriété entière correspondante doit être marquée comme "isFacetable".

IntegerPropertyOptions.OrderedRanking

Permet de spécifier comment une valeur entière doit être classée par rapport aux autres valeurs. Un entier ayant un classement plus élevé indique une importance plus élevée. Par exemple, dans certaines sources de données, une priorité plus faible indique une importance plus élevée, tandis que dans d'autres, une priorité plus élevée indique une importance plus élevée.

Enums
NO_ORDER Il n'y a pas d'ordre de classement pour l'établissement. La valeur de cette propriété n'a aucune incidence sur les résultats.
ASCENDING Cette propriété est classée par ordre croissant. Plus la valeur est faible, plus le classement est bas.
DESCENDING Cette propriété est classée par ordre décroissant. Plus la valeur est faible, plus le classement est élevé.

IntegerPropertyOptions.IntegerOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés entières. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété entière. Par exemple, si le nom de l'opérateur est priority et que le nom de la propriété est priorityVal, les requêtes telles que priority:<value> ne renvoient des résultats que lorsque la valeur de la propriété priorityVal correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de n'importe quelle propriété de chaîne ou de texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

lessThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété entière à l'aide de l'opérateur inférieur. Par exemple, si le nom de l'opérateur est prioritybelow et que le nom de la propriété est priorityVal, les requêtes telles que prioritybelow:<value> ne renvoient des résultats que lorsque la valeur de la propriété priorityVal est inférieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

greaterThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété entière à l'aide de l'opérateur "supérieur à". Par exemple, si le nom de l'opérateur est priorityabove et que le nom de la propriété est priorityVal, les requêtes telles que priorityabove:<value> ne renvoient des résultats que lorsque la valeur de la propriété priorityVal est supérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

DoublePropertyOptions

Options pour les propriétés doubles.

Représentation JSON
{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}
Champs
operatorOptions

object (DoublePropertyOptions.DoubleOperatorOptions)

Si défini, décrit comment le double doit être utilisé en tant qu'opérateur de recherche.

DoublePropertyOptions.DoubleOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés doubles. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour utiliser la propriété double lors du tri ou en tant que facette. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

TimestampPropertyOptions

Options pour les propriétés de code temporel.

Représentation JSON
{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}
Champs
operatorOptions

object (TimestampPropertyOptions.TimestampOperatorOptions)

Si défini, décrit comment le code temporel doit être utilisé en tant qu'opérateur de recherche.

TimestampPropertyOptions.TimestampOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés de code temporel. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété d'horodatage. Par exemple, si operatorName est closedon et que le nom de la propriété est closeDate, les requêtes telles que closedon:<value> ne renvoient des résultats que lorsque la valeur de la propriété closeDate correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de n'importe quelle propriété de chaîne ou de texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

lessThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété "code temporel" à l'aide de l'opérateur "inférieur à". Par exemple, si le nom de l'opérateur inférieur est closedbefore et que le nom de la propriété est closeDate, les requêtes telles que closedbefore:<value> ne renvoient des résultats que lorsque la valeur de la propriété closeDate est antérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

greaterThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété "code temporel" à l'aide de l'opérateur "supérieur à". Par exemple, si greaterThanOperatorName est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> ne renvoient des résultats que lorsque la valeur de la propriété closeDate est postérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

BooleanPropertyOptions

Options pour les propriétés booléennes.

Représentation JSON
{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}
Champs
operatorOptions

object (BooleanPropertyOptions.BooleanOperatorOptions)

Si défini, décrit comment la valeur booléenne doit être utilisée en tant qu'opérateur de recherche.

BooleanPropertyOptions.BooleanOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés booléennes. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété booléenne. Par exemple, si le nom de l'opérateur est closed et que le nom de la propriété est isClosed, les requêtes telles que closed:<value> ne renvoient des résultats que lorsque la valeur de la propriété isClosed correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de n'importe quelle propriété de chaîne ou de texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

ObjectPropertyOptions

Options des propriétés d'objet.

Représentation JSON
{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}
Champs
subobjectProperties[]

object (PropertyDefinition)

Propriétés du sous-objet. Ces propriétés représentent un objet imbriqué. Par exemple, si cette propriété représente une adresse postale, les sous-objets peuvent être nommés rue, ville et département. Le nombre maximal d'éléments est de 1 000.

EnumPropertyOptions

Les options des propriétés enum, qui vous permettent de définir un ensemble restreint de chaînes correspondant aux requêtes des utilisateurs, de définir des classements pour ces valeurs de chaîne et de définir un nom d'opérateur à associer à ces chaînes afin que les utilisateurs puissent limiter les résultats aux seuls éléments ayant une valeur spécifique. Par exemple, pour les éléments d'un système de suivi des requêtes avec des informations de priorité, vous pouvez définir p0 comme valeur d'énumération autorisée et associer cette énumération au nom de l'opérateur priority afin que les utilisateurs de recherche puissent ajouter priority:p0 à leur requête pour limiter l'ensemble des résultats aux seuls éléments indexés avec la valeur p0.

Représentation JSON
{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}
Champs
possibleValues[]

object (EnumPropertyOptions.EnumValuePair)

Liste des valeurs possibles pour la propriété d'énumération. Toutes les EnumValuePairs doivent fournir une valeur de chaîne. Si vous spécifiez une valeur entière pour un EnumValuePair, toutes les EnumValuePairs possibles doivent fournir une valeur entière. La valeur de la chaîne et la valeur entière doivent être uniques parmi toutes les valeurs possibles. Une fois définies, les valeurs possibles ne peuvent plus être supprimées ni modifiées. Si vous fournissez un classement ordonné et que vous pensez pouvoir insérer des valeurs d'énumération supplémentaires à l'avenir, laissez des espaces dans les valeurs d'entier initiales pour pouvoir ajouter une valeur entre les valeurs précédemment enregistrées. Le nombre maximal d'éléments est de 100.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

Permet de spécifier le classement ordonné de l'énumération qui détermine comment les valeurs entières fournies dans les EnumValuePairs possibles sont utilisées pour classer les résultats. Si elles sont spécifiées, des valeurs entières doivent être fournies pour toutes les valeurs EnumValuePair possibles indiquées pour cette propriété. Ne peut être utilisé que si la valeur de isRepeatable est "false".

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Si défini, décrit comment l'énumération doit être utilisée en tant qu'opérateur de recherche.

EnumPropertyOptions.EnumValuePair

La paire de valeurs d'énumération définit deux éléments: une valeur de chaîne obligatoire et une valeur entière facultative. La valeur de la chaîne définit le terme de requête nécessaire pour récupérer cet élément, par exemple p0 pour un élément prioritaire. La valeur entière détermine le classement de cette valeur de chaîne par rapport aux autres valeurs énumérées de la même propriété. Par exemple, vous pouvez associer p0 à 0 et définir une autre paire d'énumération, telle que p1 et 1. Vous devez utiliser la valeur entière en combinaison avec ordered ranking pour définir le classement d'une valeur donnée par rapport aux autres valeurs énumérées pour le même nom de propriété. Ici, un ordre de classement DESCENDANT pour les propriétés priority entraîne une amélioration du classement des éléments indexés avec une valeur de p0 par rapport aux éléments indexés avec une valeur de p1. Sans ordre de classement spécifié, la valeur entière n'a aucun effet sur le classement des éléments.

Représentation JSON
{
  "stringValue": string,
  "integerValue": integer
}
Champs
stringValue

string

Valeur de la chaîne de l'élément EnumValuePair. La longueur ne doit pas dépasser 32 caractères.

integerValue

integer

Valeur entière de l'élément EnumValuePair, qui doit être non négative. Facultatif.

EnumPropertyOptions.OrderedRanking

Permet de spécifier le sens du classement d'un entier EnumValuePair par rapport aux autres valeurs entières EnumValuePair. Pour certaines propriétés, des valeurs d'entier plus faibles indiquent une importance plus élevée, tandis que pour d'autres, un entier plus élevé indique une importance plus élevée.

Enums
NO_ORDER Il n'y a pas d'ordre de classement pour l'établissement. La valeur de cette propriété n'a aucune incidence sur les résultats.
ASCENDING Cette propriété est classée par ordre croissant. Plus la valeur est faible, plus le classement est bas.
DESCENDING Cette propriété est classée par ordre décroissant. Plus la valeur est faible, plus le classement est élevé.

EnumPropertyOptions.EnumOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés énumérées. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché. Par exemple, si vous ne fournissez aucun opérateur pour une propriété d'énumération priority avec les valeurs possibles p0 et p1, une requête contenant le terme p0 renvoie les éléments dont la valeur de la propriété priority est p0, ainsi que tous les éléments contenant la chaîne p0 dans d'autres champs. Si vous fournissez un nom d'opérateur pour l'énumération, par exemple priority, les utilisateurs de la recherche peuvent utiliser cet opérateur pour affiner les résultats uniquement aux éléments dont la valeur de cette propriété est p0, avec la requête priority:p0.

Représentation JSON
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété enum. Par exemple, si le nom de l'opérateur est priority et que le nom de la propriété est priorityVal, les requêtes telles que priority:<value> ne renvoient des résultats que lorsque la valeur de la propriété priorityVal correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de n'importe quelle propriété de chaîne ou de texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

DatePropertyOptions

Options pour les propriétés de date.

Représentation JSON
{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}
Champs
operatorOptions

object (DatePropertyOptions.DateOperatorOptions)

Si défini, décrit comment la date doit être utilisée en tant qu'opérateur de recherche.

DatePropertyOptions.DateOperatorOptions

Facultatif. Fournit un opérateur de recherche pour les propriétés de date. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}
Champs
operatorName

string

Indique la chaîne réelle requise dans la requête pour isoler la propriété de date. Par exemple, supposons qu'un objet de schéma de suivi des problèmes possède une propriété nommée closeDate qui spécifie un opérateur avec un nom d'opérateur closedon. Pour les recherches sur ces données, les requêtes telles que closedon:<value> ne renvoient des résultats que lorsque la valeur de la propriété closeDate correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de n'importe quelle propriété de chaîne ou de texte dans le champ de contenu de la source de données indexée. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

lessThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété de date à l'aide de l'opérateur inférieur. Par exemple, si le nom de l'opérateur inférieur est closedbefore et que le nom de la propriété est closeDate, les requêtes telles que closedbefore:<value> ne renvoient des résultats que lorsque la valeur de la propriété closeDate est antérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

greaterThanOperatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété de date à l'aide de l'opérateur "supérieur à". Par exemple, si greaterThanOperatorName est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> ne renvoient des résultats que lorsque la valeur de la propriété closeDate est postérieure à <value>. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

TextPropertyOptions

Options des propriétés de texte.

Représentation JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}
Champs
retrievalImportance

object (RetrievalImportance)

Indique l'importance de la qualité de recherche des jetons dans le champ lorsqu'ils sont utilisés pour la récupération.

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Si défini, décrit comment la propriété doit être utilisée en tant qu'opérateur de recherche.

RetrievalImportance

Représentation JSON
{
  "importance": enum (RetrievalImportance.Importance)
}
Champs
importance

enum (RetrievalImportance.Importance)

Indique l'importance du classement attribuée à la propriété lorsqu'elle est mise en correspondance lors de la récupération. Une fois définie, l'importance du jeton d'une propriété ne peut pas être modifiée.

RetrievalImportance.Importance

Enums
DEFAULT Traitez la correspondance comme une correspondance dans le corps du texte.
HIGHEST Traitez la correspondance comme une correspondance avec le titre de l'élément.
HIGH Accordez plus d'importance à la correspondance que au corps du texte.
LOW Traitez la correspondance comme étant moins importante que le corps du texte.
NONE Ne pas faire correspondre ce champ lors de la récupération. La propriété peut toujours être utilisée pour la mise en correspondance des opérateurs, la création de facettes et les suggestions, si vous le souhaitez.

TextPropertyOptions.TextOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés de texte. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété de texte. Par exemple, si le nom de l'opérateur est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<value> ne renvoient des résultats que lorsque la valeur de la propriété subjectLine correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de toutes les propriétés textuelles ou au texte du champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

exactMatchWithOperator

boolean

Si la valeur est définie sur "true", la valeur de texte est tokenisée en tant que valeur atomique dans les recherches avec opérateur et les correspondances d'attributs. Par exemple, si le nom de l'opérateur est "genre" et que la valeur est "science-fiction", les restrictions de requête "genre:science" et "genre:fiction" ne correspondent pas à l'élément, mais "genre:science-fiction" si. La correspondance des valeurs textuelles est sensible à la casse et ne supprime pas les caractères spéciaux. Si elle est définie sur "false", le texte est tokenisé. Par exemple, si la valeur est "science-fiction", les requêtes "genre:science" et "genre:fiction" correspondent à l'élément.

HtmlPropertyOptions

Options des propriétés HTML.

Représentation JSON
{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}
Champs
retrievalImportance

object (RetrievalImportance)

Indique l'importance de la qualité de recherche des jetons dans le champ lorsqu'ils sont utilisés pour la récupération. Ne peut être défini que sur "DEFAULT" ou "NONE".

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Si défini, décrit comment la propriété doit être utilisée en tant qu'opérateur de recherche.

HtmlPropertyOptions.HtmlOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés HTML. Cette opération est facultative. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques pertinents pour le type d'élément recherché.

Représentation JSON
{
  "operatorName": string
}
Champs
operatorName

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété HTML. Par exemple, si le nom de l'opérateur est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<value> ne renvoient des résultats que lorsque la valeur de la propriété subjectLine correspond à <value>. En revanche, une recherche qui utilise le même <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de toutes les propriétés HTML ou du texte dans le champ de contenu de l'élément. Le nom de l'opérateur ne peut contenir que des lettres minuscules (a-z). La longueur ne doit pas dépasser 32 caractères.

PropertyDisplayOptions

Options d'affichage d'un établissement.

Représentation JSON
{
  "displayLabel": string
}
Champs
displayLabel

string

Libellé convivial de la propriété utilisé si la propriété doit être affichée dans ObjectDisplayOptions. Le libellé à afficher, le cas échéant, s'affiche devant les valeurs de la propriété lorsqu'elle fait partie des options d'affichage de l'objet. Par exemple, si la valeur de la propriété est "1", elle ne constitue pas nécessairement un contexte utile pour l'utilisateur. Si le nom à afficher est "priority", l'utilisateur voit "priority : 1" dans les résultats de recherche, ce qui fournit un contexte clair aux utilisateurs de la recherche. Ce champ est facultatif. Si vous ne le renseignez pas, seules les valeurs de la propriété s'affichent. La longueur maximale est de 64 caractères.