Method: projects.locations.collections.engines.sessions.files.list

Mencantumkan metadata untuk semua file dalam sesi saat ini.

Permintaan HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/engines/*/sessions/*}/files

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
parent

string

Wajib. Nama resource Sesi. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} nama resource sesi yang memiliki file.

Parameter kueri

Parameter
filter

string

Opsional. Sintaksis filter terdiri dari bahasa ekspresi untuk membuat predikat dari satu atau beberapa kolom file yang difilter. Ekspresi filter peka huruf besar/kecil.

Nama kolom yang saat ini didukung adalah:

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

Beberapa contoh filter adalah:

  • "file_name = 'file_1'"
  • "file_name = 'file_1' AND mime_type = 'text/plain'"
  • "last_use_time > '2025-06-14T12:00:00Z'"

Untuk deskripsi lengkap format filter, lihat https://google.aip.dev/160.
pageSize

integer

Opsional. Jumlah maksimum file yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 100 file akan ditampilkan. Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000. Jika pengguna menentukan nilai yang kurang dari atau sama dengan 0 - permintaan akan ditolak dengan error INVALID_ARGUMENT.
pageToken

string

Opsional. Token halaman yang diterima dari panggilan files.list sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk files.list harus sesuai dengan panggilan yang menyediakan token halaman (kecuali pageSize, yang mungkin berbeda).
orderBy

string

Opsional. Menentukan urutan file yang ditampilkan.

Nilainya adalah string kolom yang dipisahkan koma untuk diurutkan.

Untuk urutan menaik - hanya nama kolom yang digunakan. Untuk urutan menurun - nama kolom diberi akhiran desc. Pengurutan bersifat stabil dan diterapkan secara berurutan sesuai dengan urutan kolom yang diberikan dalam string.

Kolom yang didukung untuk pengurutan:

  • upload_time: Waktu file diupload.
  • file_name: Nama file.
  • mime_type: Jenis MIME file.
  • session_name: Nama sesi tempat file berada.

Perilaku Default:

Jika kolom orderBy tidak ditentukan, file akan ditampilkan yang diurutkan berdasarkan waktu pembuatan dalam urutan menurun.

Contoh:

  1. Urutkan menurut nama file dari atas ke bawah: file_name

  2. Urutkan menurut waktu upload dalam urutan menurun: upload_time desc

  3. Urutkan menurut nama file (menaik), lalu menurut jenis konten (jenis MIME) (menurun), dan terakhir menurut waktu upload (menaik): file_name, mime_type desc, upload_time

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode SessionService.ListFiles.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
Kolom
files[]

object (FileMetadata)

FileMetadata.
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya. Teruskan nilai ini di kolom ListFilesRequest.page_token dalam panggilan berikutnya ke metode files.list untuk mengambil halaman hasil berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • discoveryengine.sessions.listSessionFileMetadata

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

FileMetadata

Menampilkan file yang dilampirkan ke sesi (file konteks)

Representasi JSON 
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "lastAddTime": string,
  "metadata": {
    string: string,
    ...
  },
  "downloadUri": string,
  "fileOriginType": enum (FileOriginType),
  "views": {
    string: {
      object (FileView)
    },
    ...
  }
}
Kolom
fileId

string

Hanya output. ID file.
name

string

Hanya output. Nama file yang diupload.
mimeType

string

Jenis konten file, lihat https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Hanya output. Ukuran file konteks dalam byte.
originalUri

string

Opsional. Lokasi asli file. Ini dapat berupa jalur file lokal, atau URI lain yang memungkinkan akses ke file dalam sistem eksternal. Ada dua skenario yang menyebabkan URL ini kosong: 1. Jika file dikirim sebagai data inline (misalnya, ditempel dari papan klip). 2. Jika lokasi asli tidak tersedia.

Perhatikan bahwa tidak ada jaminan bahwa URI akan mengarah ke file yang valid atau benar-benar ada. Misalnya, file mungkin telah diupload ke sesi, lalu dihapus dari sumber aslinya.
originalSourceType

enum (FileSource)

Opsional. Jenis sumber asli file.
uploadTime

string (Timestamp format)

Hanya output. Waktu file diupload (Jika ini adalah file yang dibuat oleh proses internal, lalu tersedia untuk sesi, ini menunjukkan waktu terjadinya).

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".
lastAddTime

string (Timestamp format)

Hanya output. Waktu file ditambahkan ke sesi. Perhatikan bahwa jika file ditambahkan, lalu dimodifikasi secara eksternal, lalu ditambahkan lagi, waktu penambahan akan 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".
metadata

map (key: string, value: string)

Opsional. Mewakili metadata terkait file yang dapat sesuai dengan kasus penggunaan tertentu. Awalan "google." dicadangkan untuk kunci yang akan digunakan oleh Google, tetapi awalan lain dapat digunakan secara bebas.
downloadUri

string

Hanya output. URL AssistantService.DownloadSessionFile untuk mendownload file. URL ini akan memerlukan kredensial yang sama dengan metode AssistantService.ListSessionFileMetadata dan akan menyediakan resource.
fileOriginType

enum (FileOriginType)

Opsional. Asal file.
views

map (key: string, value: object (FileView))

Hanya output. Tampilan alternatif objek file ini. Setiap tampilan file dikaitkan dengan peran tertentu. Kemungkinan kunci contoh: - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation"

FileOriginType

Asal file.

Enum
FILE_ORIGIN_TYPE_UNSPECIFIED Nilai default.
USER_PROVIDED File disediakan oleh pengguna.
AI_GENERATED File dibuat oleh model AI.
INTERNALLY_GENERATED File dibuat dari file lain oleh proses internal.

FileView

Mewakili versi alternatif atau "tampilan" tertentu dari objek file, seperti ringkasan, thumbnail, versi terjemahan, dll.

Representasi JSON 
{
  "viewId": string,
  "uri": string,
  "mimeType": string,
  "byteSize": string,
  "createTime": string,

  // Union field characteristics can be only one of the following:
  "imageCharacteristics": {
    object (ImageCharacteristics)
  },
  "videoCharacteristics": {
    object (VideoCharacteristics)
  },
  "fileCharacteristics": {
    object (FileCharacteristics)
  }
  // End of list of possible types for union field characteristics.
}
Kolom
viewId

string

Hanya output. ID Unik Global untuk tampilan tertentu ini.
uri

string

Hanya output. URI untuk mengakses tampilan media ini.
mimeType

string

Hanya output. Jenis MIME (misalnya, "image/jpeg", "image/png", "text/plain", "video/mp4")
byteSize

string (int64 format)

Hanya output. Ukuran tampilan dalam byte.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan tampilan.

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".
Kolom union characteristics. Karakteristik tampilan media, yang memungkinkan ekstensi fleksibel. Metadata selalu dibuat secara internal oleh proses yang membuat tampilan. characteristics hanya ada berupa salah satu diantara berikut:
imageCharacteristics

object (ImageCharacteristics)

Hanya output. Karakteristik tampilan media gambar.
videoCharacteristics

object (VideoCharacteristics)

Hanya output. Karakteristik penayangan media video.
fileCharacteristics

object (FileCharacteristics)

Hanya output. Karakteristik jenis file lainnya.

ImageCharacteristics

Karakteristik standar tampilan media gambar.

Representasi JSON 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
Kolom
width

integer

Hanya output. Lebar gambar dalam piksel.
height

integer

Hanya output. Tinggi gambar dalam piksel.
colorSpace

enum (ColorSpace)

Hanya output. Ruang warna gambar (misalnya, "RGB", "CMYK", "Grayscale").
bitDepth

integer

Hanya output. Kedalaman bit gambar (misalnya, 8-bit, 16-bit).

ColorSpace

Kemungkinan ruang warna gambar (misalnya, "RGB", "CMYK", "Grayscale").

Enum
COLOR_SPACE_UNSPECIFIED Nilai default. Ruang warna tidak diketahui.
RGB Ruang warna merah, hijau, biru.
CMYK Ruang warna cyan, magenta, kuning, dan hitam.
GRAYSCALE Ruang warna hitam putih.
YUV Ruang warna YUV.
OTHER_COLOR_SPACE Ruang warna lainnya.

VideoCharacteristics

Karakteristik standar tampilan media video.

Representasi JSON 
{
  "width": integer,
  "height": integer,
  "duration": string,
  "frameRate": number,
  "audioCodecs": [
    string
  ],
  "videoCodecs": [
    string
  ],
  "videoBitrateKbps": integer,
  "audioBitrateKbps": integer
}
Kolom
width

integer

Hanya output. Lebar video dalam piksel.
height

integer

Hanya output. Tinggi video dalam piksel.
duration

string (Duration format)

Hanya output. Durasi video.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
frameRate

number

Hanya output. Kecepatan frame (frame per detik).
audioCodecs[]

string

Hanya output. Codec audio yang digunakan dalam video.
videoCodecs[]

string

Hanya output. Codec video yang digunakan dalam video.
videoBitrateKbps

integer

Hanya output. Kecepatan bit video dalam kbps.
audioBitrateKbps

integer

Hanya output. Kecepatan bit audio dalam kbps.

FileCharacteristics

Karakteristik jenis file lainnya.

Representasi JSON 
{
  "characteristics": {
    string: string,
    ...
  }
}
Kolom
characteristics

map (key: string, value: string)

Hanya output. Peta umum karakteristik.