Constructor Detail

Method Detail

• audioDelta

   final Optional<ResponseAudioDeltaEvent> audioDelta()

  Emitted when there is a partial audio response.

• audioDone

   final Optional<ResponseAudioDoneEvent> audioDone()

  Emitted when the audio response is complete.

• audioTranscriptDelta

   final Optional<ResponseAudioTranscriptDeltaEvent> audioTranscriptDelta()

  Emitted when there is a partial transcript of audio.

• audioTranscriptDone

   final Optional<ResponseAudioTranscriptDoneEvent> audioTranscriptDone()

  Emitted when the full audio transcript is completed.

• codeInterpreterCallCodeDelta

   final Optional<ResponseCodeInterpreterCallCodeDeltaEvent> codeInterpreterCallCodeDelta()

  Emitted when a partial code snippet is added by the code interpreter.

• codeInterpreterCallCodeDone

   final Optional<ResponseCodeInterpreterCallCodeDoneEvent> codeInterpreterCallCodeDone()

  Emitted when code snippet output is finalized by the code interpreter.

• codeInterpreterCallCompleted

   final Optional<ResponseCodeInterpreterCallCompletedEvent> codeInterpreterCallCompleted()

  Emitted when the code interpreter call is completed.

• codeInterpreterCallInProgress

   final Optional<ResponseCodeInterpreterCallInProgressEvent> codeInterpreterCallInProgress()

  Emitted when a code interpreter call is in progress.

• codeInterpreterCallInterpreting

   final Optional<ResponseCodeInterpreterCallInterpretingEvent> codeInterpreterCallInterpreting()

  Emitted when the code interpreter is actively interpreting the code snippet.

• completed

   final Optional<ResponseCompletedEvent> completed()

  Emitted when the model response is complete.

• contentPartAdded

   final Optional<ResponseContentPartAddedEvent> contentPartAdded()

  Emitted when a new content part is added.

• contentPartDone

   final Optional<ResponseContentPartDoneEvent> contentPartDone()

  Emitted when a content part is done.

• created

   final Optional<ResponseCreatedEvent> created()

  An event that is emitted when a response is created.

• error

   final Optional<ResponseErrorEvent> error()

  Emitted when an error occurs.

• fileSearchCallCompleted

   final Optional<ResponseFileSearchCallCompletedEvent> fileSearchCallCompleted()

  Emitted when a file search call is completed (results found).

• fileSearchCallInProgress

   final Optional<ResponseFileSearchCallInProgressEvent> fileSearchCallInProgress()

  Emitted when a file search call is initiated.

• fileSearchCallSearching

   final Optional<ResponseFileSearchCallSearchingEvent> fileSearchCallSearching()

  Emitted when a file search is currently searching.

• functionCallArgumentsDelta

   final Optional<ResponseFunctionCallArgumentsDeltaEvent> functionCallArgumentsDelta()

  Emitted when there is a partial function-call arguments delta.

• functionCallArgumentsDone

   final Optional<ResponseFunctionCallArgumentsDoneEvent> functionCallArgumentsDone()

  Emitted when function-call arguments are finalized.

• inProgress

   final Optional<ResponseInProgressEvent> inProgress()

  Emitted when the response is in progress.

• failed

   final Optional<ResponseFailedEvent> failed()

  An event that is emitted when a response fails.

• incomplete

   final Optional<ResponseIncompleteEvent> incomplete()

  An event that is emitted when a response finishes as incomplete.

• outputItemAdded

   final Optional<ResponseOutputItemAddedEvent> outputItemAdded()

  Emitted when a new output item is added.

• outputItemDone

   final Optional<ResponseOutputItemDoneEvent> outputItemDone()

  Emitted when an output item is marked done.

• reasoningSummaryPartAdded

   final Optional<ResponseReasoningSummaryPartAddedEvent> reasoningSummaryPartAdded()

  Emitted when a new reasoning summary part is added.

• reasoningSummaryPartDone

   final Optional<ResponseReasoningSummaryPartDoneEvent> reasoningSummaryPartDone()

  Emitted when a reasoning summary part is completed.

• reasoningSummaryTextDelta

   final Optional<ResponseReasoningSummaryTextDeltaEvent> reasoningSummaryTextDelta()

  Emitted when a delta is added to a reasoning summary text.

