Constructor Detail

Method Detail

• batchCancelled

   final Optional<BatchCancelledWebhookEvent> batchCancelled()

  Sent when a batch API request has been cancelled.

• batchCompleted

   final Optional<BatchCompletedWebhookEvent> batchCompleted()

  Sent when a batch API request has been completed.

• batchExpired

   final Optional<BatchExpiredWebhookEvent> batchExpired()

  Sent when a batch API request has expired.

• batchFailed

   final Optional<BatchFailedWebhookEvent> batchFailed()

  Sent when a batch API request has failed.

• evalRunCanceled

   final Optional<EvalRunCanceledWebhookEvent> evalRunCanceled()

  Sent when an eval run has been canceled.

• evalRunFailed

   final Optional<EvalRunFailedWebhookEvent> evalRunFailed()

  Sent when an eval run has failed.

• evalRunSucceeded

   final Optional<EvalRunSucceededWebhookEvent> evalRunSucceeded()

  Sent when an eval run has succeeded.

• fineTuningJobCancelled

   final Optional<FineTuningJobCancelledWebhookEvent> fineTuningJobCancelled()

  Sent when a fine-tuning job has been cancelled.

• fineTuningJobFailed

   final Optional<FineTuningJobFailedWebhookEvent> fineTuningJobFailed()

  Sent when a fine-tuning job has failed.

• fineTuningJobSucceeded

   final Optional<FineTuningJobSucceededWebhookEvent> fineTuningJobSucceeded()

  Sent when a fine-tuning job has succeeded.

• realtimeCallIncoming

   final Optional<RealtimeCallIncomingWebhookEvent> realtimeCallIncoming()

  Sent when Realtime API Receives a incoming SIP call.

• responseCancelled

   final Optional<ResponseCancelledWebhookEvent> responseCancelled()

  Sent when a background response has been cancelled.

• responseCompleted

   final Optional<ResponseCompletedWebhookEvent> responseCompleted()

  Sent when a background response has been completed.

• responseFailed

   final Optional<ResponseFailedWebhookEvent> responseFailed()

  Sent when a background response has failed.

• responseIncomplete

   final Optional<ResponseIncompleteWebhookEvent> responseIncomplete()

  Sent when a background response has been interrupted.

• isBatchCancelled

   final Boolean isBatchCancelled()

• isBatchCompleted

   final Boolean isBatchCompleted()

• isBatchExpired

   final Boolean isBatchExpired()

• isBatchFailed

   final Boolean isBatchFailed()

• isEvalRunCanceled

   final Boolean isEvalRunCanceled()

• isEvalRunFailed

   final Boolean isEvalRunFailed()

• isEvalRunSucceeded

   final Boolean isEvalRunSucceeded()

• isFineTuningJobCancelled

   final Boolean isFineTuningJobCancelled()

• isFineTuningJobFailed

   final Boolean isFineTuningJobFailed()

• isFineTuningJobSucceeded

   final Boolean isFineTuningJobSucceeded()

• isRealtimeCallIncoming

   final Boolean isRealtimeCallIncoming()

• isResponseCancelled

   final Boolean isResponseCancelled()

• isResponseCompleted

   final Boolean isResponseCompleted()

• isResponseFailed

   final Boolean isResponseFailed()

• isResponseIncomplete

   final Boolean isResponseIncomplete()

• asBatchCancelled

   final BatchCancelledWebhookEvent asBatchCancelled()

  Sent when a batch API request has been cancelled.

• asBatchCompleted

   final BatchCompletedWebhookEvent asBatchCompleted()

  Sent when a batch API request has been completed.

• asBatchExpired

   final BatchExpiredWebhookEvent asBatchExpired()

  Sent when a batch API request has expired.

• asBatchFailed

   final BatchFailedWebhookEvent asBatchFailed()

  Sent when a batch API request has failed.

• asEvalRunCanceled

   final EvalRunCanceledWebhookEvent asEvalRunCanceled()

  Sent when an eval run has been canceled.

• asEvalRunFailed

   final EvalRunFailedWebhookEvent asEvalRunFailed()

  Sent when an eval run has failed.

• asEvalRunSucceeded

   final EvalRunSucceededWebhookEvent asEvalRunSucceeded()

  Sent when an eval run has succeeded.

• asFineTuningJobCancelled

   final FineTuningJobCancelledWebhookEvent asFineTuningJobCancelled()

  Sent when a fine-tuning job has been cancelled.

