Method: documents.searchDocumentChunks

Recherche des connaissances pour les développeurs dans la documentation pour les développeurs de Google. Renvoie des DocumentChunk en fonction de la requête de l'utilisateur. Il peut y avoir plusieurs blocs provenant du même Document. Pour récupérer des documents complets, utilisez DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments avec le DocumentChunk.parent renvoyé dans SearchDocumentChunksResponse.results.

Requête HTTP

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
query

string

Obligatoire. Fournit la chaîne de requête brute fournie par l'utilisateur, par exemple "Comment créer un bucket Cloud Storage ?". La requête ne doit pas dépasser 500 caractères. Les valeurs de plus de 500 caractères généreront une erreur INVALID_ARGUMENT.
pageSize

integer

Facultatif. Spécifie le nombre maximal de résultats à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur.

Si aucune valeur n'est spécifiée, cinq résultats au maximum sont renvoyés.

La valeur maximale est 100. Les valeurs supérieures sont réduites à 100.
pageToken

string

Facultatif. Contient un jeton de page reçu d'un appel documents.searchDocumentChunks précédent. Fournissez-le pour récupérer la page suivante.
filter

string

Facultatif. Applique un filtre strict aux résultats de recherche. L'expression est compatible avec un sous-ensemble de la syntaxe décrite sur https://google.aip.dev/160.

Alors que documents.searchDocumentChunks renvoie des DocumentChunk, le filtre est appliqué aux champs DocumentChunk.document.

Champs compatibles avec le filtrage :

  • content_length_bytes (INTEGER) : longueur du champ Document.content en octets.
  • data_source (STRING) : source du document, par exemple docs.cloud.google.com. Pour obtenir la liste complète des sources de données du corpus, consultez https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP) : code temporel de la dernière mise à jour significative du document. Une mise à jour significative est une mise à jour qui modifie le contenu Markdown ou les métadonnées d'un document.
  • uri (STRING) : URI du document, par exemple https://docs.cloud.google.com/bigquery/docs/tables.

Les champs INTEGER sont compatibles avec les opérateurs =, <, <=, > et >=.

Les champs STRING acceptent les opérateurs = (égal à) et != (différent de) pour la correspondance exacte sur l'intégralité de la chaîne. Les correspondances partielles, les correspondances de préfixe et les correspondances d'expression régulière ne sont pas acceptées.

Les champs TIMESTAMP sont compatibles avec les opérateurs =, <, <=, > et >=. Les codes temporels doivent être au format RFC-3339, par exemple "2025-01-01T00:00:00Z".

Remarque : Les noms de champs doivent être au format snake_case (par exemple, data_source). Les valeurs à droite des expressions de filtrage doivent être des littéraux de chaîne placés entre guillemets doubles (par exemple, "docs.cloud.google.com").

Vous pouvez combiner des expressions à l'aide des opérateurs logiques AND, OR et NOT (ou -). OR est prioritaire sur AND. Utilisez des parenthèses pour regrouper explicitement les éléments selon leur ordre de priorité.

Exemples :

  • Filtrer par Document.content_length_bytes : content_length_bytes < 50000
  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

La chaîne filter ne doit pas dépasser 500 caractères. Les valeurs de plus de 500 caractères généreront une erreur INVALID_ARGUMENT.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour DeveloperKnowledge.SearchDocumentChunks.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Champs
results[]

object (DocumentChunk)

Contient les résultats de recherche pour la requête donnée. Chaque DocumentChunk de cette liste contient un extrait de contenu pertinent par rapport à la requête de recherche. Utilisez le champ DocumentChunk.parent de chaque résultat avec DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments pour récupérer l'intégralité du contenu du document.
nextPageToken

string

Fournit un jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Champs d'application des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Pour plus d'informations, consultez la OAuth 2.0 Overview.