Class ConversationItemCreatedEvent.Builder
-
- All Implemented Interfaces:
public final class ConversationItemCreatedEvent.Builder
A builder for ConversationItemCreatedEvent.
-
-
Method Summary
Modifier and Type Method Description final ConversationItemCreatedEvent.Builder
eventId(String eventId)
The unique ID of the server event. final ConversationItemCreatedEvent.Builder
eventId(JsonField<String> eventId)
Sets Builder.eventId to an arbitrary JSON value. final ConversationItemCreatedEvent.Builder
item(ConversationItem item)
A single item within a Realtime conversation. final ConversationItemCreatedEvent.Builder
item(JsonField<ConversationItem> item)
Sets Builder.item to an arbitrary JSON value. final ConversationItemCreatedEvent.Builder
item(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage)
.final ConversationItemCreatedEvent.Builder
item(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage)
.final ConversationItemCreatedEvent.Builder
item(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage)
.final ConversationItemCreatedEvent.Builder
item(RealtimeConversationItemFunctionCall functionCall)
Alias for calling item with ConversationItem.ofFunctionCall(functionCall)
.final ConversationItemCreatedEvent.Builder
item(RealtimeConversationItemFunctionCallOutput functionCallOutput)
Alias for calling item with ConversationItem.ofFunctionCallOutput(functionCallOutput)
.final ConversationItemCreatedEvent.Builder
item(RealtimeMcpApprovalResponse mcpApprovalResponse)
Alias for calling item with ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse)
.final ConversationItemCreatedEvent.Builder
item(RealtimeMcpListTools mcpListTools)
Alias for calling item with ConversationItem.ofMcpListTools(mcpListTools)
.final ConversationItemCreatedEvent.Builder
item(RealtimeMcpToolCall mcpCall)
Alias for calling item with ConversationItem.ofMcpCall(mcpCall)
.final ConversationItemCreatedEvent.Builder
item(RealtimeMcpApprovalRequest mcpApprovalRequest)
Alias for calling item with ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest)
.final ConversationItemCreatedEvent.Builder
realtimeConversationItemSystemMessageItem(List<RealtimeConversationItemSystemMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemSystemMessage.builder() .content(content) .build()
final ConversationItemCreatedEvent.Builder
realtimeConversationItemUserMessageItem(List<RealtimeConversationItemUserMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemUserMessage.builder() .content(content) .build()
final ConversationItemCreatedEvent.Builder
realtimeConversationItemAssistantMessageItem(List<RealtimeConversationItemAssistantMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemAssistantMessage.builder() .content(content) .build()
final ConversationItemCreatedEvent.Builder
type(JsonValue type)
Sets the field to an arbitrary JSON value. final ConversationItemCreatedEvent.Builder
previousItemId(String previousItemId)
The ID of the preceding item in the Conversation context, allows the client to understand the order of the conversation. final ConversationItemCreatedEvent.Builder
previousItemId(Optional<String> previousItemId)
Alias for calling Builder.previousItemId with previousItemId.orElse(null)
.final ConversationItemCreatedEvent.Builder
previousItemId(JsonField<String> previousItemId)
Sets Builder.previousItemId to an arbitrary JSON value. final ConversationItemCreatedEvent.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final ConversationItemCreatedEvent.Builder
putAdditionalProperty(String key, JsonValue value)
final ConversationItemCreatedEvent.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final ConversationItemCreatedEvent.Builder
removeAdditionalProperty(String key)
final ConversationItemCreatedEvent.Builder
removeAllAdditionalProperties(Set<String> keys)
final ConversationItemCreatedEvent
build()
Returns an immutable instance of ConversationItemCreatedEvent. -
-
Method Detail
-
eventId
final ConversationItemCreatedEvent.Builder eventId(String eventId)
The unique ID of the server event.
-
eventId
final ConversationItemCreatedEvent.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.
-
item
final ConversationItemCreatedEvent.Builder item(ConversationItem item)
A single item within a Realtime conversation.
-
item
final ConversationItemCreatedEvent.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 ConversationItemCreatedEvent.Builder item(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeConversationItemFunctionCall functionCall)
Alias for calling item with
ConversationItem.ofFunctionCall(functionCall)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeConversationItemFunctionCallOutput functionCallOutput)
Alias for calling item with
ConversationItem.ofFunctionCallOutput(functionCallOutput)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeMcpApprovalResponse mcpApprovalResponse)
Alias for calling item with
ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeMcpListTools mcpListTools)
Alias for calling item with
ConversationItem.ofMcpListTools(mcpListTools)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeMcpToolCall mcpCall)
Alias for calling item with
ConversationItem.ofMcpCall(mcpCall)
.
-
item
final ConversationItemCreatedEvent.Builder item(RealtimeMcpApprovalRequest mcpApprovalRequest)
Alias for calling item with
ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest)
.
-
realtimeConversationItemSystemMessageItem
final ConversationItemCreatedEvent.Builder realtimeConversationItemSystemMessageItem(List<RealtimeConversationItemSystemMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemSystemMessage.builder() .content(content) .build()
-
realtimeConversationItemUserMessageItem
final ConversationItemCreatedEvent.Builder realtimeConversationItemUserMessageItem(List<RealtimeConversationItemUserMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemUserMessage.builder() .content(content) .build()
-
realtimeConversationItemAssistantMessageItem
final ConversationItemCreatedEvent.Builder realtimeConversationItemAssistantMessageItem(List<RealtimeConversationItemAssistantMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemAssistantMessage.builder() .content(content) .build()
-
type
final ConversationItemCreatedEvent.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.created")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
previousItemId
final ConversationItemCreatedEvent.Builder previousItemId(String previousItemId)
The ID of the preceding item in the Conversation context, allows the client to understand the order of the conversation. Can be
null
if the item has no predecessor.
-
previousItemId
final ConversationItemCreatedEvent.Builder previousItemId(Optional<String> previousItemId)
Alias for calling Builder.previousItemId with
previousItemId.orElse(null)
.
-
previousItemId
final ConversationItemCreatedEvent.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 ConversationItemCreatedEvent.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ConversationItemCreatedEvent.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ConversationItemCreatedEvent.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ConversationItemCreatedEvent.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ConversationItemCreatedEvent.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ConversationItemCreatedEvent build()
Returns an immutable instance of ConversationItemCreatedEvent.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.eventId() .item()
-
-
-
-