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

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Beantwortet eine Anfrage mithilfe von fundierter Generierung.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter OAuth 2.0 Overview.
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/developerprofiles.readonly
  • 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/developerprofiles.readonly
  • 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/developerprofiles.readonly
  • https://www.googleapis.com/auth/cloud-platform

Weitere Informationen finden Sie unter OAuth 2.0 Overview.

Antwort

Eine Antwort auf eine Anfrage.

Felder
answer_text

string

Enthält den Text der Antwort.
citations[]

AnswerCitation

Nur Ausgabe. Enthält Quellenangaben für die Antwort.
references[]

AnswerReference

Nur Ausgabe. Enthält Referenzen für die Antwort.

AnswerCitation

Quelleninformation für ein Segment.

Felder
start_index

int32

Nur Ausgabe. Gibt den Beginn des Segments an, gemessen in Byte (UTF-8-Unicode), einschließlich. Wenn es Multibyte-Zeichen gibt, wie etwa Nicht-ASCII-Zeichen, ist die Indexmessung länger als die Stringlänge.
end_index

int32

Nur Ausgabe. Gibt das Ende des Segments an, gemessen in Byte (UTF-8-Unicode), exklusiv. Wenn es Multibyte-Zeichen gibt, wie etwa Nicht-ASCII-Zeichen, ist die Indexmessung länger als die Stringlänge.
sources[]

CitationSource

Nur Ausgabe. Enthält Zitationsquellen für das zugeordnete Segment.

AnswerReference

Stellt einen Verweis auf eine Quelle dar.

Felder
Union-Feld content. Enthält den Inhalt der Referenz. Für content ist nur einer der folgenden Werte zulässig:
document_reference

DocumentReference

Nur Ausgabe. Das Referenzdokument.

CitationSource

Zitationsquelle

Felder
reference_index

int32

Nur Ausgabe. Enthält den Index von Answer.AnswerReference im wiederkehrenden Feld references.

DocumentReference

Stellt einen Verweis auf ein Dokument dar.

Felder
document_chunk

DocumentChunk

Nur Ausgabe. Enthält den Dokumentblock. Das Feld document_chunk.id ist nicht festgelegt und ist leer.

AnswerQueryRequest

Anfragenachricht für DeveloperKnowledge.AnswerQuery.

Felder
query

string

Erforderlich. Die zu beantwortende Anfrage.
filter

string

Optional. Wendet einen strengen Filter auf die Suchergebnisse an, die zur Fundierung der Antwort verwendet werden. Der Ausdruck unterstützt eine Teilmenge der unter https://google.aip.dev/160 beschriebenen Syntax.

Unterstützte Felder zum Filtern:

  • content_length_bytes (INTEGER): Die Länge des Felds Document.content in Byte.
  • data_source (STRING): Die Quelle des Dokuments, z.B. docs.cloud.google.com. Eine vollständige Liste der Datenquellen im Korpus finden Sie unter https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP): Der Zeitstempel, der angibt, wann das Dokument zuletzt inhaltlich aktualisiert wurde. Ein sinnvolles Update ist eines, bei dem sich der Markdown-Inhalt oder die Metadaten des Dokuments ändern.
  • uri (STRING): Der Dokument-URI, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

INTEGER-Felder unterstützen die Operatoren =, <, <=, > und >=.

STRING-Felder unterstützen die Operatoren = (gleich) und != (ungleich) für den genauen Abgleich des gesamten Strings. Teilübereinstimmungen, Präfixübereinstimmungen und Übereinstimmungen mit regulären Ausdrücken werden nicht unterstützt.

TIMESTAMP-Felder unterstützen die Operatoren =, <, <=, > und >=. Zeitstempel müssen im RFC-3339-Format vorliegen, z.B. "2025-01-01T00:00:00Z".

Sie können Ausdrücke mit den logischen Operatoren AND, OR und NOT (oder -) kombinieren. OR hat eine höhere Priorität als AND. Verwenden Sie Klammern für die explizite Gruppierung nach Priorität.

Beispiele:

  • Nach „Document.content_length_bytes“ filtern: „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"

Der String filter darf maximal 500 Zeichen lang sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT ausgegeben.

AnswerQueryResponse

Antwortnachricht für DeveloperKnowledge.AnswerQuery.

Felder
answer

Answer

Die Antwort auf die Anfrage.

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 zurückgegeben wie die names in der Anfrage.

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

Jeder Name darf maximal 500 Zeichen lang sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT ausgegeben.
view

DocumentView

Optional. Gibt die DocumentView des Dokuments an. Wenn nicht angegeben, wird für DeveloperKnowledge.BatchGetDocuments standardmäßig DOCUMENT_VIEW_CONTENT verwendet.

BatchGetDocumentsResponse

Antwortnachricht für DeveloperKnowledge.BatchGetDocuments.

Felder
documents[]

Document

Enthält die angeforderten Dokumente.

Dokument

Ein Dokument stellt eine Dokumentationsseite im Developer Knowledge-Korpus dar, z. B. die Seite unter https://docs.cloud.google.com/storage/docs/creating-buckets.

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

