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

Affiche les métadonnées de tous les fichiers de la session en cours.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de ressource de la session. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} nom de la ressource de session à laquelle appartient le fichier.

Paramètres de requête

Paramètres
filter

string

Facultatif. La syntaxe des filtres consiste en un langage d'expression permettant de construire un prédicat à partir d'un ou de plusieurs champs des fichiers filtrés. L'expression de filtre est sensible à la casse.

Voici les noms de champs actuellement acceptés :

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

Voici quelques exemples de filtres :

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

Pour obtenir une description complète du format de filtre, veuillez consulter https://google.aip.dev/160.
pageSize

integer

Facultatif. Nombre maximal de fichiers à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si ce paramètre n'est pas spécifié, 100 fichiers au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000. Si l'utilisateur spécifie une valeur inférieure ou égale à 0, la requête sera rejetée avec une erreur INVALID_ARGUMENT.
pageToken

string

Facultatif. Jeton de page reçu d'un appel files.list précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à files.list doivent correspondre à l'appel ayant fourni le jeton de page (sauf pageSize, qui peut être différent).
orderBy

string

Facultatif. Spécifie l'ordre dans lequel les fichiers sont renvoyés.

La valeur est une chaîne de champs séparés par une virgule selon lesquels effectuer le tri.

Pour l'ordre croissant, seul le nom du champ est utilisé. Pour l'ordre décroissant, le nom du champ est suivi de desc. Le tri est stable et appliqué de manière séquentielle en fonction de l'ordre des champs fournis dans la chaîne.

Champs acceptés pour le tri :

  • upload_time : heure à laquelle le fichier a été importé.
  • file_name : nom du fichier.
  • mime_type : type MIME du fichier.
  • session_name : nom de la session à laquelle appartient le fichier.

Comportement par défaut :

Si le champ orderBy n'est pas spécifié, les fichiers sont renvoyés triés par heure de création dans l'ordre décroissant.

Exemples :

  1. Trier par nom de fichier dans l'ordre croissant : file_name

  2. Trier par heure d'importation dans l'ordre décroissant : upload_time desc

  3. Trier par nom de fichier (ordre croissant), puis par type de contenu (type MIME) (ordre décroissant), et enfin par heure d'importation (ordre croissant) : file_name, mime_type desc, upload_time

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la méthode SessionService.ListFiles.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
Champs
files[]

object (FileMetadata)

Les FileMetadatas.
nextPageToken

string

Jeton permettant de récupérer la page de résultats suivante. Transmettez cette valeur dans le champ ListFilesRequest.page_token de l'appel suivant à la méthode files.list pour récupérer la page de résultats suivante.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.sessions.listSessionFileMetadata

Pour en savoir plus, consultez la documentation IAM.

FileMetadata

Représente un fichier joint à une session (fichier de contexte)

Représentation 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)
    },
    ...
  }
}
Champs
fileId

string

Uniquement en sortie. ID du fichier.
name

string

Uniquement en sortie. Nom du fichier importé.
mimeType

string

Type de contenu du fichier. Pour en savoir plus, consultez https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Uniquement en sortie. Taille du fichier de contexte en octets.
originalUri

string

Facultatif. Emplacement d'origine du fichier. Il peut s'agir d'un chemin d'accès à un fichier local ou de tout autre URI permettant d'accéder au fichier dans un système externe. Il existe deux scénarios dans lesquels cette URL peut être vide : 1. Si le fichier a été envoyé sous forme de données intégrées (par exemple, collées à partir du presse-papiers). 2. Si l'emplacement d'origine n'est pas disponible.

Notez que nous ne pouvons pas vous garantir que l'URI pointe vers un fichier valide ou existant. Par exemple, un fichier peut avoir été importé dans la session, puis supprimé de la source d'origine.
originalSourceType

enum (FileSource)

Facultatif. Type de source d'origine du fichier.
uploadTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le fichier a été importé (s'il s'agit d'un fichier généré par un processus interne, puis mis à disposition de la session, cela indique le moment où cela s'est produit).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
lastAddTime

string (Timestamp format)

Uniquement en sortie. Heure à laquelle le fichier a été ajouté à la session. Notez que si un fichier a été ajouté, puis modifié en externe, puis ajouté à nouveau, l'heure d'ajout sera mise à jour.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
metadata

map (key: string, value: string)

Facultatif. Représente les métadonnées associées au fichier qui peuvent convenir à des cas d'utilisation spécifiques. Le préfixe "google." est réservé à la clé pour l'utilisation par Google, mais d'autres préfixes peuvent être utilisés librement.
downloadUri

string

