REST Resource: settings.searchapplications

Ressource: SearchApplication

SearchApplication

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
Champs
name

string

Nom de l'application de recherche.

Format: searchapplications/{applicationId}.
displayName

string

Nom à afficher de l'application de recherche. Il ne doit pas dépasser 300 caractères.
dataSourceRestrictions[]

object (DataSourceRestriction)

Des restrictions sont appliquées aux configurations. Le nombre maximal d'éléments est de 10.
sourceConfig[]

object (SourceConfig)

Configuration d'une source spécifiée dans dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Configuration pour le classement des résultats.
defaultSortOptions

object (SortOptions)

Les options de tri par défaut des résultats de recherche
defaultFacetOptions[]

object (FacetOptions)

Champs par défaut permettant de renvoyer les résultats d'attributs. Les sources spécifiées ici ont également été incluses dans dataSourceRestrictions ci-dessus.
returnResultThumbnailUrls

boolean

Pour chaque résultat, nous devons renvoyer l'URI de sa vignette (le cas échéant).
operationIds[]

string

Uniquement en sortie. ID des opérations de longue durée (LRO) en cours d'exécution pour ce schéma. Champ de sortie uniquement.
enableAuditLog

boolean

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

object (QueryInterpretationConfig)

Les options par défaut pour l'interprétation des requêtes

DataSourceRestriction

Restriction liée à la source de données.

Représentation JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Champs
source

object (Source)

Source de la restriction.
filterOptions[]

object (FilterOptions)

Options de filtrage limitant les résultats. Si plusieurs filtres sont présents, ils sont regroupés par type d'objet avant de les joindre. Les filtres ayant le même type d'objet sont joints de manière conjointe, puis les expressions qui en résultent sont jointes de manière disjointe.

Le nombre maximal d'éléments est de 20.

REMARQUE: L'API Suggérer n'accepte que quelques filtres pour le moment : "objecttype", "type" et "mimetype". Pour le moment, il n'est pas possible d'utiliser des filtres spécifiques au schéma pour filtrer les suggestions.

Source

Définit les sources des API de suggestion/recherche.

Représentation JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
Champs

Champ d'union source.

source ne peut être qu'un des éléments suivants :
name

string

Nom de la source du contenu indexé par Indexing API.
predefinedSource

enum (Source.PredefinedSource)

Source de contenu prédéfinie pour Google Apps.

Source.PredefinedSource

Sources prédéfinies:

Enums
NONE
QUERY_HISTORY Suggère les requêtes émises par l'utilisateur dans le passé. Valide uniquement lorsqu'elle est utilisée avec l'API de suggestion. Ignoré lorsqu'il est utilisé dans l'API de requête.
PERSON Suggère des membres de l'organisation. Valide uniquement lorsqu'elle est utilisée avec l'API de suggestion. Entraîne une erreur lorsqu'elle est utilisée dans l'API de requête.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Options de filtrage à appliquer à la requête.

Représentation JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Champs
objectType

string

Si la valeur "objectType" est définie, 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. La longueur maximale est de 256 caractères.
filter

object (Filter)

Filtre générique permettant de limiter la recherche, par exemple lang:en ou site:xyz.

Filtre

Moyen générique d'exprimer des filtres dans une requête, qui prend en charge deux approches:

1. Définir un ValueFilter. Le nom doit correspondre à un nom d'opérateur (operatorName) 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 niveau supérieur peuvent uniquement être des opérateurs AND ou NOT. ET ne peut s'afficher qu'au niveau le plus élevé. OU ne peut s'afficher qu'en dessous d'un opérateur ET de niveau supérieur.

Représentation JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
Champs

Champ d'union filter.

filter ne peut être qu'un des éléments suivants :
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

Représentation JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Champs
operatorName

string

Valeur operatorName appliquée à la requête, telle que price_greater_than. Le filtre peut fonctionner avec les deux types de filtres définis dans le schéma de votre source de données:

  1. operatorName, où la requête filtre les résultats en fonction de la propriété correspondant à la valeur.

  2. greaterThanOperatorName ou lessThanOperatorName dans votre schéma. La requête filtre les résultats en fonction des valeurs de propriété supérieures ou inférieures à la valeur fournie dans la requête.
value

object (Value)

Valeur à comparer.

Valeur

Définition d'une valeur unique de type générique.

Représentation JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
Champs
Champ d'union value. Valeur de la propriété nommée. value ne peut être qu'un des éléments suivants :
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

Représentation JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Champs
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Opérateur logique du sous-filtre.
subFilters[]

object (Filter)

Sous-filtres.

Filter.CompositeFilter.LogicOperator

