Class ChatCompletionListParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class ChatCompletionListParams implements Params
List stored Chat Completions. Only Chat Completions that have been stored with the
storeparameter set totruewill be returned.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionListParams.BuilderA builder for ChatCompletionListParams.
public final classChatCompletionListParams.MetadataSet of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
public final classChatCompletionListParams.OrderSort order for Chat Completions by timestamp. Use
ascfor ascending order ordescfor descending order. Defaults toasc.
-
Method Summary
Modifier and Type Method Description final Optional<String>after()Identifier for the last chat completion from the previous pagination request. final Optional<Long>limit()Number of Chat Completions to retrieve. final Optional<ChatCompletionListParams.Metadata>metadata()A list of metadata keys to filter the Chat Completions by. final Optional<String>model()The model used to generate the Chat Completions. final Optional<ChatCompletionListParams.Order>order()Sort order for Chat Completions by timestamp. final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final ChatCompletionListParams.BuildertoBuilder()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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionListParamsnone()final static ChatCompletionListParams.Builderbuilder()Returns a mutable builder for constructing an instance of ChatCompletionListParams. -
-
Method Detail
-
after
final Optional<String> after()
Identifier for the last chat completion from the previous pagination request.
-
metadata
final Optional<ChatCompletionListParams.Metadata> metadata()
A list of metadata keys to filter the Chat Completions by. Example:
metadata[key1]=value1&metadata[key2]=value2
-
order
final Optional<ChatCompletionListParams.Order> order()
Sort order for Chat Completions by timestamp. Use
ascfor ascending order ordescfor descending order. Defaults toasc.
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ChatCompletionListParams.Builder toBuilder()
-
_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.
-
none
final static ChatCompletionListParams none()
-
builder
final static ChatCompletionListParams.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionListParams.
-
-
-
-