BetaAgentsListOptimizationCandidatesOptionalParams interface

Parámetros opcionales.

Extends

Propiedades

after

Un cursor para usar en la paginación. after es un ID de objeto que define tu lugar en la lista. Por ejemplo, si haces una solicitud de lista y recibes 100 objetos, terminando en obj_foo, tu llamada posterior puede incluir después=obj_foo para obtener la siguiente página de la lista.

before

Un cursor para usar en la paginación. before es un ID de objeto que define tu lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.

foundryFeatures

Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

limit

Un límite en el número de objetos que se deben devolver. El límite puede oscilar entre 1 y 100, y el valor por defecto es 20.

order

Criterio de ordenación por la created_at marca de tiempo de los objetos. asc para orden ascendente ydesc para orden descendente.

Propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

tracingOptions

Opciones que se usan al habilitar el seguimiento.

Detalles de las propiedades

after

Un cursor para usar en la paginación. after es un ID de objeto que define tu lugar en la lista. Por ejemplo, si haces una solicitud de lista y recibes 100 objetos, terminando en obj_foo, tu llamada posterior puede incluir después=obj_foo para obtener la siguiente página de la lista.

after?: string

Valor de propiedad

string

before

Un cursor para usar en la paginación. before es un ID de objeto que define tu lugar en la lista. Por ejemplo, si realiza una solicitud de lista y recibe 100 objetos, finalizando con obj_foo, la llamada posterior puede incluir before=obj_foo para capturar la página anterior de la lista.

before?: string

Valor de propiedad

string

foundryFeatures

Se requiere una marca de característica cuando se usan operaciones en versión preliminar o se modifican los recursos de vista previa persistentes.

foundryFeatures?: "AgentsOptimization=V1Preview"

Valor de propiedad

"AgentsOptimization=V1Preview"

limit

Un límite en el número de objetos que se deben devolver. El límite puede oscilar entre 1 y 100, y el valor por defecto es 20.

limit?: number

Valor de propiedad

number

order

Criterio de ordenación por la created_at marca de tiempo de los objetos. asc para orden ascendente ydesc para orden descendente.

order?: PageOrder

Valor de propiedad

Detalles de las propiedades heredadas

abortSignal

Señal que se puede usar para anular las solicitudes.

abortSignal?: AbortSignalLike

Valor de propiedad

heredado de OperationOptions.abortSignal

onResponse

Función a la que se llamará cada vez que se recibe una respuesta del servidor mientras se realiza la operación solicitada. Se puede llamar varias veces.

onResponse?: RawResponseCallback

Valor de propiedad

heredado de OperationOptions.onResponse

requestOptions

Opciones que se usan al crear y enviar solicitudes HTTP para esta operación.

requestOptions?: OperationRequestOptions

Valor de propiedad

Heredado de OperationOptions.requestOptions

tracingOptions

Opciones que se usan al habilitar el seguimiento.

tracingOptions?: OperationTracingOptions

Valor de propiedad

heredado de OperationOptions.tracingOptions