Package google.developers.knowledge.v1alpha

Indeks

DeveloperKnowledge

Interfejs Developer Knowledge API zapewnia automatyczny dostęp do publicznej dokumentacji Google dla deweloperów, co umożliwia integrację tej bazy wiedzy z własnymi aplikacjami i przepływami pracy.

Interfejs API został zaprojektowany jako kanoniczne źródło dostępu do dokumentacji Google dla deweloperów w formacie czytelnym dla komputerów.

Typowym przypadkiem użycia jest najpierw użycie metody DeveloperKnowledge.SearchDocumentChunks do znalezienia odpowiednich fragmentów dokumentu na podstawie zapytania, a następnie użycie metody DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments z nazwami zasobów dokumentu (takimi jak DocumentChunk.parent lub documents/{uri_without_scheme}) do pobrania pełnej zawartości najlepszych wyników.

Cała treść dokumentu jest podawana w formacie Markdown.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Odpowiada na zapytanie, korzystając z generowania opartego na źródłach.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

pobiera wiele dokumentów, każdy z pełną treścią w formacie Markdown;

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Pobiera pojedynczy dokument z pełną zawartością w formacie Markdown.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Wyszukuje informacje dla deweloperów w dokumentacji Google dla deweloperów. Zwraca DocumentChunk na podstawie zapytania użytkownika. Może być wiele fragmentów z tego samego Document. Aby pobrać pełne dokumenty, użyj DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments z DocumentChunk.parent zwróconym w SearchDocumentChunksResponse.results.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

Odpowiedź

Odpowiedź na zapytanie.

Pola
answer_text

string

Zawiera treść odpowiedzi.
citations[]

AnswerCitation

Tylko dane wyjściowe. Zawiera cytaty dotyczące odpowiedzi.
references[]

AnswerReference

Tylko dane wyjściowe. Zawiera odniesienia do odpowiedzi.

AnswerCitation

Informacje o cytacie w segmencie.

Pola
start_index

int32

Tylko dane wyjściowe. Wskazuje początek segmentu mierzony w bajtach (UTF-8 Unicode), włącznie z wartościami granicznymi. Jeśli występują znaki wielobajtowe, takie jak znaki spoza zestawu ASCII, indeks jest dłuższy niż ciąg znaków.
end_index

int32

Tylko dane wyjściowe. Wskazuje koniec segmentu, mierzony w bajtach (Unicode UTF-8), z wyłączeniem ostatniego bajtu. Jeśli występują znaki wielobajtowe, takie jak znaki spoza zestawu ASCII, indeks jest dłuższy niż ciąg znaków.
sources[]

CitationSource

Tylko dane wyjściowe. Zawiera źródła cytatów dla przypisanego segmentu.

AnswerReference

Reprezentuje odniesienie do źródła.

Pola
Pole zbiorcze content. Zawiera treść pliku referencyjnego. content może mieć tylko jedną z tych wartości:
document_reference

DocumentReference

Tylko dane wyjściowe. Dokument referencyjny.

CitationSource

Źródło cytatu.

Pola
reference_index

int32

Tylko dane wyjściowe. Zawiera indeks Answer.AnswerReference w polu powtarzanym references.

DocumentReference

Reprezentuje odwołanie do dokumentu.

Pola
document_chunk

DocumentChunk

Tylko dane wyjściowe. Zawiera fragment dokumentu. Pole document_chunk.id nie jest ustawione i będzie puste.

AnswerQueryRequest

Wiadomość z prośbą o dostęp do: DeveloperKnowledge.AnswerQuery.

Pola
query

string

Wymagane. Zapytanie, na które należy odpowiedzieć.
filter

string

Opcjonalnie: Stosuje rygorystyczny filtr do wyników wyszukiwania używanych do generowania odpowiedzi. Wyrażenie obsługuje podzbiór składni opisanej na stronie https://google.aip.dev/160.

Obsługiwane pola do filtrowania:

  • content_length_bytes (LICZBA CAŁKOWITA): długość pola Document.content w bajtach.
  • data_source (STRING): źródło dokumentu, np. docs.cloud.google.com. Pełną listę źródeł danych w korpusie znajdziesz na stronie https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP): sygnatura czasowa ostatniej istotnej aktualizacji dokumentu. Istotna aktualizacja to taka, która zmienia treść dokumentu w formacie Markdown lub metadane.
  • uri (STRING): identyfikator URI dokumentu, np. https://docs.cloud.google.com/bigquery/docs/tables.

Pola INTEGER obsługują operatory =, <, <=, > i >=.

