- Ressource: SearchApplication
- DataSourceRestriction
- Source
- Source.PredefinedSource
- FilterOptions
- Filtre
- Filter.ValueFilter
- Valeur
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Méthodes
Ressource: SearchApplication
SearchApplication
Représentation JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Champs | |
---|---|
name |
Nom de l'application de recherche. Format: searchapplications/{applicationId}. |
displayName |
Nom à afficher de l'application de recherche. Il ne doit pas dépasser 300 caractères. |
dataSourceRestrictions[] |
Retrictions appliquées aux configurations. Le nombre d'éléments est limité à 10. |
sourceConfig[] |
Configuration d'une source spécifiée dans dataSourceRestrictions. |
scoringConfig |
Configuration du classement des résultats. |
defaultSortOptions |
Les options de tri par défaut des résultats de recherche |
defaultFacetOptions[] |
Champs par défaut pour le renvoi des résultats d'attribut. Les sources spécifiées ici ont également été incluses dans |
returnResultThumbnailUrls |
Pour chaque résultat, nous devons renvoyer l'URI de sa vignette (le cas échéant). |
operationIds[] |
Uniquement en sortie. ID des opérations de longue durée en cours d'exécution pour ce schéma. Champ de sortie uniquement. |
enableAuditLog |
Indique si la journalisation d'audit est activée ou désactivée pour les requêtes effectuées pour l'application de recherche dans les API de requête. |
queryInterpretationConfig |
Les options par défaut pour l'interprétation des requêtes |
DataSourceRestriction
Restriction concernant la source de données.
Représentation JSON |
---|
{ "source": { object ( |
Champs | |
---|---|
source |
Source de la restriction. |
filterOptions[] |
Options de filtrage limitant les résultats. Si plusieurs filtres sont présents, ils sont regroupés par type d'objet avant la jointure. Les filtres ayant le même type d'objet sont joints de manière conjonctive, puis les expressions qui en résultent sont jointes de manière disjonctive. Le nombre d'éléments est limité à 20. REMARQUE: L'API Suggest n'est actuellement compatible qu'avec quelques filtres: "objecttype", "type" et "mimetype". Pour le moment, les filtres spécifiques à un schéma ne peuvent pas être utilisés pour filtrer les suggestions. |
Source
Définit les sources des API Suggestions/Search.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
name |
Nom de la source du contenu indexé par |
predefinedSource |
Source de contenu prédéfinie pour Google Apps. |
Source.PredefinedSource
Sources prédéfinies:
Enums | |
---|---|
NONE |
|
QUERY_HISTORY |
Suggère des requêtes émises par l'utilisateur dans le passé. Ce paramètre n'est valide que lorsqu'il est utilisé avec l'API Suggestions. Ignoré lorsqu'il est utilisé dans l'API Query. |
PERSON |
Suggère des personnes dans l'organisation. Ce paramètre n'est valide que lorsqu'il est utilisé avec l'API Suggestions. Cela entraîne une erreur lorsqu'elle est utilisée dans l'API Query. |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
Options de filtre à appliquer à la requête.
Représentation JSON |
---|
{
"objectType": string,
"filter": {
object ( |
Champs | |
---|---|
objectType |
Si objectType est défini, seuls les objets de ce type sont renvoyés. Il doit correspondre au nom de l'objet enregistré dans la définition du schéma. Il ne doit pas dépasser 256 caractères. |
filter |
Filtre générique permettant de limiter la recherche, par exemple |
Filtre
Façon générique d'exprimer des filtres dans une requête, compatible avec deux approches:
1. Définir un ValueFilter. Le nom doit correspondre à un parameterName défini dans le schéma de votre source de données.
2. Définir un CompositeFilter. Les filtres sont évalués à l'aide de l'opérateur logique. Les opérateurs de premier niveau ne peuvent être qu'un opérateur AND ou NOT. ET ne peut apparaître qu'au niveau le plus élevé. L'opérateur OR ne peut apparaître que sous un opérateur AND de niveau supérieur.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Représentation JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Champs | |
---|---|
operatorName |
|
value |
Valeur à comparer. |
Valeur
Définition d'une valeur unique avec un type générique.
Représentation JSON |
---|
{ // Union field |
Champs | |
---|---|
Champ d'union value . Valeur de la propriété nommée. value ne peut être qu'un des éléments suivants : |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
Représentation JSON |
---|
{ "logicOperator": enum ( |
Champs | |
---|---|
logicOperator |
Opérateur logique du sous-filtre. |
subFilters[] |
Sous-filtres. |
Filter.CompositeFilter.LogicOperator
Enums | |
---|---|
AND |
Opérateurs logiques, qui ne peuvent être appliqués qu'aux sous-filtres. |
OR |
|
NOT |
NOT ne peut être appliqué qu'à un seul sous-filtre. |
SourceConfig
Configurations d'une source lors du traitement d'une requête query.search
ou query.suggest
.
Représentation JSON |
---|
{ "source": { object ( |
Champs | |
---|---|
source |
Source pour laquelle cette configuration doit être utilisée. |
scoringConfig |
Configuration d'évaluation de la source. |
crowdingConfig |
Configuration de regroupement pour la source. |
SourceScoringConfig
Définissez la configuration d'évaluation. Cela permet de modifier le classement des résultats pour une source.
Représentation JSON |
---|
{
"sourceImportance": enum ( |
Champs | |
---|---|
sourceImportance |
Importance de la source. |
SourceScoringConfig.SourceImportance
L'importance d'une source, qui peut être utilisée pour indiquer si une source doit se voir attribuer une priorité plus élevée par rapport à une autre source.
Enums | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Définissez des limites de regroupement des résultats de recherche. Il s'agit d'une situation dans laquelle plusieurs résultats provenant de la même source ou de la même source "encombrent" les autres résultats, ce qui diminue la qualité de la recherche pour les utilisateurs. Pour optimiser la qualité de la recherche et la diversité des sources dans les résultats de recherche, vous pouvez définir une condition afin de réduire les résultats répétitifs par source.
Représentation JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
Champs | |
---|---|
numResults |
Nombre maximal de résultats autorisés à partir d'une source de données sur une page de résultats, à condition que les résultats provenant d'autres sources ne soient pas épuisés. La valeur spécifiée ne doit pas être négative. Une valeur par défaut est utilisée si elle est égale à 0. Pour désactiver le regroupement, définissez une valeur supérieure à 100. |
numSuggestions |
Nombre maximal de suggestions autorisées à partir d'une source. Aucune limite n'est définie pour les résultats si cette valeur est inférieure ou égale à 0. |
ScoringConfig
Configurations de notation pour une source lors du traitement d'une requête query.search
ou query.suggest
.
Représentation JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Champs | |
---|---|
disableFreshness |
Indique s'il faut utiliser la fraîcheur comme signal de classement. Par défaut, la fraîcheur est utilisée comme signal de classement. Notez que ce paramètre n'est pas disponible dans l'interface administrateur. |
disablePersonalization |
Personnaliser ou non les résultats. Par défaut, les signaux personnels seront utilisés pour améliorer les résultats. |
SortOptions
Représentation JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Champs | |
---|---|
operatorName |
Nom de l'opérateur correspondant au champ à trier. La propriété correspondante doit être marquée comme |
sortOrder |
"Croissant" est l'ordre de tri par défaut. |
SortOptions.SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Spécifie les opérateurs pour lesquels renvoyer les résultats d'attributs. Il y aura un FacetResult pour chaque combinaison sourceName/objectType/operatorName.
Représentation JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Champs | |
---|---|
sourceName |
Nom de la source à utiliser pour l'attribut. Format: datasources/{sourceId} Si ce champ est vide, toutes les sources de données seront utilisées. |
objectType |
Si objectType est défini, seuls ces objets de ce type seront utilisés pour calculer les attributs. Si ce champ est vide, tous les objets seront utilisés pour calculer les attributs. |
operatorName |
Nom de l'opérateur choisi pour l'attribut. @see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
Nombre maximal d'ensembles d'attributs à renvoyer pour cet attribut. Valeur par défaut : 10 La valeur maximale est 100. |
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é d'entier correspondante dans le schéma doit être marquée isFacetable. Le nombre de buckets renvoyés correspond à un minimum de cet ensemble et de numFacetBuckets. |
IntegerFacetingOptions
Utilisé pour spécifier les options d'attribut d'entiers.
Représentation JSON |
---|
{ "integerBuckets": [ string ] } |
Champs | |
---|---|
integerBuckets[] |
Les buckets correspondant à des nombres entiers donnés doivent être dans l'ordre strictement croissant. Par exemple, si les valeurs fournies sont (1,5,10,100), les buckets d'attributs suivants seront formés {<1, [1,5), [5-10), [10-100), >=100}. |
QueryInterpretationConfig
Options par défaut permettant d'interpréter la requête de l'utilisateur.
Représentation JSON |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Champs | |
---|---|
forceVerbatimMode |
Activez cet indicateur pour désactiver toutes les optimisations internes, telles que l'interprétation des requêtes en langage naturel (NL), la récupération supplémentaire des résultats et l'utilisation de synonymes, y compris des synonymes personnalisés. Si cet indicateur est défini sur "True", il prévaut sur l'option définie au niveau de la requête. Pour la valeur par défaut "False", l'indicateur de niveau de requête définit l'interprétation correcte pour le mode mot à mot. |
forceDisableSupplementalResults |
Définissez cet indicateur pour désactiver la récupération des résultats supplémentaires. Définir un indicateur ici ne récupère pas les résultats supplémentaires pour les requêtes associées à une application de recherche donnée. Si cet indicateur est défini sur "True", il prévaut sur l'option définie au niveau de la requête. Pour la valeur par défaut "False", l'indicateur de niveau de requête définit l'interprétation correcte pour les résultats supplémentaires. |
Méthodes |
|
---|---|
|
Crée une application de recherche. |
|
Supprime une application de recherche. |
|
Récupère l'application de recherche spécifiée. |
|
Liste toutes les applications de recherche. |
|
Met à jour une application de recherche. |
|
Réinitialise les paramètres par défaut d'une application de recherche. |
|
Met à jour une application de recherche. |