string

Nur Ausgabe. Gibt die Datenquelle des Dokuments an. Beispieldatenquelle: firebase.google.com
title

string

Nur Ausgabe. Gibt den Titel des Dokuments an.
update_time

Timestamp

Nur Ausgabe. Der Zeitstempel, der angibt, wann der Inhalt oder die Metadaten des Dokuments zuletzt aktualisiert wurden.
view

DocumentView

Nur Ausgabe. Gibt die DocumentView des Dokuments an.
content_length_bytes

int32

Nur Ausgabe. Die Länge des Felds content in Byte.

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

Document

Nur Ausgabe. Stellt Metadaten zum Document dar, aus dem dieser Block stammt. Die DocumentView dieser Document-Nachricht wird auf DOCUMENT_VIEW_BASIC festgelegt. Sie ist hier enthalten, damit Clients nicht DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments aufrufen müssen, wenn sie nur die Metadatenfelder benötigen. Andernfalls sollten Clients DeveloperKnowledge.GetDocument oder DeveloperKnowledge.BatchGetDocuments verwenden, um den vollständigen Dokumentinhalt abzurufen.
relevance_score

double

Nur Ausgabe. Stellt den Relevanzwert des Chunks für die Suchanfrage dar. Ein höherer Wert weist auf eine höhere Relevanz des Chunks hin. Der Wert liegt im Bereich [0,0, 1,0].

DocumentView

Gibt an, welche Felder des Document enthalten sind.

Enums
DOCUMENT_VIEW_UNSPECIFIED Der Standardwert bzw. der nicht festgelegte Wert. Den Standardwert für die einzelnen API-Methoden finden Sie in der jeweiligen Dokumentation, wenn DocumentView nicht angegeben ist.
DOCUMENT_VIEW_BASIC

Enthält nur die grundlegenden Metadatenfelder:

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

Dies ist die Standardansicht für DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Umfasst alle Document-Felder.
DOCUMENT_VIEW_CONTENT

Enthält die Felder DOCUMENT_VIEW_BASIC und das Feld content.

Dies ist die Standardansicht für DeveloperKnowledge.GetDocument und DeveloperKnowledge.BatchGetDocuments.

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

Der Name darf maximal 500 Zeichen lang sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT ausgegeben.
view

DocumentView

Optional. Gibt die DocumentView des Dokuments an. Wenn nicht angegeben, wird für DeveloperKnowledge.GetDocument standardmäßig DOCUMENT_VIEW_CONTENT verwendet.

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?“. Die Abfrage darf maximal 500 Zeichen lang sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT zurückgegeben.
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 100. Werte über 100 werden implizit auf 100 umgewandelt.
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.
filter

string

Optional. Wendet einen strengen Filter auf die Suchergebnisse an. Der Ausdruck unterstützt eine Teilmenge der unter https://google.aip.dev/160 beschriebenen Syntax.

Während SearchDocumentChunks DocumentChunk zurückgibt, wird der Filter auf DocumentChunk.document-Felder angewendet.

Unterstützte Felder zum Filtern:

  • content_length_bytes (INTEGER): Die Länge des Felds Document.content in Byte.
  • data_source (STRING): Die Quelle des Dokuments, z.B. docs.cloud.google.com. Eine vollständige Liste der Datenquellen im Korpus finden Sie unter https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP): Der Zeitstempel, der angibt, wann das Dokument zuletzt inhaltlich aktualisiert wurde. Ein sinnvolles Update ist eines, bei dem sich der Markdown-Inhalt oder die Metadaten des Dokuments ändern.
  • uri (STRING): Der Dokument-URI, z.B. https://docs.cloud.google.com/bigquery/docs/tables.

INTEGER-Felder unterstützen die Operatoren =, <, <=, > und >=.

STRING-Felder unterstützen die Operatoren = (gleich) und != (ungleich) für den genauen Abgleich des gesamten Strings. Teilübereinstimmungen, Präfixübereinstimmungen und Übereinstimmungen mit regulären Ausdrücken werden nicht unterstützt.

TIMESTAMP-Felder unterstützen die Operatoren =, <, <=, > und >=. Zeitstempel müssen im RFC-3339-Format vorliegen, z.B. "2025-01-01T00:00:00Z".

Sie können Ausdrücke mit den logischen Operatoren AND, OR und NOT (oder -) kombinieren. OR hat eine höhere Priorität als AND. Verwenden Sie Klammern für die explizite Gruppierung nach Priorität.

Beispiele:

  • Nach „Document.content_length_bytes“ filtern: „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"

Der String filter darf maximal 500 Zeichen lang sein. Bei längeren Werten wird der Fehler INVALID_ARGUMENT ausgegeben.

SearchDocumentChunksResponse

Antwortnachricht für DeveloperKnowledge.SearchDocumentChunks.

Felder
results[]

DocumentChunk

Enthält die Suchergebnisse für die angegebene Abfrage. 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

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.