Enums
AND Opérateurs logiques, qui ne peuvent être appliqués qu'aux sous-filtres.
OR
NOT L'opérateur 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 (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Champs
source

object (Source)

Source pour laquelle cette configuration doit être utilisée.
scoringConfig

object (SourceScoringConfig)

Configuration d'évaluation pour la source.
crowdingConfig

object (SourceCrowdingConfig)

Configuration de regroupement pour la source.

SourceScoringConfig

Définissez la configuration de l'évaluation. Cela permet de modifier le classement des résultats pour une source.

Représentation JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Champs
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Importance de la source.

SourceScoringConfig.SourceImportance

Importance d'une source, qui peut être utilisée pour indiquer si une source doit se voir accorder une priorité plus élevée dans le classement qu'une autre.

Enums
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Définissez des limites de regroupement des résultats de recherche. Le regroupement est une situation dans laquelle plusieurs résultats provenant de la même source ou de l'hôte sont "exclusifs" d'autres résultats, ce qui diminue la qualité de la recherche pour les utilisateurs. Pour améliorer 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

integer

Nombre maximal de résultats autorisés depuis une source de données dans une page de résultats tant que les résultats d'autres sources ne sont pas épuisés. La valeur spécifiée ne doit pas être négative. Une valeur par défaut est utilisée si cette valeur est égale à 0. Pour désactiver le regroupement, définissez une valeur supérieure à 100.
numSuggestions

integer

Nombre maximal de suggestions autorisées à partir d'une source. Aucune limite ne sera définie sur les résultats si cette valeur est inférieure ou égale à 0.

ScoringConfig

Évaluation des configurations d'une source lors du traitement d'une requête query.search ou query.suggest.

Représentation JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Champs
disableFreshness

boolean

Indique si l'actualisation doit être utilisée comme signal de classement. Par défaut, l'actualisation est utilisée comme signal de classement. Notez que ce paramètre n'est pas disponible dans l'interface administrateur.
disablePersonalization

boolean

Indique si les résultats doivent être personnalisés. Par défaut, les signaux personnels sont utilisés pour améliorer les résultats.

SortOptions

Représentation JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Champs
operatorName

string

Nom de l'opérateur correspondant au champ sur lequel effectuer le tri. La propriété correspondante doit être marquée comme sortable.
sortOrder

enum (SortOptions.SortOrder)

"Croissant" est l'ordre de tri par défaut

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

Spécifie les opérateurs pour lesquels des résultats d'attribut doivent être renvoyés. Il existe un FacetResult pour chaque combinaison sourceName/objectType/operatorName.

Représentation JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Champs
sourceName

string

Nom de la source à utiliser. Format: datasources/{sourceId} Si ce champ est vide, toutes les sources de données seront utilisées.
objectType

string

Si la valeur "objectType" est définie, seuls ces objets de ce type sont utilisés pour calculer les attributs. Si ce champ est vide, tous les objets seront utilisés pour calculer les attributs.
operatorName

string

Nom de l'opérateur choisi pour les attributs. @voir cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Nombre maximal de buckets d'attributs à renvoyer pour cet attribut. Valeur par défaut : 10 La valeur maximale est 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Si cet attribut est défini, il décrit les options d'attributs d'entiers pour la propriété d'entier donnée. La propriété d'entier correspondante dans le schéma doit être marquée comme isFacetable. Le nombre de buckets renvoyés serait au minimum de cette valeur et de numFacetBuckets.

IntegerFacetingOptions

Permet de spécifier des options d'attributs de nombre entier.

Représentation JSON 
{
  "integerBuckets": [
    string
  ]
}
Champs
integerBuckets[]

string (Int64Value format)

Les buckets pour les valeurs entières doivent être strictement dans l'ordre 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 pour interpréter la requête de l'utilisateur.

Représentation JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Champs
forceVerbatimMode

boolean

Activez cet indicateur pour désactiver toutes les optimisations internes, telles que l'interprétation des requêtes en langage naturel (NL), l'extraction de résultats supplémentaires et l'utilisation de synonymes, y compris ceux 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 au niveau de la requête définit l'interprétation correcte pour le mode mot à mot.
forceDisableSupplementalResults

boolean

Définissez cet indicateur pour désactiver la récupération de résultats supplémentaires. Si vous définissez un indicateur ici, les résultats supplémentaires ne seront pas récupérés 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 au niveau de la requête définit l'interprétation correcte des résultats supplémentaires.

Méthodes

create

 Crée une application de recherche.

delete

 Supprime une application de recherche.

get

 Récupère l'application de recherche spécifiée.

list

 Liste toutes les applications de recherche.

patch

 Met à jour une application de recherche.

reset

 Réinitialise les paramètres par défaut d'une application de recherche.

update

 Met à jour une application de recherche.