MessagesListMessagesOptionalParams interface
可选参数。
属性
| after | 用于分页的游标。 之后是一个对象 ID,用于定义列表中的位置。 例如,如果发出列表请求并接收 100 个对象,以obj_foo结尾,则后续调用可以包含 after=obj_foo,以便提取列表的下一页。 |
| before | 用于分页的游标。 before 是定义列表中位置的对象 ID。 例如,如果发出列表请求并接收 100 个对象,以obj_foo结尾,则后续调用可以包括 before=obj_foo,以便提取列表的上一页。 |
| limit | 要返回的对象数的限制。 限制可以介于 1 和 100 之间,默认值为 20。 |
| order | 按对象的created_at时间戳排序顺序。 asc 表示升序和降序的 desc。 |
| run |
按生成消息的运行 ID 筛选消息。 |
继承属性
| abort |
可用于中止请求的信号。 |
| on |
在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。 |
| request |
为此作创建和发送 HTTP 请求时使用的选项。 |
| tracing |
启用跟踪时使用的选项。 |
属性详细信息
after
用于分页的游标。 之后是一个对象 ID,用于定义列表中的位置。 例如,如果发出列表请求并接收 100 个对象,以obj_foo结尾,则后续调用可以包含 after=obj_foo,以便提取列表的下一页。
after?: string
属性值
string
before
用于分页的游标。 before 是定义列表中位置的对象 ID。 例如,如果发出列表请求并接收 100 个对象,以obj_foo结尾,则后续调用可以包括 before=obj_foo,以便提取列表的上一页。
before?: string
属性值
string
limit
要返回的对象数的限制。 限制可以介于 1 和 100 之间,默认值为 20。
limit?: number
属性值
number
order
runId
按生成消息的运行 ID 筛选消息。
runId?: string
属性值
string
继承属性详细信息
abortSignal
onResponse
在执行请求的作时,每次从服务器接收响应时调用的函数。 可以多次调用。
onResponse?: RawResponseCallback
属性值
继承自 OperationOptions.onResponse
requestOptions
为此作创建和发送 HTTP 请求时使用的选项。
requestOptions?: OperationRequestOptions
属性值
继承自 OperationOptions.requestOptions
tracingOptions
启用跟踪时使用的选项。
tracingOptions?: OperationTracingOptions
属性值
继承自 OperationOptions.tracingOptions