REST Resource: corpora.documents

Referensi: Dokumen

Document adalah kumpulan Chunk. Corpus dapat memiliki maksimum 10.000 Document.

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

string

Tidak dapat diubah. ID. Nama resource Document. ID (nama tidak termasuk awalan "corpora/*/documents/") dapat berisi hingga 40 karakter yang merupakan alfanumerik huruf kecil atau tanda hubung (-). ID tidak dapat diawali atau diakhiri dengan tanda hubung. Jika nama saat pembuatan kosong, nama unik akan diambil dari displayName beserta akhiran acak 12 karakter. Contoh: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

Opsional. Nama tampilan yang dapat dibaca manusia untuk Document. Nama tampilan tidak boleh lebih dari 512 karakter, termasuk spasi. Contoh: "Dokumentasi Semantic Retriever"

customMetadata[]

object (CustomMetadata)

Opsional. Metadata kustom yang disediakan pengguna yang disimpan sebagai key-value pair yang digunakan untuk membuat kueri. Document dapat memiliki maksimum 20 CustomMetadata.

updateTime

string (Timestamp format)

Hanya output. Stempel waktu saat Document terakhir diperbarui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

createTime

string (Timestamp format)

Hanya output. Stempel waktu saat Document dibuat.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

Metode

create

Membuat Document kosong.

delete

Menghapus Document.

get

Mendapatkan informasi tentang Document tertentu.

list

Mencantumkan semua Document dalam Corpus.

patch

Memperbarui Document.

query

Melakukan penelusuran semantik melalui Document.