REST Resource: documents

Recurso: Document

Um documento representa um conteúdo do corpus de conhecimento do desenvolvedor.

Representação JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
Campos
name

string

Identificador. Contém o nome do recurso do documento. Formato: documents/{uri_without_scheme} Exemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Apenas saída. Fornece o URI do conteúdo, como docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Apenas saída. Contém todo o conteúdo do documento no formato Markdown.
description

string

Apenas saída. Fornece uma descrição do documento.
dataSource

string

Apenas saída. Especifica a fonte de dados do documento. Exemplo de fonte de dados: firebase.google.com
title

string

Apenas saída. Fornece o título do documento.
updateTime

string (Timestamp format)

Apenas saída. Representa o carimbo de data/hora da última atualização do conteúdo ou dos metadados do documento.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Apenas saída. Especifica o DocumentView do documento.

DocumentView

Especifica quais campos do Document estão incluídos.

Tipos enumerados
DOCUMENT_VIEW_UNSPECIFIED O valor padrão / não definido. Consulte cada método de API para conferir o valor padrão se DocumentView não for especificado.
DOCUMENT_VIEW_BASIC

Inclui apenas os campos de metadados básicos: - name - uri - dataSource - title - description - updateTime - view

Esse é o padrão de visualização para DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Inclui todos os campos Document.
DOCUMENT_VIEW_CONTENT

Inclui os campos DOCUMENT_VIEW_BASIC e o campo content.

Esse é o padrão de visualização para DeveloperKnowledge.GetDocument e DeveloperKnowledge.BatchGetDocuments.

Métodos

batchGet

 Recupera vários documentos, cada um com todo o conteúdo do Markdown.

get

 Recupera um único documento com todo o conteúdo do Markdown.

searchDocumentChunks

 Pesquisa o conhecimento do desenvolvedor na documentação do Google.