UserFile

  • This document details the structure of a file sent from a user to an agent, as represented in JSON format.

  • The file structure includes a category field specifying the file type, drawn from the FileCategory enum.

  • An optional thumbnail field, detailed as a FileInfo object, may be present to represent the file, particularly for images and videos.

  • The payload field, which is a FileInfo object, contains the actual file data.

A file sent from a user to the agent.

JSON representation
{
  "category": enum (FileCategory),
  "thumbnail": {
    object (FileInfo)
  },
  "payload": {
    object (FileInfo)
  }
}
Fields
category

enum (FileCategory)

The category the file belongs to.

thumbnail

object (FileInfo)

(Optional) A thumbnail representing the file. Usually sent alongside image and video files.

payload

object (FileInfo)

The file.