REST Resource: documents

Recurso: Document

Un Document representa una parte del contenido del corpus de Developer Knowledge.

Representación JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
Campos
name

string

Es el identificador. Contiene el nombre del recurso del documento. Formato: documents/{uri_without_scheme} Ejemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Solo salida. Proporciona el URI del contenido, como docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Solo salida. Contiene el contenido completo del documento en formato Markdown.
description

string

Solo salida. Proporciona una descripción del documento.
dataSource

string

Solo salida. Especifica la fuente de datos del documento. Fuente de datos de ejemplo: firebase.google.com
title

string

Solo salida. Proporciona el título del documento.
updateTime

string (Timestamp format)

Solo salida. Representa la marca de tiempo en la que se actualizó por última vez el contenido o los metadatos del documento.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Solo salida. Especifica el DocumentView del documento.

DocumentView

Especifica qué campos de Document se incluyen.

Enums
DOCUMENT_VIEW_UNSPECIFIED Es el valor predeterminado o no establecido. Consulta el valor predeterminado de cada método de la API si no se especifica DocumentView.
DOCUMENT_VIEW_BASIC

Solo incluye los campos de metadatos básicos: - name - uri - dataSource - title - description - updateTime - view

Esta es la vista predeterminada de DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Incluye todos los campos de Document.
DOCUMENT_VIEW_CONTENT

Incluye los campos DOCUMENT_VIEW_BASIC y el campo content.

Esta es la vista predeterminada de DeveloperKnowledge.GetDocument y DeveloperKnowledge.BatchGetDocuments.

Métodos

batchGet

 Recupera varios documentos, cada uno con su contenido completo en Markdown.

get

 Recupera un solo documento con su contenido completo en Markdown.

searchDocumentChunks

 Busca conocimiento para desarrolladores en la documentación para desarrolladores de Google.