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

Class ChatCompletionFunctions

java.lang.Object
com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionFunctions
@Deprecated public class ChatCompletionFunctions extends Object
Deprecated.
ChatCompletionFunctions

  • Constructor Details

    • ChatCompletionFunctions

      public ChatCompletionFunctions()
      Deprecated.

  • Method Details

    • description

      @Nonnull public ChatCompletionFunctions description(@Nullable String description)
      Deprecated.
      Set the description of this ChatCompletionFunctions instance and return the same instance.
      Parameters:
      description - A description of what the function does, used by the model to choose when and how to call the function.
      Returns:
      The same instance of this ChatCompletionFunctions class

    • getDescription

      @Nonnull public String getDescription()
      Deprecated.
      A description of what the function does, used by the model to choose when and how to call the function.
      Returns:
      description The description of this ChatCompletionFunctions instance.

    • setDescription

      public void setDescription(@Nullable String description)
      Deprecated.
      Set the description of this ChatCompletionFunctions instance.
      Parameters:
      description - A description of what the function does, used by the model to choose when and how to call the function.

    • name

      @Nonnull public ChatCompletionFunctions name(@Nonnull String name)
      Deprecated.
      Set the name of this ChatCompletionFunctions instance and return the same instance.
      Parameters:
      name - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
      Returns:
      The same instance of this ChatCompletionFunctions class

    • getName

      @Nonnull public String getName()
      Deprecated.
      The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
      Returns:
      name The name of this ChatCompletionFunctions instance.

    • setName

      public void setName(@Nonnull String name)
      Deprecated.
      Set the name of this ChatCompletionFunctions instance.
      Parameters:
      name - The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

    • parameters

      @Nonnull public ChatCompletionFunctions parameters(@Nullable Map<String,Object> parameters)
      Deprecated.
      Set the parameters of this ChatCompletionFunctions instance and return the same instance.
      Parameters:
      parameters - The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list.
      Returns:
      The same instance of this ChatCompletionFunctions class

    • putparametersItem

      @Nonnull public ChatCompletionFunctions putparametersItem(@Nonnull String key, @Nullable Object parametersItem)
      Deprecated.
      Put one parameters instance to this ChatCompletionFunctions instance.
      Parameters:
      key - The String key of this parameters instance
      parametersItem - The parameters that should be added under the given key
      Returns:
      The same instance of type ChatCompletionFunctions

    • getParameters

      @Nonnull public Map<String,Object> getParameters()
      Deprecated.
      The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list.
      Returns:
      parameters The parameters of this ChatCompletionFunctions instance.

    • setParameters

      public void setParameters(@Nullable Map<String,Object> parameters)
      Deprecated.
      Set the parameters of this ChatCompletionFunctions instance.
      Parameters:
      parameters - The parameters the functions accepts, described as a JSON Schema object. See the guide](https://learn.microsoft.com/en-us/azure/ai-services/openai/how-to/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. Omitting `parameters` defines a function with an empty parameter list.

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Deprecated.
      Get the names of the unrecognizable properties of the ChatCompletionFunctions.
      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 ChatCompletionFunctions 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()
      Deprecated.
      Get the value of all properties of this ChatCompletionFunctions instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Deprecated.
      Set an unrecognizable property of this ChatCompletionFunctions 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)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object

    • toString

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