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

Listet Metadaten für alle Dateien in der aktuellen Sitzung auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Ressourcenname der Sitzung. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} Name der Sitzungsressource, zu der die Datei gehört.

Abfrageparameter

Parameter
filter

string

Optional. Die Filtersyntax besteht aus einer Ausdruckssprache zum Erstellen eines Prädikats aus einem oder mehreren Feldern der gefilterten Dateien. Bei Filterausdrücken wird zwischen Groß- und Kleinschreibung unterschieden.

Derzeit werden folgende Feldnamen unterstützt:

  • upload_time
  • last_add_time
  • last_use_time
  • file_name
  • mime_type

Hier einige Beispiele für Filter:

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

Eine vollständige Beschreibung des Filterformats finden Sie unter https://google.aip.dev/160.
pageSize

integer

Optional. Die maximale Anzahl der zurückzugebenden Dateien. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 100 Dateien zurückgegeben. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt. Wenn der Nutzer einen Wert angibt, der kleiner oder gleich 0 ist, wird die Anfrage mit dem Fehler INVALID_ARGUMENT abgelehnt.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen files.list-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen für files.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat (mit Ausnahme von pageSize, das sich unterscheiden kann).
orderBy

string

Optional. Gibt die Reihenfolge an, in der Dateien zurückgegeben werden.

Der Wert ist ein durch Kommas getrennter String von Feldern, nach denen sortiert werden soll.

Bei aufsteigender Reihenfolge wird nur der Feldname verwendet. Bei absteigender Reihenfolge wird dem Feldnamen das Suffix desc angehängt. Die Sortierung ist stabil und wird sequenziell entsprechend der Reihenfolge der Felder im String angewendet.

Unterstützte Felder für die Sortierung:

  • upload_time: Die Uhrzeit, zu der die Datei hochgeladen wurde.
  • file_name: Der Name der Datei.
  • mime_type: Der MIME-Typ der Datei.
  • session_name: Der Name der Sitzung, zu der die Datei gehört.

Standardverhalten:

Wenn das Feld orderBy nicht angegeben ist, werden die Dateien nach Erstellungszeit in absteigender Reihenfolge sortiert zurückgegeben.

Beispiele:

  1. Nach Dateinamen in aufsteigender Reihenfolge sortieren: file_name

  2. Nach Upload-Zeit in absteigender Reihenfolge sortieren: upload_time desc

  3. Nach Dateiname (aufsteigend), dann nach Inhaltstyp (MIME-Typ) (absteigend) und schließlich nach Upload-Zeit (aufsteigend) sortieren: file_name, mime_type desc, upload_time

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode SessionService.ListFiles.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "files": [
    {
      object (FileMetadata)
    }
  ],
  "nextPageToken": string
}
Felder
files[]

object (FileMetadata)

Die FileMetadata.
nextPageToken

string

Ein Token zum Abrufen der nächsten Ergebnisseite. Übergeben Sie diesen Wert im Feld ListFilesRequest.page_token im nachfolgenden Aufruf der Methode files.list, um die nächste Ergebnisseite abzurufen.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • discoveryengine.sessions.listSessionFileMetadata

Weitere Informationen finden Sie in der IAM-Dokumentation.

FileMetadata

Stellt eine Datei dar, die an eine Sitzung angehängt ist (Kontextdatei).

JSON-Darstellung 
{
  "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)
    },
    ...
  }
}
Felder
fileId

string

Nur Ausgabe. Die ID der Datei.
name

string

Nur Ausgabe. Der Name der hochgeladenen Datei.
mimeType

string

Der Inhaltstyp der Datei. Weitere Informationen finden Sie unter https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

Nur Ausgabe. Die Größe der Kontextdatei in Byte.
originalUri

string

Optional. Der ursprüngliche Speicherort der Datei. Dies kann ein lokaler Dateipfad oder ein beliebiger anderer URI sein, der den Zugriff auf die Datei in einem externen System ermöglicht. Es gibt zwei Szenarien, in denen diese URL leer sein kann: 1. Wenn die Datei als Inline-Daten gesendet wurde (z.B. aus der Zwischenablage eingefügt). 2. Wenn der ursprüngliche Speicherort nicht verfügbar ist.

Es gibt keine Garantie dafür, dass der URI auf eine gültige oder tatsächlich vorhandene Datei verweist. Beispielsweise wurde eine Datei in die Sitzung hochgeladen und dann aus der ursprünglichen Quelle gelöscht.
originalSourceType

enum (FileSource)

Optional. Der Typ der ursprünglichen Quelle der Datei.
uploadTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Datei hochgeladen wurde. Wenn es sich um eine Datei handelt, die durch einen internen Prozess generiert und dann für die Sitzung verfügbar gemacht wurde, gibt dies den Zeitpunkt an, zu dem dies geschehen ist.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
lastAddTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Datei der Sitzung hinzugefügt wurde. Wenn eine Datei hinzugefügt, dann extern geändert und dann noch einmal hinzugefügt wurde, wird die Hinzufügungszeit aktualisiert.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
metadata

map (key: string, value: string)

