Package google.developers.knowledge.v1alpha

Indeks

DeveloperKnowledge

Interfejs Developer Knowledge API zapewnia zautomatyzowany 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 dostępnej w formacie czytelnym dla maszyn.

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.

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/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/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/cloud-platform

Więcej informacji znajdziesz w sekcji OAuth 2.0 Overview.

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

BatchGetDocumentsResponse

Wiadomość z odpowiedzią dla DeveloperKnowledge.BatchGetDocuments.

Pola
documents[]

Document

zawiera wymagane dokumenty,

Dokument

Dokument reprezentuje fragment treści z korpusu wiedzy dla deweloperów.

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

string

Tylko dane wyjściowe. Zawiera tytuł dokumentu.

DocumentChunk

DocumentChunk to 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.

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

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?”.
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 20. Wartości powyżej 20 spowodują błąd INVALID_ARGUMENT.
page_token

string

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

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

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