AgentsListOptionalParams interface

Package:

@azure/ai-projects

Optional parameters.

Extends

OperationOptions

Properties

after	A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.
before	A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
kind	Filter agents by kind. If not provided, all agents are returned.
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 created_at timestamp of the objects. asc for ascending order anddesc for descending order.

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

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

after?: string

Property Value

string

before

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.

before?: string

Property Value

string

kind

Filter agents by kind. If not provided, all agents are returned.

kind?: AgentKind

Property Value

AgentKind

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 created_at timestamp of the objects. asc for ascending order anddesc for descending order.

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