REST Resource: settings.searchapplications

Ressource: SearchApplication

Application de recherche

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. Ne doit pas dépasser 300 caractères.

dataSourceRestrictions[]

object (DataSourceRestriction)

Restrictions appliquées aux configurations. Le nombre d'éléments est limité à 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)

Options par défaut pour le tri des résultats de recherche

defaultFacetOptions[]

object (FacetOptions)

Champs par défaut pour les résultats d'attribut renvoyés. Les sources spécifiées ici ont également été incluses dans dataSourceRestrictions ci-dessus.

returnResultThumbnailUrls

boolean

Chaque résultat doit renvoyer l'URI de sa vignette (le cas échéant).

operationIds[]

string

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

boolean

Indique si la journalisation d'audit est activée/désactivée pour les requêtes effectuées pour l'application de recherche dans les API de requête.

queryInterpretationConfig

object (QueryInterpretationConfig)

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

Restriction de source de données

Restriction concernant 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 filtre limitant les résultats. Si plusieurs filtres sont présents, ils sont regroupés par type d'objet avant l'association. Les filtres avec le même type d'objet sont joints de manière conjointe, puis les expressions obtenues sont jointes de manière disjointe.

Le nombre d'éléments est limité à 20.

REMARQUE: L'API Suggest n'est actuellement compatible qu'avec peu de 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 pour les API Suggestions/search.

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éfini pour Google Apps.

Source.prédéfiniSource

Sources prédéfinies:

Enums
NONE
QUERY_HISTORY Suggère des requêtes émises par l'utilisateur par le passé. Valide uniquement lorsqu'il est utilisé avec l'API de suggestion. Ce paramètre est ignoré lorsqu'il est utilisé dans l'API de requête.
PERSON Suggère des membres de l'organisation. Valide uniquement lorsqu'il est utilisé avec l'API de suggestion. Elle génère une erreur lorsqu'elle est utilisée dans l'API Query.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

Options du filtre

Options de filtre à appliquer à la requête.

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

string

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. Ne doit pas dépasser 256 caractères

filter

object (Filter)

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

Filter

Un moyen générique d'exprimer des filtres dans une requête, compatible avec deux approches:

1. Définissez un ValueFilter. Le nom doit correspondre à un 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 apparaître qu'au niveau le plus élevé. L'opérateur "OU" ne peut apparaître que sous l'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)

Filtre

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

string

operatorName appliqué à la requête, par exemple 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 en fonction de la propriété qui correspond à 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.

Value

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 fractionnaires. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

booleanValue

boolean

dateValue

object (Date)

Filtre composite

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 N'EST PAS applicable à 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 de l'évaluation de la source.

crowdingConfig

object (SourceCrowdingConfig)

Configuration de regroupement pour la source.

Configuration de la source

Définissez la configuration du score. Cela permet de modifier le classement des résultats d'une source.

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

enum (SourceScoringConfig.SourceImportance)

Importance de la source.

SourceScoringConfig.SourceImportance

L'importance d'une source pour indiquer si une source doit avoir une priorité plus élevée qu'une autre pour être mieux classée

Enums
DEFAULT
LOW
HIGH

Configuration de la source source

Définissez des limites de regroupement des résultats de recherche. Le regroupement est une situation dans laquelle plusieurs résultats issus de la même source ou d'un même hébergeur "excluent" les autres résultats, réduisant ainsi la qualité de la recherche. 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 la répétition des résultats par source.

Représentation JSON
{
  "numResults": integer,
  "numSuggestions": integer
}
Champs
numResults

integer

Nombre maximal de résultats autorisés par une source de données sur 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 depuis une source. Aucune limite ne sera définie pour les résultats si cette valeur est inférieure ou égale à 0.

Configuration Scoring

Configurations d'évaluation pour 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 la fraîcheur doit être utilisée 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

boolean

Indique s'il faut personnaliser les résultats. Par défaut, des 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 à trier. 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 les résultats d'attribut doivent être renvoyés. Il y aura 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 à appliquer à l'attribut. Format: datasources/{sourceId} Si ce champ est vide, toutes les sources de données seront utilisées.

objectType

string

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

string

Nom de l'opérateur choisi pour l'attribut. @see 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 défini, décrit les options d'attribut d'entiers pour la propriété entière donnée. La propriété d'entier correspondante dans le schéma doit être définie sur isFacetable. Le nombre de buckets renvoyés est inférieur à ce nombre et à numFacetBuckets.

Options entières

Permet de spécifier les options d'attribut d'entiers.

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

string (Int64Value format)

Les buckets pour des valeurs entières données doivent être dans un 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}.

Interprétation de requête

Options par défaut pour interpréter la requête de l'utilisateur.

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

boolean

Activez cette option pour désactiver toutes les optimisations internes, comme l'interprétation des requêtes en langage naturel (NL), la récupération des résultats supplémentaires et l'utilisation de synonymes, y compris les synonymes. Si cette option est définie sur "True", elle a la priorité sur l'option définie au niveau de la requête. Si la valeur par défaut est "False", l'indicateur au niveau de la requête définit l'interprétation correcte du mode mot à mot.

forceDisableSupplementalResults

boolean

Définissez cette option pour désactiver la récupération des 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 cette option est définie sur "True", elle a la priorité sur l'option définie au niveau de la requête. Si la valeur par défaut est "False", l'option 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

Répertorie toutes les applications de recherche.

patch

Met à jour une application de recherche.

reset

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

update

Met à jour une application de recherche.