Docuents

Resource REST: corpora.documents

Resource: Dokumen

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

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

Tidak dapat diubah. ID. Nama resource Document. ID (nama yang tidak termasuk awalan "corpora/*/documents/") dapat berisi maksimal 40 karakter yang merupakan alfanumerik dalam huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama tersebut kosong saat dibuat, nama unik akan diambil dari displayName bersama dengan 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 Pengambil Semantik"

customMetadata[] object (CustomMetadata)

Opsional. Metadata kustom yang disediakan pengguna yang disimpan sebagai pasangan nilai kunci yang digunakan untuk membuat kueri. Document dapat memiliki maksimal 20 CustomMetadata.

updateTime string (Timestamp format)

Hanya output. Stempel waktu saat Document terakhir diperbarui.

Stempel waktu dalam 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 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: corpora.documents.create

Membuat Document kosong.

Endpoint

posting https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Parameter jalur

parent string

Wajib. Nama Corpus tempat Document ini akan dibuat. Contoh: corpora/my-corpus-123 Formatnya adalah corpora/{corpora}.

Isi permintaan

Isi permintaan memuat instance Document.

Isi respons

Jika berhasil, isi respons memuat instance Document yang baru dibuat.

Metode: corpora.documents.list

Mencantumkan semua Document dalam Corpus.

Endpoint

dapatkan https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

Parameter jalur

parent string

Wajib. Nama Corpus yang berisi Document. Contoh: corpora/my-corpus-123 Formatnya adalah corpora/{corpora}.

Parameter kueri

pageSize integer

Opsional. Jumlah maksimum Document untuk ditampilkan (per halaman). Layanan mungkin menampilkan lebih sedikit Document.

Jika tidak ditentukan, maksimal 10 Document akan ditampilkan. Batas ukuran maksimum adalah 20 Document detik per halaman.

pageToken string

Opsional. Token halaman, diterima dari panggilan documents.list sebelumnya.

Berikan nextPageToken yang ditampilkan dalam respons sebagai argumen terhadap permintaan berikutnya untuk mengambil halaman berikutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan ke documents.list harus cocok dengan panggilan yang menyediakan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari documents.list yang berisi daftar Document yang diberi nomor halaman. Document diurutkan berdasarkan document.create_time menaik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
documents[] object (Document)

Document yang ditampilkan.

nextPageToken string

Token, yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, maka tidak ada lagi halaman.

Representasi JSON 
{
  "documents": [
    {
      object (Document)
    }
  ],
  "nextPageToken": string
}

Metode: corpora.documents.query

Melakukan penelusuran semantik melalui Document.

Endpoint

posting https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

Parameter jalur

name string

Wajib. Nama Document yang akan dikueri. Contoh: corpora/my-corpus-123/documents/the-doc-abc Formatnya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Bidang
query string

Wajib. String kueri untuk melakukan penelusuran semantik.

resultsCount integer

Opsional. Jumlah maksimum Chunk untuk ditampilkan. Layanan mungkin menampilkan lebih sedikit Chunk.

Jika tidak ditentukan, maksimal 10 Chunk akan ditampilkan. Jumlah hasil maksimum yang ditentukan adalah 100.

metadataFilters[] object (MetadataFilter)

Opsional. Filter untuk metadata Chunk. Setiap objek MetadataFilter harus sesuai dengan kunci unik. Beberapa objek MetadataFilter digabungkan dengan "AND" logis.

Catatan: Pemfilteran tingkat Document tidak didukung untuk permintaan ini karena nama Document sudah ditentukan.

Contoh kueri: (year >= 2020 OR tahun < 2010) AND (genre = drama OR genre = action)

Daftar objek MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" kondisi = [{int_value = 2020, operations = GREATER_EQUAL}, {int_value = 2010, operasi = KURANG}}, {key = "chunk.custom_metadata.genre" kondisi = [{stringValue = "drama", operasi = EQUAL}, {stringValue = "tindakan", operasi = EQUAL}}]

Contoh kueri untuk rentang nilai numerik: (tahun > 2015 AND tahun <= 2020)

Daftar objek MetadataFilter: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; kondisi = [{int_value = 2020, operasi = LESS_EQUAL}]}]

Catatan: "AND" untuk kunci yang sama hanya didukung untuk nilai numerik. Nilai string hanya mendukung "OR" untuk kunci yang sama.

Isi respons

Respons dari documents.query yang berisi daftar potongan yang relevan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Bidang
relevantChunks[] object (RelevantChunk)

Menampilkan potongan-potongan yang relevan.

Representasi JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metode: corpora.documents.get

Mendapatkan informasi tentang Document tertentu.

Endpoint

dapatkan https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

Parameter jalur

name string

Wajib. Nama Document yang akan diambil. Contoh: corpora/my-corpus-123/documents/the-doc-abc Formatnya adalah corpora/{corpora}/documents/{document}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Document.

Metode: corpora.documents.patch

Memperbarui Document.

Endpoint

tambalan https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

Parameter jalur

document.name string

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

Parameter kueri

updateMask string (FieldMask format)

Wajib. Daftar kolom yang akan diperbarui. Saat ini, metode ini hanya mendukung update displayName dan customMetadata.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi permintaan

Isi permintaan memuat instance Document.

Isi respons

Jika berhasil, isi respons memuat instance Document.

Metode: corpora.documents.delete

Menghapus Document.

Endpoint

hapus https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

Parameter jalur

name string

Wajib. Nama resource Document yang akan dihapus. Contoh: corpora/my-corpus-123/documents/the-doc-abc Formatnya adalah corpora/{corpora}/documents/{document}.

Parameter kueri

force boolean

Opsional. Jika disetel ke benar (true), semua Chunk dan objek yang terkait dengan Document ini juga akan dihapus.

Jika salah (default), error FAILED_PRECONDITION akan ditampilkan jika Document berisi Chunk.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons akan kosong.

CustomMetadata

Metadata yang disediakan pengguna disimpan sebagai key-value pair.

Representasi JSON 
{
  "key": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}
Bidang
key string

Wajib. Kunci metadata yang akan disimpan.

Kolom union value.

value hanya dapat berupa salah satu dari yang berikut:

stringValue string

Nilai string metadata yang akan disimpan.

stringListValue object (StringList)

Nilai StringList metadata yang akan disimpan.

numericValue number

Nilai numerik metadata yang akan disimpan.

StringList

Nilai string yang disediakan pengguna yang ditetapkan ke satu kunci metadata.

Representasi JSON 
{
  "values": [
    string
  ]
}
Bidang
values[] string

Nilai string metadata yang akan disimpan.