Package com.azure.ai.openai.responses.models

Enum ResponsesStreamEventType

java.lang.Object
java.lang.Enum<ResponsesStreamEventType>
com.azure.ai.openai.responses.models.ResponsesStreamEventType
All Implemented Interfaces:
Serializable, Comparable<ResponsesStreamEventType>, java.lang.constant.Constable
public enum ResponsesStreamEventType extends Enum<ResponsesStreamEventType>
Defines values for ResponsesStreamEventType.

  • Enum Constant Details

    • ERROR

      public static final ResponsesStreamEventType ERROR
      Enum value error.

    • RESPONSE_COMPLETED

      public static final ResponsesStreamEventType RESPONSE_COMPLETED
      Enum value response.completed.

    • RESPONSE_CONTENT_PART_ADDED

      public static final ResponsesStreamEventType RESPONSE_CONTENT_PART_ADDED
      Enum value response.content_part.added.

    • RESPONSE_CONTENT_PART_DONE

      public static final ResponsesStreamEventType RESPONSE_CONTENT_PART_DONE
      Enum value response.content_part.done.

    • RESPONSE_CREATED

      public static final ResponsesStreamEventType RESPONSE_CREATED
      Enum value response.created.

    • RESPONSE_FAILED

      public static final ResponsesStreamEventType RESPONSE_FAILED
      Enum value response.failed.

    • RESPONSE_FILE_SEARCH_CALL_COMPLETED

      public static final ResponsesStreamEventType RESPONSE_FILE_SEARCH_CALL_COMPLETED
      Enum value response.file_search_call.completed.

    • RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS

      public static final ResponsesStreamEventType RESPONSE_FILE_SEARCH_CALL_IN_PROGRESS
      Enum value response.file_search_call.in.progress.

    • RESPONSE_FILE_SEARCH_CALL_SEARCHING

      public static final ResponsesStreamEventType RESPONSE_FILE_SEARCH_CALL_SEARCHING
      Enum value response.file_search_call.searching.

    • RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA

      public static final ResponsesStreamEventType RESPONSE_FUNCTION_CALL_ARGUMENTS_DELTA
      Enum value response.function_call_arguments.delta.

    • RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE

      public static final ResponsesStreamEventType RESPONSE_FUNCTION_CALL_ARGUMENTS_DONE
      Enum value response.function_call_arguments.done.

    • RESPONSE_IN_PROGRESS

      public static final ResponsesStreamEventType RESPONSE_IN_PROGRESS
      Enum value response.in_progress.

    • RESPONSE_INCOMPLETE

      public static final ResponsesStreamEventType RESPONSE_INCOMPLETE
      Enum value response.incomplete.

    • RESPONSE_OUTPUT_ITEM_ADDED

      public static final ResponsesStreamEventType RESPONSE_OUTPUT_ITEM_ADDED
      Enum value response.output_item.added.

    • RESPONSE_OUTPUT_ITEM_DONE

      public static final ResponsesStreamEventType RESPONSE_OUTPUT_ITEM_DONE
      Enum value response.output_item.done.

    • RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED

      public static final ResponsesStreamEventType RESPONSE_OUTPUT_TEXT_ANNOTATION_ADDED
      Enum value response.output_text.annotation.added.

    • RESPONSE_OUTPUT_TEXT_DELTA

      public static final ResponsesStreamEventType RESPONSE_OUTPUT_TEXT_DELTA
      Enum value response.output_text.delta.

    • RESPONSE_OUTPUT_TEXT_DONE

      public static final ResponsesStreamEventType RESPONSE_OUTPUT_TEXT_DONE
      Enum value response.output_text.done.

    • RESPONSE_REFUSAL_DELTA

      public static final ResponsesStreamEventType RESPONSE_REFUSAL_DELTA
      Enum value response.refusal.delta.

    • RESPONSE_REFUSAL_DONE

      public static final ResponsesStreamEventType RESPONSE_REFUSAL_DONE
      Enum value response.refusal.done.

    • RESPONSE_WEB_SEARCH_CALL_COMPLETED

      public static final ResponsesStreamEventType RESPONSE_WEB_SEARCH_CALL_COMPLETED
      Enum value response.web_search_call.completed.

    • RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS

      public static final ResponsesStreamEventType RESPONSE_WEB_SEARCH_CALL_IN_PROGRESS
      Enum value response.web_search_call.in_progress.

    • RESPONSE_WEB_SEARCH_CALL_SEARCHING

      public static final ResponsesStreamEventType RESPONSE_WEB_SEARCH_CALL_SEARCHING
      Enum value response.web_search_call.searching.

  • Method Details

    • values

      public static ResponsesStreamEventType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ResponsesStreamEventType valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromString

      public static ResponsesStreamEventType fromString(String value)
      Parses a serialized value to a ResponsesStreamEventType instance.
      Parameters:
      value - the serialized value to parse.
      Returns:
      the parsed ResponsesStreamEventType object, or null if unable to parse.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ResponsesStreamEventType>