REST Resource: documents

Источник: Документ

Документ представляет собой фрагмент контента из корпуса знаний разработчиков.

JSON-представление 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
Поля
name

string

Идентификатор. Содержит имя ресурса документа. Формат: documents/{uri_without_scheme} Пример: documents/docs.cloud.google.com/storage/docs/creating-buckets

uri

string

Только для вывода. Предоставляет URI контента, например, docs.cloud.google.com/storage/docs/creating-buckets .

content

string

Только для вывода. Содержит полное содержимое документа в формате Markdown.

description

string

Только для вывода. Содержит описание документа.

dataSource

string

Только для вывода. Указывает источник данных документа. Пример источника данных: firebase.google.com

title

string

Только для вывода. Содержит заголовок документа.

updateTime

string ( Timestamp format)

Только для вывода. Представляет собой метку времени последнего обновления содержимого или метаданных документа.

Используется RFC 3339, согласно которому сгенерированный вывод всегда будет Z-нормализован и будет содержать 0, 3, 6 или 9 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

view

enum ( DocumentView )

Только для вывода. Указывает DocumentView документа.

Просмотр документа

Указывает, какие поля Document включены.

Перечисления
DOCUMENT_VIEW_UNSPECIFIED Значение по умолчанию / не задано. Если DocumentView не указан, см. значение по умолчанию для каждого метода API.
DOCUMENT_VIEW_BASIC

Включает только основные поля метаданных: - name - uri - dataSource - title - description - updateTime - view

Это представление по умолчанию для DeveloperKnowledge.SearchDocumentChunks .

DOCUMENT_VIEW_FULL Включает все поля Document .
DOCUMENT_VIEW_CONTENT

Включает поля DOCUMENT_VIEW_BASIC и поле content .

Это представление по умолчанию для DeveloperKnowledge.GetDocument и DeveloperKnowledge.BatchGetDocuments .

Методы

batchGet

 Извлекает несколько документов, каждый из которых содержит полный текст в формате Markdown.

get

 Извлекает отдельный документ со всем его содержимым в формате Markdown.

searchDocumentChunks

 Поиск информации для разработчиков в документации Google.