Pola STRING obsługują operatory = (równa się) i != (nie równa się) w przypadku dopasowania ścisłego do całego ciągu znaków. Dopasowanie częściowe, dopasowanie prefiksu i dopasowanie wyrażenia regularnego nie są obsługiwane.

Pola TIMESTAMP obsługują operatory =, <, <=, > i >=. Sygnatury czasowe muszą być w formacie RFC-3339, np. "2025-01-01T00:00:00Z".

Wyrażenia możesz łączyć za pomocą operatorów logicznych AND, OR i NOT (lub -). OR ma wyższy priorytet niż AND. Używaj nawiasów do jawnego grupowania według kolejności wykonywania działań.

Przykłady:

  • Filtruj według: 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"

Ciąg znaków filter nie może przekraczać 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.

AnswerQueryResponse

Wiadomość z odpowiedzią dla: DeveloperKnowledge.AnswerQuery.

Pola
answer

Answer

Odpowiedź na zapytanie.

BatchGetDocumentsRequest

Wiadomość z prośbą o dostęp do: DeveloperKnowledge.BatchGetDocuments.

Pola
names[]

string

Wymagane. Określa nazwy dokumentów do pobrania. W ramach jednej operacji zbiorczej można pobrać maksymalnie 20 dokumentów. Dokumenty są zwracane w tej samej kolejności co names w żądaniu.

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

Każda nazwa może mieć maksymalnie 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.
view

DocumentView

Opcjonalnie: Określa DocumentView dokumentu. Jeśli nie określono inaczej, domyślnie DeveloperKnowledge.BatchGetDocuments to DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Wiadomość z odpowiedzią dla: DeveloperKnowledge.BatchGetDocuments.

Pola
documents[]

Document

zawierać wymagane dokumenty,

Dokument

Dokument reprezentuje stronę dokumentacji w korpusie wiedzy dla deweloperów, np. stronę https://docs.cloud.google.com/storage/docs/creating-buckets.

Pola
name

string

Identyfikator. Zawiera nazwę zasobu dokumentu. Format: documents/{uri_without_scheme} Przykład: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Tylko dane wyjściowe. Podaje identyfikator URI treści, np. https://docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Tylko dane wyjściowe. Zawiera pełną treść dokumentu w formacie Markdown.
description

string

Tylko dane wyjściowe. Zawiera opis dokumentu.
data_source

string

Tylko dane wyjściowe. Określa źródło danych dokumentu. Przykładowe źródło danych: firebase.google.com
title

string

Tylko dane wyjściowe. Tytuł dokumentu.
update_time

Timestamp

Tylko dane wyjściowe. Reprezentuje sygnaturę czasową ostatniej aktualizacji treści lub metadanych dokumentu.
view

DocumentView

Tylko dane wyjściowe. Określa DocumentView dokumentu.
content_length_bytes

int32

Tylko dane wyjściowe. Długość pola content w bajtach.

DocumentChunk

DocumentChunk reprezentuje fragment treści z Document w korpusie DeveloperKnowledge. Aby pobrać całą zawartość dokumentu, przekaż parent do DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments.

Pola
parent

string

Tylko dane wyjściowe. Zawiera nazwę zasobu dokumentu, z którego pochodzi ten fragment. Format: documents/{uri_without_scheme} Przykład: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Tylko dane wyjściowe. Określa identyfikator tego fragmentu w dokumencie. Identyfikator fragmentu jest unikalny w obrębie dokumentu, ale nie jest unikalny globalnie we wszystkich dokumentach. Identyfikator fragmentu nie jest stały i może się zmieniać.
content

string

Tylko dane wyjściowe. Zawiera treść fragmentu dokumentu.
document

Document

Tylko dane wyjściowe. Reprezentuje metadane dotyczące Document, z którego pochodzi ten fragment. DocumentView tej wiadomości Document zostanie ustawiony na DOCUMENT_VIEW_BASIC. Jest on tu uwzględniony dla wygody, aby klienci nie musieli wywoływać metody DeveloperKnowledge.GetDocument ani DeveloperKnowledge.BatchGetDocuments, jeśli potrzebują tylko pól metadanych. W przeciwnym razie klienci powinni używać metody DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments, aby pobrać pełną treść dokumentu.
relevance_score

double

Tylko dane wyjściowe. Reprezentuje wynik trafności fragmentu w odniesieniu do zapytania. Wyższy wynik oznacza większą trafność fragmentu. Wynik mieści się w zakresie [0,0; 1,0].

DocumentView

Określa, które pola Document są uwzględnione.

Wartości w polu enum
DOCUMENT_VIEW_UNSPECIFIED Wartość domyślna lub nieustawiona. Jeśli nie określono właściwości DocumentView, sprawdź wartość domyślną dla każdej metody interfejsu API.
DOCUMENT_VIEW_BASIC