Optional. Stellt Metadaten zur Datei dar, die für bestimmte Anwendungsfälle geeignet sein können. Das Präfix „google.“ ist für den Schlüssel zur Verwendung durch Google reserviert. Andere Präfixe können frei verwendet werden.
downloadUri

string

Nur Ausgabe. Die AssistantService.DownloadSessionFile-URL zum Herunterladen der Datei. Für diese URL sind dieselben Anmeldedaten wie für die AssistantService.ListSessionFileMetadata-Methode erforderlich. Sie stellt die Ressource bereit.
fileOriginType

enum (FileOriginType)

Optional. Der Ursprung der Datei.
views

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

Nur Ausgabe. Alternative Ansichten dieses Dateiobjekts. Jede Dateiansicht ist einer bestimmten Rolle zugeordnet. Mögliche Beispielschlüssel: – „thumbnail“ – „mobile_thumbnail“ – „clip“ – „summary“ – „translation“

FileOriginType

Der Ursprung der Datei.

Enums
FILE_ORIGIN_TYPE_UNSPECIFIED Standardwert.
USER_PROVIDED Die Datei wurde vom Nutzer bereitgestellt.
AI_GENERATED Die Datei wurde von einem KI-Modell generiert.
INTERNALLY_GENERATED Die Datei wurde durch einen internen Prozess aus anderen Dateien generiert.

FileView

Stellt eine bestimmte alternative Version oder „Ansicht“ eines Dateiobjekts dar, z. B. eine Zusammenfassung, ein Vorschaubild oder eine übersetzte Version.

JSON-Darstellung 
{
  "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.
}
Felder
viewId

string

Nur Ausgabe. Global eindeutige ID für diese Ansicht.
uri

string

Nur Ausgabe. Der URI für den Zugriff auf diese Media-Ansicht.
mimeType

string

Nur Ausgabe. MIME-Typ (z.B. „image/jpeg“, „image/png“, „text/plain“, „video/mp4“)
byteSize

string (int64 format)

Nur Ausgabe. Die Größe der Ansicht in Byte.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Ansicht erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
Union-Feld characteristics. Merkmale der Media-Ansicht, die flexible Erweiterungen ermöglichen. Metadaten werden immer intern vom Prozess generiert, der die Ansicht erstellt. Für characteristics ist nur einer der folgenden Werte zulässig:
imageCharacteristics

object (ImageCharacteristics)

Nur Ausgabe. Eigenschaften einer Bildmedienansicht.
videoCharacteristics

object (VideoCharacteristics)

Nur Ausgabe. Merkmale einer Video-Media-Ansicht.
fileCharacteristics

object (FileCharacteristics)

Nur Ausgabe. Merkmale anderer Dateitypen

ImageCharacteristics

Standardmerkmale einer Bildmedienansicht.

JSON-Darstellung 
{
  "width": integer,
  "height": integer,
  "colorSpace": enum (ColorSpace),
  "bitDepth": integer
}
Felder
width

integer

Nur Ausgabe. Die Breite des Bildes in Pixeln.
height

integer

Nur Ausgabe. Höhe des Bildes in Pixeln.
colorSpace

enum (ColorSpace)

Nur Ausgabe. Farbraum des Bildes (z.B. „RGB“, „CMYK“, „Grayscale“).
bitDepth

integer

Nur Ausgabe. Bittiefe des Bildes (z.B. 8-Bit, 16-Bit).

ColorSpace

Mögliche Farbräume eines Bildes (z.B. „RGB“, „CMYK“, „Grayscale“).

Enums
COLOR_SPACE_UNSPECIFIED Standardwert. Unbekannter Farbraum.
RGB Rot-, Grün- und Blau-Farbraum.
CMYK Cyan, Magenta, Gelb und Schwarz.
GRAYSCALE Graustufen-Farbraum.
YUV YUV-Farbraum.
OTHER_COLOR_SPACE Anderer Farbraum.

VideoCharacteristics

Standardmerkmale einer Video-Media-Ansicht.

JSON-Darstellung 
{
  "width": integer,
  "height": integer,
  "duration": string,
  "frameRate": number,
  "audioCodecs": [
    string
  ],
  "videoCodecs": [
    string
  ],
  "videoBitrateKbps": integer,
  "audioBitrateKbps": integer
}
Felder
width

integer

Nur Ausgabe. Breite des Videos in Pixeln.
height

integer

Nur Ausgabe. Höhe des Videos in Pixeln.
duration

string (Duration format)

Nur Ausgabe. Videodauer

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit "s". Beispiel: "3.5s".
frameRate

number

Nur Ausgabe. Framerate (Bilder pro Sekunde).
audioCodecs[]

string

Nur Ausgabe. Im Video verwendete Audio-Codecs.
videoCodecs[]

string

Nur Ausgabe. Im Video verwendete Video-Codecs.
videoBitrateKbps

integer

Nur Ausgabe. Bitrate des Videos in kbit/s.
audioBitrateKbps

integer

Nur Ausgabe. Bitrate des Audiosignals in kbit/s.

FileCharacteristics

Merkmale anderer Dateitypen

JSON-Darstellung 
{
  "characteristics": {
    string: string,
    ...
  }
}
Felder
characteristics

map (key: string, value: string)

Nur Ausgabe. Generische Karte mit Merkmalen.