File Search Stores

File Search API menyediakan layanan menjawab pertanyaan yang dihosting untuk membangun sistem Retrieval Augmented Generation (RAG) menggunakan infrastruktur Google.

Metode: media.uploadToFileSearchStore

Mengupload data ke FileSearchStore, memproses dan membagi data sebelum menyimpannya dalam Dokumen FileSearchStore.

Endpoint

  • URI upload, untuk permintaan upload media:
 postingan https://generativelanguage.googleapis.com/upload/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore
  • URI metadata, khusus untuk permintaan metadata:
 post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore

Parameter jalur

fileSearchStoreName string

Wajib. Tidak dapat diubah. Nama FileSearchStore untuk mengupload file. Contoh: fileSearchStores/my-file-search-store-123 Formatnya adalah fileSearchStores/{filesearchstore}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
displayName string

Opsional. Nama tampilan dokumen yang dibuat.

customMetadata[] object (CustomMetadata)

Metadata kustom yang akan dikaitkan dengan data.

chunkingConfig object (ChunkingConfig)

Opsional. Konfigurasi untuk memberi tahu layanan cara membagi data. Jika tidak disediakan, layanan akan menggunakan parameter default.

mimeType string

Opsional. Jenis MIME data. Jika tidak diberikan, nilai akan disimpulkan dari konten yang diupload.

Isi respons

Ini adalah salinan google.longrunning.Operation. Kita perlu menyalinnya karena untuk berinteraksi dengan scotty, kita perlu menambahkan kolom khusus scotty yang tidak dapat ditambahkan di proto Operasi tingkat teratas.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
name string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.

metadata object

Metadata spesifik per layanan yang terkait dengan operasi. Metadata ini biasanya berisi informasi progres dan metadata umum, seperti waktu pembuatan. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan jenis metadatanya, jika ada.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Jika nilainya adalah false, itu berarti operasi masih berlangsung. Jika true, operasi sudah selesai, dan error atau response tersedia.

result Union type
Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari hal berikut:
error object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.

response object

Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Representasi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Metode: fileSearchStores.create

Membuat FileSearchStore kosong.

Endpoint

postingan https://generativelanguage.googleapis.com/v1beta/fileSearchStores

Isi permintaan

Isi permintaan memuat instance FileSearchStore.

Kolom
displayName string

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

Isi respons

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

Metode: fileSearchStores.delete

Menghapus FileSearchStore.

Endpoint

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

Parameter jalur

name string

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

Parameter kueri

force boolean

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

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons adalah objek JSON kosong.

Metode: fileSearchStores.get

Mendapatkan informasi tentang FileSearchStore tertentu.

Endpoint

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

Parameter jalur

name string

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance FileSearchStore.

Metode: fileSearchStores.list

Mencantumkan semua FileSearchStores yang dimiliki oleh pengguna.

Endpoint

get https://generativelanguage.googleapis.com/v1beta/fileSearchStores

Parameter kueri

pageSize integer

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

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

pageToken string

Opsional. Token halaman, yang diterima dari panggilan fileSearchStores.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 fileSearchStores.list harus sesuai dengan panggilan yang memberikan token halaman.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons dari fileSearchStores.list yang berisi daftar FileSearchStores yang di-pagination. Hasil diurutkan berdasarkan fileSearchStore.create_time menaik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Kolom
fileSearchStores[] object (FileSearchStore)

ragStores yang ditampilkan.

nextPageToken string

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

Representasi JSON 
{
  "fileSearchStores": [
    {
      object (FileSearchStore)
    }
  ],
  "nextPageToken": string
}

Metode: fileSearchStores.importFile

Mengimpor File dari Layanan File ke FileSearchStore.

Endpoint

postingan https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:importFile

Parameter jalur

fileSearchStoreName string

Wajib. Tidak dapat diubah. Nama FileSearchStore untuk mengimpor file ke dalamnya. Contoh: fileSearchStores/my-file-search-store-123 Formatnya adalah fileSearchStores/{filesearchstore}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Kolom
fileName string

