REST Resource: corpora.documents

Risorsa: documento

Un Document è una raccolta di Chunk. Un Corpus può avere un massimo di 10.000 Document.

Rappresentazione JSON
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
Campi
name

string

Immutabile. Identificatore. Il nome della risorsa Document. L'ID (nome senza il prefisso "corpora/*/documents/") può contenere fino a 40 caratteri alfanumerici minuscoli o trattini (-). L'ID non può iniziare o terminare con un trattino. Se al momento della creazione il nome risulta vuoto, da displayName verrà ricavato un nome univoco insieme a un suffisso casuale di 12 caratteri. Esempio: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Campo facoltativo. Il nome visualizzato leggibile per Document. Il nome visualizzato non deve superare i 512 caratteri, spazi inclusi. Esempio: "Semantic Retriever Documentazione"

customMetadata[]

object (CustomMetadata)

Campo facoltativo. Metadati personalizzati forniti dall'utente archiviati come coppie chiave-valore utilizzate per le query. Un Document può avere un massimo di 20 CustomMetadata.

updateTime

string (Timestamp format)

Solo output. Il timestamp dell'ultimo aggiornamento di Document.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Solo output. Il timestamp relativo alla creazione di Document.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Metodi

create

Crea un oggetto Document vuoto.

delete

Elimina un Document.

get

Riceve informazioni su un Document specifico.

list

Elenca tutti i Document in un Corpus.

patch

Aggiorna un Document.

query

Esegue la ricerca semantica su un elemento Document.