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

Mengupload file konteks untuk digunakan sebagai sumber panggilan bantuan dalam sesi.

Permintaan HTTP

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:addContextFile

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}

Jika - ditentukan sebagai ID sesi, sesi baru akan dibuat dengan ID yang dibuat secara otomatis.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "fileName": string,
  "mimeType": string,

  // Union field file can be only one of the following:
  "fileContents": string
  // End of list of possible types for union field file.
}
Kolom
fileName

string

Wajib. Nama file.

mimeType

string

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

Kolom ini wajib diisi jika sumber data tidak memberikan jenis konten.

Kolom union file. Isi file. file hanya ada berupa salah satu diantara berikut:
fileContents

string (bytes format)

Isi file disediakan secara inline.

String berenkode base64.

Isi respons

Respons untuk metode AssistantService.AddContextFile.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "session": string,
  "fileId": string,
  "tokenCount": string
}
Kolom
session

string

Nama sesi, baik yang disediakan, maupun yang baru dibuat.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

fileId

string

ID file yang diupload.

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.

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.addContextFile

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.