REST Resource: documents

Risorsa: Document

Un documento rappresenta un contenuto del corpus di conoscenze per gli sviluppatori.

Rappresentazione JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
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 dei contenuti, ad esempio docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Solo output. Contiene tutti i contenuti del documento in formato Markdown.
description

string

Solo output. Fornisce una descrizione del documento.
dataSource

string

Solo output. Specifica l'origine dati del documento. Esempio di origine dati: 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.

DocumentView

Specifica quali campi di Document sono inclusi.

Enum
DOCUMENT_VIEW_UNSPECIFIED Il valore predefinito / non impostato. Consulta ogni metodo API per il relativo valore predefinito se DocumentView non è specificato.
DOCUMENT_VIEW_BASIC

Include solo i campi dei metadati di base: - name - uri - dataSource - title - description - updateTime - view

Questo è il valore predefinito della visualizzazione per DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Include tutti i campi Document.
DOCUMENT_VIEW_CONTENT

Include i campi DOCUMENT_VIEW_BASIC e il campo content.

Questo è il valore predefinito della visualizzazione per DeveloperKnowledge.GetDocument e DeveloperKnowledge.BatchGetDocuments.

Metodi

batchGet

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

get

 Recupera un singolo documento con i relativi contenuti Markdown completi.

searchDocumentChunks

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