Method: documents.searchDocumentChunks

Recherchez des informations pour les développeurs dans la documentation 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 ?".
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 20. Les valeurs supérieures génèrent une erreur INVALID_ARGUMENT.
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.

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 l'intégralité du contenu du document.
nextPageToken

string

Facultatif. 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/cloud-platform

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

DocumentChunk

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

Représentation JSON 
{
  "parent": string,
  "id": string,
  "content": string
}
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 à l'échelle globale pour 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.