AgentsListOptimizationCandidatesOptionalParams interface

Package:

@azure/ai-projects

Optional parameters.

Extends

OperationOptions

Properties

after	Candidate-ID cursor identifying the last item from the previous page.
before	Candidate-ID cursor identifying the first item from the following page.
expand	Comma-separated list of expand keys. Pass mutations to populate mutation value fields; omit to receive mutation items containing only type. Additional expand keys may be added in future previews.
limit	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
order	Sort order by the candidate started_at timestamp.

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

after

Candidate-ID cursor identifying the last item from the previous page.

after?: string

Property Value

string

before

Candidate-ID cursor identifying the first item from the following page.

before?: string

Property Value

string

expand

Comma-separated list of expand keys. Pass mutations to populate mutation value fields; omit to receive mutation items containing only type. Additional expand keys may be added in future previews.

expand?: "mutations"[]

Property Value

"mutations"[]

limit

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

limit?: number

Property Value

number

order

Sort order by the candidate started_at timestamp.

order?: PageOrder

Property Value

PageOrder

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