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

Elenca i metadati di tutti i file nella sessione corrente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa della sessione. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} nome della risorsa di sessione a cui appartiene il file.

Parametri di query

Parametri
filter

string

Facoltativo. La sintassi del filtro è costituita da un linguaggio di espressione per creare un predicato da uno o più campi dei file filtrati. L'espressione del filtro è sensibile alle maiuscole.

I nomi dei campi attualmente supportati sono:

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

Ecco alcuni esempi di filtri:

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

Per una descrizione completa del formato del filtro, consulta la pagina https://google.aip.dev/160.
pageSize

integer

Facoltativo. Il numero massimo di file da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verranno restituiti al massimo 100 file. Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000. Se l'utente specifica un valore minore o uguale a 0, la richiesta verrà rifiutata con un errore INVALID_ARGUMENT.
pageToken

string

Facoltativo. Un token di pagina ricevuto da una precedente chiamata files.list. Forniscilo per recuperare la pagina successiva.

Durante la paginazione, tutti gli altri parametri forniti a files.list devono corrispondere alla chiamata che ha fornito il token di pagina (ad eccezione di pageSize, che può essere diverso).
orderBy

string

Facoltativo. Specifica l'ordine in cui vengono restituiti i file.

Il valore è una stringa separata da virgole dei campi in base ai quali eseguire l'ordinamento.

Per l'ordine crescente, viene utilizzato solo il nome del campo. Per l'ordine decrescente, il nome del campo è preceduto dal suffisso desc. L'ordinamento è stabile e viene applicato in sequenza in base all'ordine dei campi forniti nella stringa.

Campi supportati per l'ordinamento:

  • upload_time: L'ora in cui è stato caricato il file.
  • file_name: il nome del file.
  • mime_type: il tipo MIME del file.
  • session_name: il nome della sessione a cui appartiene il file.

Comportamento predefinito:

Se il campo orderBy non è specificato, i file verranno restituiti ordinati in base all'ora di creazione in ordine decrescente.

Esempi:

  1. Ordina per nome file in ordine crescente: file_name

  2. Ordina per ora di caricamento in ordine decrescente: upload_time desc

  3. Ordina per nome file (in ordine crescente), poi per tipo di contenuto (tipo MIME) (in ordine decrescente) e infine per ora di caricamento (in ordine crescente): file_name, mime_type desc, upload_time

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Messaggio di risposta per il metodo SessionService.ListFiles.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
Campi
files[]

object (FileMetadata)

Gli anni FileMetadata.
nextPageToken

string

Un token per recuperare la pagina dei risultati successiva. Passa questo valore nel campo ListFilesRequest.page_token nella chiamata successiva al metodo files.list per recuperare la pagina successiva dei risultati.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa parent:

  • discoveryengine.sessions.listSessionFileMetadata

Per saperne di più, consulta la documentazione di IAM.

FileMetadata

Rappresenta un file allegato a una sessione (file di contesto)

Rappresentazione 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)
    },
    ...
  }
}
Campi
fileId

string

Solo output. L'ID del file.
name

string

Solo output. Il nome del file caricato.
mimeType

string

Il tipo di contenuto del file. Vedi https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Solo output. Le dimensioni del file di contesto in byte.
originalUri

string

Facoltativo. La posizione originale del file. Può essere un percorso di file locale o qualsiasi altro URI che consenta di accedere al file in un sistema esterno. Esistono due scenari in cui questo URL potrebbe essere vuoto: 1. Se il file è stato inviato come dati incorporati (ad es. incollati dagli appunti). 2. Se la posizione originale non è disponibile.

Tieni presente che non è garantito che l'URI rimandi a un file valido o effettivamente esistente. Ad esempio, un file potrebbe essere stato caricato nella sessione e poi eliminato dall'origine originale.
originalSourceType

enum (FileSource)

Facoltativo. Il tipo di origine originale del file.
uploadTime

string (Timestamp format)

Solo output. L'ora in cui è stato caricato il file (se si tratta di un file generato da un processo interno e poi reso disponibile per la sessione, indica il momento in cui è stato generato).

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
lastAddTime

string (Timestamp format)

Solo output. L'ora in cui il file è stato aggiunto alla sessione. Tieni presente che se un file è stato aggiunto, poi modificato esternamente e poi aggiunto di nuovo, l'ora di aggiunta verrà aggiornata.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
metadata

map (key: string, value: string)

