Class MessageListParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class MessageListParams implements Params
Returns a list of messages for a given thread.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
MessageListParams.Builder
A builder for MessageListParams.
public final class
MessageListParams.Order
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
Method Summary
Modifier and Type Method Description final String
threadId()
final Optional<String>
after()
A cursor for use in pagination. final Optional<String>
before()
A cursor for use in pagination. final Optional<Long>
limit()
A limit on the number of objects to be returned. final Optional<MessageListParams.Order>
order()
Sort order by the created_at
timestamp of the objects.final Optional<String>
runId()
Filter messages by the run ID that generated them. final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final MessageListParams.Builder
toBuilder()
final String
_pathParam(Integer index)
Headers
_headers()
The full set of headers in the parameters, including both fixed and additional headers. QueryParams
_queryParams()
The full set of query params in the parameters, including both fixed and additional query params. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static MessageListParams.Builder
builder()
Returns a mutable builder for constructing an instance of MessageListParams. -
-
Method Detail
-
after
final Optional<String> 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
final Optional<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, starting with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list.
-
limit
final Optional<Long> limit()
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
-
order
final Optional<MessageListParams.Order> order()
Sort order by the
created_at
timestamp of the objects.asc
for ascending order anddesc
for descending order.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final MessageListParams.Builder toBuilder()
-
_pathParam
final String _pathParam(Integer index)
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
builder
final static MessageListParams.Builder builder()
Returns a mutable builder for constructing an instance of MessageListParams.
The following fields are required:
.threadId()
-
-
-
-