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)

Retrictions 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 du 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 pour le renvoi des résultats d'attribut. 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 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 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 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 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 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 (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. Il ne doit pas dépasser 256 caractères.

filter

object (Filter)

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

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 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

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 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 pour les 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 avec un 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)

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à 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)

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 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 de la source.

crowdingConfig

object (SourceCrowdingConfig)

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 (SourceScoringConfig.SourceImportance)
}
Champs
sourceImportance

enum (SourceScoringConfig.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

integer

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

integer

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

boolean

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

boolean

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 (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 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 (IntegerFacetingOptions)
  }
}
Champs
sourceName

string

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

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 d'ensembles 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, 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[]

string (Int64Value format)

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

boolean

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

boolean

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

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.