Class ConversationItemCreateEvent.Builder
-
- All Implemented Interfaces:
public final class ConversationItemCreateEvent.Builder
A builder for ConversationItemCreateEvent.
-
-
Method Summary
Modifier and Type Method Description final ConversationItemCreateEvent.Builder
item(ConversationItem item)
A single item within a Realtime conversation. final ConversationItemCreateEvent.Builder
item(JsonField<ConversationItem> item)
Sets Builder.item to an arbitrary JSON value. final ConversationItemCreateEvent.Builder
item(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage)
.final ConversationItemCreateEvent.Builder
item(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage)
.final ConversationItemCreateEvent.Builder
item(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage)
.final ConversationItemCreateEvent.Builder
item(RealtimeConversationItemFunctionCall functionCall)
Alias for calling item with ConversationItem.ofFunctionCall(functionCall)
.final ConversationItemCreateEvent.Builder
item(RealtimeConversationItemFunctionCallOutput functionCallOutput)
Alias for calling item with ConversationItem.ofFunctionCallOutput(functionCallOutput)
.final ConversationItemCreateEvent.Builder
item(RealtimeMcpApprovalResponse mcpApprovalResponse)
Alias for calling item with ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse)
.final ConversationItemCreateEvent.Builder
item(RealtimeMcpListTools mcpListTools)
Alias for calling item with ConversationItem.ofMcpListTools(mcpListTools)
.final ConversationItemCreateEvent.Builder
item(RealtimeMcpToolCall mcpToolCall)
Alias for calling item with ConversationItem.ofMcpToolCall(mcpToolCall)
.final ConversationItemCreateEvent.Builder
item(RealtimeMcpApprovalRequest mcpApprovalRequest)
Alias for calling item with ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest)
.final ConversationItemCreateEvent.Builder
realtimeConversationItemSystemMessageItem(List<RealtimeConversationItemSystemMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemSystemMessage.builder() .content(content) .build()
final ConversationItemCreateEvent.Builder
realtimeConversationItemUserMessageItem(List<RealtimeConversationItemUserMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemUserMessage.builder() .content(content) .build()
final ConversationItemCreateEvent.Builder
realtimeConversationItemAssistantMessageItem(List<RealtimeConversationItemAssistantMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemAssistantMessage.builder() .content(content) .build()
final ConversationItemCreateEvent.Builder
type(JsonValue type)
Sets the field to an arbitrary JSON value. final ConversationItemCreateEvent.Builder
eventId(String eventId)
Optional client-generated ID used to identify this event. final ConversationItemCreateEvent.Builder
eventId(JsonField<String> eventId)
Sets Builder.eventId to an arbitrary JSON value. final ConversationItemCreateEvent.Builder
previousItemId(String previousItemId)
The ID of the preceding item after which the new item will be inserted. final ConversationItemCreateEvent.Builder
previousItemId(JsonField<String> previousItemId)
Sets Builder.previousItemId to an arbitrary JSON value. final ConversationItemCreateEvent.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final ConversationItemCreateEvent.Builder
putAdditionalProperty(String key, JsonValue value)
final ConversationItemCreateEvent.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final ConversationItemCreateEvent.Builder
removeAdditionalProperty(String key)
final ConversationItemCreateEvent.Builder
removeAllAdditionalProperties(Set<String> keys)
final ConversationItemCreateEvent
build()
Returns an immutable instance of ConversationItemCreateEvent. -
-
Method Detail
-
item
final ConversationItemCreateEvent.Builder item(ConversationItem item)
A single item within a Realtime conversation.
-
item
final ConversationItemCreateEvent.Builder item(JsonField<ConversationItem> item)
Sets Builder.item to an arbitrary JSON value.
You should usually call Builder.item with a well-typed ConversationItem value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeConversationItemFunctionCall functionCall)
Alias for calling item with
ConversationItem.ofFunctionCall(functionCall)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeConversationItemFunctionCallOutput functionCallOutput)
Alias for calling item with
ConversationItem.ofFunctionCallOutput(functionCallOutput)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeMcpApprovalResponse mcpApprovalResponse)
Alias for calling item with
ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeMcpListTools mcpListTools)
Alias for calling item with
ConversationItem.ofMcpListTools(mcpListTools)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeMcpToolCall mcpToolCall)
Alias for calling item with
ConversationItem.ofMcpToolCall(mcpToolCall)
.
-
item
final ConversationItemCreateEvent.Builder item(RealtimeMcpApprovalRequest mcpApprovalRequest)
Alias for calling item with
ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest)
.
-
realtimeConversationItemSystemMessageItem
final ConversationItemCreateEvent.Builder realtimeConversationItemSystemMessageItem(List<RealtimeConversationItemSystemMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemSystemMessage.builder() .content(content) .build()
-
realtimeConversationItemUserMessageItem
final ConversationItemCreateEvent.Builder realtimeConversationItemUserMessageItem(List<RealtimeConversationItemUserMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemUserMessage.builder() .content(content) .build()
-
realtimeConversationItemAssistantMessageItem
final ConversationItemCreateEvent.Builder realtimeConversationItemAssistantMessageItem(List<RealtimeConversationItemAssistantMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemAssistantMessage.builder() .content(content) .build()
-
type
final ConversationItemCreateEvent.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("conversation.item.create")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
eventId
final ConversationItemCreateEvent.Builder eventId(String eventId)
Optional client-generated ID used to identify this event.
-
eventId
final ConversationItemCreateEvent.Builder eventId(JsonField<String> eventId)
Sets Builder.eventId to an arbitrary JSON value.
You should usually call Builder.eventId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
previousItemId
final ConversationItemCreateEvent.Builder previousItemId(String previousItemId)
The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation. If set to
root
, the new item will be added to the beginning of the conversation. If set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.
-
previousItemId
final ConversationItemCreateEvent.Builder previousItemId(JsonField<String> previousItemId)
Sets Builder.previousItemId to an arbitrary JSON value.
You should usually call Builder.previousItemId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ConversationItemCreateEvent.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ConversationItemCreateEvent.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ConversationItemCreateEvent.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ConversationItemCreateEvent.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ConversationItemCreateEvent.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ConversationItemCreateEvent build()
Returns an immutable instance of ConversationItemCreateEvent.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.item()
-
-
-
-