ListFilesOptions interface

Package:

@azure/openai-assistants

The details used to list files.

Extends

OperationOptions

Properties

purpose

A value that, when provided, limits list results to files matching the corresponding purpose.

Inherited Properties

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.

Property Details

purpose

A value that, when provided, limits list results to files matching the corresponding purpose.

purpose?: string

Property Value

string

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

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.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions