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 pour la source de données. Le nombre d'éléments est limité à 10.

operationIds[]

string

ID des opérations de longue durée en cours d'exécution pour ce schéma. Après avoir modifié le schéma, attendez la fin des opérations 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 d'éléments doivent définir le champ objectType sur cette valeur. Par exemple, si name correspond à Document, les requêtes d'indexation des é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). Il ne doit pas dépasser 256 caractères.

options

object (ObjectOptions)

Options facultatives spécifiques aux objets.

propertyDefinitions[]

object (PropertyDefinition)

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

ObjectOptions

Options associées à 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 manière dont l'objet s'affiche sur la page de résultats de Cloud Search.

suggestionFilteringOperators[]

string

Opérateurs permettant de filtrer les suggestions. Pour l'API query.suggest, seuls les opérateurs mentionnés ici seront respectés dans FilterOptions. Seuls les opérateurs TEXT et ENUM sont acceptés.

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

Même s'il s'agit d'un tableau, un seul opérateur peut être spécifié. Il s'agit d'un tableau pouvant être étendu à l'avenir.

Les opérateurs mappés à plusieurs propriétés au sein du 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é d'actualisation à utiliser lorsque vous ajustez le classement d'un élément dans les résultats de recherche. Les dates plus récentes et plus récentes indiquent une qualité supérieure. Utilisez la propriété d'option d'actualisation qui fonctionne le mieux avec vos données. Pour les documents de partage de fichiers, l'heure de la dernière modification est la plus pertinente. Pour les données d'événement d'agenda, l'heure à laquelle l'événement se produit est un indicateur d'actualisation plus pertinent. Ainsi, les événements d'agenda qui se produisent peu de temps avant la requête de recherche sont considérés comme étant de meilleure qualité et classés en conséquence.

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

string

Cette propriété indique le niveau d'actualisation de l'objet dans l'index. Si cette propriété est définie, il doit s'agir d'une propriété de premier niveau dans property definitions. Il doit s'agir de timestamp type ou date type. Sinon, l'API d'indexation utilise updateTime comme indicateur d'actualisation. Il ne doit pas dépasser 256 caractères.

Lorsqu'une propriété est utilisée pour calculer l'actualisation, 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 non actualisé. 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 d'article. Cette étape est FACULTATIVE. Si elle n'est pas fournie, aucun libellé d'objet n'est affiché sur la ligne de contexte des résultats de recherche. Il ne doit pas dépasser 64 caractères.

metalines[]

object (ObjectDisplayOptions.Metaline)

Définit les propriétés affichées dans les métalignes des résultats de recherche. Les valeurs des propriétés sont affichées dans l'ordre indiqué ici. Si une propriété contient plusieurs valeurs, toutes s'affichent avant les propriétés suivantes. C'est pourquoi il est recommandé de spécifier des propriétés singulières 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 de métalignes est limité à 3.

ObjectDisplayOptions.Metaline

Une métaligne est une liste de propriétés qui s'affichent 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 d'établissements est de 5.

ObjectDisplayOptions.DisplayedProperty

Référence à une propriété de niveau supérieur dans l'objet à afficher dans les résultats de recherche. Les valeurs des propriétés choisies s'affichent dans les résultats de la recherche avec les display label pour 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 la définition d'une propriété pour l'objet. Si le nom n'est pas une propriété définie dans le schéma, une erreur est générée lorsque vous essayez de mettre à jour le schéma.

PropertyDefinition

Définition d'une propriété au sein d'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 la propriété. Les requêtes d'indexation d'éléments 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 comportant des champs d'objet doivent définir la valeur name de ce champ sur subject_line. Utilisez le nom comme identifiant pour la propriété d'objet. Une fois enregistré en tant que propriété d'un objet, vous ne pouvez pas réutiliser ce nom pour une autre propriété au sein 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). Il ne doit pas dépasser 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 défini sur true, indique que les utilisateurs de l'API Query peuvent utiliser les champs de propriété correspondants dans les résultats. Toutefois, le stockage des champs nécessite davantage d'espace et utilise plus de bande passante pour les requêtes de recherche, ce qui a un impact sur les performances des ensembles de données volumineux. Définissez ce paramètre sur true uniquement si le champ est nécessaire pour les résultats de recherche. Ne peut pas être "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 n'a qu'une seule description, mais peut avoir plusieurs commentaires. Ne peut pas être "true" pour les propriétés dont le type est une valeur booléenne. Si la valeur est définie sur "false", les propriétés qui contiennent plusieurs valeurs entraînent le refus de la demande d'indexation de cet élément.