• reasoningSummaryTextDone

   final Optional<ResponseReasoningSummaryTextDoneEvent> reasoningSummaryTextDone()

  Emitted when a reasoning summary text is completed.

• refusalDelta

   final Optional<ResponseRefusalDeltaEvent> refusalDelta()

  Emitted when there is a partial refusal text.

• refusalDone

   final Optional<ResponseRefusalDoneEvent> refusalDone()

  Emitted when refusal text is finalized.

• outputTextAnnotationAdded

   final Optional<ResponseTextAnnotationDeltaEvent> outputTextAnnotationAdded()

  Emitted when a text annotation is added.

• outputTextDelta

   final Optional<ResponseTextDeltaEvent> outputTextDelta()

  Emitted when there is an additional text delta.

• outputTextDone

   final Optional<ResponseTextDoneEvent> outputTextDone()

  Emitted when text content is finalized.

• webSearchCallCompleted

   final Optional<ResponseWebSearchCallCompletedEvent> webSearchCallCompleted()

  Emitted when a web search call is completed.

• webSearchCallInProgress

   final Optional<ResponseWebSearchCallInProgressEvent> webSearchCallInProgress()

  Emitted when a web search call is initiated.

• webSearchCallSearching

   final Optional<ResponseWebSearchCallSearchingEvent> webSearchCallSearching()

  Emitted when a web search call is executing.

• isAudioDelta

   final Boolean isAudioDelta()

• isAudioDone

   final Boolean isAudioDone()

• isAudioTranscriptDelta

   final Boolean isAudioTranscriptDelta()

• isAudioTranscriptDone

   final Boolean isAudioTranscriptDone()

• isCodeInterpreterCallCodeDelta

   final Boolean isCodeInterpreterCallCodeDelta()

• isCodeInterpreterCallCodeDone

   final Boolean isCodeInterpreterCallCodeDone()

• isCodeInterpreterCallCompleted

   final Boolean isCodeInterpreterCallCompleted()

• isCodeInterpreterCallInProgress

   final Boolean isCodeInterpreterCallInProgress()

• isCodeInterpreterCallInterpreting

   final Boolean isCodeInterpreterCallInterpreting()

• isCompleted

   final Boolean isCompleted()

• isContentPartAdded

   final Boolean isContentPartAdded()

• isContentPartDone

   final Boolean isContentPartDone()

• isCreated

   final Boolean isCreated()

• isError

   final Boolean isError()

• isFileSearchCallCompleted

   final Boolean isFileSearchCallCompleted()

• isFileSearchCallInProgress

   final Boolean isFileSearchCallInProgress()

• isFileSearchCallSearching

   final Boolean isFileSearchCallSearching()

• isFunctionCallArgumentsDelta

   final Boolean isFunctionCallArgumentsDelta()

• isFunctionCallArgumentsDone

   final Boolean isFunctionCallArgumentsDone()

• isInProgress

   final Boolean isInProgress()

• isFailed

   final Boolean isFailed()

• isIncomplete

   final Boolean isIncomplete()

• isOutputItemAdded

   final Boolean isOutputItemAdded()

• isOutputItemDone

   final Boolean isOutputItemDone()

• isReasoningSummaryPartAdded

   final Boolean isReasoningSummaryPartAdded()

• isReasoningSummaryPartDone

   final Boolean isReasoningSummaryPartDone()

• isReasoningSummaryTextDelta

   final Boolean isReasoningSummaryTextDelta()

• isReasoningSummaryTextDone

   final Boolean isReasoningSummaryTextDone()

• isRefusalDelta

   final Boolean isRefusalDelta()

• isRefusalDone

   final Boolean isRefusalDone()

• isOutputTextAnnotationAdded

   final Boolean isOutputTextAnnotationAdded()

• isOutputTextDelta

   final Boolean isOutputTextDelta()

• isOutputTextDone

   final Boolean isOutputTextDone()

• isWebSearchCallCompleted

   final Boolean isWebSearchCallCompleted()

• isWebSearchCallInProgress

   final Boolean isWebSearchCallInProgress()

• isWebSearchCallSearching

   final Boolean isWebSearchCallSearching()

• asAudioDelta

   final ResponseAudioDeltaEvent asAudioDelta()

  Emitted when there is a partial audio response.

• asAudioDone

   final ResponseAudioDoneEvent asAudioDone()

  Emitted when the audio response is complete.

