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

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

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource de la session. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

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 AssistantService.ListSessionFileMetadata.

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

Représentation JSON 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
Champs
fileMetadata[]

object (FileMetadata)

Les FileMetadatas.
totalQuotaPercentage
(deprecated)

number

Obsolète : ce champ ne peut pas être défini ou la valeur peut ne pas prendre en compte tous les types de fichiers. À retirer.

Pourcentage total du quota utilisé par tous les fichiers.

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

  • discoveryengine.sessions.listSessionFileMetadata

Pour en savoir plus, consultez la documentation IAM.

FileMetadata

Métadonnées du fichier.

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

string

ID du fichier.
name

string

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)

Taille du fichier de contexte en octets.
tokenCount
(deprecated)

string (int64 format)

Obsolète : ce champ ne sera pas défini pour tous les types de fichiers et sera supprimé à terme.

Longueur du fichier mesurée en jetons.
quotaPercentage
(deprecated)

number

Obsolète : ce champ ne sera pas défini pour tous les types de fichiers et sera supprimé à terme.

Pourcentage du quota utilisé par le fichier.
selected

boolean

Si le fichier est sélectionné pour être utilisé.
usedInConversation

boolean

Indique si le fichier a déjà été utilisé dans la session (c'est-à-dire dans une requête) et fait partie de l'historique des conversations, ou s'il a seulement été importé et n'a pas encore été utilisé.
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".
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.
session

string

Uniquement en sortie. Nom de ressource de la session. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.