Schema

{
  "name": string,
  "options": {
    object (ObjectOptions)
  },
  "propertyDefinitions": [
    {
      object (PropertyDefinition)
    }
  ]
}

string

Nom de l'objet, qui définit ensuite son type. Le champ objectType doit être égal à cette valeur pour les requêtes d'indexation des éléments. Par exemple, si la valeur de 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 être nommée de manière 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). Ne doit pas dépasser 256 caractères

object (ObjectOptions)

Options facultatives spécifiques aux objets.

object (PropertyDefinition)

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

{
  "freshnessOptions": {
    object (ObjectOptions.FreshnessOptions)
  },
  "displayOptions": {
    object (ObjectDisplayOptions)
  },
  "suggestionFilteringOperators": [
    string
  ]
}

object (ObjectOptions.FreshnessOptions)

Options d'actualisation d'un objet.

object (ObjectDisplayOptions)

Options permettant de déterminer l'affichage de l'objet sur la page des résultats Cloud Search.

string

Opérateurs permettant de filtrer les suggestions. Pour l'API query.suggest, seuls les opérateurs mentionnés ici seront respectés dans le 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, un seul opérateur peut être spécifié. Ce tableau est destiné à l'extensibilité future.

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

{
  "freshnessProperty": string,
  "freshnessDuration": string
}

string

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

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

string (Duration format)

Délai après lequel 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. Se termine par "s". Exemple : "3.5s".

{
  "objectDisplayLabel": string,
  "metalines": [
    {
      object (ObjectDisplayOptions.Metaline)
    }
  ]
}

string

Libellé convivial à afficher dans les résultats de recherche afin d'indiquer le type d'élément. Cette propriété est FACULTATIVE ; si elle n'est pas fournie, aucun libellé d'objet ne s'affiche sur la ligne de contexte des résultats de recherche. Ne doit pas dépasser 64 caractères

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, elles s'affichent toutes avant les propriétés suivantes. C'est pourquoi nous vous recommandons de spécifier les 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 maximal de métalignes est de 3.

{
  "properties": [
    {
      object (ObjectDisplayOptions.DisplayedProperty)
    }
  ]
}

object (ObjectDisplayOptions.DisplayedProperty)

Liste des propriétés affichées pour la métaline. Le nombre maximal d'établissements est 5.

{
  "propertyName": string
}

string

Nom de la propriété de premier niveau, telle que définie dans la définition de la 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 lors de la tentative de mise à jour du schéma.

{
  "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.
}

string

Nom de la propriété. La valeur de property name doit être égale à cette valeur pour les requêtes d'indexation d'éléments envoyées à l'API d'indexation. Par exemple, si le nom est subject_line, les requêtes d'indexation des éléments de document avec des champs "subject" doivent définir la valeur name pour ce champ sur subject_line. Utilisez le nom comme identifiant pour la propriété d'objet. Une fois enregistré en tant que propriété pour un objet, vous ne pouvez pas réutiliser ce nom pour une autre propriété dans 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). Ne doit pas dépasser 256 caractères

boolean

Indique que la propriété identifie les données à renvoyer dans les résultats de recherche via l'API Query. Si la valeur est true, indique que les utilisateurs de l'API Query peuvent utiliser les champs de propriété correspondants dans les résultats. Cependant, 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 grands ensembles de données. Définissez ce champ sur true uniquement si le champ est nécessaire pour les résultats de recherche. Ne peut pas être vraie pour les propriétés dont le type est un objet.

boolean

Indique que plusieurs valeurs sont autorisées pour la propriété. Par exemple, un document ne comporte qu'une seule description, mais il peut contenir plusieurs commentaires. Ne peut pas être vraie pour les propriétés dont le type est booléen. Si la valeur est "false", les propriétés contenant plusieurs valeurs entraînent le refus de la demande d'indexation de cet élément.

boolean

Indique que la propriété peut être utilisée pour le tri. Ne peut pas être vraie pour les propriétés reproductibles. Ce champ ne peut pas être défini sur "true" pour les propriétés dont le type est "object". Pour définir cette option, IsReturnable doit être défini sur "true". Uniquement compatible avec les propriétés booléennes, les dates, les doubles, les entiers et les horodatages.

boolean

