Class ConversationItem
-
- All Implemented Interfaces:
public final class ConversationItemA single item within a Realtime conversation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceConversationItem.VisitorAn interface that defines how to map each variant of ConversationItem to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<RealtimeConversationItemSystemMessage>realtimeConversationItemSystemMessage()A system message in a Realtime conversation can be used to provide additional context or instructions to the model. final Optional<RealtimeConversationItemUserMessage>realtimeConversationItemUserMessage()A user message item in a Realtime conversation. final Optional<RealtimeConversationItemAssistantMessage>realtimeConversationItemAssistantMessage()An assistant message item in a Realtime conversation. final Optional<RealtimeConversationItemFunctionCall>functionCall()A function call item in a Realtime conversation. final Optional<RealtimeConversationItemFunctionCallOutput>functionCallOutput()A function call output item in a Realtime conversation. final Optional<RealtimeMcpApprovalResponse>mcpApprovalResponse()A Realtime item responding to an MCP approval request. final Optional<RealtimeMcpListTools>mcpListTools()A Realtime item listing tools available on an MCP server. final Optional<RealtimeMcpToolCall>mcpCall()A Realtime item representing an invocation of a tool on an MCP server. final Optional<RealtimeMcpApprovalRequest>mcpApprovalRequest()A Realtime item requesting human approval of a tool invocation. final BooleanisRealtimeConversationItemSystemMessage()final BooleanisRealtimeConversationItemUserMessage()final BooleanisRealtimeConversationItemAssistantMessage()final BooleanisFunctionCall()final BooleanisFunctionCallOutput()final BooleanisMcpApprovalResponse()final BooleanisMcpListTools()final BooleanisMcpCall()final BooleanisMcpApprovalRequest()final RealtimeConversationItemSystemMessageasRealtimeConversationItemSystemMessage()A system message in a Realtime conversation can be used to provide additional context or instructions to the model. final RealtimeConversationItemUserMessageasRealtimeConversationItemUserMessage()A user message item in a Realtime conversation. final RealtimeConversationItemAssistantMessageasRealtimeConversationItemAssistantMessage()An assistant message item in a Realtime conversation. final RealtimeConversationItemFunctionCallasFunctionCall()A function call item in a Realtime conversation. final RealtimeConversationItemFunctionCallOutputasFunctionCallOutput()A function call output item in a Realtime conversation. final RealtimeMcpApprovalResponseasMcpApprovalResponse()A Realtime item responding to an MCP approval request. final RealtimeMcpListToolsasMcpListTools()A Realtime item listing tools available on an MCP server. final RealtimeMcpToolCallasMcpCall()A Realtime item representing an invocation of a tool on an MCP server. final RealtimeMcpApprovalRequestasMcpApprovalRequest()A Realtime item requesting human approval of a tool invocation. final Optional<JsonValue>_json()final <T extends Any> Taccept(ConversationItem.Visitor<T> visitor)final ConversationItemvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ConversationItemofRealtimeConversationItemSystemMessage(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)A system message in a Realtime conversation can be used to provide additional context or instructions to the model. final static ConversationItemofRealtimeConversationItemUserMessage(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)A user message item in a Realtime conversation. final static ConversationItemofRealtimeConversationItemAssistantMessage(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)An assistant message item in a Realtime conversation. final static ConversationItemofFunctionCall(RealtimeConversationItemFunctionCall functionCall)A function call item in a Realtime conversation. final static ConversationItemofFunctionCallOutput(RealtimeConversationItemFunctionCallOutput functionCallOutput)A function call output item in a Realtime conversation. final static ConversationItemofMcpApprovalResponse(RealtimeMcpApprovalResponse mcpApprovalResponse)A Realtime item responding to an MCP approval request. final static ConversationItemofMcpListTools(RealtimeMcpListTools mcpListTools)A Realtime item listing tools available on an MCP server. final static ConversationItemofMcpCall(RealtimeMcpToolCall mcpCall)A Realtime item representing an invocation of a tool on an MCP server. final static ConversationItemofMcpApprovalRequest(RealtimeMcpApprovalRequest mcpApprovalRequest)A Realtime item requesting human approval of a tool invocation. -
-
Method Detail
-
realtimeConversationItemSystemMessage
final Optional<RealtimeConversationItemSystemMessage> realtimeConversationItemSystemMessage()
A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. "the user is now asking about a different topic"), use system messages.
-
realtimeConversationItemUserMessage
final Optional<RealtimeConversationItemUserMessage> realtimeConversationItemUserMessage()
A user message item in a Realtime conversation.
-
realtimeConversationItemAssistantMessage
final Optional<RealtimeConversationItemAssistantMessage> realtimeConversationItemAssistantMessage()
An assistant message item in a Realtime conversation.
-
functionCall
final Optional<RealtimeConversationItemFunctionCall> functionCall()
A function call item in a Realtime conversation.
-
functionCallOutput
final Optional<RealtimeConversationItemFunctionCallOutput> functionCallOutput()
A function call output item in a Realtime conversation.
-
mcpApprovalResponse
final Optional<RealtimeMcpApprovalResponse> mcpApprovalResponse()
A Realtime item responding to an MCP approval request.
-
mcpListTools
final Optional<RealtimeMcpListTools> mcpListTools()
A Realtime item listing tools available on an MCP server.
-
mcpCall
final Optional<RealtimeMcpToolCall> mcpCall()
A Realtime item representing an invocation of a tool on an MCP server.
-
mcpApprovalRequest
final Optional<RealtimeMcpApprovalRequest> mcpApprovalRequest()
A Realtime item requesting human approval of a tool invocation.
-
isRealtimeConversationItemSystemMessage
final Boolean isRealtimeConversationItemSystemMessage()
-
isRealtimeConversationItemUserMessage
final Boolean isRealtimeConversationItemUserMessage()
-
isRealtimeConversationItemAssistantMessage
final Boolean isRealtimeConversationItemAssistantMessage()
-
isFunctionCall
final Boolean isFunctionCall()
-
isFunctionCallOutput
final Boolean isFunctionCallOutput()
-
isMcpApprovalResponse
final Boolean isMcpApprovalResponse()
-
isMcpListTools
final Boolean isMcpListTools()
-
isMcpApprovalRequest
final Boolean isMcpApprovalRequest()
-
asRealtimeConversationItemSystemMessage
final RealtimeConversationItemSystemMessage asRealtimeConversationItemSystemMessage()
A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. "the user is now asking about a different topic"), use system messages.
-
asRealtimeConversationItemUserMessage
final RealtimeConversationItemUserMessage asRealtimeConversationItemUserMessage()
A user message item in a Realtime conversation.
-
asRealtimeConversationItemAssistantMessage
final RealtimeConversationItemAssistantMessage asRealtimeConversationItemAssistantMessage()
An assistant message item in a Realtime conversation.
-
asFunctionCall
final RealtimeConversationItemFunctionCall asFunctionCall()
A function call item in a Realtime conversation.
-
asFunctionCallOutput
final RealtimeConversationItemFunctionCallOutput asFunctionCallOutput()
A function call output item in a Realtime conversation.
-
asMcpApprovalResponse
final RealtimeMcpApprovalResponse asMcpApprovalResponse()
A Realtime item responding to an MCP approval request.
-
asMcpListTools
final RealtimeMcpListTools asMcpListTools()
A Realtime item listing tools available on an MCP server.
-
asMcpCall
final RealtimeMcpToolCall asMcpCall()
A Realtime item representing an invocation of a tool on an MCP server.
-
asMcpApprovalRequest
final RealtimeMcpApprovalRequest asMcpApprovalRequest()
A Realtime item requesting human approval of a tool invocation.
-
accept
final <T extends Any> T accept(ConversationItem.Visitor<T> visitor)
-
validate
final ConversationItem validate()
-
ofRealtimeConversationItemSystemMessage
final static ConversationItem ofRealtimeConversationItemSystemMessage(RealtimeConversationItemSystemMessage realtimeConversationItemSystemMessage)
A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. "the user is now asking about a different topic"), use system messages.
-
ofRealtimeConversationItemUserMessage
final static ConversationItem ofRealtimeConversationItemUserMessage(RealtimeConversationItemUserMessage realtimeConversationItemUserMessage)
A user message item in a Realtime conversation.
-
ofRealtimeConversationItemAssistantMessage
final static ConversationItem ofRealtimeConversationItemAssistantMessage(RealtimeConversationItemAssistantMessage realtimeConversationItemAssistantMessage)
An assistant message item in a Realtime conversation.
-
ofFunctionCall
final static ConversationItem ofFunctionCall(RealtimeConversationItemFunctionCall functionCall)
A function call item in a Realtime conversation.
-
ofFunctionCallOutput
final static ConversationItem ofFunctionCallOutput(RealtimeConversationItemFunctionCallOutput functionCallOutput)
A function call output item in a Realtime conversation.
-
ofMcpApprovalResponse
final static ConversationItem ofMcpApprovalResponse(RealtimeMcpApprovalResponse mcpApprovalResponse)
A Realtime item responding to an MCP approval request.
-
ofMcpListTools
final static ConversationItem ofMcpListTools(RealtimeMcpListTools mcpListTools)
A Realtime item listing tools available on an MCP server.
-
ofMcpCall
final static ConversationItem ofMcpCall(RealtimeMcpToolCall mcpCall)
A Realtime item representing an invocation of a tool on an MCP server.
-
ofMcpApprovalRequest
final static ConversationItem ofMcpApprovalRequest(RealtimeMcpApprovalRequest mcpApprovalRequest)
A Realtime item requesting human approval of a tool invocation.
-
-
-
-