BetaAgentsListSessionsOptionalParams interface
Parâmetros opcionais.
- Extends
Propriedades
| after | Um cursor para uso na paginação.
|
| before | Um cursor para uso na paginação.
|
| foundry |
Uma aceitação de sinalizador de recurso necessária ao usar operações de visualização ou modificar recursos de visualização persistentes. |
| limit | Um limite no número de objetos a serem retornados. "Limit" pode variar entre 1 e 100 e o padrão é 20. |
| order | Classificar a ordem pelo carimbo de data/hora |
Propriedades herdadas
| abort |
O sinal que pode ser usado para anular solicitações. |
| on |
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes. |
| request |
Opções usadas ao criar e enviar solicitações HTTP para esta operação. |
| tracing |
Opções usadas quando o rastreamento está habilitado. |
Detalhes da propriedade
after
Um cursor para uso na paginação.
after é uma ID de objeto que define seu lugar na lista.
Por exemplo, caso faça uma solicitação de lista e receba 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir after=obj_foo, para buscar a próxima página da lista.
after?: string
Valor da propriedade
string
before
Um cursor para uso na paginação.
before é uma ID de objeto que define seu lugar na lista.
Por exemplo, se você fizer uma solicitação de lista e receber 100 objetos, terminando com obj_foo, sua chamada subsequente poderá incluir before=obj_foo para buscar a página anterior da lista.
before?: string
Valor da propriedade
string
foundryFeatures
Uma aceitação de sinalizador de recurso necessária ao usar operações de visualização ou modificar recursos de visualização persistentes.
foundryFeatures?: "AgentEndpoints=V1Preview"
Valor da propriedade
"AgentEndpoints=V1Preview"
limit
Um limite no número de objetos a serem retornados. "Limit" pode variar entre 1 e 100 e o padrão é 20.
limit?: number
Valor da propriedade
number
order
Classificar a ordem pelo carimbo de data/hora created_at dos objetos.
asc para ordem crescente edesc para ordem decrescente.
order?: PageOrder
Valor da propriedade
Detalhes das propriedades herdadas
abortSignal
O sinal que pode ser usado para anular solicitações.
abortSignal?: AbortSignalLike
Valor da propriedade
herdado de OperationOptions.abortSignal
onResponse
Uma função a ser chamada sempre que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
onResponse?: RawResponseCallback
Valor da propriedade
herdado de OperationOptions.onResponse
requestOptions
Opções usadas ao criar e enviar solicitações HTTP para esta operação.
requestOptions?: OperationRequestOptions
Valor da propriedade
Herdado de OperationOptions.requestOptions
tracingOptions
Opções usadas quando o rastreamento está habilitado.
tracingOptions?: OperationTracingOptions
Valor da propriedade
herdado de OperationOptions.tracingOptions