REST Resource: documents

Risorsa: Documento

Un documento rappresenta una pagina di documentazione nel corpus di conoscenze per sviluppatori, come la pagina all'indirizzo https://docs.cloud.google.com/storage/docs/creating-buckets.

Rappresentazione JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView),
  "contentLengthBytes": integer
}
Campi
name

string

Identificatore. Contiene il nome della risorsa del documento. Formato: documents/{uri_without_scheme} Esempio: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Solo output. Fornisce l'URI del contenuto, ad esempio https://docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Solo output. Contiene l'intero contenuto del documento in formato Markdown.
description

string

Solo output. Fornisce una descrizione del documento.
dataSource

string

Solo output. Specifica l'origine dati del documento. Origine dati di esempio: firebase.google.com
title

string

Solo output. Fornisce il titolo del documento.
updateTime

string (Timestamp format)

Solo output. Rappresenta il timestamp dell'ultimo aggiornamento dei contenuti o dei metadati del documento.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Solo output. Specifica il DocumentView del documento.
contentLengthBytes

integer

Solo output. La lunghezza del campo content in byte.

DocumentView

Specifica quali campi di Document sono inclusi.

Enum
DOCUMENT_VIEW_UNSPECIFIED Il valore predefinito / non impostato. Se DocumentView non è specificato, consulta il valore predefinito di ogni metodo API.
DOCUMENT_VIEW_BASIC

Include solo i campi dei metadati di base:

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

Questa è la visualizzazione predefinita per DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Include tutti i campi Document.
DOCUMENT_VIEW_CONTENT

Include i campi DOCUMENT_VIEW_BASIC e il campo content.

Questa è la visualizzazione predefinita per DeveloperKnowledge.GetDocument e DeveloperKnowledge.BatchGetDocuments.

Metodi

batchGet

 Recupera più documenti, ognuno con i relativi contenuti Markdown completi.

get

 Recupera un singolo documento con tutti i suoi contenuti in formato Markdown.

searchDocumentChunks

 Cerca informazioni per gli sviluppatori nella documentazione per gli sviluppatori di Google.