Uniquement en sortie. URL AssistantService.DownloadSessionFile permettant de télécharger le fichier. Cette URL nécessitera les mêmes identifiants que la méthode AssistantService.ListSessionFileMetadata et fournira la ressource.
fileOriginType

enum (FileOriginType)

Facultatif. Origine du fichier.
views

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

Uniquement en sortie. Vues alternatives de cet objet de fichier. Chaque vue de fichier est associée à un rôle spécifique. Exemples de clés possibles : - "thumbnail" - "mobile_thumbnail" - "clip" - "summary" - "translation"

FileOriginType

Origine du fichier.

Enums
FILE_ORIGIN_TYPE_UNSPECIFIED Valeur par défaut.
USER_PROVIDED Le fichier a été fourni par l'utilisateur.
AI_GENERATED Le fichier a été généré par un modèle d'IA.
INTERNALLY_GENERATED Le fichier a été généré à partir d'autres fichiers par un processus interne.

FileView

Représente une version ou une "vue" alternative spécifique d'un objet de fichier, comme un résumé, une miniature, une version traduite, etc.

Représentation 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.
}
Champs
viewId

string

Uniquement en sortie. Identifiant unique mondial pour cette vue spécifique.
uri

string

Uniquement en sortie. URI permettant d'accéder à cette vue multimédia.
mimeType

string

Uniquement en sortie. Type MIME (par exemple, "image/jpeg", "image/png", "text/plain", "video/mp4")
byteSize

string (int64 format)

Uniquement en sortie. Taille de la vue en octets.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de la vue.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Champ d'union characteristics. Caractéristiques de la vue média, permettant des extensions flexibles. Les métadonnées sont toujours générées en interne par le processus de création de la vue. characteristics ne peut être qu'un des éléments suivants :
imageCharacteristics

object (ImageCharacteristics)

Uniquement en sortie. Caractéristiques d'une vue de contenu multimédia d'image.
videoCharacteristics

object (VideoCharacteristics)

Uniquement en sortie. Caractéristiques d'une vue média vidéo.
fileCharacteristics

object (FileCharacteristics)

Uniquement en sortie. Caractéristiques des autres types de fichiers.

ImageCharacteristics

Caractéristiques standards d'une vue média d'image.

Représentation JSON 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
Champs
width

integer

Uniquement en sortie. Largeur de l'image en pixels.
height

integer

Uniquement en sortie. Hauteur de l'image en pixels.
colorSpace

enum (ColorSpace)

Uniquement en sortie. Espace colorimétrique de l'image (par exemple, "RGB", "CMYK", "Nuances de gris").
bitDepth

integer

Uniquement en sortie. Profondeur de bits de l'image (par exemple, 8 bits, 16 bits).

ColorSpace

Espaces colorimétriques possibles d'une image (par exemple, "RGB", "CMYK", "Nuances de gris").

Enums
COLOR_SPACE_UNSPECIFIED Valeur par défaut. Espace colorimétrique inconnu.
RGB Espace colorimétrique rouge, vert et bleu.
CMYK Espace colorimétrique cyan, magenta, jaune et noir.
GRAYSCALE Espace colorimétrique en nuances de gris.
YUV Espace colorimétrique YUV.
OTHER_COLOR_SPACE Autre espace colorimétrique.

VideoCharacteristics

Caractéristiques standards d'une vue de média vidéo.

Représentation JSON 
{
  "width": integer,
  "height": integer,
  "duration": string,
  "frameRate": number,
  "audioCodecs": [
    string
  ],
  "videoCodecs": [
    string
  ],
  "videoBitrateKbps": integer,
  "audioBitrateKbps": integer
}
Champs
width

integer

Uniquement en sortie. Largeur de la vidéo en pixels.
height

integer

Uniquement en sortie. Hauteur de la vidéo en pixels.
duration

string (Duration format)

Uniquement en sortie. Durée de la vidéo.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
frameRate

number

Uniquement en sortie. Fréquence d'images (images par seconde).
audioCodecs[]

string

Uniquement en sortie. Codecs audio utilisés dans la vidéo.
videoCodecs[]

string

Uniquement en sortie. Codecs vidéo utilisés dans la vidéo.
videoBitrateKbps

integer

Uniquement en sortie. Débit de la vidéo en kbit/s.
audioBitrateKbps

integer

Uniquement en sortie. Débit audio en kbit/s.

FileCharacteristics

Caractéristiques des autres types de fichiers.

Représentation JSON 
{
  "characteristics": {
    string: string,
    ...
  }
}
Champs
characteristics

map (key: string, value: string)

Uniquement en sortie. Carte générique des caractéristiques.