REST Resource: projects.locations.dataStores.branches.documents

Referensi: Dokumen

Dokumen menangkap semua informasi metadata mentah dari item yang akan direkomendasikan atau dicari.

Representasi JSON 
{
  "name": string,
  "id": string,
  "schemaId": string,
  "content": {
    object (Content)
  },
  "parentDocumentId": string,
  "derivedStructData": {
    object
  },
  "aclInfo": {
    object (AclInfo)
  },
  "indexTime": string,
  "indexStatus": {
    object (IndexStatus)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "structData": {
    object
  },
  "jsonData": string
  // End of mutually exclusive fields.
}
Kolom
name

string

Tidak dapat diubah. Nama resource lengkap dokumen. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1.024 karakter.
id

string

Tidak dapat diubah. ID dokumen.

ID harus sesuai dengan standar RFC-1034 dengan batas panjang 128 karakter.
schemaId

string

ID skema yang berada di penyimpanan data yang sama.
content

object (Content)

Data tidak terstruktur yang ditautkan ke dokumen ini. Konten hanya dapat ditetapkan dan harus ditetapkan jika dokumen ini berada di penyimpanan data CONTENT_REQUIRED.
parentDocumentId

string

ID dokumen induk. Saat ini mendukung hierarki dokumen maksimal dua tingkat.

ID harus sesuai dengan standar RFC-1034 dengan batas panjang 63 karakter.
derivedStructData

object (Struct format)

Hanya output. Kolom ini adalah OUTPUT_ONLY. Kolom ini berisi data turunan yang tidak ada dalam dokumen input asli.
aclInfo

object (AclInfo)

Informasi kontrol akses untuk dokumen.
indexTime

string (Timestamp format)

Hanya output. Waktu saat dokumen terakhir kali diindeks.

Jika kolom ini diisi, artinya dokumen telah diindeks. Meskipun dokumen biasanya dapat ditelusuri dalam hitungan detik setelah pengindeksan, terkadang proses ini dapat memerlukan waktu hingga beberapa jam.

Jika kolom ini tidak diisi, artinya dokumen belum pernah diindeks.

Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
indexStatus

object (IndexStatus)

Hanya output. Status indeks dokumen.

  • Jika dokumen berhasil diindeks, kolom indexTime akan diisi.
  • Jika tidak, jika dokumen tidak diindeks karena error, kolom errorSamples akan diisi.
  • Jika tidak, jika indeks dokumen sedang berlangsung, kolom pendingMessage akan diisi.
Representasi data. Salah satu dari struct_data atau json_data harus diberikan. Jika tidak, error INVALID_ARGUMENT akan ditampilkan. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
structData

object (Struct format)

Data JSON terstruktur untuk dokumen. Data ini harus sesuai dengan Schema terdaftar. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
jsonData

string

Representasi string JSON dari dokumen. Data ini harus sesuai dengan Schema terdaftar. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.
Akhir kolom yang saling eksklusif.

Metode

create

 Membuat Document.

delete

 Menghapus Document.

get

 Mendapatkan Document.

getProcessedDocument

 Mendapatkan informasi tata letak yang diuraikan untuk Document.

import

 Impor massal beberapa Document.

list

 Mendapatkan daftar Document.

patch

 Memperbarui Document.

purge

 Menghapus secara permanen semua Document yang dipilih di cabang.