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

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

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname der Sitzung. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für die Methode AssistantService.ListSessionFileMetadata.

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

JSON-Darstellung 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
Felder
fileMetadata[]

object (FileMetadata)

Die FileMetadata.
totalQuotaPercentage
(deprecated)

number

Verworfen: Dieses Feld darf nicht festgelegt werden oder der Wert berücksichtigt möglicherweise nicht alle Dateitypen. Wird entfernt.

Der prozentuale Anteil des Gesamtkontingents, der von allen Dateien verwendet wird.

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

  • discoveryengine.sessions.listSessionFileMetadata

Weitere Informationen finden Sie in der IAM-Dokumentation.

FileMetadata

Die Metadaten der Datei.

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

string

Die ID der Datei.
name

string

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)

Die Größe der Kontextdatei in Byte.
tokenCount
(deprecated)

string (int64 format)

Verworfen: Dieses Feld wird nicht für alle Dateitypen festgelegt und wird demnächst entfernt.

Die Länge der Datei in Tokens.
quotaPercentage
(deprecated)

number

Verworfen: Dieses Feld wird nicht für alle Dateitypen festgelegt und wird demnächst entfernt.

Der Prozentsatz des Kontingents, der von der Datei verwendet wird.
selected

boolean

Wenn die Datei zur Verwendung ausgewählt ist.
usedInConversation

boolean

Gibt an, ob die Datei bereits in der Sitzung verwendet wurde (d.h. in einer Anfrage) und Teil des Unterhaltungsverlaufs ist oder nur hochgeladen, aber noch nicht verwendet wurde.
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".
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.
session

string

Nur Ausgabe. Der Ressourcenname der Sitzung. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.