Class ResponsesServerEvent
-
- All Implemented Interfaces:
public final class ResponsesServerEventServer events emitted by the Responses WebSocket server.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceResponsesServerEvent.VisitorAn interface that defines how to map each variant of ResponsesServerEvent to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<ResponseAudioDeltaEvent>responseAudioDelta()Emitted when there is a partial audio response. final Optional<ResponseAudioDoneEvent>responseAudioDone()Emitted when the audio response is complete. final Optional<ResponseAudioTranscriptDeltaEvent>responseAudioTranscriptDelta()Emitted when there is a partial transcript of audio. final Optional<ResponseAudioTranscriptDoneEvent>responseAudioTranscriptDone()Emitted when the full audio transcript is completed. final Optional<ResponseCodeInterpreterCallCodeDeltaEvent>responseCodeInterpreterCallCodeDelta()Emitted when a partial code snippet is streamed by the code interpreter. final Optional<ResponseCodeInterpreterCallCodeDoneEvent>responseCodeInterpreterCallCodeDone()Emitted when the code snippet is finalized by the code interpreter. final Optional<ResponseCodeInterpreterCallCompletedEvent>responseCodeInterpreterCallCompleted()Emitted when the code interpreter call is completed. final Optional<ResponseCodeInterpreterCallInProgressEvent>responseCodeInterpreterCallInProgress()Emitted when a code interpreter call is in progress. final Optional<ResponseCodeInterpreterCallInterpretingEvent>responseCodeInterpreterCallInterpreting()Emitted when the code interpreter is actively interpreting the code snippet. final Optional<ResponseCompletedEvent>responseCompleted()Emitted when the model response is complete. final Optional<ResponseContentPartAddedEvent>responseContentPartAdded()Emitted when a new content part is added. final Optional<ResponseContentPartDoneEvent>responseContentPartDone()Emitted when a content part is done. final Optional<ResponseCreatedEvent>responseCreated()An event that is emitted when a response is created. final Optional<ResponseErrorEvent>error()Emitted when an error occurs. final Optional<ResponseFileSearchCallCompletedEvent>responseFileSearchCallCompleted()Emitted when a file search call is completed (results found). final Optional<ResponseFileSearchCallInProgressEvent>responseFileSearchCallInProgress()Emitted when a file search call is initiated. final Optional<ResponseFileSearchCallSearchingEvent>responseFileSearchCallSearching()Emitted when a file search is currently searching. final Optional<ResponseFunctionCallArgumentsDeltaEvent>responseFunctionCallArgumentsDelta()Emitted when there is a partial function-call arguments delta. final Optional<ResponseFunctionCallArgumentsDoneEvent>responseFunctionCallArgumentsDone()Emitted when function-call arguments are finalized. final Optional<ResponseInProgressEvent>responseInProgress()Emitted when the response is in progress. final Optional<ResponseFailedEvent>responseFailed()An event that is emitted when a response fails. final Optional<ResponseIncompleteEvent>responseIncomplete()An event that is emitted when a response finishes as incomplete. final Optional<ResponseOutputItemAddedEvent>responseOutputItemAdded()Emitted when a new output item is added. final Optional<ResponseOutputItemDoneEvent>responseOutputItemDone()Emitted when an output item is marked done. final Optional<ResponseReasoningSummaryPartAddedEvent>responseReasoningSummaryPartAdded()Emitted when a new reasoning summary part is added. final Optional<ResponseReasoningSummaryPartDoneEvent>responseReasoningSummaryPartDone()Emitted when a reasoning summary part is completed. final Optional<ResponseReasoningSummaryTextDeltaEvent>responseReasoningSummaryTextDelta()Emitted when a delta is added to a reasoning summary text. final Optional<ResponseReasoningSummaryTextDoneEvent>responseReasoningSummaryTextDone()Emitted when a reasoning summary text is completed. final Optional<ResponseReasoningTextDeltaEvent>responseReasoningTextDelta()Emitted when a delta is added to a reasoning text. final Optional<ResponseReasoningTextDoneEvent>responseReasoningTextDone()Emitted when a reasoning text is completed. final Optional<ResponseRefusalDeltaEvent>responseRefusalDelta()Emitted when there is a partial refusal text. final Optional<ResponseRefusalDoneEvent>responseRefusalDone()Emitted when refusal text is finalized. final Optional<ResponseTextDeltaEvent>responseOutputTextDelta()Emitted when there is an additional text delta. final Optional<ResponseTextDoneEvent>responseOutputTextDone()Emitted when text content is finalized. final Optional<ResponseWebSearchCallCompletedEvent>responseWebSearchCallCompleted()Emitted when a web search call is completed. final Optional<ResponseWebSearchCallInProgressEvent>responseWebSearchCallInProgress()Emitted when a web search call is initiated. final Optional<ResponseWebSearchCallSearchingEvent>responseWebSearchCallSearching()Emitted when a web search call is executing. final Optional<ResponseImageGenCallCompletedEvent>responseImageGenerationCallCompleted()Emitted when an image generation tool call has completed and the final image is available. final Optional<ResponseImageGenCallGeneratingEvent>responseImageGenerationCallGenerating()Emitted when an image generation tool call is actively generating an image (intermediate state). final Optional<ResponseImageGenCallInProgressEvent>responseImageGenerationCallInProgress()Emitted when an image generation tool call is in progress. final Optional<ResponseImageGenCallPartialImageEvent>responseImageGenerationCallPartialImage()Emitted when a partial image is available during image generation streaming. final Optional<ResponseMcpCallArgumentsDeltaEvent>responseMcpCallArgumentsDelta()Emitted when there is a delta (partial update) to the arguments of an MCP tool call. final Optional<ResponseMcpCallArgumentsDoneEvent>responseMcpCallArgumentsDone()Emitted when the arguments for an MCP tool call are finalized. final Optional<ResponseMcpCallCompletedEvent>responseMcpCallCompleted()Emitted when an MCP tool call has completed successfully. final Optional<ResponseMcpCallFailedEvent>responseMcpCallFailed()Emitted when an MCP tool call has failed. final Optional<ResponseMcpCallInProgressEvent>responseMcpCallInProgress()Emitted when an MCP tool call is in progress. final Optional<ResponseMcpListToolsCompletedEvent>responseMcpListToolsCompleted()Emitted when the list of available MCP tools has been successfully retrieved. final Optional<ResponseMcpListToolsFailedEvent>responseMcpListToolsFailed()Emitted when the attempt to list available MCP tools has failed. final Optional<ResponseMcpListToolsInProgressEvent>responseMcpListToolsInProgress()Emitted when the system is in the process of retrieving the list of available MCP tools. final Optional<ResponseOutputTextAnnotationAddedEvent>responseOutputTextAnnotationAdded()Emitted when an annotation is added to output text content. final Optional<ResponseQueuedEvent>responseQueued()Emitted when a response is queued and waiting to be processed. final Optional<ResponseCustomToolCallInputDeltaEvent>responseCustomToolCallInputDelta()Event representing a delta (partial update) to the input of a custom tool call. final Optional<ResponseCustomToolCallInputDoneEvent>responseCustomToolCallInputDone()Event indicating that input for a custom tool call is complete. final BooleanisResponseAudioDelta()final BooleanisResponseAudioDone()final BooleanisResponseAudioTranscriptDelta()final BooleanisResponseAudioTranscriptDone()final BooleanisResponseCodeInterpreterCallCodeDelta()final BooleanisResponseCodeInterpreterCallCodeDone()final BooleanisResponseCodeInterpreterCallCompleted()final BooleanisResponseCodeInterpreterCallInProgress()final BooleanisResponseCodeInterpreterCallInterpreting()final BooleanisResponseCompleted()final BooleanisResponseContentPartAdded()final BooleanisResponseContentPartDone()final BooleanisResponseCreated()final BooleanisError()final BooleanisResponseFileSearchCallCompleted()final BooleanisResponseFileSearchCallInProgress()final BooleanisResponseFileSearchCallSearching()final BooleanisResponseFunctionCallArgumentsDelta()final BooleanisResponseFunctionCallArgumentsDone()final BooleanisResponseInProgress()final BooleanisResponseFailed()final BooleanisResponseIncomplete()final BooleanisResponseOutputItemAdded()final BooleanisResponseOutputItemDone()final BooleanisResponseReasoningSummaryPartAdded()final BooleanisResponseReasoningSummaryPartDone()final BooleanisResponseReasoningSummaryTextDelta()final BooleanisResponseReasoningSummaryTextDone()final BooleanisResponseReasoningTextDelta()final BooleanisResponseReasoningTextDone()final BooleanisResponseRefusalDelta()final BooleanisResponseRefusalDone()final BooleanisResponseOutputTextDelta()final BooleanisResponseOutputTextDone()final BooleanisResponseWebSearchCallCompleted()final BooleanisResponseWebSearchCallInProgress()final BooleanisResponseWebSearchCallSearching()final BooleanisResponseImageGenerationCallCompleted()final BooleanisResponseImageGenerationCallGenerating()final BooleanisResponseImageGenerationCallInProgress()final BooleanisResponseImageGenerationCallPartialImage()final BooleanisResponseMcpCallArgumentsDelta()final BooleanisResponseMcpCallArgumentsDone()final BooleanisResponseMcpCallCompleted()final BooleanisResponseMcpCallFailed()final BooleanisResponseMcpCallInProgress()final BooleanisResponseMcpListToolsCompleted()final BooleanisResponseMcpListToolsFailed()final BooleanisResponseMcpListToolsInProgress()final BooleanisResponseOutputTextAnnotationAdded()final BooleanisResponseQueued()final BooleanisResponseCustomToolCallInputDelta()final BooleanisResponseCustomToolCallInputDone()final ResponseAudioDeltaEventasResponseAudioDelta()Emitted when there is a partial audio response. final ResponseAudioDoneEventasResponseAudioDone()Emitted when the audio response is complete. final ResponseAudioTranscriptDeltaEventasResponseAudioTranscriptDelta()Emitted when there is a partial transcript of audio. final ResponseAudioTranscriptDoneEventasResponseAudioTranscriptDone()Emitted when the full audio transcript is completed. final ResponseCodeInterpreterCallCodeDeltaEventasResponseCodeInterpreterCallCodeDelta()Emitted when a partial code snippet is streamed by the code interpreter. final ResponseCodeInterpreterCallCodeDoneEventasResponseCodeInterpreterCallCodeDone()Emitted when the code snippet is finalized by the code interpreter. final ResponseCodeInterpreterCallCompletedEventasResponseCodeInterpreterCallCompleted()Emitted when the code interpreter call is completed. final ResponseCodeInterpreterCallInProgressEventasResponseCodeInterpreterCallInProgress()Emitted when a code interpreter call is in progress. final ResponseCodeInterpreterCallInterpretingEventasResponseCodeInterpreterCallInterpreting()Emitted when the code interpreter is actively interpreting the code snippet. final ResponseCompletedEventasResponseCompleted()Emitted when the model response is complete. final ResponseContentPartAddedEventasResponseContentPartAdded()Emitted when a new content part is added. final ResponseContentPartDoneEventasResponseContentPartDone()Emitted when a content part is done. final ResponseCreatedEventasResponseCreated()An event that is emitted when a response is created. final ResponseErrorEventasError()Emitted when an error occurs. final ResponseFileSearchCallCompletedEventasResponseFileSearchCallCompleted()Emitted when a file search call is completed (results found). final ResponseFileSearchCallInProgressEventasResponseFileSearchCallInProgress()Emitted when a file search call is initiated. final ResponseFileSearchCallSearchingEventasResponseFileSearchCallSearching()Emitted when a file search is currently searching. final ResponseFunctionCallArgumentsDeltaEventasResponseFunctionCallArgumentsDelta()Emitted when there is a partial function-call arguments delta. final ResponseFunctionCallArgumentsDoneEventasResponseFunctionCallArgumentsDone()Emitted when function-call arguments are finalized. final ResponseInProgressEventasResponseInProgress()Emitted when the response is in progress. final ResponseFailedEventasResponseFailed()An event that is emitted when a response fails. final ResponseIncompleteEventasResponseIncomplete()An event that is emitted when a response finishes as incomplete. final ResponseOutputItemAddedEventasResponseOutputItemAdded()Emitted when a new output item is added. final ResponseOutputItemDoneEventasResponseOutputItemDone()Emitted when an output item is marked done. final ResponseReasoningSummaryPartAddedEventasResponseReasoningSummaryPartAdded()Emitted when a new reasoning summary part is added. final ResponseReasoningSummaryPartDoneEventasResponseReasoningSummaryPartDone()Emitted when a reasoning summary part is completed. final ResponseReasoningSummaryTextDeltaEventasResponseReasoningSummaryTextDelta()Emitted when a delta is added to a reasoning summary text. final ResponseReasoningSummaryTextDoneEventasResponseReasoningSummaryTextDone()Emitted when a reasoning summary text is completed. final ResponseReasoningTextDeltaEventasResponseReasoningTextDelta()Emitted when a delta is added to a reasoning text. final ResponseReasoningTextDoneEventasResponseReasoningTextDone()Emitted when a reasoning text is completed. final ResponseRefusalDeltaEventasResponseRefusalDelta()Emitted when there is a partial refusal text. final ResponseRefusalDoneEventasResponseRefusalDone()Emitted when refusal text is finalized. final ResponseTextDeltaEventasResponseOutputTextDelta()Emitted when there is an additional text delta. final ResponseTextDoneEventasResponseOutputTextDone()Emitted when text content is finalized. final ResponseWebSearchCallCompletedEventasResponseWebSearchCallCompleted()Emitted when a web search call is completed. final ResponseWebSearchCallInProgressEventasResponseWebSearchCallInProgress()Emitted when a web search call is initiated. final ResponseWebSearchCallSearchingEventasResponseWebSearchCallSearching()Emitted when a web search call is executing. final ResponseImageGenCallCompletedEventasResponseImageGenerationCallCompleted()Emitted when an image generation tool call has completed and the final image is available. final ResponseImageGenCallGeneratingEventasResponseImageGenerationCallGenerating()Emitted when an image generation tool call is actively generating an image (intermediate state). final ResponseImageGenCallInProgressEventasResponseImageGenerationCallInProgress()Emitted when an image generation tool call is in progress. final ResponseImageGenCallPartialImageEventasResponseImageGenerationCallPartialImage()Emitted when a partial image is available during image generation streaming. final ResponseMcpCallArgumentsDeltaEventasResponseMcpCallArgumentsDelta()Emitted when there is a delta (partial update) to the arguments of an MCP tool call. final ResponseMcpCallArgumentsDoneEventasResponseMcpCallArgumentsDone()Emitted when the arguments for an MCP tool call are finalized. final ResponseMcpCallCompletedEventasResponseMcpCallCompleted()Emitted when an MCP tool call has completed successfully. final ResponseMcpCallFailedEventasResponseMcpCallFailed()Emitted when an MCP tool call has failed. final ResponseMcpCallInProgressEventasResponseMcpCallInProgress()Emitted when an MCP tool call is in progress. final ResponseMcpListToolsCompletedEventasResponseMcpListToolsCompleted()Emitted when the list of available MCP tools has been successfully retrieved. final ResponseMcpListToolsFailedEventasResponseMcpListToolsFailed()Emitted when the attempt to list available MCP tools has failed. final ResponseMcpListToolsInProgressEventasResponseMcpListToolsInProgress()Emitted when the system is in the process of retrieving the list of available MCP tools. final ResponseOutputTextAnnotationAddedEventasResponseOutputTextAnnotationAdded()Emitted when an annotation is added to output text content. final ResponseQueuedEventasResponseQueued()Emitted when a response is queued and waiting to be processed. final ResponseCustomToolCallInputDeltaEventasResponseCustomToolCallInputDelta()Event representing a delta (partial update) to the input of a custom tool call. final ResponseCustomToolCallInputDoneEventasResponseCustomToolCallInputDone()Event indicating that input for a custom tool call is complete. final Optional<JsonValue>_json()final <T extends Any> Taccept(ResponsesServerEvent.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final ResponsesServerEventvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponsesServerEventofResponseAudioDelta(ResponseAudioDeltaEvent responseAudioDelta)Emitted when there is a partial audio response. final static ResponsesServerEventofResponseAudioDone(ResponseAudioDoneEvent responseAudioDone)Emitted when the audio response is complete. final static ResponsesServerEventofResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent responseAudioTranscriptDelta)Emitted when there is a partial transcript of audio. final static ResponsesServerEventofResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent responseAudioTranscriptDone)Emitted when the full audio transcript is completed. final static ResponsesServerEventofResponseCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDeltaEvent responseCodeInterpreterCallCodeDelta)Emitted when a partial code snippet is streamed by the code interpreter. final static ResponsesServerEventofResponseCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDoneEvent responseCodeInterpreterCallCodeDone)Emitted when the code snippet is finalized by the code interpreter. final static ResponsesServerEventofResponseCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompletedEvent responseCodeInterpreterCallCompleted)Emitted when the code interpreter call is completed. final static ResponsesServerEventofResponseCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgressEvent responseCodeInterpreterCallInProgress)Emitted when a code interpreter call is in progress. final static ResponsesServerEventofResponseCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpretingEvent responseCodeInterpreterCallInterpreting)Emitted when the code interpreter is actively interpreting the code snippet. final static ResponsesServerEventofResponseCompleted(ResponseCompletedEvent responseCompleted)Emitted when the model response is complete. final static ResponsesServerEventofResponseContentPartAdded(ResponseContentPartAddedEvent responseContentPartAdded)Emitted when a new content part is added. final static ResponsesServerEventofResponseContentPartDone(ResponseContentPartDoneEvent responseContentPartDone)Emitted when a content part is done. final static ResponsesServerEventofResponseCreated(ResponseCreatedEvent responseCreated)An event that is emitted when a response is created. final static ResponsesServerEventofError(ResponseErrorEvent error)Emitted when an error occurs. final static ResponsesServerEventofResponseFileSearchCallCompleted(ResponseFileSearchCallCompletedEvent responseFileSearchCallCompleted)Emitted when a file search call is completed (results found). final static ResponsesServerEventofResponseFileSearchCallInProgress(ResponseFileSearchCallInProgressEvent responseFileSearchCallInProgress)Emitted when a file search call is initiated. final static ResponsesServerEventofResponseFileSearchCallSearching(ResponseFileSearchCallSearchingEvent responseFileSearchCallSearching)Emitted when a file search is currently searching. final static ResponsesServerEventofResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent responseFunctionCallArgumentsDelta)Emitted when there is a partial function-call arguments delta. final static ResponsesServerEventofResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent responseFunctionCallArgumentsDone)Emitted when function-call arguments are finalized. final static ResponsesServerEventofResponseInProgress(ResponseInProgressEvent responseInProgress)Emitted when the response is in progress. final static ResponsesServerEventofResponseFailed(ResponseFailedEvent responseFailed)An event that is emitted when a response fails. final static ResponsesServerEventofResponseIncomplete(ResponseIncompleteEvent responseIncomplete)An event that is emitted when a response finishes as incomplete. final static ResponsesServerEventofResponseOutputItemAdded(ResponseOutputItemAddedEvent responseOutputItemAdded)Emitted when a new output item is added. final static ResponsesServerEventofResponseOutputItemDone(ResponseOutputItemDoneEvent responseOutputItemDone)Emitted when an output item is marked done. final static ResponsesServerEventofResponseReasoningSummaryPartAdded(ResponseReasoningSummaryPartAddedEvent responseReasoningSummaryPartAdded)Emitted when a new reasoning summary part is added. final static ResponsesServerEventofResponseReasoningSummaryPartDone(ResponseReasoningSummaryPartDoneEvent responseReasoningSummaryPartDone)Emitted when a reasoning summary part is completed. final static ResponsesServerEventofResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDeltaEvent responseReasoningSummaryTextDelta)Emitted when a delta is added to a reasoning summary text. final static ResponsesServerEventofResponseReasoningSummaryTextDone(ResponseReasoningSummaryTextDoneEvent responseReasoningSummaryTextDone)Emitted when a reasoning summary text is completed. final static ResponsesServerEventofResponseReasoningTextDelta(ResponseReasoningTextDeltaEvent responseReasoningTextDelta)Emitted when a delta is added to a reasoning text. final static ResponsesServerEventofResponseReasoningTextDone(ResponseReasoningTextDoneEvent responseReasoningTextDone)Emitted when a reasoning text is completed. final static ResponsesServerEventofResponseRefusalDelta(ResponseRefusalDeltaEvent responseRefusalDelta)Emitted when there is a partial refusal text. final static ResponsesServerEventofResponseRefusalDone(ResponseRefusalDoneEvent responseRefusalDone)Emitted when refusal text is finalized. final static ResponsesServerEventofResponseOutputTextDelta(ResponseTextDeltaEvent responseOutputTextDelta)Emitted when there is an additional text delta. final static ResponsesServerEventofResponseOutputTextDone(ResponseTextDoneEvent responseOutputTextDone)Emitted when text content is finalized. final static ResponsesServerEventofResponseWebSearchCallCompleted(ResponseWebSearchCallCompletedEvent responseWebSearchCallCompleted)Emitted when a web search call is completed. final static ResponsesServerEventofResponseWebSearchCallInProgress(ResponseWebSearchCallInProgressEvent responseWebSearchCallInProgress)Emitted when a web search call is initiated. final static ResponsesServerEventofResponseWebSearchCallSearching(ResponseWebSearchCallSearchingEvent responseWebSearchCallSearching)Emitted when a web search call is executing. final static ResponsesServerEventofResponseImageGenerationCallCompleted(ResponseImageGenCallCompletedEvent responseImageGenerationCallCompleted)Emitted when an image generation tool call has completed and the final image is available. final static ResponsesServerEventofResponseImageGenerationCallGenerating(ResponseImageGenCallGeneratingEvent responseImageGenerationCallGenerating)Emitted when an image generation tool call is actively generating an image (intermediate state). final static ResponsesServerEventofResponseImageGenerationCallInProgress(ResponseImageGenCallInProgressEvent responseImageGenerationCallInProgress)Emitted when an image generation tool call is in progress. final static ResponsesServerEventofResponseImageGenerationCallPartialImage(ResponseImageGenCallPartialImageEvent responseImageGenerationCallPartialImage)Emitted when a partial image is available during image generation streaming. final static ResponsesServerEventofResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDeltaEvent responseMcpCallArgumentsDelta)Emitted when there is a delta (partial update) to the arguments of an MCP tool call. final static ResponsesServerEventofResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDoneEvent responseMcpCallArgumentsDone)Emitted when the arguments for an MCP tool call are finalized. final static ResponsesServerEventofResponseMcpCallCompleted(ResponseMcpCallCompletedEvent responseMcpCallCompleted)Emitted when an MCP tool call has completed successfully. final static ResponsesServerEventofResponseMcpCallFailed(ResponseMcpCallFailedEvent responseMcpCallFailed)Emitted when an MCP tool call has failed. final static ResponsesServerEventofResponseMcpCallInProgress(ResponseMcpCallInProgressEvent responseMcpCallInProgress)Emitted when an MCP tool call is in progress. final static ResponsesServerEventofResponseMcpListToolsCompleted(ResponseMcpListToolsCompletedEvent responseMcpListToolsCompleted)Emitted when the list of available MCP tools has been successfully retrieved. final static ResponsesServerEventofResponseMcpListToolsFailed(ResponseMcpListToolsFailedEvent responseMcpListToolsFailed)Emitted when the attempt to list available MCP tools has failed. final static ResponsesServerEventofResponseMcpListToolsInProgress(ResponseMcpListToolsInProgressEvent responseMcpListToolsInProgress)Emitted when the system is in the process of retrieving the list of available MCP tools. final static ResponsesServerEventofResponseOutputTextAnnotationAdded(ResponseOutputTextAnnotationAddedEvent responseOutputTextAnnotationAdded)Emitted when an annotation is added to output text content. final static ResponsesServerEventofResponseQueued(ResponseQueuedEvent responseQueued)Emitted when a response is queued and waiting to be processed. final static ResponsesServerEventofResponseCustomToolCallInputDelta(ResponseCustomToolCallInputDeltaEvent responseCustomToolCallInputDelta)Event representing a delta (partial update) to the input of a custom tool call. final static ResponsesServerEventofResponseCustomToolCallInputDone(ResponseCustomToolCallInputDoneEvent responseCustomToolCallInputDone)Event indicating that input for a custom tool call is complete. -
-
Method Detail
-
responseAudioDelta
final Optional<ResponseAudioDeltaEvent> responseAudioDelta()
Emitted when there is a partial audio response.
-
responseAudioDone
final Optional<ResponseAudioDoneEvent> responseAudioDone()
Emitted when the audio response is complete.
-
responseAudioTranscriptDelta
final Optional<ResponseAudioTranscriptDeltaEvent> responseAudioTranscriptDelta()
Emitted when there is a partial transcript of audio.
-
responseAudioTranscriptDone
final Optional<ResponseAudioTranscriptDoneEvent> responseAudioTranscriptDone()
Emitted when the full audio transcript is completed.
-
responseCodeInterpreterCallCodeDelta
final Optional<ResponseCodeInterpreterCallCodeDeltaEvent> responseCodeInterpreterCallCodeDelta()
Emitted when a partial code snippet is streamed by the code interpreter.
-
responseCodeInterpreterCallCodeDone
final Optional<ResponseCodeInterpreterCallCodeDoneEvent> responseCodeInterpreterCallCodeDone()
Emitted when the code snippet is finalized by the code interpreter.
-
responseCodeInterpreterCallCompleted
final Optional<ResponseCodeInterpreterCallCompletedEvent> responseCodeInterpreterCallCompleted()
Emitted when the code interpreter call is completed.
-
responseCodeInterpreterCallInProgress
final Optional<ResponseCodeInterpreterCallInProgressEvent> responseCodeInterpreterCallInProgress()
Emitted when a code interpreter call is in progress.
-
responseCodeInterpreterCallInterpreting
final Optional<ResponseCodeInterpreterCallInterpretingEvent> responseCodeInterpreterCallInterpreting()
Emitted when the code interpreter is actively interpreting the code snippet.
-
responseCompleted
final Optional<ResponseCompletedEvent> responseCompleted()
Emitted when the model response is complete.
-
responseContentPartAdded
final Optional<ResponseContentPartAddedEvent> responseContentPartAdded()
Emitted when a new content part is added.
-
responseContentPartDone
final Optional<ResponseContentPartDoneEvent> responseContentPartDone()
Emitted when a content part is done.
-
responseCreated
final Optional<ResponseCreatedEvent> responseCreated()
An event that is emitted when a response is created.
-
error
final Optional<ResponseErrorEvent> error()
Emitted when an error occurs.
-
responseFileSearchCallCompleted
final Optional<ResponseFileSearchCallCompletedEvent> responseFileSearchCallCompleted()
Emitted when a file search call is completed (results found).
-
responseFileSearchCallInProgress
final Optional<ResponseFileSearchCallInProgressEvent> responseFileSearchCallInProgress()
Emitted when a file search call is initiated.
-
responseFileSearchCallSearching
final Optional<ResponseFileSearchCallSearchingEvent> responseFileSearchCallSearching()
Emitted when a file search is currently searching.
-
responseFunctionCallArgumentsDelta
final Optional<ResponseFunctionCallArgumentsDeltaEvent> responseFunctionCallArgumentsDelta()
Emitted when there is a partial function-call arguments delta.
-
responseFunctionCallArgumentsDone
final Optional<ResponseFunctionCallArgumentsDoneEvent> responseFunctionCallArgumentsDone()
Emitted when function-call arguments are finalized.
-
responseInProgress
final Optional<ResponseInProgressEvent> responseInProgress()
Emitted when the response is in progress.
-
responseFailed
final Optional<ResponseFailedEvent> responseFailed()
An event that is emitted when a response fails.
-
responseIncomplete
final Optional<ResponseIncompleteEvent> responseIncomplete()
An event that is emitted when a response finishes as incomplete.
-
responseOutputItemAdded
final Optional<ResponseOutputItemAddedEvent> responseOutputItemAdded()
Emitted when a new output item is added.
-
responseOutputItemDone
final Optional<ResponseOutputItemDoneEvent> responseOutputItemDone()
Emitted when an output item is marked done.
-
responseReasoningSummaryPartAdded
final Optional<ResponseReasoningSummaryPartAddedEvent> responseReasoningSummaryPartAdded()
Emitted when a new reasoning summary part is added.
-
responseReasoningSummaryPartDone
final Optional<ResponseReasoningSummaryPartDoneEvent> responseReasoningSummaryPartDone()
Emitted when a reasoning summary part is completed.
-
responseReasoningSummaryTextDelta
final Optional<ResponseReasoningSummaryTextDeltaEvent> responseReasoningSummaryTextDelta()
Emitted when a delta is added to a reasoning summary text.
-
responseReasoningSummaryTextDone
final Optional<ResponseReasoningSummaryTextDoneEvent> responseReasoningSummaryTextDone()
Emitted when a reasoning summary text is completed.
-
responseReasoningTextDelta
final Optional<ResponseReasoningTextDeltaEvent> responseReasoningTextDelta()
Emitted when a delta is added to a reasoning text.
-
responseReasoningTextDone
final Optional<ResponseReasoningTextDoneEvent> responseReasoningTextDone()
Emitted when a reasoning text is completed.
-
responseRefusalDelta
final Optional<ResponseRefusalDeltaEvent> responseRefusalDelta()
Emitted when there is a partial refusal text.
-
responseRefusalDone
final Optional<ResponseRefusalDoneEvent> responseRefusalDone()
Emitted when refusal text is finalized.
-
responseOutputTextDelta
final Optional<ResponseTextDeltaEvent> responseOutputTextDelta()
Emitted when there is an additional text delta.
-
responseOutputTextDone
final Optional<ResponseTextDoneEvent> responseOutputTextDone()
Emitted when text content is finalized.
-
responseWebSearchCallCompleted
final Optional<ResponseWebSearchCallCompletedEvent> responseWebSearchCallCompleted()
Emitted when a web search call is completed.
-
responseWebSearchCallInProgress
final Optional<ResponseWebSearchCallInProgressEvent> responseWebSearchCallInProgress()
Emitted when a web search call is initiated.
-
responseWebSearchCallSearching
final Optional<ResponseWebSearchCallSearchingEvent> responseWebSearchCallSearching()
Emitted when a web search call is executing.
-
responseImageGenerationCallCompleted
final Optional<ResponseImageGenCallCompletedEvent> responseImageGenerationCallCompleted()
Emitted when an image generation tool call has completed and the final image is available.
-
responseImageGenerationCallGenerating
final Optional<ResponseImageGenCallGeneratingEvent> responseImageGenerationCallGenerating()
Emitted when an image generation tool call is actively generating an image (intermediate state).
-
responseImageGenerationCallInProgress
final Optional<ResponseImageGenCallInProgressEvent> responseImageGenerationCallInProgress()
Emitted when an image generation tool call is in progress.
-
responseImageGenerationCallPartialImage
final Optional<ResponseImageGenCallPartialImageEvent> responseImageGenerationCallPartialImage()
Emitted when a partial image is available during image generation streaming.
-
responseMcpCallArgumentsDelta
final Optional<ResponseMcpCallArgumentsDeltaEvent> responseMcpCallArgumentsDelta()
Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
-
responseMcpCallArgumentsDone
final Optional<ResponseMcpCallArgumentsDoneEvent> responseMcpCallArgumentsDone()
Emitted when the arguments for an MCP tool call are finalized.
-
responseMcpCallCompleted
final Optional<ResponseMcpCallCompletedEvent> responseMcpCallCompleted()
Emitted when an MCP tool call has completed successfully.
-
responseMcpCallFailed
final Optional<ResponseMcpCallFailedEvent> responseMcpCallFailed()
Emitted when an MCP tool call has failed.
-
responseMcpCallInProgress
final Optional<ResponseMcpCallInProgressEvent> responseMcpCallInProgress()
Emitted when an MCP tool call is in progress.
-
responseMcpListToolsCompleted
final Optional<ResponseMcpListToolsCompletedEvent> responseMcpListToolsCompleted()
Emitted when the list of available MCP tools has been successfully retrieved.
-
responseMcpListToolsFailed
final Optional<ResponseMcpListToolsFailedEvent> responseMcpListToolsFailed()
Emitted when the attempt to list available MCP tools has failed.
-
responseMcpListToolsInProgress
final Optional<ResponseMcpListToolsInProgressEvent> responseMcpListToolsInProgress()
Emitted when the system is in the process of retrieving the list of available MCP tools.
-
responseOutputTextAnnotationAdded
final Optional<ResponseOutputTextAnnotationAddedEvent> responseOutputTextAnnotationAdded()
Emitted when an annotation is added to output text content.
-
responseQueued
final Optional<ResponseQueuedEvent> responseQueued()
Emitted when a response is queued and waiting to be processed.
-
responseCustomToolCallInputDelta
final Optional<ResponseCustomToolCallInputDeltaEvent> responseCustomToolCallInputDelta()
Event representing a delta (partial update) to the input of a custom tool call.
-
responseCustomToolCallInputDone
final Optional<ResponseCustomToolCallInputDoneEvent> responseCustomToolCallInputDone()
Event indicating that input for a custom tool call is complete.
-
isResponseAudioDelta
final Boolean isResponseAudioDelta()
-
isResponseAudioDone
final Boolean isResponseAudioDone()
-
isResponseAudioTranscriptDelta
final Boolean isResponseAudioTranscriptDelta()
-
isResponseAudioTranscriptDone
final Boolean isResponseAudioTranscriptDone()
-
isResponseCodeInterpreterCallCodeDelta
final Boolean isResponseCodeInterpreterCallCodeDelta()
-
isResponseCodeInterpreterCallCodeDone
final Boolean isResponseCodeInterpreterCallCodeDone()
-
isResponseCodeInterpreterCallCompleted
final Boolean isResponseCodeInterpreterCallCompleted()
-
isResponseCodeInterpreterCallInProgress
final Boolean isResponseCodeInterpreterCallInProgress()
-
isResponseCodeInterpreterCallInterpreting
final Boolean isResponseCodeInterpreterCallInterpreting()
-
isResponseCompleted
final Boolean isResponseCompleted()
-
isResponseContentPartAdded
final Boolean isResponseContentPartAdded()
-
isResponseContentPartDone
final Boolean isResponseContentPartDone()
-
isResponseCreated
final Boolean isResponseCreated()
-
isResponseFileSearchCallCompleted
final Boolean isResponseFileSearchCallCompleted()
-
isResponseFileSearchCallInProgress
final Boolean isResponseFileSearchCallInProgress()
-
isResponseFileSearchCallSearching
final Boolean isResponseFileSearchCallSearching()
-
isResponseFunctionCallArgumentsDelta
final Boolean isResponseFunctionCallArgumentsDelta()
-
isResponseFunctionCallArgumentsDone
final Boolean isResponseFunctionCallArgumentsDone()
-
isResponseInProgress
final Boolean isResponseInProgress()
-
isResponseFailed
final Boolean isResponseFailed()
-
isResponseIncomplete
final Boolean isResponseIncomplete()
-
isResponseOutputItemAdded
final Boolean isResponseOutputItemAdded()
-
isResponseOutputItemDone
final Boolean isResponseOutputItemDone()
-
isResponseReasoningSummaryPartAdded
final Boolean isResponseReasoningSummaryPartAdded()
-
isResponseReasoningSummaryPartDone
final Boolean isResponseReasoningSummaryPartDone()
-
isResponseReasoningSummaryTextDelta
final Boolean isResponseReasoningSummaryTextDelta()
-
isResponseReasoningSummaryTextDone
final Boolean isResponseReasoningSummaryTextDone()
-
isResponseReasoningTextDelta
final Boolean isResponseReasoningTextDelta()
-
isResponseReasoningTextDone
final Boolean isResponseReasoningTextDone()
-
isResponseRefusalDelta
final Boolean isResponseRefusalDelta()
-
isResponseRefusalDone
final Boolean isResponseRefusalDone()
-
isResponseOutputTextDelta
final Boolean isResponseOutputTextDelta()
-
isResponseOutputTextDone
final Boolean isResponseOutputTextDone()
-
isResponseWebSearchCallCompleted
final Boolean isResponseWebSearchCallCompleted()
-
isResponseWebSearchCallInProgress
final Boolean isResponseWebSearchCallInProgress()
-
isResponseWebSearchCallSearching
final Boolean isResponseWebSearchCallSearching()
-
isResponseImageGenerationCallCompleted
final Boolean isResponseImageGenerationCallCompleted()
-
isResponseImageGenerationCallGenerating
final Boolean isResponseImageGenerationCallGenerating()
-
isResponseImageGenerationCallInProgress
final Boolean isResponseImageGenerationCallInProgress()
-
isResponseImageGenerationCallPartialImage
final Boolean isResponseImageGenerationCallPartialImage()
-
isResponseMcpCallArgumentsDelta
final Boolean isResponseMcpCallArgumentsDelta()
-
isResponseMcpCallArgumentsDone
final Boolean isResponseMcpCallArgumentsDone()
-
isResponseMcpCallCompleted
final Boolean isResponseMcpCallCompleted()
-
isResponseMcpCallFailed
final Boolean isResponseMcpCallFailed()
-
isResponseMcpCallInProgress
final Boolean isResponseMcpCallInProgress()
-
isResponseMcpListToolsCompleted
final Boolean isResponseMcpListToolsCompleted()
-
isResponseMcpListToolsFailed
final Boolean isResponseMcpListToolsFailed()
-
isResponseMcpListToolsInProgress
final Boolean isResponseMcpListToolsInProgress()
-
isResponseOutputTextAnnotationAdded
final Boolean isResponseOutputTextAnnotationAdded()
-
isResponseQueued
final Boolean isResponseQueued()
-
isResponseCustomToolCallInputDelta
final Boolean isResponseCustomToolCallInputDelta()
-
isResponseCustomToolCallInputDone
final Boolean isResponseCustomToolCallInputDone()
-
asResponseAudioDelta
final ResponseAudioDeltaEvent asResponseAudioDelta()
Emitted when there is a partial audio response.
-
asResponseAudioDone
final ResponseAudioDoneEvent asResponseAudioDone()
Emitted when the audio response is complete.
-
asResponseAudioTranscriptDelta
final ResponseAudioTranscriptDeltaEvent asResponseAudioTranscriptDelta()
Emitted when there is a partial transcript of audio.
-
asResponseAudioTranscriptDone
final ResponseAudioTranscriptDoneEvent asResponseAudioTranscriptDone()
Emitted when the full audio transcript is completed.
-
asResponseCodeInterpreterCallCodeDelta
final ResponseCodeInterpreterCallCodeDeltaEvent asResponseCodeInterpreterCallCodeDelta()
Emitted when a partial code snippet is streamed by the code interpreter.
-
asResponseCodeInterpreterCallCodeDone
final ResponseCodeInterpreterCallCodeDoneEvent asResponseCodeInterpreterCallCodeDone()
Emitted when the code snippet is finalized by the code interpreter.
-
asResponseCodeInterpreterCallCompleted
final ResponseCodeInterpreterCallCompletedEvent asResponseCodeInterpreterCallCompleted()
Emitted when the code interpreter call is completed.
-
asResponseCodeInterpreterCallInProgress
final ResponseCodeInterpreterCallInProgressEvent asResponseCodeInterpreterCallInProgress()
Emitted when a code interpreter call is in progress.
-
asResponseCodeInterpreterCallInterpreting
final ResponseCodeInterpreterCallInterpretingEvent asResponseCodeInterpreterCallInterpreting()
Emitted when the code interpreter is actively interpreting the code snippet.
-
asResponseCompleted
final ResponseCompletedEvent asResponseCompleted()
Emitted when the model response is complete.
-
asResponseContentPartAdded
final ResponseContentPartAddedEvent asResponseContentPartAdded()
Emitted when a new content part is added.
-
asResponseContentPartDone
final ResponseContentPartDoneEvent asResponseContentPartDone()
Emitted when a content part is done.
-
asResponseCreated
final ResponseCreatedEvent asResponseCreated()
An event that is emitted when a response is created.
-
asError
final ResponseErrorEvent asError()
Emitted when an error occurs.
-
asResponseFileSearchCallCompleted
final ResponseFileSearchCallCompletedEvent asResponseFileSearchCallCompleted()
Emitted when a file search call is completed (results found).
-
asResponseFileSearchCallInProgress
final ResponseFileSearchCallInProgressEvent asResponseFileSearchCallInProgress()
Emitted when a file search call is initiated.
-
asResponseFileSearchCallSearching
final ResponseFileSearchCallSearchingEvent asResponseFileSearchCallSearching()
Emitted when a file search is currently searching.
-
asResponseFunctionCallArgumentsDelta
final ResponseFunctionCallArgumentsDeltaEvent asResponseFunctionCallArgumentsDelta()
Emitted when there is a partial function-call arguments delta.
-
asResponseFunctionCallArgumentsDone
final ResponseFunctionCallArgumentsDoneEvent asResponseFunctionCallArgumentsDone()
Emitted when function-call arguments are finalized.
-
asResponseInProgress
final ResponseInProgressEvent asResponseInProgress()
Emitted when the response is in progress.
-
asResponseFailed
final ResponseFailedEvent asResponseFailed()
An event that is emitted when a response fails.
-
asResponseIncomplete
final ResponseIncompleteEvent asResponseIncomplete()
An event that is emitted when a response finishes as incomplete.
-
asResponseOutputItemAdded
final ResponseOutputItemAddedEvent asResponseOutputItemAdded()
Emitted when a new output item is added.
-
asResponseOutputItemDone
final ResponseOutputItemDoneEvent asResponseOutputItemDone()
Emitted when an output item is marked done.
-
asResponseReasoningSummaryPartAdded
final ResponseReasoningSummaryPartAddedEvent asResponseReasoningSummaryPartAdded()
Emitted when a new reasoning summary part is added.
-
asResponseReasoningSummaryPartDone
final ResponseReasoningSummaryPartDoneEvent asResponseReasoningSummaryPartDone()
Emitted when a reasoning summary part is completed.
-
asResponseReasoningSummaryTextDelta
final ResponseReasoningSummaryTextDeltaEvent asResponseReasoningSummaryTextDelta()
Emitted when a delta is added to a reasoning summary text.
-
asResponseReasoningSummaryTextDone
final ResponseReasoningSummaryTextDoneEvent asResponseReasoningSummaryTextDone()
Emitted when a reasoning summary text is completed.
-
asResponseReasoningTextDelta
final ResponseReasoningTextDeltaEvent asResponseReasoningTextDelta()
Emitted when a delta is added to a reasoning text.
-
asResponseReasoningTextDone
final ResponseReasoningTextDoneEvent asResponseReasoningTextDone()
Emitted when a reasoning text is completed.
-
asResponseRefusalDelta
final ResponseRefusalDeltaEvent asResponseRefusalDelta()
Emitted when there is a partial refusal text.
-
asResponseRefusalDone
final ResponseRefusalDoneEvent asResponseRefusalDone()
Emitted when refusal text is finalized.
-
asResponseOutputTextDelta
final ResponseTextDeltaEvent asResponseOutputTextDelta()
Emitted when there is an additional text delta.
-
asResponseOutputTextDone
final ResponseTextDoneEvent asResponseOutputTextDone()
Emitted when text content is finalized.
-
asResponseWebSearchCallCompleted
final ResponseWebSearchCallCompletedEvent asResponseWebSearchCallCompleted()
Emitted when a web search call is completed.
-
asResponseWebSearchCallInProgress
final ResponseWebSearchCallInProgressEvent asResponseWebSearchCallInProgress()
Emitted when a web search call is initiated.
-
asResponseWebSearchCallSearching
final ResponseWebSearchCallSearchingEvent asResponseWebSearchCallSearching()
Emitted when a web search call is executing.
-
asResponseImageGenerationCallCompleted
final ResponseImageGenCallCompletedEvent asResponseImageGenerationCallCompleted()
Emitted when an image generation tool call has completed and the final image is available.
-
asResponseImageGenerationCallGenerating
final ResponseImageGenCallGeneratingEvent asResponseImageGenerationCallGenerating()
Emitted when an image generation tool call is actively generating an image (intermediate state).
-
asResponseImageGenerationCallInProgress
final ResponseImageGenCallInProgressEvent asResponseImageGenerationCallInProgress()
Emitted when an image generation tool call is in progress.
-
asResponseImageGenerationCallPartialImage
final ResponseImageGenCallPartialImageEvent asResponseImageGenerationCallPartialImage()
Emitted when a partial image is available during image generation streaming.
-
asResponseMcpCallArgumentsDelta
final ResponseMcpCallArgumentsDeltaEvent asResponseMcpCallArgumentsDelta()
Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
-
asResponseMcpCallArgumentsDone
final ResponseMcpCallArgumentsDoneEvent asResponseMcpCallArgumentsDone()
Emitted when the arguments for an MCP tool call are finalized.
-
asResponseMcpCallCompleted
final ResponseMcpCallCompletedEvent asResponseMcpCallCompleted()
Emitted when an MCP tool call has completed successfully.
-
asResponseMcpCallFailed
final ResponseMcpCallFailedEvent asResponseMcpCallFailed()
Emitted when an MCP tool call has failed.
-
asResponseMcpCallInProgress
final ResponseMcpCallInProgressEvent asResponseMcpCallInProgress()
Emitted when an MCP tool call is in progress.
-
asResponseMcpListToolsCompleted
final ResponseMcpListToolsCompletedEvent asResponseMcpListToolsCompleted()
Emitted when the list of available MCP tools has been successfully retrieved.
-
asResponseMcpListToolsFailed
final ResponseMcpListToolsFailedEvent asResponseMcpListToolsFailed()
Emitted when the attempt to list available MCP tools has failed.
-
asResponseMcpListToolsInProgress
final ResponseMcpListToolsInProgressEvent asResponseMcpListToolsInProgress()
Emitted when the system is in the process of retrieving the list of available MCP tools.
-
asResponseOutputTextAnnotationAdded
final ResponseOutputTextAnnotationAddedEvent asResponseOutputTextAnnotationAdded()
Emitted when an annotation is added to output text content.
-
asResponseQueued
final ResponseQueuedEvent asResponseQueued()
Emitted when a response is queued and waiting to be processed.
-
asResponseCustomToolCallInputDelta
final ResponseCustomToolCallInputDeltaEvent asResponseCustomToolCallInputDelta()
Event representing a delta (partial update) to the input of a custom tool call.
-
asResponseCustomToolCallInputDone
final ResponseCustomToolCallInputDoneEvent asResponseCustomToolCallInputDone()
Event indicating that input for a custom tool call is complete.
-
accept
final <T extends Any> T accept(ResponsesServerEvent.Visitor<T> visitor)
Maps this instance's current variant to a value of type T using the given visitor.
Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = responsesServerEvent.accept(new ResponsesServerEvent.Visitor<Optional<String>>() { @Override public Optional<String> visitResponseAudioDelta(ResponseAudioDeltaEvent responseAudioDelta) { return Optional.of(responseAudioDelta.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final ResponsesServerEvent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
ofResponseAudioDelta
final static ResponsesServerEvent ofResponseAudioDelta(ResponseAudioDeltaEvent responseAudioDelta)
Emitted when there is a partial audio response.
-
ofResponseAudioDone
final static ResponsesServerEvent ofResponseAudioDone(ResponseAudioDoneEvent responseAudioDone)
Emitted when the audio response is complete.
-
ofResponseAudioTranscriptDelta
final static ResponsesServerEvent ofResponseAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent responseAudioTranscriptDelta)
Emitted when there is a partial transcript of audio.
-
ofResponseAudioTranscriptDone
final static ResponsesServerEvent ofResponseAudioTranscriptDone(ResponseAudioTranscriptDoneEvent responseAudioTranscriptDone)
Emitted when the full audio transcript is completed.
-
ofResponseCodeInterpreterCallCodeDelta
final static ResponsesServerEvent ofResponseCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDeltaEvent responseCodeInterpreterCallCodeDelta)
Emitted when a partial code snippet is streamed by the code interpreter.
-
ofResponseCodeInterpreterCallCodeDone
final static ResponsesServerEvent ofResponseCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDoneEvent responseCodeInterpreterCallCodeDone)
Emitted when the code snippet is finalized by the code interpreter.
-
ofResponseCodeInterpreterCallCompleted
final static ResponsesServerEvent ofResponseCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompletedEvent responseCodeInterpreterCallCompleted)
Emitted when the code interpreter call is completed.
-
ofResponseCodeInterpreterCallInProgress
final static ResponsesServerEvent ofResponseCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgressEvent responseCodeInterpreterCallInProgress)
Emitted when a code interpreter call is in progress.
-
ofResponseCodeInterpreterCallInterpreting
final static ResponsesServerEvent ofResponseCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpretingEvent responseCodeInterpreterCallInterpreting)
Emitted when the code interpreter is actively interpreting the code snippet.
-
ofResponseCompleted
final static ResponsesServerEvent ofResponseCompleted(ResponseCompletedEvent responseCompleted)
Emitted when the model response is complete.
-
ofResponseContentPartAdded
final static ResponsesServerEvent ofResponseContentPartAdded(ResponseContentPartAddedEvent responseContentPartAdded)
Emitted when a new content part is added.
-
ofResponseContentPartDone
final static ResponsesServerEvent ofResponseContentPartDone(ResponseContentPartDoneEvent responseContentPartDone)
Emitted when a content part is done.
-
ofResponseCreated
final static ResponsesServerEvent ofResponseCreated(ResponseCreatedEvent responseCreated)
An event that is emitted when a response is created.
-
ofError
final static ResponsesServerEvent ofError(ResponseErrorEvent error)
Emitted when an error occurs.
-
ofResponseFileSearchCallCompleted
final static ResponsesServerEvent ofResponseFileSearchCallCompleted(ResponseFileSearchCallCompletedEvent responseFileSearchCallCompleted)
Emitted when a file search call is completed (results found).
-
ofResponseFileSearchCallInProgress
final static ResponsesServerEvent ofResponseFileSearchCallInProgress(ResponseFileSearchCallInProgressEvent responseFileSearchCallInProgress)
Emitted when a file search call is initiated.
-
ofResponseFileSearchCallSearching
final static ResponsesServerEvent ofResponseFileSearchCallSearching(ResponseFileSearchCallSearchingEvent responseFileSearchCallSearching)
Emitted when a file search is currently searching.
-
ofResponseFunctionCallArgumentsDelta
final static ResponsesServerEvent ofResponseFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent responseFunctionCallArgumentsDelta)
Emitted when there is a partial function-call arguments delta.
-
ofResponseFunctionCallArgumentsDone
final static ResponsesServerEvent ofResponseFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent responseFunctionCallArgumentsDone)
Emitted when function-call arguments are finalized.
-
ofResponseInProgress
final static ResponsesServerEvent ofResponseInProgress(ResponseInProgressEvent responseInProgress)
Emitted when the response is in progress.
-
ofResponseFailed
final static ResponsesServerEvent ofResponseFailed(ResponseFailedEvent responseFailed)
An event that is emitted when a response fails.
-
ofResponseIncomplete
final static ResponsesServerEvent ofResponseIncomplete(ResponseIncompleteEvent responseIncomplete)
An event that is emitted when a response finishes as incomplete.
-
ofResponseOutputItemAdded
final static ResponsesServerEvent ofResponseOutputItemAdded(ResponseOutputItemAddedEvent responseOutputItemAdded)
Emitted when a new output item is added.
-
ofResponseOutputItemDone
final static ResponsesServerEvent ofResponseOutputItemDone(ResponseOutputItemDoneEvent responseOutputItemDone)
Emitted when an output item is marked done.
-
ofResponseReasoningSummaryPartAdded
final static ResponsesServerEvent ofResponseReasoningSummaryPartAdded(ResponseReasoningSummaryPartAddedEvent responseReasoningSummaryPartAdded)
Emitted when a new reasoning summary part is added.
-
ofResponseReasoningSummaryPartDone
final static ResponsesServerEvent ofResponseReasoningSummaryPartDone(ResponseReasoningSummaryPartDoneEvent responseReasoningSummaryPartDone)
Emitted when a reasoning summary part is completed.
-
ofResponseReasoningSummaryTextDelta
final static ResponsesServerEvent ofResponseReasoningSummaryTextDelta(ResponseReasoningSummaryTextDeltaEvent responseReasoningSummaryTextDelta)
Emitted when a delta is added to a reasoning summary text.
-
ofResponseReasoningSummaryTextDone
final static ResponsesServerEvent ofResponseReasoningSummaryTextDone(ResponseReasoningSummaryTextDoneEvent responseReasoningSummaryTextDone)
Emitted when a reasoning summary text is completed.
-
ofResponseReasoningTextDelta
final static ResponsesServerEvent ofResponseReasoningTextDelta(ResponseReasoningTextDeltaEvent responseReasoningTextDelta)
Emitted when a delta is added to a reasoning text.
-
ofResponseReasoningTextDone
final static ResponsesServerEvent ofResponseReasoningTextDone(ResponseReasoningTextDoneEvent responseReasoningTextDone)
Emitted when a reasoning text is completed.
-
ofResponseRefusalDelta
final static ResponsesServerEvent ofResponseRefusalDelta(ResponseRefusalDeltaEvent responseRefusalDelta)
Emitted when there is a partial refusal text.
-
ofResponseRefusalDone
final static ResponsesServerEvent ofResponseRefusalDone(ResponseRefusalDoneEvent responseRefusalDone)
Emitted when refusal text is finalized.
-
ofResponseOutputTextDelta
final static ResponsesServerEvent ofResponseOutputTextDelta(ResponseTextDeltaEvent responseOutputTextDelta)
Emitted when there is an additional text delta.
-
ofResponseOutputTextDone
final static ResponsesServerEvent ofResponseOutputTextDone(ResponseTextDoneEvent responseOutputTextDone)
Emitted when text content is finalized.
-
ofResponseWebSearchCallCompleted
final static ResponsesServerEvent ofResponseWebSearchCallCompleted(ResponseWebSearchCallCompletedEvent responseWebSearchCallCompleted)
Emitted when a web search call is completed.
-
ofResponseWebSearchCallInProgress
final static ResponsesServerEvent ofResponseWebSearchCallInProgress(ResponseWebSearchCallInProgressEvent responseWebSearchCallInProgress)
Emitted when a web search call is initiated.
-
ofResponseWebSearchCallSearching
final static ResponsesServerEvent ofResponseWebSearchCallSearching(ResponseWebSearchCallSearchingEvent responseWebSearchCallSearching)
Emitted when a web search call is executing.
-
ofResponseImageGenerationCallCompleted
final static ResponsesServerEvent ofResponseImageGenerationCallCompleted(ResponseImageGenCallCompletedEvent responseImageGenerationCallCompleted)
Emitted when an image generation tool call has completed and the final image is available.
-
ofResponseImageGenerationCallGenerating
final static ResponsesServerEvent ofResponseImageGenerationCallGenerating(ResponseImageGenCallGeneratingEvent responseImageGenerationCallGenerating)
Emitted when an image generation tool call is actively generating an image (intermediate state).
-
ofResponseImageGenerationCallInProgress
final static ResponsesServerEvent ofResponseImageGenerationCallInProgress(ResponseImageGenCallInProgressEvent responseImageGenerationCallInProgress)
Emitted when an image generation tool call is in progress.
-
ofResponseImageGenerationCallPartialImage
final static ResponsesServerEvent ofResponseImageGenerationCallPartialImage(ResponseImageGenCallPartialImageEvent responseImageGenerationCallPartialImage)
Emitted when a partial image is available during image generation streaming.
-
ofResponseMcpCallArgumentsDelta
final static ResponsesServerEvent ofResponseMcpCallArgumentsDelta(ResponseMcpCallArgumentsDeltaEvent responseMcpCallArgumentsDelta)
Emitted when there is a delta (partial update) to the arguments of an MCP tool call.
-
ofResponseMcpCallArgumentsDone
final static ResponsesServerEvent ofResponseMcpCallArgumentsDone(ResponseMcpCallArgumentsDoneEvent responseMcpCallArgumentsDone)
Emitted when the arguments for an MCP tool call are finalized.
-
ofResponseMcpCallCompleted
final static ResponsesServerEvent ofResponseMcpCallCompleted(ResponseMcpCallCompletedEvent responseMcpCallCompleted)
Emitted when an MCP tool call has completed successfully.
-
ofResponseMcpCallFailed
final static ResponsesServerEvent ofResponseMcpCallFailed(ResponseMcpCallFailedEvent responseMcpCallFailed)
Emitted when an MCP tool call has failed.
-
ofResponseMcpCallInProgress
final static ResponsesServerEvent ofResponseMcpCallInProgress(ResponseMcpCallInProgressEvent responseMcpCallInProgress)
Emitted when an MCP tool call is in progress.
-
ofResponseMcpListToolsCompleted
final static ResponsesServerEvent ofResponseMcpListToolsCompleted(ResponseMcpListToolsCompletedEvent responseMcpListToolsCompleted)
Emitted when the list of available MCP tools has been successfully retrieved.
-
ofResponseMcpListToolsFailed
final static ResponsesServerEvent ofResponseMcpListToolsFailed(ResponseMcpListToolsFailedEvent responseMcpListToolsFailed)
Emitted when the attempt to list available MCP tools has failed.
-
ofResponseMcpListToolsInProgress
final static ResponsesServerEvent ofResponseMcpListToolsInProgress(ResponseMcpListToolsInProgressEvent responseMcpListToolsInProgress)
Emitted when the system is in the process of retrieving the list of available MCP tools.
-
ofResponseOutputTextAnnotationAdded
final static ResponsesServerEvent ofResponseOutputTextAnnotationAdded(ResponseOutputTextAnnotationAddedEvent responseOutputTextAnnotationAdded)
Emitted when an annotation is added to output text content.
-
ofResponseQueued
final static ResponsesServerEvent ofResponseQueued(ResponseQueuedEvent responseQueued)
Emitted when a response is queued and waiting to be processed.
-
ofResponseCustomToolCallInputDelta
final static ResponsesServerEvent ofResponseCustomToolCallInputDelta(ResponseCustomToolCallInputDeltaEvent responseCustomToolCallInputDelta)
Event representing a delta (partial update) to the input of a custom tool call.
-
ofResponseCustomToolCallInputDone
final static ResponsesServerEvent ofResponseCustomToolCallInputDone(ResponseCustomToolCallInputDoneEvent responseCustomToolCallInputDone)
Event indicating that input for a custom tool call is complete.
-
-
-
-