isSortable

boolean

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

isFacetable

boolean

Indique que la propriété peut être utilisée pour générer des attributs. Ne peut pas être "true" pour les propriétés dont le type est "object". Pour définir cette option, la valeur IsReturnable doit être "true". Disponible uniquement pour les propriétés booléennes, d'énumération, d'entiers et de texte.

isSuggestable

boolean

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

isWildcardSearchable

boolean

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

displayOptions

object (PropertyDisplayOptions)

Options qui déterminent la manière dont la propriété est affichée sur la page de résultats Cloud Search 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. Dans le cas où les options devraient ê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 du 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 des nombres entiers.

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 trié pour l'entier. Ne peut être utilisé que si isRepeatable est défini sur "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 ordered ranking. Les requêtes d'indexation dont les valeurs sont inférieures à la valeur minimale sont acceptées et classées avec la même pondération 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 ordered ranking. Les requêtes d'indexation dont les valeurs sont supérieures au maximum 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 cet attribut est défini, décrit comment l'entier doit être utilisé comme opérateur de recherche.

integerFacetingOptions

object (IntegerFacetingOptions)

Si cet attribut est défini, décrit les options d'attributs entiers pour la propriété d'entier donnée. La propriété de type entier correspondante doit être marquée isFacetable.

IntegerPropertyOptions.OrderedRanking

Permet de spécifier la manière dont une valeur entière doit être classée par rapport à d'autres valeurs. Un nombre entier ayant un classement plus élevé suggère une plus grande importance. 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'existe aucun ordre de classement pour la propriété. Les résultats ne sont pas ajustés en fonction de la valeur de cette propriété.
ASCENDING Cette propriété est classée par ordre croissant. Plus la valeur est faible, plus le classement est élevé.
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 des entiers. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au 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é de l'entier. Par exemple, si le paramètre "operatorName" est priorité et que le nom de la propriété est prioritéVal, les requêtes telles que priorité:<valeur> n'affichent que les résultats dont la valeur de la propriété nommée prioritéVal correspond à <valeur>. En revanche, une recherche qui utilise la même valeur <valeur> sans opérateur renvoie tous les éléments où <valeur> correspond à la valeur des propriétés de type "Chaîne" ou au texte de l'élément du champ de contenu. 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 l'entier à l'aide de l'opérateur inférieur à. Par exemple, si "lessThanOperatorName" correspond à PriorityVal et que le nom de la propriété est prioritéVal, les requêtes telles que Prioritybelow:<value> n'affichent les résultats que lorsque la valeur de la propriété nommée 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é de l'entier à l'aide de l'opérateur "supérieur à". Par exemple, si "greatThanOperatorName" est défini sur Priorityabove et que le nom de la propriété est PriorityVal, les requêtes telles que prioritéau-dessus:<value> n'affichent les résultats que lorsque la valeur de la propriété nommée 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 ce champ est défini, décrit comment le caractère double doit être utilisé comme opérateur de recherche.

DoublePropertyOptions.DoubleOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés doubles. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au 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 afin d'utiliser la propriété double lors du tri ou en tant qu'attribut. 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 des propriétés d'horodatage.

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

object (TimestampPropertyOptions.TimestampOperatorOptions)

Si ce champ est défini, décrit comment utiliser le code temporel comme opérateur de recherche.

TimestampPropertyOptions.TimestampOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés d'horodatage. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au 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é de code temporel. Par exemple, si "operatorName" est closedon et que le nom de la propriété est closeDate, les requêtes telles que closedon:<value> n'affichent que les résultats dont la valeur de la propriété nommée closeDate correspond à <value>. En revanche, une recherche qui utilise la même valeur <value> sans opérateur renvoie tous les éléments où <value> correspond à la valeur des propriétés de chaîne ou au texte du champ de contenu. 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 afin d'isoler la propriété de code temporel à l'aide de l'opérateur "inférieur à". Par exemple, si lessThanOperatorName est closedbefore et le nom de la propriété closeDate, les requêtes telles que closedbefore:<value> n'affichent que les résultats dont la valeur de la propriété nommée 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 afin d'isoler la propriété de code temporel à l'aide de l'opérateur "supérieur à". Par exemple, si "greatThanOperatorName" est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> affichent uniquement les résultats dont la valeur de la propriété nommée 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 ce champ est défini, décrit comment utiliser la valeur booléenne comme opérateur de recherche.

