Class ResponseOutputItemDoneEvent.Builder
-
- All Implemented Interfaces:
public final class ResponseOutputItemDoneEvent.Builder
A builder for ResponseOutputItemDoneEvent.
-
-
Method Summary
Modifier and Type Method Description final ResponseOutputItemDoneEvent.Builder
eventId(String eventId)
The unique ID of the server event. final ResponseOutputItemDoneEvent.Builder
eventId(JsonField<String> eventId)
Sets Builder.eventId to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
item(ConversationItem item)
A single item within a Realtime conversation. final ResponseOutputItemDoneEvent.Builder
item(JsonField<ConversationItem> item)
Sets Builder.item to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
item(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
Alias for calling item with ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeConversationItemFunctionCall functionCall)
Alias for calling item with ConversationItem.ofFunctionCall(functionCall)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeConversationItemFunctionCallOutput functionCallOutput)
Alias for calling item with ConversationItem.ofFunctionCallOutput(functionCallOutput)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeMcpApprovalResponse mcpApprovalResponse)
Alias for calling item with ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeMcpListTools mcpListTools)
Alias for calling item with ConversationItem.ofMcpListTools(mcpListTools)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeMcpToolCall mcpToolCall)
Alias for calling item with ConversationItem.ofMcpToolCall(mcpToolCall)
.final ResponseOutputItemDoneEvent.Builder
item(RealtimeMcpApprovalRequest mcpApprovalRequest)
Alias for calling item with ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest)
.final ResponseOutputItemDoneEvent.Builder
realtimeConversationItemSystemMessageItem(List<RealtimeConversationItemSystemMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemSystemMessage.builder() .content(content) .build()
final ResponseOutputItemDoneEvent.Builder
realtimeConversationItemUserMessageItem(List<RealtimeConversationItemUserMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemUserMessage.builder() .content(content) .build()
final ResponseOutputItemDoneEvent.Builder
realtimeConversationItemAssistantMessageItem(List<RealtimeConversationItemAssistantMessage.Content> content)
Alias for calling item with the following: RealtimeConversationItemAssistantMessage.builder() .content(content) .build()
final ResponseOutputItemDoneEvent.Builder
outputIndex(Long outputIndex)
The index of the output item in the Response. final ResponseOutputItemDoneEvent.Builder
outputIndex(JsonField<Long> outputIndex)
Sets Builder.outputIndex to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
responseId(String responseId)
The ID of the Response to which the item belongs. final ResponseOutputItemDoneEvent.Builder
responseId(JsonField<String> responseId)
Sets Builder.responseId to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
type(JsonValue type)
Sets the field to an arbitrary JSON value. final ResponseOutputItemDoneEvent.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final ResponseOutputItemDoneEvent.Builder
putAdditionalProperty(String key, JsonValue value)
final ResponseOutputItemDoneEvent.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final ResponseOutputItemDoneEvent.Builder
removeAdditionalProperty(String key)
final ResponseOutputItemDoneEvent.Builder
removeAllAdditionalProperties(Set<String> keys)
final ResponseOutputItemDoneEvent
build()
Returns an immutable instance of ResponseOutputItemDoneEvent. -
-
Method Detail
-
eventId
final ResponseOutputItemDoneEvent.Builder eventId(String eventId)
The unique ID of the server event.
-
eventId
final ResponseOutputItemDoneEvent.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 ResponseOutputItemDoneEvent.Builder item(ConversationItem item)
A single item within a Realtime conversation.
-
item
final ResponseOutputItemDoneEvent.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 ResponseOutputItemDoneEvent.Builder item(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemSystemMessage(realtimeConversationItemSystemMessage)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemUserMessage(realtimeConversationItemUserMessage)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
Alias for calling item with
ConversationItem.ofRealtimeConversationItemAssistantMessage(realtimeConversationItemAssistantMessage)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeConversationItemFunctionCall functionCall)
Alias for calling item with
ConversationItem.ofFunctionCall(functionCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeConversationItemFunctionCallOutput functionCallOutput)
Alias for calling item with
ConversationItem.ofFunctionCallOutput(functionCallOutput)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeMcpApprovalResponse mcpApprovalResponse)
Alias for calling item with
ConversationItem.ofMcpApprovalResponse(mcpApprovalResponse)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeMcpListTools mcpListTools)
Alias for calling item with
ConversationItem.ofMcpListTools(mcpListTools)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeMcpToolCall mcpToolCall)
Alias for calling item with
ConversationItem.ofMcpToolCall(mcpToolCall)
.
-
item
final ResponseOutputItemDoneEvent.Builder item(RealtimeMcpApprovalRequest mcpApprovalRequest)
Alias for calling item with
ConversationItem.ofMcpApprovalRequest(mcpApprovalRequest)
.
-
realtimeConversationItemSystemMessageItem
final ResponseOutputItemDoneEvent.Builder realtimeConversationItemSystemMessageItem(List<RealtimeConversationItemSystemMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemSystemMessage.builder() .content(content) .build()
-
realtimeConversationItemUserMessageItem
final ResponseOutputItemDoneEvent.Builder realtimeConversationItemUserMessageItem(List<RealtimeConversationItemUserMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemUserMessage.builder() .content(content) .build()
-
realtimeConversationItemAssistantMessageItem
final ResponseOutputItemDoneEvent.Builder realtimeConversationItemAssistantMessageItem(List<RealtimeConversationItemAssistantMessage.Content> content)
Alias for calling item with the following:
RealtimeConversationItemAssistantMessage.builder() .content(content) .build()
-
outputIndex
final ResponseOutputItemDoneEvent.Builder outputIndex(Long outputIndex)
The index of the output item in the Response.
-
outputIndex
final ResponseOutputItemDoneEvent.Builder outputIndex(JsonField<Long> outputIndex)
Sets Builder.outputIndex to an arbitrary JSON value.
You should usually call Builder.outputIndex with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
responseId
final ResponseOutputItemDoneEvent.Builder responseId(String responseId)
The ID of the Response to which the item belongs.
-
responseId
final ResponseOutputItemDoneEvent.Builder responseId(JsonField<String> responseId)
Sets Builder.responseId to an arbitrary JSON value.
You should usually call Builder.responseId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
type
final ResponseOutputItemDoneEvent.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("response.output_item.done")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final ResponseOutputItemDoneEvent.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final ResponseOutputItemDoneEvent.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final ResponseOutputItemDoneEvent.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final ResponseOutputItemDoneEvent.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final ResponseOutputItemDoneEvent.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final ResponseOutputItemDoneEvent build()
Returns an immutable instance of ResponseOutputItemDoneEvent.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.eventId() .item() .outputIndex() .responseId()
-
-
-
-