• asAudioTranscriptDelta

   final ResponseAudioTranscriptDeltaEvent asAudioTranscriptDelta()

  Emitted when there is a partial transcript of audio.

• asAudioTranscriptDone

   final ResponseAudioTranscriptDoneEvent asAudioTranscriptDone()

  Emitted when the full audio transcript is completed.

• asCodeInterpreterCallCodeDelta

   final ResponseCodeInterpreterCallCodeDeltaEvent asCodeInterpreterCallCodeDelta()

  Emitted when a partial code snippet is added by the code interpreter.

• asCodeInterpreterCallCodeDone

   final ResponseCodeInterpreterCallCodeDoneEvent asCodeInterpreterCallCodeDone()

  Emitted when code snippet output is finalized by the code interpreter.

• asCodeInterpreterCallCompleted

   final ResponseCodeInterpreterCallCompletedEvent asCodeInterpreterCallCompleted()

  Emitted when the code interpreter call is completed.

• asCodeInterpreterCallInProgress

   final ResponseCodeInterpreterCallInProgressEvent asCodeInterpreterCallInProgress()

  Emitted when a code interpreter call is in progress.

• asCodeInterpreterCallInterpreting

   final ResponseCodeInterpreterCallInterpretingEvent asCodeInterpreterCallInterpreting()

  Emitted when the code interpreter is actively interpreting the code snippet.

• asCompleted

   final ResponseCompletedEvent asCompleted()

  Emitted when the model response is complete.

• asContentPartAdded

   final ResponseContentPartAddedEvent asContentPartAdded()

  Emitted when a new content part is added.

• asContentPartDone

   final ResponseContentPartDoneEvent asContentPartDone()

  Emitted when a content part is done.

• asCreated

   final ResponseCreatedEvent asCreated()

  An event that is emitted when a response is created.

• asError

   final ResponseErrorEvent asError()

  Emitted when an error occurs.

• asFileSearchCallCompleted

   final ResponseFileSearchCallCompletedEvent asFileSearchCallCompleted()

  Emitted when a file search call is completed (results found).

• asFileSearchCallInProgress

   final ResponseFileSearchCallInProgressEvent asFileSearchCallInProgress()

  Emitted when a file search call is initiated.

• asFileSearchCallSearching

   final ResponseFileSearchCallSearchingEvent asFileSearchCallSearching()

  Emitted when a file search is currently searching.

• asFunctionCallArgumentsDelta

   final ResponseFunctionCallArgumentsDeltaEvent asFunctionCallArgumentsDelta()

  Emitted when there is a partial function-call arguments delta.

• asFunctionCallArgumentsDone

   final ResponseFunctionCallArgumentsDoneEvent asFunctionCallArgumentsDone()

  Emitted when function-call arguments are finalized.

• asInProgress

   final ResponseInProgressEvent asInProgress()

  Emitted when the response is in progress.

• asFailed

   final ResponseFailedEvent asFailed()

  An event that is emitted when a response fails.

• asIncomplete

   final ResponseIncompleteEvent asIncomplete()

  An event that is emitted when a response finishes as incomplete.

• asOutputItemAdded

   final ResponseOutputItemAddedEvent asOutputItemAdded()

  Emitted when a new output item is added.

• asOutputItemDone

   final ResponseOutputItemDoneEvent asOutputItemDone()

  Emitted when an output item is marked done.

• asReasoningSummaryPartAdded

   final ResponseReasoningSummaryPartAddedEvent asReasoningSummaryPartAdded()

  Emitted when a new reasoning summary part is added.

• asReasoningSummaryPartDone

   final ResponseReasoningSummaryPartDoneEvent asReasoningSummaryPartDone()

  Emitted when a reasoning summary part is completed.

• asReasoningSummaryTextDelta

   final ResponseReasoningSummaryTextDeltaEvent asReasoningSummaryTextDelta()

  Emitted when a delta is added to a reasoning summary text.

• asReasoningSummaryTextDone

   final ResponseReasoningSummaryTextDoneEvent asReasoningSummaryTextDone()

  Emitted when a reasoning summary text is completed.

• asRefusalDelta

   final ResponseRefusalDeltaEvent asRefusalDelta()

  Emitted when there is a partial refusal text.

