Method: documents.searchDocumentChunks

Recherche des connaissances des 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 de nombreux 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/v1/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 ?".
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, au maximum cinq résultats sont renvoyés.

La valeur maximale est 20. Les valeurs supérieures génèrent une erreur INVALID_ARGUMENT.
pageToken

string

Facultatif. Contient un jeton de page, reçu lors 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.

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

Champs compatibles pour le filtrage :

  • dataSource (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.
  • updateTime (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 du document.
  • uri (STRING) : URI du document, par exemple https://docs.cloud.google.com/bigquery/docs/tables.

Les champs STRING sont compatibles avec les opérateurs = (égal à) et != (différent de) pour une correspondance exacte sur l'ensemble de la chaîne. La correspondance partielle, la correspondance de préfixe et la correspondance d'expression régulière ne sont pas compatibles.

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

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 priorités.

Exemples :

  • dataSource = "docs.cloud.google.com" OR dataSource = "firebase.google.com"
  • dataSource != "firebase.google.com"
  • updateTime < "2024-01-01T00:00:00Z"
  • updateTime >= "2025-01-22T00:00:00Z" AND (dataSource = "developer.chrome.com" OR dataSource = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

La chaîne filter ne doit pas dépasser 500 caractères. Les valeurs supérieures à 500 caractères génèrent 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 pour la requête de recherche. Utilisez le champ DocumentChunk.parent de chaque résultat avec DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments pour récupérer le contenu complet du document.
nextPageToken

string

Facultatif. Fournit un jeton qui peut ê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.

Niveaux d'accès 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/cloud-platform

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

DocumentChunk

Un DocumentChunk représente un élément de contenu d'un Document dans le corpus DeveloperKnowledge. Pour récupérer l'intégralité du contenu du document, transmettez le parent à DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments.

Représentation JSON 
{
  "parent": string,
  "id": string,
  "content": string,
  "document": {
    object (Document)
  }
}
Champs
parent

string

Uniquement en sortie. Contient le nom de ressource du document dont provient ce bloc. Format : documents/{uri_without_scheme} Exemple : documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Uniquement en sortie. Spécifie l'ID de ce bloc dans le document. L'ID de bloc est unique dans un document, mais pas globalement unique dans tous les documents. L'ID de bloc n'est pas stable et peut changer au fil du temps.
content

string

Uniquement en sortie. Contient le contenu du bloc de document.
document

object (Document)

Uniquement en sortie. Représente les métadonnées du Document dont provient ce bloc. Le DocumentView de ce message Document sera défini sur DOCUMENT_VIEW_BASIC. Il est inclus ici pour plus de commodité, afin que les clients n'aient pas besoin d'appeler DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments s'ils n'ont besoin que des champs de métadonnées. Sinon, les clients doivent utiliser DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments pour récupérer l'intégralité du contenu du document.