Wajib. Nama File yang akan diimpor. Contoh: files/abc-123

customMetadata[] object (CustomMetadata)

Metadata kustom yang akan dikaitkan dengan file.

chunkingConfig object (ChunkingConfig)

Opsional. Konfigurasi untuk memberi tahu layanan cara membagi file menjadi beberapa bagian. Jika tidak disediakan, layanan akan menggunakan parameter default.

Isi respons

Jika berhasil, isi respons memuat instance Operation.

REST Resource: fileSearchStores.operations

Resource: Operation

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Kolom
name string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.

metadata object

Metadata spesifik per layanan yang terkait dengan operasi. Metadata ini biasanya berisi informasi progres dan metadata umum, seperti waktu pembuatan. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan jenis metadatanya, jika ada.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Jika nilainya adalah false, itu berarti operasi masih berlangsung. Jika true, operasi sudah selesai, dan error atau response tersedia.

result Union type
Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari hal berikut:
error object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.

response object

Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Representasi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Metode: fileSearchStores.operations.get

Mendapatkan status terbaru dari operasi yang berjalan lama. Klien dapat menggunakan metode ini untuk polling hasil operasi pada interval seperti yang direkomendasikan oleh layanan API.

Endpoint

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

Parameter jalur

name string

Nama resource operasi. Formatnya adalah fileSearchStores/{filesearchstore}/operations/{operation}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Operation.

REST Resource: fileSearchStores.upload.operations

Resource: Operation

Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.

Kolom
name string

Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.

metadata object

Metadata spesifik per layanan yang terkait dengan operasi. Metadata ini biasanya berisi informasi progres dan metadata umum, seperti waktu pembuatan. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan jenis metadatanya, jika ada.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Jika nilainya adalah false, itu berarti operasi masih berlangsung. Jika true, operasi sudah selesai, dan error atau response tersedia.

result Union type
Hasil operasi, yang dapat berupa error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari hal berikut:
error object (Status)

Hasil error operasi jika terjadi kegagalan atau pembatalan.

response object

Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.

Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.

Representasi JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Metode: fileSearchStores.upload.operations.get

Mendapatkan status terbaru dari operasi yang berjalan lama. Klien dapat menggunakan metode ini untuk polling hasil operasi pada interval seperti yang direkomendasikan oleh layanan API.

Endpoint

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

Parameter jalur

name string

Nama resource operasi. Formatnya adalah fileSearchStores/{filesearchstore}/upload/operations/{operation}.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat instance Operation.

REST Resource: fileSearchStores

Resource: FileSearchStore

FileSearchStore adalah kumpulan Document.

Kolom
name string

Hanya output. Tidak dapat diubah. ID. Nama resource FileSearchStore. ID ini (nama tidak termasuk awalan "fileSearchStores/") dapat berisi hingga 40 karakter yang berupa alfanumerik huruf kecil atau tanda hubung (-). ID ini hanya berupa output. Nama unik akan diambil dari displayName beserta akhiran acak 12 karakter. Contoh: fileSearchStores/my-awesome-file-search-store-123a456b789c Jika displayName tidak diberikan, nama akan dibuat secara acak.

displayName string

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

createTime string (Timestamp format)

Hanya output. Stempel waktu saat FileSearchStore 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".

updateTime string (Timestamp format)

Hanya output. Stempel Waktu saat FileSearchStore 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".

activeDocumentsCount string (int64 format)

Hanya output. Jumlah dokumen dalam FileSearchStore yang aktif dan siap diambil.

pendingDocumentsCount string (int64 format)

Hanya output. Jumlah dokumen dalam FileSearchStore yang sedang diproses.

failedDocumentsCount string (int64 format)

Hanya output. Jumlah dokumen dalam FileSearchStore yang gagal diproses.

sizeBytes string (int64 format)

Hanya output. Ukuran byte mentah yang dimasukkan ke dalam FileSearchStore. Ini adalah ukuran total semua dokumen dalam FileSearchStore.

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "activeDocumentsCount": string,
  "pendingDocumentsCount": string,
  "failedDocumentsCount": string,
  "sizeBytes": string
}