Method: projects.locations.collections.engines.sessions.listSessionFileMetadata

Mencantumkan metadata untuk semua file dalam sesi saat ini.

Permintaan HTTP

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

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
name

string

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

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk metode AssistantService.ListSessionFileMetadata.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
Kolom
fileMetadata[]

object (FileMetadata)

FileMetadata.
totalQuotaPercentage
(deprecated)

number

Tidak digunakan lagi: Kolom ini mungkin tidak ditetapkan, atau nilai mungkin tidak memperhitungkan semua jenis file. Akan dihapus.

Total persentase kuota yang digunakan oleh semua file.

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 name:

  • discoveryengine.sessions.listSessionFileMetadata

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

FileMetadata

Metadata file.

Representasi JSON 
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "tokenCount": string,
  "quotaPercentage": number,
  "selected": boolean,
  "usedInConversation": boolean,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "metadata": {
    string: string,
    ...
  },
  "session": string
}
Kolom
fileId

string

ID file.
name

string

Nama file yang diupload.
mimeType

string

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

string (int64 format)

Ukuran file konteks dalam byte.
tokenCount
(deprecated)

string (int64 format)

Tidak digunakan lagi: Kolom ini tidak akan disetel untuk semua jenis file, dan pada akhirnya akan dihapus.

Panjang file yang diukur dalam token.
quotaPercentage
(deprecated)

number

Tidak digunakan lagi: Kolom ini tidak akan disetel untuk semua jenis file, dan pada akhirnya akan dihapus.

Persentase kuota yang digunakan oleh file.
selected

boolean

Jika file dipilih untuk digunakan.
usedInConversation

boolean

Apakah file digunakan dalam sesi sebelumnya (yaitu digunakan dalam kueri) dan merupakan bagian dari histori percakapan, atau hanya diupload dan belum digunakan.
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".
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.
session

string

Hanya output. Nama resource sesi. Format projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.