Package google.developers.knowledge.v1alpha

Indeks

DeveloperKnowledge

Interfejs Developer Knowledge API zapewnia automatyczny dostęp do publicznej dokumentacji dla deweloperów Google, dzięki czemu możesz zintegrować tę bazę wiedzy z własnymi aplikacjami i przepływami pracy.

Ten interfejs API ma być kanonicznym źródłem dokumentacji dla deweloperów Google w formacie czytelnym dla komputerów.

Typowy przypadek użycia to najpierw użycie funkcji DeveloperKnowledge.SearchDocumentChunks do znalezienia odpowiednich identyfikatorów URI stron na podstawie zapytania, a następnie użycie funkcji DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments do pobrania pełnej treści najlepszych wyników.

Cała zawartość dokumentu jest dostępna w formacie Markdown.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse)

Odpowiada na zapytanie za pomocą 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 sekcji OAuth 2.0 Overview.
BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Pobiera wiele dokumentów, z których każdy zawiera pełną treść 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 sekcji 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 sekcji 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. Z tego samego Document może pochodzić wiele fragmentów. Aby pobrać pełne dokumenty, użyj DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments z wartością DocumentChunk.parent zwróconą 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 sekcji OAuth 2.0 Overview.

Odpowiedź

Odpowiedź na zapytanie.

Pola
answer_text

string

Zawiera tekst 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 cytowaniu segmentu.

Pola
start_index

int32

Tylko dane wyjściowe. Wskazuje początek segmentu, mierzony w bajtach (Unicode UTF-8), włącznie z wartościami granicznymi. Jeśli występują znaki wielobajtowe, np. znaki spoza zestawu ASCII, pomiar indeksu jest dłuższy niż długość ciągu.
end_index

int32

Tylko dane wyjściowe. Wskazuje koniec segmentu, mierzony w bajtach (Unicode UTF-8), z wyłączeniem ostatniego bajta. Jeśli występują znaki wielobajtowe, np. znaki spoza zestawu ASCII, pomiar indeksu jest dłuższy niż długość ciągu.
sources[]

CitationSource

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

AnswerReference

Reprezentuje odwołanie do źródła.

Pola
Pole zbiorcze content. Zawiera treść odniesienia. 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 elementu 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

Prośba o wiadomość do użytkownika DeveloperKnowledge.AnswerQuery.

Pola
query

string

Wymagane. Zapytanie, na które chcesz uzyskać odpowiedź.
filter

string

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

Pola obsługiwane w przypadku filtrowania:

  • content_length_bytes (INTEGER): 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 zawartość w formacie Markdown lub metadane dokumentu.
  • 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 dokładnego dopasowania całego ciągu znaków. Nie są obsługiwane częściowe dopasowanie, dopasowanie prefiksu ani dopasowanie do wyrażenia regularnego.

Pola SYGNATURA CZASOWA 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 priorytetów.

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

Prośba o wiadomość do użytkownika DeveloperKnowledge.BatchGetDocuments.

Pola
names[]

string

Wymagane. Określa nazwy dokumentów do pobrania. W jednej partii 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

Długość każdej nazwy 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 podasz tu żadnej wartości, DeveloperKnowledge.BatchGetDocuments przyjmie domyślnie wartość DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Wiadomość z odpowiedzią dla DeveloperKnowledge.BatchGetDocuments.

Pola
documents[]

Document

zawiera wymagane dokumenty;

Dokument

Dokument to strona dokumentacji w korpusie wiedzy dla deweloperów, np. strona 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. Zawiera identyfikator URI treści, np. 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. Zawiera tytuł dokumentu.
update_time

Timestamp

Tylko dane wyjściowe. Sygnatura czasowa 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ż wartość parent do parametru 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 ramach dokumentu, ale nie jest unikalny globalnie w różnych dokumentach. Identyfikator fragmentu nie jest stały i może się z czasem zmienić.
content

string

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

Document

Tylko dane wyjściowe. Zawiera 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ć funkcji DeveloperKnowledge.GetDocument ani DeveloperKnowledge.BatchGetDocuments, jeśli potrzebują tylko pól metadanych. W przeciwnym razie klienci powinni używać DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments, aby pobrać pełną treść dokumentu.
relevance_score

double

Tylko dane wyjściowe. Reprezentuje wynik trafności fragmentu względem 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 nieokreślona. Jeśli nie podasz wartości DocumentView, wartość domyślna każdej metody interfejsu API jest podana w jej opisie.
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 w przypadku DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Zawiera wszystkie pola Document.
DOCUMENT_VIEW_CONTENT

Zawiera pola DOCUMENT_VIEW_BASIC i content.

Jest to domyślny widok w przypadku DeveloperKnowledge.GetDocument i DeveloperKnowledge.BatchGetDocuments.

GetDocumentRequest

Prośba o wiadomość do użytkownika 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 mieć więcej niż 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 podasz tu żadnej wartości, DeveloperKnowledge.GetDocument przyjmie domyślnie wartość DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

Prośba o wiadomość do użytkownika 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ć mniej niż ta wartość.

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

Maksymalna wartość to 100. Wartości powyżej 100 zostaną przekształcone w 100.
page_token

string

Opcjonalnie. Zawiera token strony otrzymany z poprzedniego wywołania SearchDocumentChunks. Podaj ten token, 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.

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

Pola obsługiwane w przypadku filtrowania:

  • content_length_bytes (INTEGER): 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 zawartość w formacie Markdown lub metadane dokumentu.
  • 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 dokładnego dopasowania całego ciągu znaków. Nie są obsługiwane częściowe dopasowanie, dopasowanie prefiksu ani dopasowanie do wyrażenia regularnego.

Pola SYGNATURA CZASOWA 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 priorytetów.

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 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 DocumentChunk na tej liście zawiera fragment treści związany z zapytaniem. Użyj pola DocumentChunk.parent w każdym wyniku z DeveloperKnowledge.GetDocument lub DeveloperKnowledge.BatchGetDocuments, aby pobrać pełną treść dokumentu.
next_page_token

string

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