• asRefusalDone

   final ResponseRefusalDoneEvent asRefusalDone()

  Emitted when refusal text is finalized.

• asOutputTextAnnotationAdded

   final ResponseTextAnnotationDeltaEvent asOutputTextAnnotationAdded()

  Emitted when a text annotation is added.

• asOutputTextDelta

   final ResponseTextDeltaEvent asOutputTextDelta()

  Emitted when there is an additional text delta.

• asOutputTextDone

   final ResponseTextDoneEvent asOutputTextDone()

  Emitted when text content is finalized.

• asWebSearchCallCompleted

   final ResponseWebSearchCallCompletedEvent asWebSearchCallCompleted()

  Emitted when a web search call is completed.

• asWebSearchCallInProgress

   final ResponseWebSearchCallInProgressEvent asWebSearchCallInProgress()

  Emitted when a web search call is initiated.

• asWebSearchCallSearching

   final ResponseWebSearchCallSearchingEvent asWebSearchCallSearching()

  Emitted when a web search call is executing.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(ResponseStreamEvent.Visitor<T> visitor)

• validate

   final ResponseStreamEvent validate()

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofAudioDelta

   final static ResponseStreamEvent ofAudioDelta(ResponseAudioDeltaEvent audioDelta)

  Emitted when there is a partial audio response.

• ofAudioDone

   final static ResponseStreamEvent ofAudioDone(ResponseAudioDoneEvent audioDone)

  Emitted when the audio response is complete.

• ofAudioTranscriptDelta

   final static ResponseStreamEvent ofAudioTranscriptDelta(ResponseAudioTranscriptDeltaEvent audioTranscriptDelta)

  Emitted when there is a partial transcript of audio.

• ofAudioTranscriptDone

   final static ResponseStreamEvent ofAudioTranscriptDone(ResponseAudioTranscriptDoneEvent audioTranscriptDone)

  Emitted when the full audio transcript is completed.

• ofCodeInterpreterCallCodeDelta

   final static ResponseStreamEvent ofCodeInterpreterCallCodeDelta(ResponseCodeInterpreterCallCodeDeltaEvent codeInterpreterCallCodeDelta)

  Emitted when a partial code snippet is added by the code interpreter.

• ofCodeInterpreterCallCodeDone

   final static ResponseStreamEvent ofCodeInterpreterCallCodeDone(ResponseCodeInterpreterCallCodeDoneEvent codeInterpreterCallCodeDone)

  Emitted when code snippet output is finalized by the code interpreter.

• ofCodeInterpreterCallCompleted

   final static ResponseStreamEvent ofCodeInterpreterCallCompleted(ResponseCodeInterpreterCallCompletedEvent codeInterpreterCallCompleted)

  Emitted when the code interpreter call is completed.

• ofCodeInterpreterCallInProgress

   final static ResponseStreamEvent ofCodeInterpreterCallInProgress(ResponseCodeInterpreterCallInProgressEvent codeInterpreterCallInProgress)

  Emitted when a code interpreter call is in progress.

• ofCodeInterpreterCallInterpreting

   final static ResponseStreamEvent ofCodeInterpreterCallInterpreting(ResponseCodeInterpreterCallInterpretingEvent codeInterpreterCallInterpreting)

  Emitted when the code interpreter is actively interpreting the code snippet.

• ofCompleted

   final static ResponseStreamEvent ofCompleted(ResponseCompletedEvent completed)

  Emitted when the model response is complete.

• ofContentPartAdded

   final static ResponseStreamEvent ofContentPartAdded(ResponseContentPartAddedEvent contentPartAdded)

  Emitted when a new content part is added.

• ofContentPartDone

   final static ResponseStreamEvent ofContentPartDone(ResponseContentPartDoneEvent contentPartDone)

  Emitted when a content part is done.

• ofCreated

   final static ResponseStreamEvent ofCreated(ResponseCreatedEvent created)

  An event that is emitted when a response is created.

• ofError

   final static ResponseStreamEvent ofError(ResponseErrorEvent error)

  Emitted when an error occurs.

• ofFileSearchCallCompleted

   final static ResponseStreamEvent ofFileSearchCallCompleted(ResponseFileSearchCallCompletedEvent fileSearchCallCompleted)

  Emitted when a file search call is completed (results found).