Facoltativo. Rappresenta i metadati relativi al file che possono essere adatti a casi d'uso particolari. Il prefisso "google." è riservato alla chiave per l'utilizzo da parte di Google, ma gli altri prefissi possono essere utilizzati liberamente.
downloadUri

string

Solo output. L'URL AssistantService.DownloadSessionFile per scaricare il file. Questo URL avrà bisogno delle stesse credenziali del metodo AssistantService.ListSessionFileMetadata e fornirà la risorsa.
fileOriginType

enum (FileOriginType)

Facoltativo. L'origine del file.
views

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

Solo output. Visualizzazioni alternative di questo oggetto file. Ogni visualizzazione dei file è associata a un ruolo specifico. Possibili chiavi di esempio: - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation"

FileOriginType

L'origine del file.

Enum
FILE_ORIGIN_TYPE_UNSPECIFIED Valore predefinito.
USER_PROVIDED Il file è stato fornito dall'utente.
AI_GENERATED Il file è stato generato da un modello di AI.
INTERNALLY_GENERATED Il file è stato generato da altri file mediante un processo interno.

FileView

Rappresenta una versione o una "visualizzazione" alternativa specifica di un oggetto file, ad esempio un riepilogo, una miniatura, una versione tradotta e così via.

Rappresentazione 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.
}
Campi
viewId

string

Solo output. ID univoco a livello globale per questa visualizzazione specifica.
uri

string

Solo output. L'URI per accedere a questa visualizzazione dei contenuti multimediali.
mimeType

string

Solo output. Tipo MIME (ad es. "image/jpeg", "image/png", "text/plain", "video/mp4")
byteSize

string (int64 format)

Solo output. Le dimensioni della visualizzazione in byte.
createTime

string (Timestamp format)

Solo output. L'ora in cui è stata creata la vista.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Campo unione characteristics. Caratteristiche della visualizzazione dei contenuti multimediali, che consente estensioni flessibili. I metadati vengono sempre generati internamente dal processo di creazione della vista. characteristics può essere solo uno dei seguenti:
imageCharacteristics

object (ImageCharacteristics)

Solo output. Caratteristiche di una visualizzazione dei contenuti multimediali di un'immagine.
videoCharacteristics

object (VideoCharacteristics)

Solo output. Caratteristiche di una visualizzazione di contenuti multimediali video.
fileCharacteristics

object (FileCharacteristics)

Solo output. Caratteristiche di altri tipi di file.

ImageCharacteristics

Caratteristiche standard di una visualizzazione di contenuti multimediali con immagini.

Rappresentazione JSON 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
Campi
width

integer

Solo output. La larghezza dell'immagine in pixel.
height

integer

Solo output. Altezza dell'immagine in pixel.
colorSpace

enum (ColorSpace)

Solo output. Spazio colore dell'immagine (ad es. "RGB", "CMYK", "Scala di grigi").
bitDepth

integer

Solo output. Profondità di bit dell'immagine (ad es. 8 bit, 16 bit).

ColorSpace

Possibili spazi colore di un'immagine (ad es. "RGB", "CMYK", "Scala di grigi").

Enum
COLOR_SPACE_UNSPECIFIED Valore predefinito. Spazio colore sconosciuto.
RGB Spazio colore rosso, verde, blu.
CMYK Spazio colore ciano, magenta, giallo e nero.
GRAYSCALE Spazio colore in scala di grigi.
YUV Spazio colore YUV.
OTHER_COLOR_SPACE Altro spazio colore.

VideoCharacteristics

Caratteristiche standard di una visualizzazione di contenuti multimediali video.

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

integer

Solo output. Larghezza del video in pixel.
height

integer

Solo output. Altezza del video in pixel.
duration

string (Duration format)

Solo output. Durata del video.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
frameRate

number

Solo output. Frequenza fotogrammi (frame al secondo).
audioCodecs[]

string

Solo output. Codec audio utilizzati nel video.
videoCodecs[]

string

Solo output. Codec video utilizzati nel video.
videoBitrateKbps

integer

Solo output. Velocità in bit del video in kbps.
audioBitrateKbps

integer

Solo output. Velocità in bit dell'audio in kbps.

FileCharacteristics

Caratteristiche di altri tipi di file.

Rappresentazione JSON 
{
  "characteristics": {
    string: string,
    ...
  }
}
Campi
characteristics

map (key: string, value: string)

Solo output. Mappa generica delle caratteristiche.