Package com.sap.ai.sdk.orchestration.model

Class ResponseFormatText

java.lang.Object
com.sap.ai.sdk.orchestration.model.ResponseFormatText
All Implemented Interfaces:
TemplateResponseFormat
public class ResponseFormatText extends Object implements TemplateResponseFormat
ResponseFormatText

  • Constructor Details

    • ResponseFormatText

      protected ResponseFormatText()
      Default constructor for ResponseFormatText.

  • Method Details

    • type

      @Nonnull public ResponseFormatText type(@Nonnull ResponseFormatText.TypeEnum type)
      Set the type of this ResponseFormatText instance and return the same instance.
      Parameters:
      type - The type of response format being defined: `text`
      Returns:
      The same instance of this ResponseFormatText class

    • getType

      @Nonnull public ResponseFormatText.TypeEnum getType()
      The type of response format being defined: `text`
      Returns:
      type The type of this ResponseFormatText instance.

    • setType

      public void setType(@Nonnull ResponseFormatText.TypeEnum type)
      Set the type of this ResponseFormatText instance.
      Parameters:
      type - The type of response format being defined: `text`

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the ResponseFormatText.
      Returns:
      The set of properties names

    • getCustomField

      @Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException
      Deprecated.
      Use toMap() instead.
      Get the value of an unrecognizable property of this ResponseFormatText instance.
      Parameters:
      name - The name of the property
      Returns:
      The value of the property
      Throws:
      NoSuchElementException - If no property with the given name could be found.

    • toMap

      @Nonnull public Map<String,Object> toMap()
      Get the value of all properties of this ResponseFormatText instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Set an unrecognizable property of this ResponseFormatText instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      customFieldName - The name of the property
      customFieldValue - The value of the property

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • create

      public static ResponseFormatText.Builder create()
      Create a type-safe, fluent-api builder object to construct a new ResponseFormatText instance with all required arguments.