Package google.developers.knowledge.v1alpha

Index

DeveloperKnowledge

L'API Developer Knowledge fournit un accès programmatique à la documentation publique pour les développeurs de Google. 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.

Tout le contenu du document 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

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/devprofiles.full_control

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

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/devprofiles.full_control

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

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Recherchez des informations pour les développeurs dans la documentation Google. Cette méthode renvoie des blocs de documents en fonction de la requête de l'utilisateur. Il peut y avoir de nombreux blocs pour le 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

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/devprofiles.full_control

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

BatchGetDocumentsRequest

Message de requête pour DeveloperKnowledge.BatchGetDocuments.

Champs
names[]

string

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

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. 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. URI du contenu, par exemple docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Uniquement en sortie. Contenu complet du document au format Markdown.
description

string

Uniquement en sortie. Description du document.

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 parent à DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments.

Champs
parent

string

Uniquement en sortie. 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. ID de ce bloc dans le document. L'ID de bloc est unique dans un document, mais pas à l'échelle mondiale pour tous les documents. L'ID de bloc n'est pas stable et peut changer au fil du temps.
content

string

Uniquement en sortie. Contenu du bloc de document.

GetDocumentRequest

Message de requête pour DeveloperKnowledge.GetDocument.

Champs
name

string

Obligatoire. 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. Chaîne de requête brute fournie par l'utilisateur, par exemple "Comment créer un bucket Cloud Storage ?".
page_size

int32

Facultatif. 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.
page_token

string

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

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