Package google.developers.knowledge.v1alpha

Index

DeveloperKnowledge

Die Developer Knowledge API bietet programmatischen Zugriff auf die öffentliche Entwicklerdokumentation von Google. So können Sie diese Knowledge Base in Ihre eigenen Anwendungen und Workflows einbinden.

Die API ist als kanonische Quelle für den maschinenlesbaren Zugriff auf die Entwicklerdokumentation von Google konzipiert.

Ein typischer Anwendungsfall ist, zuerst DeveloperKnowledge.SearchDocumentChunks zu verwenden, um relevante Seiten-URIs basierend auf einer Anfrage zu finden, und dann DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments, um den vollständigen Inhalt der Top-Ergebnisse abzurufen.

Alle Dokumentinhalte werden im Markdown-Format bereitgestellt.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Ruft mehrere Dokumente ab, die jeweils den vollständigen Markdown-Inhalt enthalten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter OAuth 2.0 Overview.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Ruft ein einzelnes Dokument mit seinem vollständigen Markdown-Inhalt ab.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter OAuth 2.0 Overview.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Sucht in der Entwicklerdokumentation von Google nach Informationen für Entwickler. Gibt DocumentChunks basierend auf der Anfrage des Nutzers zurück. Es kann viele Chunks aus derselben Document geben. Wenn Sie vollständige Dokumente abrufen möchten, verwenden Sie DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments mit dem DocumentChunk.parent, das in der SearchDocumentChunksResponse.results zurückgegeben wird.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

BatchGetDocumentsRequest

Anfragenachricht für DeveloperKnowledge.BatchGetDocuments.

Felder
names[]

string

Erforderlich. Gibt die Namen der abzurufenden Dokumente an. In einem Batch können maximal 20 Dokumente abgerufen werden. Die Dokumente werden in derselben Reihenfolge wie die names in der Anfrage zurückgegeben.

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

BatchGetDocumentsResponse

Antwortnachricht für DeveloperKnowledge.BatchGetDocuments.

Felder
documents[]

Document

Enthält die angeforderten Dokumente.

Dokument

Ein Dokument stellt einen Inhalt aus dem Developer Knowledge-Korpus dar.

Felder
name

string

ID. Enthält den Ressourcennamen des Dokuments. Format: documents/{uri_without_scheme} Beispiel: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Nur Ausgabe. Gibt den URI des Inhalts an, z. B. docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Nur Ausgabe. Enthält den vollständigen Inhalt des Dokuments im Markdown-Format.
description

string

Nur Ausgabe. Bietet eine Beschreibung des Dokuments.
title

string

Nur Ausgabe. Gibt den Titel des Dokuments an.

DocumentChunk

Ein DocumentChunk stellt einen Inhalt aus einem Document im DeveloperKnowledge-Korpus dar. Wenn Sie den gesamten Dokumentinhalt abrufen möchten, übergeben Sie parent an DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments.

Felder
parent

string

Nur Ausgabe. Enthält den Ressourcennamen des Dokuments, aus dem dieser Chunk stammt. Format: documents/{uri_without_scheme} Beispiel: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Nur Ausgabe. Gibt die ID dieses Chunks innerhalb des Dokuments an. Die Chunk-ID ist innerhalb eines Dokuments eindeutig, aber nicht global über alle Dokumente hinweg. Die Chunk-ID ist nicht stabil und kann sich im Laufe der Zeit ändern.
content

string

Nur Ausgabe. Enthält den Inhalt des Dokumentblocks.

GetDocumentRequest

Anfragenachricht für DeveloperKnowledge.GetDocument.

Felder
name

string

Erforderlich. Gibt den Namen des abzurufenden Dokuments an. Format: documents/{uri_without_scheme} Beispiel: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Anfragenachricht für DeveloperKnowledge.SearchDocumentChunks.

Felder
query

string

Erforderlich. Enthält den vom Nutzer angegebenen Rohabfragestring, z. B. „Wie erstelle ich einen Cloud Storage-Bucket?“.
page_size

int32

Optional. Gibt die maximale Anzahl der zurückzugebenden Ergebnisse an. Der Dienst gibt möglicherweise weniger als diesen Wert zurück.

Falls nicht angegeben, werden maximal 5 Ergebnisse zurückgegeben.

Der Höchstwert beträgt 20. Höhere Werte führen zu einem INVALID_ARGUMENT-Fehler.
page_token

string

Optional. Enthält ein Seitentoken, das von einem vorherigen SearchDocumentChunks-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

SearchDocumentChunksResponse

Antwortnachricht für DeveloperKnowledge.SearchDocumentChunks.

Felder
results[]

DocumentChunk

Enthält die Suchergebnisse für die angegebene Anfrage. Jedes DocumentChunk in dieser Liste enthält einen Ausschnitt von Inhalten, die für die Suchanfrage relevant sind. Verwenden Sie das Feld DocumentChunk.parent jedes Ergebnisses mit DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments, um den vollständigen Dokumentinhalt abzurufen.
next_page_token

string

Optional. Stellt ein Token bereit, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.