Constructor Detail

Method Detail

• threadMessageCreated

   final Optional<MessageStreamEvent.ThreadMessageCreated> threadMessageCreated()

  Occurs when a message is created.

• threadMessageInProgress

   final Optional<MessageStreamEvent.ThreadMessageInProgress> threadMessageInProgress()

  Occurs when a message moves to an in_progress state.

• threadMessageDelta

   final Optional<MessageStreamEvent.ThreadMessageDelta> threadMessageDelta()

  Occurs when parts of a Message are being streamed.

• threadMessageCompleted

   final Optional<MessageStreamEvent.ThreadMessageCompleted> threadMessageCompleted()

  Occurs when a message is completed.

• threadMessageIncomplete

   final Optional<MessageStreamEvent.ThreadMessageIncomplete> threadMessageIncomplete()

  Occurs when a message ends before it is completed.

• isThreadMessageCreated

   final Boolean isThreadMessageCreated()

• isThreadMessageInProgress

   final Boolean isThreadMessageInProgress()

• isThreadMessageDelta

   final Boolean isThreadMessageDelta()

• isThreadMessageCompleted

   final Boolean isThreadMessageCompleted()

• isThreadMessageIncomplete

   final Boolean isThreadMessageIncomplete()

• asThreadMessageCreated

   final MessageStreamEvent.ThreadMessageCreated asThreadMessageCreated()

  Occurs when a message is created.

• asThreadMessageInProgress

   final MessageStreamEvent.ThreadMessageInProgress asThreadMessageInProgress()

  Occurs when a message moves to an in_progress state.

• asThreadMessageDelta

   final MessageStreamEvent.ThreadMessageDelta asThreadMessageDelta()

  Occurs when parts of a Message are being streamed.

• asThreadMessageCompleted

   final MessageStreamEvent.ThreadMessageCompleted asThreadMessageCompleted()

  Occurs when a message is completed.

• asThreadMessageIncomplete

   final MessageStreamEvent.ThreadMessageIncomplete asThreadMessageIncomplete()

  Occurs when a message ends before it is completed.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(MessageStreamEvent.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 = messageStreamEvent.accept(new MessageStreamEvent.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitThreadMessageCreated(ThreadMessageCreated threadMessageCreated) {
          return Optional.of(threadMessageCreated.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final MessageStreamEvent 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()

• ofThreadMessageCreated

   final static MessageStreamEvent ofThreadMessageCreated(MessageStreamEvent.ThreadMessageCreated threadMessageCreated)

  Occurs when a message is created.

• ofThreadMessageInProgress

   final static MessageStreamEvent ofThreadMessageInProgress(MessageStreamEvent.ThreadMessageInProgress threadMessageInProgress)

  Occurs when a message moves to an in_progress state.

• ofThreadMessageDelta

   final static MessageStreamEvent ofThreadMessageDelta(MessageStreamEvent.ThreadMessageDelta threadMessageDelta)

  Occurs when parts of a Message are being streamed.

• ofThreadMessageCompleted

   final static MessageStreamEvent ofThreadMessageCompleted(MessageStreamEvent.ThreadMessageCompleted threadMessageCompleted)

  Occurs when a message is completed.

• ofThreadMessageIncomplete

   final static MessageStreamEvent ofThreadMessageIncomplete(MessageStreamEvent.ThreadMessageIncomplete threadMessageIncomplete)

  Occurs when a message ends before it is completed.