Share via

ListMessagesOptionalParams interface

  • Reference
Package:
@azure/ai-projects

Optional parameters for listing messages.

Extends

ListMessagesQueryParamProperties,OperationOptions

Inherited Properties

abortSignal

The signal which can be used to abort requests.
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.
limit

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
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.
order

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Possible values: "asc", "desc"
requestOptions

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

Filter messages by the run ID that generated them.
tracingOptions

Options used when tracing is enabled.

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

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

Inherited From ListMessagesQueryParamProperties.after

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

Inherited From ListMessagesQueryParamProperties.before

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

Inherited From ListMessagesQueryParamProperties.limit

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

order

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Possible values: "asc", "desc"

order?: string

Property Value

string

Inherited From ListMessagesQueryParamProperties.order

requestOptions

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

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

runId

Filter messages by the run ID that generated them.

runId?: string

Property Value

string

Inherited From ListMessagesQueryParamProperties.runId

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions