Class MessageListParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class MessageListParams implements Params
Get the messages in a stored chat completion. Only Chat Completions that have been created with the
store
parameter set totrue
will be returned.
-
-
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 for messages by timestamp. Use
asc
for ascending order ordesc
for descending order. Defaults toasc
.
-
Method Summary
Modifier and Type Method Description final String
completionId()
final Optional<String>
after()
Identifier for the last message from the previous pagination request. final Optional<Long>
limit()
Number of messages to retrieve. final Optional<MessageListParams.Order>
order()
Sort order for messages by timestamp. final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
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. final String
getPathParam(Integer index)
final MessageListParams.Builder
toBuilder()
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
-
completionId
final String completionId()
-
after
final Optional<String> after()
Identifier for the last message from the previous pagination request.
-
order
final Optional<MessageListParams.Order> order()
Sort order for messages by timestamp. Use
asc
for ascending order ordesc
for descending order. Defaults toasc
.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
_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.
-
getPathParam
final String getPathParam(Integer index)
-
toBuilder
final MessageListParams.Builder toBuilder()
-
builder
final static MessageListParams.Builder builder()
Returns a mutable builder for constructing an instance of MessageListParams.
The following fields are required:
.completionId()
-
-
-
-