Indique que la propriété peut être utilisée pour générer des attributs. Ce champ ne peut pas être défini sur "true" pour les propriétés dont le type est "object". Pour définir cette option, IsReturnable doit être défini sur "true". Uniquement compatible avec les propriétés booléennes, d'énumération, d'entier et de texte.

boolean

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

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 textuelles. Pour définir cette option, IsReturnable doit être défini sur "true". Dans une source de données donnée, vous pouvez marquer jusqu'à cinq propriétés comme iswildcardSearchable. Pour en savoir plus, consultez Définir les propriétés d'un objet.

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 dans la propriété display options de l'objet.

object (IntegerPropertyOptions)

object (DoublePropertyOptions)

object (TimestampPropertyOptions)

object (BooleanPropertyOptions)

object (ObjectPropertyOptions)

object (EnumPropertyOptions)

object (DatePropertyOptions)

object (TextPropertyOptions)

object (HtmlPropertyOptions)

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

enum (IntegerPropertyOptions.OrderedRanking)

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

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 demandes d'indexation dont les valeurs sont inférieures au minimum sont acceptées et classées avec la même pondération que les éléments indexés avec la valeur minimale.

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 la valeur est supérieure à 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.

object (IntegerPropertyOptions.IntegerOperatorOptions)

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

object (IntegerFacetingOptions)

Si défini, décrit les options d'attribut d'entiers pour la propriété entière donnée. La propriété d'entier correspondante doit être définie sur isFacetable.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'entier. Par exemple, si la valeur de l'opérateur "operatorName" est priority et que le nom de la propriété est priorityVal, les requêtes telles que priority:<value> n'affichent que les résultats associés à la valeur de la propriété nommée priorityVal. En revanche, une recherche utilisant le même élément <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de toutes les propriétés "String" ou du texte du champ "content" pour 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.

string

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

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'entier à l'aide de l'opérateur "supérieur à". Par exemple, si "largeThanOperatorName" est défini sur priorityabove et que le nom de la propriété est priorityVal, les requêtes telles que priorityabove:<value> n'affichent que les résultats dont le nom priorityVal est supérieur à <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.

{
  "operatorOptions": {
    object (DoublePropertyOptions.DoubleOperatorOptions)
  }
}

object (DoublePropertyOptions.DoubleOperatorOptions)

Si ce champ est défini, il décrit comment utiliser le double en tant qu'opérateur de recherche.

{
  "operatorName": string
}

string

Indique le nom de l'opérateur requis dans la requête pour utiliser la double propriété dans le 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.

{
  "operatorOptions": {
    object (TimestampPropertyOptions.TimestampOperatorOptions)
  }
}

object (TimestampPropertyOptions.TimestampOperatorOptions)

Si ce champ est défini, il décrit comment l'horodatage doit être utilisé en tant qu'opérateur de recherche.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'horodatage. Par exemple, si la méthode "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 correspondant à la valeur de la propriété nommée closeDate, qui correspond à <value>. En revanche, une recherche utilisant le même <value> sans opérateur renvoie tous les éléments où <value> correspond à la valeur de toutes les propriétés "String" ou du texte du champ "content". 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.

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'horodatage à 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:<valeur> n'affichent que les résultats dont la valeur de la propriété nommée closeDate est antérieure à <valeur>. 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.

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'horodatage à l'aide de l'opérateur "supérieur à". Par exemple, si "largeThanOperatorName" est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> n'affichent que les résultats dont la valeur 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.

{
  "operatorOptions": {
    object (BooleanPropertyOptions.BooleanOperatorOptions)
  }
}

object (BooleanPropertyOptions.BooleanOperatorOptions)

Si ce champ est défini, il décrit comment utiliser la valeur booléenne comme opérateur de recherche.

{
  "operatorName": string
}

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété booléenne. Par exemple, si la méthode "operatorName" est closed et que le nom de la propriété est isClosed, les requêtes telles que close:<value> n'affichent que les résultats associés à la valeur de la propriété isClosed. <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.

{
  "subobjectProperties": [
    {
      object (PropertyDefinition)
    }
  ]
}

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

{
  "possibleValues": [
    {
      object (EnumPropertyOptions.EnumValuePair)
    }
  ],
  "orderedRanking": enum (EnumPropertyOptions.OrderedRanking),
  "operatorOptions": {
    object (EnumPropertyOptions.EnumOperatorOptions)
  }
}

