FilesAdapter

Defined in: packages/ai/src/activities/files/adapter.ts:78

The files adapter contract. upload is required; get/delete are optional and present only when the provider has a lifecycle API.

TName is the provider name literal ('openai', 'gemini', ...); concrete adapters bind it so the handles they issue carry their provenance in the type system.

Each method takes an optional { abortSignal }. Adapters should forward it to the provider request when supported.

Type Parameters#

TName#

TName extends string = string

Properties#

delete?#

optional delete?: (id, options?) => Promise<void>;

Defined in: packages/ai/src/activities/files/adapter.ts:89

Parameters#

id#

string

options?#

abortSignal?#

AbortSignal

Returns#

Promise<void>

get?#

optional get?: (id, options?) => Promise<FileHandle<TName>>;

Defined in: packages/ai/src/activities/files/adapter.ts:85

Parameters#

id#

string

options?#

abortSignal?#

AbortSignal

Returns#

Promise<FileHandle<TName>>

kind#

readonly kind: "files";

Defined in: packages/ai/src/activities/files/adapter.ts:79

name#

readonly name: TName;

Defined in: packages/ai/src/activities/files/adapter.ts:80

upload#

upload: (input, options?) => Promise<FileHandle<TName>>;

Defined in: packages/ai/src/activities/files/adapter.ts:81

Parameters#

input#

FileUploadInput

options?#

abortSignal?#

AbortSignal

Returns#

Promise<FileHandle<TName>>