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

現在のセッション内のすべてのファイルのメタデータを一覧表示します。

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。セッションのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

AssistantService.ListSessionFileMetadata メソッドに対するレスポンス メッセージ。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
フィールド
fileMetadata[]

object (FileMetadata)

FileMetadata。
totalQuotaPercentage
(deprecated)

number

非推奨: このフィールドは設定されない場合や、値がすべてのファイル形式を考慮していない場合があります。削除予定。

すべてのファイルで使用されている合計割り当ての割合。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.sessions.listSessionFileMetadata

詳細については、IAM のドキュメントをご覧ください。

FileMetadata

ファイルのメタデータ。

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
}
フィールド
fileId

string

ファイルの ID。
name

string

アップロードされたファイルの名前。
mimeType

string

ファイルのコンテンツ タイプ。https://www.iana.org/assignments/media-types/media-types.xhtml をご覧ください。
byteSize

string (int64 format)

コンテキスト ファイルのサイズ（バイト単位）。
tokenCount
(deprecated)

string (int64 format)

非推奨: このフィールドはすべてのファイル形式で設定されず、最終的には削除されます。

トークン単位で測定されたファイルの長さ。
quotaPercentage
(deprecated)

number

非推奨: このフィールドはすべてのファイル形式で設定されず、最終的には削除されます。

ファイルで使用されている割り当ての割合。
selected

boolean

ファイルが使用されるように選択されている場合。
usedInConversation

boolean

ファイルがセッションで以前に使用された（クエリで使用された）ことがあり、会話履歴の一部であるか、アップロードされただけでまだ使用されていないか。
originalUri

string

省略可。ファイルの元の場所。ローカル ファイルパス、または外部システムでファイルにアクセスできるその他の URI を指定できます。この URL が空になるシナリオは 2 つあります。1. ファイルがインライン データとして送信された場合（クリップボードから貼り付けられた場合など）。2. 元の場所が利用できない場合。

URI が有効なファイルまたは実際に存在するファイルを指している保証はありません。たとえば、ファイルがセッションにアップロードされた後、元のソースから削除された場合などです。
originalSourceType

enum (FileSource)

省略可。ファイルの元のソースのタイプ。
uploadTime

string (Timestamp format)

出力専用。ファイルがアップロードされた時刻（内部プロセスで生成され、セッションで使用可能になったファイルの場合は、その時点を示します）。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
metadata

map (key: string, value: string)

省略可。特定のユースケースに適したファイルに関連するメタデータを表します。接頭辞「google.」は、Google が使用するキー用に予約されていますが、他の接頭辞は自由に使用できます。
session

string

出力専用。セッションのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}。