• ofFileSearchCallInProgress

   final static ResponseStreamEvent ofFileSearchCallInProgress(ResponseFileSearchCallInProgressEvent fileSearchCallInProgress)

  Emitted when a file search call is initiated.

• ofFileSearchCallSearching

   final static ResponseStreamEvent ofFileSearchCallSearching(ResponseFileSearchCallSearchingEvent fileSearchCallSearching)

  Emitted when a file search is currently searching.

• ofFunctionCallArgumentsDelta

   final static ResponseStreamEvent ofFunctionCallArgumentsDelta(ResponseFunctionCallArgumentsDeltaEvent functionCallArgumentsDelta)

  Emitted when there is a partial function-call arguments delta.

• ofFunctionCallArgumentsDone

   final static ResponseStreamEvent ofFunctionCallArgumentsDone(ResponseFunctionCallArgumentsDoneEvent functionCallArgumentsDone)

  Emitted when function-call arguments are finalized.

• ofInProgress

   final static ResponseStreamEvent ofInProgress(ResponseInProgressEvent inProgress)

  Emitted when the response is in progress.

• ofFailed

   final static ResponseStreamEvent ofFailed(ResponseFailedEvent failed)

  An event that is emitted when a response fails.

• ofIncomplete

   final static ResponseStreamEvent ofIncomplete(ResponseIncompleteEvent incomplete)

  An event that is emitted when a response finishes as incomplete.

• ofOutputItemAdded

   final static ResponseStreamEvent ofOutputItemAdded(ResponseOutputItemAddedEvent outputItemAdded)

  Emitted when a new output item is added.

• ofOutputItemDone

   final static ResponseStreamEvent ofOutputItemDone(ResponseOutputItemDoneEvent outputItemDone)

  Emitted when an output item is marked done.

• ofReasoningSummaryPartAdded

   final static ResponseStreamEvent ofReasoningSummaryPartAdded(ResponseReasoningSummaryPartAddedEvent reasoningSummaryPartAdded)

  Emitted when a new reasoning summary part is added.

• ofReasoningSummaryPartDone

   final static ResponseStreamEvent ofReasoningSummaryPartDone(ResponseReasoningSummaryPartDoneEvent reasoningSummaryPartDone)

  Emitted when a reasoning summary part is completed.

• ofReasoningSummaryTextDelta

   final static ResponseStreamEvent ofReasoningSummaryTextDelta(ResponseReasoningSummaryTextDeltaEvent reasoningSummaryTextDelta)

  Emitted when a delta is added to a reasoning summary text.

• ofReasoningSummaryTextDone

   final static ResponseStreamEvent ofReasoningSummaryTextDone(ResponseReasoningSummaryTextDoneEvent reasoningSummaryTextDone)

  Emitted when a reasoning summary text is completed.

• ofRefusalDelta

   final static ResponseStreamEvent ofRefusalDelta(ResponseRefusalDeltaEvent refusalDelta)

  Emitted when there is a partial refusal text.

• ofRefusalDone

   final static ResponseStreamEvent ofRefusalDone(ResponseRefusalDoneEvent refusalDone)

  Emitted when refusal text is finalized.

• ofOutputTextAnnotationAdded

   final static ResponseStreamEvent ofOutputTextAnnotationAdded(ResponseTextAnnotationDeltaEvent outputTextAnnotationAdded)

  Emitted when a text annotation is added.

• ofOutputTextDelta

   final static ResponseStreamEvent ofOutputTextDelta(ResponseTextDeltaEvent outputTextDelta)

  Emitted when there is an additional text delta.

• ofOutputTextDone

   final static ResponseStreamEvent ofOutputTextDone(ResponseTextDoneEvent outputTextDone)

  Emitted when text content is finalized.

• ofWebSearchCallCompleted

   final static ResponseStreamEvent ofWebSearchCallCompleted(ResponseWebSearchCallCompletedEvent webSearchCallCompleted)

  Emitted when a web search call is completed.

• ofWebSearchCallInProgress

   final static ResponseStreamEvent ofWebSearchCallInProgress(ResponseWebSearchCallInProgressEvent webSearchCallInProgress)

  Emitted when a web search call is initiated.

• ofWebSearchCallSearching

   final static ResponseStreamEvent ofWebSearchCallSearching(ResponseWebSearchCallSearchingEvent webSearchCallSearching)

  Emitted when a web search call is executing.