Class ChatCompletionUpdateParams
-
- All Implemented Interfaces:
-
com.openai.core.Params
public final class ChatCompletionUpdateParams implements Params
Modify a stored chat completion. Only Chat Completions that have been created with the
store
parameter set totrue
can be modified. Currently, the only supported modification is to update themetadata
field.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatCompletionUpdateParams.Builder
A builder for ChatCompletionUpdateParams.
public final class
ChatCompletionUpdateParams.Body
public final class
ChatCompletionUpdateParams.Metadata
Set 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.
-
Method Summary
Modifier and Type Method Description final Optional<String>
completionId()
final Optional<ChatCompletionUpdateParams.Metadata>
metadata()
Set of 16 key-value pairs that can be attached to an object. final JsonField<ChatCompletionUpdateParams.Metadata>
_metadata()
Returns the raw JSON value of metadata. final Map<String, JsonValue>
_additionalBodyProperties()
final Headers
_additionalHeaders()
final QueryParams
_additionalQueryParams()
final ChatCompletionUpdateParams.Builder
toBuilder()
final ChatCompletionUpdateParams.Body
_body()
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 ChatCompletionUpdateParams.Builder
builder()
Returns a mutable builder for constructing an instance of ChatCompletionUpdateParams. -
-
Method Detail
-
completionId
final Optional<String> completionId()
-
metadata
final Optional<ChatCompletionUpdateParams.Metadata> metadata()
Set 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.
-
_metadata
final JsonField<ChatCompletionUpdateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final ChatCompletionUpdateParams.Builder toBuilder()
-
_body
final ChatCompletionUpdateParams.Body _body()
-
_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 ChatCompletionUpdateParams.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionUpdateParams.
The following fields are required:
.metadata()
-
-
-
-