Skip to main content

Interface: IFileRef

Defined in: contracts/types.ts:165

Pointer to a stored blob: the file pointer the application holds instead of the bytes.

Returned by AIGateway.uploadFile (the FileStore produces it), passed back in IGatewayAskInput.files, stored in an IFilePart of the user turn.

Properties​

id​

id: string

Defined in: contracts/types.ts:167

The file's id, unique in the tenant.

mime​

mime: string

Defined in: contracts/types.ts:176

MIME type, e.g. "image/png", "application/pdf".

name​

name: string

Defined in: contracts/types.ts:180

Original file name.

size​

size: number

Defined in: contracts/types.ts:178

Bytes.

tenantId​

tenantId: string

Defined in: contracts/types.ts:169

The tenant that owns the file.

userId​

userId: string

Defined in: contracts/types.ts:174

Who uploaded the file. Part of where the file is stored, so that all files of a user can be deleted at once. The gateway checks it: a question may carry only the calling user's own files, another user's pointer is a 400.