Class ResponseInputMessageItem.Builder
-
- All Implemented Interfaces:
public final class ResponseInputMessageItem.Builder
A builder for ResponseInputMessageItem.
-
-
Method Summary
-
-
Method Detail
-
id
final ResponseInputMessageItem.Builder id(String id)
The unique ID of the message input.
-
id
final ResponseInputMessageItem.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 ResponseInputMessageItem.Builder content(List<ResponseInputContent> content)
A list of one or many input items to the model, containing different content types.
-
content
final ResponseInputMessageItem.Builder content(JsonField<List<ResponseInputContent>> content)
Sets Builder.content to an arbitrary JSON value.
You should usually call Builder.content with a well-typed
List<ResponseInputContent>
value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addContent
final ResponseInputMessageItem.Builder addContent(ResponseInputContent content)
Adds a single ResponseInputContent to Builder.content.
-
addContent
final ResponseInputMessageItem.Builder addContent(ResponseInputText inputText)
Alias for calling addContent with
ResponseInputContent.ofInputText(inputText)
.
-
addContent
final ResponseInputMessageItem.Builder addContent(ResponseInputImage inputImage)
Alias for calling addContent with
ResponseInputContent.ofInputImage(inputImage)
.
-
addContent
final ResponseInputMessageItem.Builder addContent(ResponseInputFile inputFile)
Alias for calling addContent with
ResponseInputContent.ofInputFile(inputFile)
.
-
addInputTextContent
final ResponseInputMessageItem.Builder addInputTextContent(String text)
Alias for calling addContent with the following:
ResponseInputText.builder() .text(text) .build()
-
addInputImageContent
final ResponseInputMessageItem.Builder addInputImageContent(ResponseInputImage.Detail detail)
Alias for calling addContent with the following:
ResponseInputImage.builder() .detail(detail) .build()
-
role
final ResponseInputMessageItem.Builder role(ResponseInputMessageItem.Role role)
The role of the message input. One of
user
,system
, ordeveloper
.
-
role
final ResponseInputMessageItem.Builder role(JsonField<ResponseInputMessageItem.Role> role)
Sets Builder.role to an arbitrary JSON value.
You should usually call Builder.role with a well-typed Role value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final ResponseInputMessageItem.Builder status(ResponseInputMessageItem.Status status)
The status of item. One of
in_progress
,completed
, orincomplete
. Populated when items are returned via API.
-
status
final ResponseInputMessageItem.Builder status(JsonField<ResponseInputMessageItem.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 ResponseInputMessageItem.Builder type(ResponseInputMessageItem.Type type)
The type of the message input. Always set to
message
.
-
type
final ResponseInputMessageItem.Builder type(JsonField<ResponseInputMessageItem.Type> type)
Sets Builder.type to an arbitrary JSON value.
You should usually call Builder.type with a well-typed Type value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ResponseInputMessageItem.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseInputMessageItem.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseInputMessageItem.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseInputMessageItem.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseInputMessageItem.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseInputMessageItem build()
Returns an immutable instance of ResponseInputMessageItem.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.id() .content() .role()
-
-
-
-