Class AiSearchItems`Abstract`

Items collection service for an AI Search instance. Provides list, upload, and access to individual items.

Index

Constructors

Methods

delete get list upload uploadAndPoll

Constructors

constructor

new AiSearchItems(): AiSearchItems
Returns AiSearchItems

Methods

delete

delete(itemId: string): Promise<void>
Delete an item from the instance.
Parameters
- itemId: string
  The item identifier.
Returns Promise<void>
- Defined in src/server/worker-configuration.d.ts:4286

get

get(itemId: string): AiSearchItem
Get an item by ID.
Parameters
- itemId: string
  The item identifier.
Returns AiSearchItem
Item service for info, download, sync, logs, and chunks operations.
- Defined in src/server/worker-configuration.d.ts:4281

list

list(params?: AiSearchListItemsParams): Promise<AiSearchListItemsResponse>
List items in this instance.
Parameters
- Optionalparams: AiSearchListItemsParams
Returns Promise<AiSearchListItemsResponse>
- Defined in src/server/worker-configuration.d.ts:4251

upload

upload(
    name: string,
    content: string | ReadableStream<any> | Blob,
    options?: AiSearchUploadItemOptions,
): Promise<AiSearchItemInfo>
Upload a file as an item. Behaves as an upsert: if an item with the same filename already exists, it is overwritten and re-indexed.
Parameters
- name: string
  Filename for the uploaded item.
- content: string | ReadableStream<any> | Blob
  File content as a ReadableStream, Blob, or string.
- Optionaloptions: AiSearchUploadItemOptions
  Optional metadata to attach to the item.
Returns Promise<AiSearchItemInfo>
The created item info.
- Defined in src/server/worker-configuration.d.ts:4260

uploadAndPoll

uploadAndPoll(
    name: string,
    content: string | ReadableStream<any> | Blob,
    options?: AiSearchUploadItemOptions & {
        pollIntervalMs?: number;
        timeoutMs?: number;
    },
): Promise<AiSearchItemInfo>
Upload a file and poll until processing completes. Behaves as an upsert: if an item with the same filename already exists, it is overwritten and re-indexed.
Parameters
- name: string
  Filename for the uploaded item.
- content: string | ReadableStream<any> | Blob
  File content as a ReadableStream, Blob, or string.
- Optionaloptions: AiSearchUploadItemOptions & { pollIntervalMs?: number; timeoutMs?: number }
  Optional metadata and polling configuration.
  - OptionalpollIntervalMs?: number
    Polling interval in milliseconds (default 1000).
  - OptionaltimeoutMs?: number
    Maximum time to wait in milliseconds (default 30000).
Returns Promise<AiSearchItemInfo>
The item info after processing completes (or timeout).
- Defined in src/server/worker-configuration.d.ts:4270