Package google.developers.knowledge.v1alpha

Index

DeveloperKnowledge

L'API Developer Knowledge fournit un accès programmatique à la documentation publique de Google pour les développeurs. Vous pouvez ainsi intégrer cette base de connaissances à vos propres applications et workflows.

L'API est conçue pour être la source canonique d'accès à la documentation pour les développeurs de Google, lisible par machine.

Un cas d'utilisation typique consiste à utiliser d'abord DeveloperKnowledge.SearchDocumentChunks pour trouver les URI de page pertinents en fonction d'une requête, puis à utiliser DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments pour récupérer le contenu complet des meilleurs résultats.

Le contenu des documents est fourni au format Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Récupère plusieurs documents, chacun avec son contenu Markdown complet.

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

rpc GetDocument(GetDocumentRequest) returns (Document)

Récupère un seul document avec son contenu Markdown complet.

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Recherche des connaissances pour les développeurs dans la documentation Google qui leur est destinée. 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.

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.

BatchGetDocumentsRequest

Message de requête pour DeveloperKnowledge.BatchGetDocuments.

Champs
names[]

string

Obligatoire. Indique les noms des documents à récupérer. Vous pouvez récupérer jusqu'à 20 documents par lot. Les documents sont renvoyés dans le même ordre que les names dans la requête.

Format : documents/{uri_without_scheme} Exemple : documents/docs.cloud.google.com/storage/docs/creating-buckets

BatchGetDocumentsResponse

Message de réponse pour DeveloperKnowledge.BatchGetDocuments.

Champs
documents[]

Document

Contient les documents demandés.

Document

Un document représente un élément de contenu du corpus de connaissances pour les développeurs.

Champs
name

string

Identifiant. Contient le nom de ressource du document. Format : documents/{uri_without_scheme} Exemple : documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Uniquement en sortie. Fournit l'URI du contenu, tel que docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Uniquement en sortie. Contient l'intégralité du contenu du document au format Markdown.
description

string

Uniquement en sortie. Fournit une description du document.
title

string

Uniquement en sortie. Indique le titre du document.

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.

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.

GetDocumentRequest

Message de requête pour DeveloperKnowledge.GetDocument.

Champs
name

string

Obligatoire. Indique le nom du document à récupérer. Format : documents/{uri_without_scheme} Exemple : documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Message de requête pour DeveloperKnowledge.SearchDocumentChunks.

Champs
query

string

Obligatoire. Fournit la chaîne de requête brute fournie par l'utilisateur, par exemple "Comment créer un bucket Cloud Storage ?".
page_size

int32

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 à 20 généreront une erreur INVALID_ARGUMENT.
page_token

string

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

SearchDocumentChunksResponse

Message de réponse pour DeveloperKnowledge.SearchDocumentChunks.

Champs
results[]

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

string

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