• asFineTuningJobFailed

   final FineTuningJobFailedWebhookEvent asFineTuningJobFailed()

  Sent when a fine-tuning job has failed.

• asFineTuningJobSucceeded

   final FineTuningJobSucceededWebhookEvent asFineTuningJobSucceeded()

  Sent when a fine-tuning job has succeeded.

• asRealtimeCallIncoming

   final RealtimeCallIncomingWebhookEvent asRealtimeCallIncoming()

  Sent when Realtime API Receives a incoming SIP call.

• asResponseCancelled

   final ResponseCancelledWebhookEvent asResponseCancelled()

  Sent when a background response has been cancelled.

• asResponseCompleted

   final ResponseCompletedWebhookEvent asResponseCompleted()

  Sent when a background response has been completed.

• asResponseFailed

   final ResponseFailedWebhookEvent asResponseFailed()

  Sent when a background response has failed.

• asResponseIncomplete

   final ResponseIncompleteWebhookEvent asResponseIncomplete()

  Sent when a background response has been interrupted.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(UnwrapWebhookEvent.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 = unwrapWebhookEvent.accept(new UnwrapWebhookEvent.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitBatchCancelled(BatchCancelledWebhookEvent batchCancelled) {
          return Optional.of(batchCancelled.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final UnwrapWebhookEvent 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.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofBatchCancelled

   final static UnwrapWebhookEvent ofBatchCancelled(BatchCancelledWebhookEvent batchCancelled)

  Sent when a batch API request has been cancelled.

• ofBatchCompleted

   final static UnwrapWebhookEvent ofBatchCompleted(BatchCompletedWebhookEvent batchCompleted)

  Sent when a batch API request has been completed.

• ofBatchExpired

   final static UnwrapWebhookEvent ofBatchExpired(BatchExpiredWebhookEvent batchExpired)

  Sent when a batch API request has expired.

• ofBatchFailed

   final static UnwrapWebhookEvent ofBatchFailed(BatchFailedWebhookEvent batchFailed)

  Sent when a batch API request has failed.

• ofEvalRunCanceled

   final static UnwrapWebhookEvent ofEvalRunCanceled(EvalRunCanceledWebhookEvent evalRunCanceled)

  Sent when an eval run has been canceled.

• ofEvalRunFailed

   final static UnwrapWebhookEvent ofEvalRunFailed(EvalRunFailedWebhookEvent evalRunFailed)

  Sent when an eval run has failed.

• ofEvalRunSucceeded

   final static UnwrapWebhookEvent ofEvalRunSucceeded(EvalRunSucceededWebhookEvent evalRunSucceeded)

  Sent when an eval run has succeeded.

• ofFineTuningJobCancelled

   final static UnwrapWebhookEvent ofFineTuningJobCancelled(FineTuningJobCancelledWebhookEvent fineTuningJobCancelled)

  Sent when a fine-tuning job has been cancelled.

• ofFineTuningJobFailed

   final static UnwrapWebhookEvent ofFineTuningJobFailed(FineTuningJobFailedWebhookEvent fineTuningJobFailed)

  Sent when a fine-tuning job has failed.

• ofFineTuningJobSucceeded

   final static UnwrapWebhookEvent ofFineTuningJobSucceeded(FineTuningJobSucceededWebhookEvent fineTuningJobSucceeded)

  Sent when a fine-tuning job has succeeded.

• ofRealtimeCallIncoming

   final static UnwrapWebhookEvent ofRealtimeCallIncoming(RealtimeCallIncomingWebhookEvent realtimeCallIncoming)

  Sent when Realtime API Receives a incoming SIP call.

• ofResponseCancelled

   final static UnwrapWebhookEvent ofResponseCancelled(ResponseCancelledWebhookEvent responseCancelled)

  Sent when a background response has been cancelled.

• ofResponseCompleted

   final static UnwrapWebhookEvent ofResponseCompleted(ResponseCompletedWebhookEvent responseCompleted)

  Sent when a background response has been completed.

• ofResponseFailed

   final static UnwrapWebhookEvent ofResponseFailed(ResponseFailedWebhookEvent responseFailed)

  Sent when a background response has failed.

• ofResponseIncomplete

   final static UnwrapWebhookEvent ofResponseIncomplete(ResponseIncompleteWebhookEvent responseIncomplete)

  Sent when a background response has been interrupted.