BooleanPropertyOptions.BooleanOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés booléennes. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au 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 opérateurName est closed et que le nom de la propriété est isClosed, les requêtes telles que closed:<value> n'affichent que les résultats dont la valeur de la propriété nommée isClosed correspond à <value>. En revanche, une recherche qui utilise la même valeur <value> sans opérateur renvoie tous les éléments où <value> correspond à la valeur des propriétés de chaîne 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.

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 propriétés subobjectProperties peuvent être nommées street, city et state. Le nombre d'éléments est limité à 1 000.

EnumPropertyOptions

Les options des propriétés d'énumération vous permettent de définir un ensemble restreint de chaînes pour correspondre 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 éléments ayant une valeur spécifique. Par exemple, pour les éléments d'un système de suivi des requêtes contenant des informations de priorité, vous pouvez définir p0 comme valeur d'énumération autorisée et lier cette énumération au nom d'opérateur priorité, de sorte que les utilisateurs de la recherche puissent ajouter priorité: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 une 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 pas être supprimées ni modifiées. Si vous spécifiez un classement ordonné et que vous pensez pouvoir insérer d'autres valeurs d'énumération à l'avenir, laissez des espaces dans les valeurs entières initiales afin de permettre l'ajout d'une valeur entre les valeurs précédemment enregistrées. Le nombre d'éléments est limité à 100.

orderedRanking

enum (EnumPropertyOptions.OrderedRanking)

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

operatorOptions

object (EnumPropertyOptions.EnumOperatorOptions)

Si cet attribut est défini, décrit comment l'énumération doit être utilisée comme 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 du nombre entier détermine le classement de cette valeur de chaîne par rapport aux autres valeurs énumérées pour la même propriété. Par exemple, vous pouvez associer p0 à 0 et définir une autre paire d'énumérations, telle que p1 et 1. Vous devez utiliser la valeur entière 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 de DESCending pour les propriétés de priorité entraîne une amélioration du classement des éléments indexés avec une valeur de p0 par rapport à ceux indexés avec une valeur de p1. Si aucun ordre de classement spécifié n'est spécifié, la valeur entière n'a aucune incidence sur le classement de l'élément.

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

string

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

integerValue

integer

Valeur entière de l'EnumValuePair qui ne doit pas être négative. Facultatif.

EnumPropertyOptions.OrderedRanking

Permet de spécifier l'orientation du classement d'un entier EnumValuePair par rapport aux autres valeurs entières EnumValuePair. Pour certaines propriétés, des valeurs entières inférieures indiquent une importance plus élevée, tandis que dans d'autres, un nombre entier élevé indique une importance plus élevée.

Enums
NO_ORDER Il n'existe aucun ordre de classement pour la propriété. Les résultats ne sont pas ajustés en fonction de la valeur de cette propriété.
ASCENDING Cette propriété est classée par ordre croissant. Plus la valeur est faible, plus le classement est élevé.
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 d'énumération. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au type d'élément recherché. Par exemple, si vous ne fournissez aucun opérateur pour une propriété d'énumération priorité avec les valeurs possibles p0 et p1, une requête contenant le terme p0 renvoie les éléments dont la valeur p0 est p0, ainsi que tous ceux qui contiennent la chaîne p0 dans d'autres champs. Si vous fournissez un nom d'opérateur pour l'énumération, tel que priorité, les utilisateurs de la recherche peuvent l'utiliser pour affiner les résultats afin d'affiner les résultats afin de n'afficher que les éléments dont la valeur de propriété est p0, à l'aide de la requête priorité: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é d'énumération. Par exemple, si le paramètre "operatorName" est priorité et que le nom de la propriété est prioritéVal, les requêtes telles que priorité:<valeur> n'affichent que les résultats dont la valeur de la propriété nommée prioritéVal correspond à <valeur>. En revanche, une recherche qui utilise la même valeur <valeur> sans opérateur renvoie tous les éléments où <valeur> correspond à la valeur des propriétés de type "Chaîne" ou au texte de l'élément du champ de contenu. 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 ce champ est défini, décrit comment la date doit être utilisée comme 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 liés au type d'élément recherché.

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

