ListKnowledgeSourceFilesOptions interface

Options for listing files in a File knowledge source.

Properties

pageSize	The maximum number of files to return in one page.
prefix	Optional directory-like path prefix used to filter files.
search	A string used to narrow the file listing.
searchType	Specifies how the `search` parameter is interpreted. Currently only `prefix` is supported.

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

The maximum number of files to return in one page.

pageSize?: number

number

Optional directory-like path prefix used to filter files.

prefix?: string

string

A string used to narrow the file listing.

search?: string

string

Specifies how the search parameter is interpreted. Currently only prefix is supported.

searchType?: string

string

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Inherited From OperationOptions.abortSignal

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Inherited From OperationOptions.onResponse

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Inherited From OperationOptions.requestOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Inherited From OperationOptions.tracingOptions

Was this page helpful?