REST Resource: documents

Ressource : Document

Un document représente un élément de contenu du corpus de connaissances pour les développeurs.

Représentation JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
Champs
name

string

Identifiant. Contient le nom de ressource du document. Format : documents/{uri_without_scheme} Exemple : documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Uniquement en sortie. Fournit l'URI du contenu, par exemple docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Uniquement en sortie. Contient l'intégralité du contenu du document au format Markdown.
description

string

Uniquement en sortie. Fournit une description du document.
dataSource

string

Uniquement en sortie. Spécifie la source de données du document. Exemple de source de données : firebase.google.com
title

string

Uniquement en sortie. Fournit le titre du document.
updateTime

string (Timestamp format)

Uniquement en sortie. Représente l'horodatage de la dernière mise à jour du contenu ou des métadonnées du document.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Uniquement en sortie. Spécifie le DocumentView du document.

DocumentView

Spécifie les champs Document inclus.

Enums
DOCUMENT_VIEW_UNSPECIFIED Valeur par défaut / non définie. Consultez la valeur par défaut de chaque méthode d'API si DocumentView n'est pas spécifié.
DOCUMENT_VIEW_BASIC

Inclut uniquement les champs de métadonnées de base : - name - uri - dataSource - title - description - updateTime - view

Il s'agit de la valeur par défaut de la vue pour DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Inclut tous les champs Document.
DOCUMENT_VIEW_CONTENT

Inclut les champs DOCUMENT_VIEW_BASIC et le champ content.

Il s'agit de la valeur par défaut de la vue pour DeveloperKnowledge.GetDocument et DeveloperKnowledge.BatchGetDocuments.

Méthodes

batchGet

 Récupère plusieurs documents, chacun avec son contenu Markdown complet.

get

 Récupère un seul document avec son contenu Markdown complet.

searchDocumentChunks

 Recherche des connaissances pour les développeurs dans la documentation Google destinée aux développeurs.