string

Indique la chaîne requise dans la requête pour isoler la propriété de date. Par exemple, supposons qu'un objet schéma de suivi d'un problème possède une propriété nommée closeDate qui spécifie un opérateur dont le nom d'opérateur est closedon. Pour les recherches portant sur ces données, les requêtes telles que closedon:<value> n'affichent des résultats que lorsque la valeur de la propriété closeDate correspond à <value>. En revanche, une recherche qui utilise la même valeur <value> sans opérateur renvoie tous les éléments où <value> correspond à la valeur des propriétés de chaîne ou au texte du 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 lessThanOperatorName est closedbefore et le nom de la propriété closeDate, les requêtes telles que closedbefore:<value> n'affichent que les résultats dont la valeur de la propriété nommée 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 "greatThanOperatorName" est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> affichent uniquement les résultats dont la valeur de la propriété nommée 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 la recherche des jetons dans le champ lorsqu'ils sont utilisés pour la récupération.

operatorOptions

object (TextPropertyOptions.TextOperatorOptions)

Si cet attribut est défini, décrit comment la propriété doit être utilisée comme opérateur de recherche.

RetrievalImportance

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

enum (RetrievalImportance.Importance)

Indique l'importance de 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 plus être modifiée.

RetrievalImportance.Importance

Enums
DEFAULT Traitez la correspondance comme une correspondance avec le corps du texte.
HIGHEST Traitez la correspondance comme une correspondance avec le titre de l'élément.
HIGH Traitez la correspondance avec une importance plus élevée que le corps du texte.
LOW Traitez la correspondance avec une importance moins élevée que le corps du texte.
NONE Ne mettez pas en correspondance ce champ lors de la récupération. La propriété peut toujours être utilisée pour la mise en correspondance des opérateurs, les attributs et les suggestions, si vous le souhaitez.

TextPropertyOptions.TextOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés de texte. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au 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 opérateurName est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<valeur> n'affichent des résultats que lorsque la valeur de la propriété nommée subjectLine correspond à <valeur>. En revanche, une recherche qui utilise la même valeur <valeur> sans opérateur renvoie tous les éléments où <valeur> correspond à la valeur des propriétés de texte ou du 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 "true", la valeur de texte est tokenisée comme une valeur atomique dans les recherches d'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, contrairement à "genre:science-fiction". La mise en correspondance des valeurs textuelles est sensible à la casse et ne supprime pas les caractères spéciaux. Si la valeur est "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 la recherche des jetons dans le champ lorsqu'ils sont utilisés pour la récupération. Peut uniquement être défini sur DEFAULT ou NONE.

operatorOptions

object (HtmlPropertyOptions.HtmlOperatorOptions)

Si cet attribut est défini, décrit comment la propriété doit être utilisée comme opérateur de recherche.

HtmlPropertyOptions.HtmlOperatorOptions

Permet de fournir un opérateur de recherche pour les propriétés HTML. Ceci est facultatif. Les opérateurs query.search permettent aux utilisateurs de limiter la requête à des champs spécifiques liés au 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 opérateurName est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<valeur> n'affichent des résultats que lorsque la valeur de la propriété nommée subjectLine correspond à <valeur>. En revanche, une recherche qui utilise la même valeur <value> sans opérateur renvoie tous les éléments où <valeur> correspond à la valeur de toute propriété HTML ou du 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.

PropertyDisplayOptions

Options d'affichage d'une propriété.

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

string

Libellé convivial de la propriété utilisée si elle est spécifiée pour être affichée dans ObjectDisplayOptions. S'il est fourni, le libellé d'affichage s'affiche devant les valeurs des propriétés lorsque celle-ci fait partie des options d'affichage des objets. Par exemple, si la valeur de la propriété est "1", la valeur en elle-même ne constitue pas nécessairement un contexte utile pour l'utilisateur. Si le nom à afficher donné est "priorité", l'utilisateur voit "priorité : 1" dans les résultats de recherche, ce qui fournit un contexte clair aux utilisateurs. Cette valeur est FACULTATIVE ; si elle n'est pas fournie, seules les valeurs de propriété sont affichées. Il ne doit pas dépasser 64 caractères.