object (EnumPropertyOptions.EnumValuePair)

Liste des valeurs possibles pour la propriété d'énumération. Tous les EnumValuePairs doivent fournir une valeur de chaîne. Si vous spécifiez une valeur entière pour une paire EnumValuePair, toutes les paires EnumValue possibles doivent fournir une valeur entière. La valeur de chaîne et la valeur entière doivent être uniques sur toutes les valeurs possibles. Une fois définies, les valeurs possibles ne peuvent plus être supprimées ni modifiées. Si vous indiquez un classement ordonné et pensez que vous pourriez insérer d'autres valeurs d'énumération à l'avenir, laissez des valeurs manquantes dans les valeurs entières initiales pour pouvoir ajouter une valeur entre les valeurs précédemment enregistrées. Le nombre d'éléments est limité à 100.

enum (EnumPropertyOptions.OrderedRanking)

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

object (EnumPropertyOptions.EnumOperatorOptions)

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

{
  "stringValue": string,
  "integerValue": integer
}

string

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

integer

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

{
  "operatorName": string
}

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété d'énumération. Par exemple, si la valeur de l'opérateur "operatorName" est priority et que le nom de la propriété est priorityVal, les requêtes telles que priority:<value> n'affichent que les résultats associés à la valeur de la propriété nommée priorityVal. En revanche, une recherche utilisant le même élément <value> sans opérateur renvoie tous les éléments pour lesquels <value> correspond à la valeur de toutes les propriétés "String" ou du texte du champ "content" pour 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.

{
  "operatorOptions": {
    object (DatePropertyOptions.DateOperatorOptions)
  }
}

object (DatePropertyOptions.DateOperatorOptions)

Si ce champ est défini, il décrit comment la date doit être utilisée comme opérateur de recherche.

{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string
}

string

Indique la chaîne réelle requise dans la requête pour isoler la propriété de date. Supposons, par exemple, qu'un objet schéma de suivi des problèmes possède une propriété nommée closeDate qui spécifie un opérateur dont le paramètre "operatorName" est closedon. Pour les recherches effectuées sur ces données, des requêtes telles que closedon:<valeur> n'affichent que les résultats dont la valeur de la propriété closeDate correspond à <valeur>. En revanche, une recherche utilisant le même attribut <value> sans opérateur renvoie tous les éléments où <valeur> correspond à la valeur de tout élément de type 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.

string

Indique le nom de l'opérateur requis dans la requête afin d'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:<valeur> n'affichent que les résultats dont la valeur de la propriété nommée closeDate est antérieure à <valeur>. 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.

string

Indique le nom de l'opérateur requis dans la requête afin d'isoler la propriété de date à l'aide de l'opérateur "supérieur à". Par exemple, si "largeThanOperatorName" est closedafter et que le nom de la propriété est closeDate, les requêtes telles que closedafter:<value> n'affichent que les résultats dont la valeur 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.

{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (TextPropertyOptions.TextOperatorOptions)
  }
}

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.

object (TextPropertyOptions.TextOperatorOptions)

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

{
  "importance": enum (RetrievalImportance.Importance)
}

enum (RetrievalImportance.Importance)

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

{
  "operatorName": string,
  "exactMatchWithOperator": boolean
}

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété de texte. Par exemple, si la valeur de l'opérateur "operatorName" est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<value> n'affichent que les résultats contenant la valeur de la propriété nommée subjectLine. <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.

boolean

Si la valeur est "true", la valeur de texte est tokenisée comme une valeur atomique dans les recherches avec l'opérateur et les correspondances d'attribut. 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 correspondance de la valeur textuelle 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.

{
  "retrievalImportance": {
    object (RetrievalImportance)
  },
  "operatorOptions": {
    object (HtmlPropertyOptions.HtmlOperatorOptions)
  }
}

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. Ne peut être défini que sur DEFAULT ou NONE.

object (HtmlPropertyOptions.HtmlOperatorOptions)

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

{
  "operatorName": string
}

string

Indique le nom de l'opérateur requis dans la requête pour isoler la propriété HTML. Par exemple, si la valeur de l'élément "operatorName" est subject et que le nom de la propriété est subjectLine, les requêtes telles que subject:<value> n'affichent que les résultats contenant la valeur de la propriété subjectLine. <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.

{
  "displayLabel": string
}

string

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