Documents

File Search API mereferensikan file sumber mentah, atau dokumen, sebagai objek File sementara.

Metode: fileSearchStores.documents.delete

Menghapus Document.

Endpoint

delete https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

Parameter jalur

name string

Wajib. Nama resource Document yang akan dihapus. Contoh: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Formatnya adalah fileSearchStores/{filesearchstore}/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 adalah objek JSON kosong.

Metode: fileSearchStores.documents.get

Mendapatkan informasi tentang Document tertentu.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}

Parameter jalur

name string

Wajib. Nama Document yang akan diambil. Contoh: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Formatnya adalah fileSearchStores/{filesearchstore}/documents/{document}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Document.

Metode: fileSearchStores.documents.list

Mencantumkan semua Document dalam Corpus.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/{parent=fileSearchStores/*}/documents

Parameter jalur

parent string

Wajib. Nama FileSearchStore yang berisi Document. Contoh: fileSearchStores/my-file-search-store-123 Formatnya adalah fileSearchStores/{filesearchstore}.

Parameter kueri

pageSize integer

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

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

pageToken string

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

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

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk documents.list harus sesuai dengan panggilan yang memberikan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari documents.list yang berisi daftar Document bernomor halaman. Document diurutkan berdasarkan document.create_time dari bawah ke atas.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
documents[] object (Document)

Document yang ditampilkan.

nextPageToken string

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

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

Metode: fileSearchStores.documents.query

Melakukan penelusuran semantik di Document.

Endpoint

postingan https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/documents/*}:query

Parameter jalur

name string

Wajib. Nama Document yang akan dikueri. Contoh: fileSearchStores/my-file-search-store-123/documents/the-doc-abc Formatnya adalah fileSearchStores/{filesearchstore}/documents/{document}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
query string

Wajib. String kueri untuk melakukan penelusuran semantik.

resultsCount integer

Opsional. Jumlah maksimum Chunk yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit Chunk.

Jika tidak ditentukan, paling banyak 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 year < 2010) AND (genre = drama OR genre = action)

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

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

MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = 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:

Kolom
relevantChunks[] object (RelevantChunk)

Chunk yang relevan yang ditampilkan.

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

REST Resource: fileSearchStores.documents

Resource: Document

Document adalah kumpulan Chunk.

Kolom
name string

Tidak dapat diubah. ID. Nama resource Document. ID (nama tidak termasuk awalan "fileSearchStores/*/documents/") dapat berisi hingga 40 karakter yang berupa alfanumerik huruf kecil atau tanda hubung (-). ID tidak boleh diawali atau diakhiri dengan tanda hubung. Jika nama kosong saat dibuat, nama unik akan diambil dari displayName beserta akhiran acak 12 karakter. Contoh: fileSearchStores/{file_search_store_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 Pengambilan Semantik"

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

Hanya output. Stempel Waktu saat Document terakhir diperbarui.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi 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".

createTime string (Timestamp format)

Hanya output. Stempel waktu saat Document dibuat.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi 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".

state enum (State)

Hanya output. Status Document saat ini.

sizeBytes string (int64 format)

Hanya output. Ukuran byte mentah yang dimasukkan ke dalam Dokumen.

mimeType string

Hanya output. Jenis MIME Dokumen.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string,
  "state": enum (State),
  "sizeBytes": string,
  "mimeType": string
}

Negara Bagian

Status untuk siklus proses Document.

Enum
STATE_UNSPECIFIED Nilai default. Nilai ini digunakan jika status tidak ada.
STATE_PENDING Beberapa Chunks dari Document sedang diproses (penyimpanan vektor dan embedding).
STATE_ACTIVE Semua Chunks dari Document diproses dan tersedia untuk kueri.
STATE_FAILED Beberapa Chunks dari Document gagal diproses.