- Requête HTTP
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- QueryInterpretationOptions
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- QueryInterpretation
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- QueryInterpretation.InterpretationType
- QueryInterpretation.Reason
- SearchResult
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Extrait
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MatchRange
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Métadonnées
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ResultDisplayMetadata
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ResultDisplayMetadata.ResultDisplayLine
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ResultDisplayMetadata.ResultDisplayField
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ResultDebugInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- StructuredResult
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SpellResult
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FacetResult
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- FacetBucket
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ResponseDebugInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ErrorInfo
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ErrorMessage
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ResultCounts
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SourceResultCount
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Essayer
L'API Cloud Search Query fournit la méthode de recherche qui renvoie les résultats les plus pertinents à partir d'une requête utilisateur. Les résultats peuvent provenir d'applications Google Workspace, telles que Gmail ou Google Drive, ou de données que vous avez indexées à partir d'un tiers.
Remarque:L'exécution de cette API nécessite un compte utilisateur final standard. Un compte de service ne peut pas effectuer directement des requêtes à l'API Query. Pour effectuer des requêtes à l'aide d'un compte de service, configurez la délégation d'autorité au niveau du domaine Google Workspace.
Requête HTTP
POST https://cloudsearch.googleapis.com/v1/query/search
L'URL utilise la syntaxe de transcodage gRPC.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{ "requestOptions": { object ( |
Champs | |
---|---|
requestOptions |
Options de requête, telles que l'application de recherche et le fuseau horaire de l'utilisateur. |
query |
Chaîne de requête brute. Pour connaître les opérateurs de recherche compatibles, consultez Affiner une recherche à l'aide d'opérateurs. |
pageSize |
Nombre maximal de résultats de recherche à renvoyer par page. Les valeurs valides sont comprises entre 1 et 100 inclus. La valeur par défaut est 10. La valeur minimale est 50 lorsque des résultats supérieurs à 2 000 sont demandés. |
start |
Index de départ des résultats. |
dataSourceRestrictions[] |
Sources à utiliser pour les requêtes. Si aucune valeur n'est spécifiée, toutes les sources de données de l'application de recherche actuelle sont utilisées. |
facetOptions[] |
|
sortOptions |
Les options de tri des résultats de recherche |
queryInterpretationOptions |
pour interpréter la requête de l'utilisateur. |
contextAttributes[] |
Attributs de contexte de la requête qui seront utilisés pour ajuster le classement des résultats de recherche. Le nombre maximal d'éléments est de 10. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Réponse de l'API Search.
Représentation JSON |
---|
{ "queryInterpretation": { object ( |
Champs | |
---|---|
queryInterpretation |
Résultat de l'interprétation de la requête utilisateur. Ce champ est vide si l'interprétation de la requête est désactivée. |
results[] |
Résultats d'une requête de recherche. |
structuredResults[] |
Résultats structurés pour la requête utilisateur. Ces résultats ne sont pas pris en compte dans la valeur "pageSize". |
spellResults[] |
Suggestion orthographique de la requête. |
facetResults[] |
Résultats d'attributs répétés. |
hasMoreResults |
Indique si d'autres résultats de recherche correspondent à la requête. |
debugInfo |
Informations de débogage concernant la réponse. |
errorInfo |
Informations sur l'erreur concernant la réponse. |
resultCounts |
Informations développées sur le nombre de résultats. |
Champ d'union
Dans les rares cas où le système ne parvient pas à effectuer une recherche dans tous les documents, réexécutez la requête. |
|
resultCountEstimate |
Estimation du nombre de résultats pour cette requête. |
resultCountExact |
Nombre exact de résultats pour cette requête. |
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
Pour en savoir plus, consultez le Guide relatif aux autorisations.
QueryInterpretationOptions
pour interpréter la requête de l'utilisateur.
Représentation JSON |
---|
{ "disableNlInterpretation": boolean, "enableVerbatimMode": boolean, "disableSupplementalResults": boolean } |
Champs | |
---|---|
disableNlInterpretation |
Indicateur permettant de désactiver l'interprétation des requêtes en langage naturel (NL) La valeur par défaut est "false". Définissez-la sur "true" pour désactiver l'interprétation en langage naturel. L'interprétation en langage naturel ne s'applique qu'aux sources de données prédéfinies. |
enableVerbatimMode |
Activez cette option pour désactiver toutes les optimisations internes, telles que l'interprétation des requêtes en langage naturel (NL), l'extraction de résultats complémentaire et l'utilisation de synonymes, y compris ceux personnalisés. L'interprétation NS est désactivée si l'un des deux indicateurs est vrai. |
disableSupplementalResults |
Utilisez cet indicateur pour désactiver les résultats supplémentaires d'une requête. Le paramètre des résultats supplémentaires sélectionné au niveau de SearchApplication sera prioritaire s'il est défini sur "True". |
QueryInterpretation
Représentation JSON |
---|
{ "interpretedQuery": string, "interpretationType": enum ( |
Champs | |
---|---|
interpretedQuery |
Interprétation de la requête utilisée dans la recherche. Par exemple, les requêtes avec une intention de langage naturel comme "e-mail de Jean" sera interprété comme "from:john source:mail". Ce champ n'est pas renseigné lorsque le motif est NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY. |
interpretationType |
|
reason |
Motif de l'interprétation de la requête. Ce champ ne sera pas UNSPECIFIED si le type d'interprétation n'est pas NONE. |
QueryInterpretation.InterpretationType
Enums | |
---|---|
NONE |
Ni l'interprétation en langage naturel, ni une version plus large de la requête ne sont utilisées pour extraire les résultats de recherche. |
BLEND |
Les résultats de la requête d'origine sont mélangés avec d'autres résultats. La raison de la combinaison de ces autres résultats avec ceux de la requête d'origine est indiquée dans le champ "Motif". ci-dessous. |
REPLACE |
Les résultats de la requête d'origine sont remplacés. Le motif du remplacement des résultats de la requête d'origine est indiqué dans le champ "Motif". ci-dessous. |
QueryInterpretation.Reason
Enums | |
---|---|
UNSPECIFIED |
|
QUERY_HAS_NATURAL_LANGUAGE_INTENT |
L'interprétation en langage naturel de la requête est utilisée pour extraire les résultats de la recherche. |
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY |
La similarité des termes de requête et de document est utilisée pour élargir de manière sélective la requête afin d'obtenir des résultats de recherche supplémentaires, étant donné que le nombre de résultats correspondant à la requête de l'utilisateur est insuffisant. La requête interprétée sera vide dans ce cas. |
SearchResult
Résultats contenant des informations indexées pour un document.
Représentation JSON |
---|
{ "title": string, "url": string, "snippet": { object ( |
Champs | |
---|---|
title |
Titre du résultat de recherche. |
url |
URL du résultat de recherche. L'URL contient une redirection Google vers l'élément en question. Cette URL est signée et ne doit pas être modifiée. |
snippet |
Concaténation de tous les extraits (résumés) disponibles pour ce résultat. |
metadata |
métadonnées du résultat de recherche. |
clusteredResults[] |
Si la source est en cluster, fournissez la liste des résultats mis en cluster. Il n'y aura qu'un seul niveau de résultats en cluster. Si la source actuelle n'est pas activée pour le clustering, ce champ sera vide. |
debugInfo |
Informations de débogage concernant ce résultat de recherche. |
Extrait
Extrait du résultat de recherche résumant le contenu de la page obtenue.
Représentation JSON |
---|
{
"snippet": string,
"matchRanges": [
{
object ( |
Champs | |
---|---|
snippet |
Extrait du document. Extrait du document. Peut contenir un caractère HTML avec échappement qui ne doit pas être échappé avant l'affichage. |
matchRanges[] |
Plages correspondantes dans l'extrait. |
MatchRange
Plage correspondante d'un extrait [début, fin).
Représentation JSON |
---|
{ "start": integer, "end": integer } |
Champs | |
---|---|
start |
Position de départ de la correspondance dans l'extrait. |
end |
Fin de la correspondance dans l'extrait. |
Métadonnées
les métadonnées d'un résultat de recherche avec correspondance.
Représentation JSON |
---|
{ "source": { object ( |
Champs | |
---|---|
source |
Source nommée du résultat, par exemple Gmail. |
mimeType |
Type MIME du résultat de recherche. |
thumbnailUrl |
URL de la vignette du résultat. |
owner |
propriétaire (généralement un créateur) du document ou de l'objet du résultat de recherche |
createTime |
Heure de création de ce document ou de cet objet dans le résultat de recherche. Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
updateTime |
Date de la dernière modification de l'objet dans les résultats de recherche. Si elle n'est pas définie dans l'élément, la valeur renvoyée ici est vide. Lorsque Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
fields[] |
Champs indexés dans les données structurées, renvoyés en tant que propriété nommée générique. |
displayOptions |
qui spécifient comment afficher un résultat de recherche basé sur des données structurées. |
objectType |
Type d'objet du résultat de recherche. |
ResultDisplayMetadata
Représentation JSON |
---|
{
"objectTypeLabel": string,
"metalines": [
{
object ( |
Champs | |
---|---|
objectTypeLabel |
Libellé d'affichage de l'objet. |
metalines[] |
La métaligne du contenu à afficher avec le résultat. |
ResultDisplayMetadata.ResultDisplayLine
Ensemble des champs qui constituent une ligne affichée
Représentation JSON |
---|
{
"fields": [
{
object ( |
Champs | |
---|---|
fields[] |
ResultDisplayMetadata.ResultDisplayField
Afficher les champs pour les résultats de query.search
Représentation JSON |
---|
{
"label": string,
"operatorName": string,
"property": {
object ( |
Champs | |
---|---|
label |
Libellé d'affichage de la propriété. |
operatorName |
Nom d'opérateur de la propriété. |
property |
Paire nom/valeur de la propriété. |
ResultDebugInfo
Informations de débogage sur le résultat.
Représentation JSON |
---|
{ "formattedDebugInfo": string } |
Champs | |
---|---|
formattedDebugInfo |
Informations de débogage générales mises en forme pour être affichées. |
StructuredResult
Résultats structurés renvoyés dans la requête de recherche.
Représentation JSON |
---|
{
"person": {
object ( |
Champs | |
---|---|
person |
Représentation d'une personne |
SpellResult
Représentation JSON |
---|
{ "suggestedQuery": string } |
Champs | |
---|---|
suggestedQuery |
Suggestion orthographique de la requête. |
FacetResult
Réponse d'attribut spécifique à la source
Représentation JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"buckets": [
{
object ( |
Champs | |
---|---|
sourceName |
Nom de la source pour laquelle les résultats d'attribut sont renvoyés. Ce champ ne sera pas vide. |
objectType |
Type d'objet pour lequel les résultats d'attribut sont renvoyés. Ce champ peut être vide. |
operatorName |
Nom de l'opérateur choisi pour les attributs. @voir cloudsearch.SchemaPropertyOptions |
buckets[] |
FacetBuckets pour les valeurs dans la réponse contenant au moins un résultat avec le filtre correspondant. |
FacetBucket
Un bucket dans un attribut est l'unité de fonctionnement de base. Un bucket peut comprendre une valeur unique OU une plage de valeurs contiguë, en fonction du type de champ divisé en buckets. FacetBucket n'est actuellement utilisé que pour renvoyer l'objet de réponse.
Représentation JSON |
---|
{ "count": integer, "percentage": integer, "filter": { object ( |
Champs | |
---|---|
count |
Nombre de résultats correspondant à la valeur du bucket. Les décomptes ne sont renvoyés que pour les recherches dont l'exactitude est garantie. Cloud Search ne garantit pas que le nombre d'attributs n'est pas garanti pour les requêtes. De plus, il est possible que le nombre d'attributs ne soit présent que par intermittence, même pour des requêtes identiques. Ne créez pas de dépendances si le nombre d'attributs existe. utilisez plutôt des pourcentages de sortie d'attribut qui sont toujours renvoyés. |
percentage |
Pourcentage de résultats correspondant à la valeur du bucket. La valeur renvoyée est comprise entre 0 et 100. Elle est arrondie à un nombre entier si elle est fractionnaire. Si la valeur n'est pas explicitement renvoyée, elle représente un pourcentage arrondi à 0. Les pourcentages sont renvoyés pour toutes les recherches, mais il s'agit d'une estimation. Étant donné que les pourcentages sont toujours renvoyés, vous devez afficher des pourcentages plutôt que des nombres. |
filter |
Filtre à transmettre dans la requête de recherche si le bucket correspondant est sélectionné. |
value |
|
ResponseDebugInfo
Informations de débogage concernant la réponse.
Représentation JSON |
---|
{ "formattedDebugInfo": string } |
Champs | |
---|---|
formattedDebugInfo |
Informations de débogage générales mises en forme pour être affichées. |
Information sur l'erreur
Informations sur l'erreur concernant la réponse.
Représentation JSON |
---|
{
"errorMessages": [
{
object ( |
Champs | |
---|---|
errorMessages[] |
|
ErrorMessage
Message d'erreur par réponse source.
Représentation JSON |
---|
{
"source": {
object ( |
Champs | |
---|---|
source |
|
errorMessage |
|
ResultCounts
Informations sur le nombre de résultats
Représentation JSON |
---|
{
"sourceResultCounts": [
{
object ( |
Champs | |
---|---|
sourceResultCounts[] |
Informations sur le nombre de résultats pour chaque source avec résultats. |
SourceResultCount
Informations sur le nombre de résultats par source.
Représentation JSON |
---|
{ "source": { object ( |
Champs | |
---|---|
source |
Source à laquelle les informations sur le nombre de résultats sont associées. |
hasMoreResults |
Indique si d'autres résultats de recherche sont disponibles pour cette source. |
Champ d'union
|
|
resultCountEstimate |
Estimation du nombre de résultats pour cette source. |
resultCountExact |
Nombre exact de résultats pour cette source. |