Class ResponseOutputMessage.Builder
-
- All Implemented Interfaces:
public final class ResponseOutputMessage.Builder
A builder for ResponseOutputMessage.
-
-
Method Summary
-
-
Method Detail
-
id
final ResponseOutputMessage.Builder id(String id)
The unique ID of the output message.
-
id
final ResponseOutputMessage.Builder id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value.
You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
content
final ResponseOutputMessage.Builder content(List<ResponseOutputMessage.Content> content)
The content of the output message.
-
content
final ResponseOutputMessage.Builder content(JsonField<List<ResponseOutputMessage.Content>> content)
Sets Builder.content to an arbitrary JSON value.
You should usually call Builder.content with a well-typed
List<Content>
value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addContent
final ResponseOutputMessage.Builder addContent(ResponseOutputMessage.Content content)
Adds a single Content to Builder.content.
-
addContent
final ResponseOutputMessage.Builder addContent(ResponseOutputText outputText)
Alias for calling addContent with
Content.ofOutputText(outputText)
.
-
addContent
final ResponseOutputMessage.Builder addContent(ResponseOutputRefusal refusal)
Alias for calling addContent with
Content.ofRefusal(refusal)
.
-
addRefusalContent
final ResponseOutputMessage.Builder addRefusalContent(String refusal)
Alias for calling addContent with the following:
ResponseOutputRefusal.builder() .refusal(refusal) .build()
-
role
final ResponseOutputMessage.Builder role(JsonValue role)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("assistant")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final ResponseOutputMessage.Builder status(ResponseOutputMessage.Status status)
The status of the message input. One of
in_progress
,completed
, orincomplete
. Populated when input items are returned via API.
-
status
final ResponseOutputMessage.Builder status(JsonField<ResponseOutputMessage.Status> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
type
final ResponseOutputMessage.Builder type(JsonValue type)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("message")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ResponseOutputMessage.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseOutputMessage.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseOutputMessage.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseOutputMessage.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseOutputMessage.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseOutputMessage build()
Returns an immutable instance of ResponseOutputMessage.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.id() .content() .status()
-
-
-
-