Package com.sap.ai.sdk.foundationmodels.openai.model

# Enum Class OpenAiChatCompletionParameters.ResponseFormat

java.lang.Object
java.lang.Enum<OpenAiChatCompletionParameters.ResponseFormat>
com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatCompletionParameters.ResponseFormat

All Implemented Interfaces:
  `Serializable`, `Comparable<OpenAiChatCompletionParameters.ResponseFormat>`, `Constable`

Enclosing class:
  `OpenAiChatCompletionParameters`

public static enum OpenAiChatCompletionParameters.ResponseFormat extends Enum<OpenAiChatCompletionParameters.ResponseFormat>
"response_format": { "type": "json_object" }

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from class java.lang.Enum

  `Enum.EnumDesc<E extends Enum<E>>`

- ## Enum Constant Summary

  Enum Constants
  Enum Constant
  Description
  `JSON_OBJECT`
  Setting to `json_object` enables JSON mode.
  `TEXT`
  Response format is a plain text string.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static OpenAiChatCompletionParameters.ResponseFormat`
  `valueOf(String name)`
  Returns the enum constant of this class with the specified name.
  `static OpenAiChatCompletionParameters.ResponseFormat[]`
  `values()`
  Returns an array containing the constants of this enum class, in the order they are declared.

  ### Methods inherited from class java.lang.Enum

  `clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

  ### Methods inherited from class java.lang.Object

  `getClass, notify, notifyAll, wait, wait, wait`

- ## Enum Constant Details

  - ### JSON_OBJECT

    public static final OpenAiChatCompletionParameters.ResponseFormat JSON_OBJECT
    Setting to `json_object` enables JSON mode. This guarantees that the message the model generates is valid JSON.

  - ### TEXT

    public static final OpenAiChatCompletionParameters.ResponseFormat TEXT
    Response format is a plain text string.

- ## Method Details

  - ### values

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

  - ### valueOf

    public static OpenAiChatCompletionParameters.ResponseFormat valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      `NullPointerException` - if the argument is null