REST Resource: documents

Zasób: Dokument

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

Zapis JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView),
  "contentLengthBytes": integer
}
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 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.
dataSource

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

string (Timestamp format)

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

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

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

integer

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

DocumentView

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

Wartości w polu enum
DOCUMENT_VIEW_UNSPECIFIED Wartość domyślna / nieustawiona. Jeśli nie określono DocumentView, wartość domyślna jest podana w opisie każdej metody interfejsu API.
DOCUMENT_VIEW_BASIC

Obejmuje tylko podstawowe pola metadanych:

  • name
  • uri
  • dataSource
  • title
  • description
  • updateTime
  • view
  • contentLengthBytes

Jest to domyślna wartość widoku w przypadku DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Obejmuje wszystkie pola Document.
DOCUMENT_VIEW_CONTENT

Obejmuje pola DOCUMENT_VIEW_BASIC i pole content.

Jest to domyślna wartość widoku w przypadku DeveloperKnowledge.GetDocument i DeveloperKnowledge.BatchGetDocuments.

Metody

batchGet

 Pobiera wiele dokumentów, z których każdy zawiera pełną treść w formacie Markdown.

get

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

searchDocumentChunks

 Wyszukuje wiedzę dla deweloperów w dokumentacji Google dla deweloperów.