Zawiera tylko podstawowe pola metadanych:

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

Jest to domyślny widok dla: DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Zawiera wszystkie pola Document.
DOCUMENT_VIEW_CONTENT

Zawiera pola DOCUMENT_VIEW_BASIC i pole content.

Jest to domyślny widok dla DeveloperKnowledge.GetDocument i DeveloperKnowledge.BatchGetDocuments.

GetDocumentRequest

Wiadomość z prośbą o dostęp do: DeveloperKnowledge.GetDocument.

Pola
name

string

Wymagane. Określa nazwę dokumentu do pobrania. Format: documents/{uri_without_scheme} Przykład: documents/docs.cloud.google.com/storage/docs/creating-buckets

Nazwa nie może przekraczać 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.
view

DocumentView

Opcjonalnie: Określa DocumentView dokumentu. Jeśli nie określono inaczej, domyślnie DeveloperKnowledge.GetDocument to DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

Wiadomość z prośbą o dostęp do: DeveloperKnowledge.SearchDocumentChunks.

Pola
query

string

Wymagane. Zawiera nieprzetworzony ciąg zapytania podany przez użytkownika, np. „Jak utworzyć zasobnik Cloud Storage?”. Zapytanie nie może przekraczać 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.
page_size

int32

Opcjonalnie: Określa maksymalną liczbę wyników do zwrócenia. Usługa może zwrócić mniejszą liczbę wyników.

Jeśli nie podano tego argumentu, zwracanych jest maksymalnie 5 wyników.

Maksymalna wartość to 100. Wartości powyżej 100 zostaną zmienione na 100.
page_token

string

Opcjonalnie: Zawiera token strony otrzymany z poprzedniego wywołania SearchDocumentChunks. Podaj go, aby pobrać kolejną stronę.
filter

string

Opcjonalnie: Stosuje ścisły filtr do wyników wyszukiwania. Wyrażenie obsługuje podzbiór składni opisanej na stronie https://google.aip.dev/160.

SearchDocumentChunks zwraca DocumentChunk, a filtr jest stosowany do pól DocumentChunk.document.

Obsługiwane pola do filtrowania:

  • content_length_bytes (LICZBA CAŁKOWITA): długość pola Document.content w bajtach.
  • data_source (STRING): źródło dokumentu, np. docs.cloud.google.com. Pełną listę źródeł danych w korpusie znajdziesz na stronie https://developers.google.com/knowledge/reference/corpus-reference.
  • update_time (TIMESTAMP): sygnatura czasowa ostatniej istotnej aktualizacji dokumentu. Istotna aktualizacja to taka, która zmienia treść dokumentu w formacie Markdown lub metadane.
  • uri (STRING): identyfikator URI dokumentu, np. https://docs.cloud.google.com/bigquery/docs/tables.

Pola INTEGER obsługują operatory =, <, <=, > i >=.

Pola STRING obsługują operatory = (równa się) i != (nie równa się) w przypadku dopasowania ścisłego do całego ciągu znaków. Dopasowanie częściowe, dopasowanie prefiksu i dopasowanie wyrażenia regularnego nie są obsługiwane.

Pola TIMESTAMP obsługują operatory =, <, <=, > i >=. Sygnatury czasowe muszą być w formacie RFC-3339, np. "2025-01-01T00:00:00Z".

Uwaga: nazwy pól muszą być zapisane w formacie snake_case (np. data_source). Wartości po prawej stronie wyrażeń filtra muszą być literałami ciągu znaków ujętymi w cudzysłów (np. "docs.cloud.google.com").

Wyrażenia możesz łączyć za pomocą operatorów logicznych AND, OR i NOT (lub -). OR ma wyższy priorytet niż AND. Używaj nawiasów do jawnego grupowania według kolejności wykonywania działań.

Przykłady:

  • Filtruj według: 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"

Ciąg znaków filter nie może przekraczać 500 znaków. Wartości dłuższe niż 500 znaków spowodują błąd INVALID_ARGUMENT.

SearchDocumentChunksResponse

Wiadomość z odpowiedzią dla: DeveloperKnowledge.SearchDocumentChunks.

Pola
results[]

DocumentChunk

Zawiera wyniki wyszukiwania dla danego zapytania. Każdy element DocumentChunk na tej liście zawiera fragment treści związany z zapytaniem. Użyj pola DocumentChunk.parent każdego wyniku z DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments, aby pobrać pełną treść dokumentu.
next_page_token

string

Podaje token, który można wysłać jako page_token, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.