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.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Répond à une requête à l'aide de la génération ancrée.

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.
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/developerprofiles.readonly
  • 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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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. 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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

Réponse

Réponse à une requête.

Champs
answer_text

string

Contient le texte de la réponse.
citations[]

AnswerCitation

Uniquement en sortie. Contient des citations pour la réponse.
references[]

AnswerReference

Uniquement en sortie. Contient des références pour la réponse.

AnswerCitation

Informations de citation pour un segment.

Champs
start_index

int32

Uniquement en sortie. Indique le début du segment, mesuré en octets (Unicode UTF-8), inclus. S'il existe des caractères multi-octets, tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne.
end_index

int32

Uniquement en sortie. Indique la fin du segment, mesurée en octets (Unicode UTF-8), exclusive. S'il existe des caractères multi-octets, tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne.
sources[]

CitationSource

Uniquement en sortie. Contient les sources de citation pour le segment attribué.

AnswerReference

Représente une référence à une source.

Champs
Champ d'union content. Contient le contenu de la référence. content ne peut être qu'un des éléments suivants :
document_reference

DocumentReference

Uniquement en sortie. Document de référence.

CitationSource

Source de la citation.

Champs
reference_index

int32

Uniquement en sortie. Contient l'index de Answer.AnswerReference dans le champ répété references.

DocumentReference

Représente une référence à un document.

Champs
document_chunk

DocumentChunk

Uniquement en sortie. Contient le bloc de document. Le champ document_chunk.id n'est pas défini et sera vide.

AnswerQueryRequest

Message de requête pour DeveloperKnowledge.AnswerQuery.

Champs
query

string

Obligatoire. Requête à laquelle répondre.
filter

string

Facultatif. Applique un filtre strict aux résultats de recherche utilisés pour ancrer la réponse. L'expression accepte un sous-ensemble de la syntaxe décrite sur https://google.aip.dev/160.

Champs acceptant 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 modification significative est une modification qui affecte 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".

Vous pouvez combiner des expressions à l'aide des opérateurs logiques AND, OR et NOT (ou -). OR a une priorité plus élevée que AND. Utilisez des parenthèses pour regrouper explicitement les éléments selon leur 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.

AnswerQueryResponse

Message de réponse pour DeveloperKnowledge.AnswerQuery.

Champs
answer

Answer

Réponse à la requête.

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

Chaque nom ne doit pas dépasser 500 caractères. Les valeurs de plus de 500 caractères généreront une erreur INVALID_ARGUMENT.
view

DocumentView

Facultatif. Spécifie le DocumentView du document. Si aucune valeur n'est spécifiée, DeveloperKnowledge.BatchGetDocuments prend la valeur par défaut DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Message de réponse pour DeveloperKnowledge.BatchGetDocuments.

Champs
documents[]

Document

Contient les documents demandés.

Document

Un document représente une page de documentation dans le corpus de connaissances pour les développeurs, comme la page https://docs.cloud.google.com/storage/docs/creating-buckets.

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

string

Uniquement en sortie. Spécifie la source de données du document. Exemple de source de données : firebase.google.com
title

string

Uniquement en sortie. Indique le titre du document.
update_time

Timestamp

Uniquement en sortie. Représente le code temporel de la dernière mise à jour du contenu ou des métadonnées du document.
view

DocumentView

Uniquement en sortie. Spécifie le DocumentView du document.
content_length_bytes

int32

Uniquement en sortie. Longueur du champ content en octets.

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

Document

Uniquement en sortie. Représente les métadonnées du Document à partir duquel ce bloc provient. 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 extraire l'intégralité du contenu du document.
relevance_score

double

Uniquement en sortie. Représente le score de pertinence du bloc par rapport à la requête de recherche. Plus le score est élevé, plus le bloc est pertinent. Le score est compris dans la plage [0,0, 1,0].

DocumentView

Spécifie les champs du Document inclus.

Enums
DOCUMENT_VIEW_UNSPECIFIED Valeur par défaut / non définie. Consultez la valeur par défaut de chaque méthode d'API si DocumentView n'est pas spécifié.
DOCUMENT_VIEW_BASIC

Inclut uniquement les champs de métadonnées de base :

  • name
  • uri
  • data_source
  • title
  • description
  • update_time
  • view
  • content_length_bytes

Il s'agit de la vue par défaut pour DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Inclut tous les champs Document.
DOCUMENT_VIEW_CONTENT

Inclut les champs DOCUMENT_VIEW_BASIC et content.

Il s'agit de la vue par défaut pour DeveloperKnowledge.GetDocument et DeveloperKnowledge.BatchGetDocuments.

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

Le nom ne doit pas dépasser 500 caractères. Les valeurs de plus de 500 caractères généreront une erreur INVALID_ARGUMENT.
view

DocumentView

Facultatif. Spécifie le DocumentView du document. Si aucune valeur n'est spécifiée, DeveloperKnowledge.GetDocument prend la valeur par défaut DOCUMENT_VIEW_CONTENT.

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 ?". 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.
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 100. Les valeurs supérieures sont réduites à 100.
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.
filter

string

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

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

Champs acceptant 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 modification significative est une modification qui affecte 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".

Vous pouvez combiner des expressions à l'aide des opérateurs logiques AND, OR et NOT (ou -). OR a une priorité plus élevée que AND. Utilisez des parenthèses pour regrouper explicitement les éléments selon leur 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.

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

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.