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

Class ChatCompletionFunctionCall

java.lang.Object
com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionFunctionCall
public class ChatCompletionFunctionCall extends Object
Deprecated and replaced by `tool_calls`. The name and arguments of a function that should be called, as generated by the model.

  • Constructor Details

    • ChatCompletionFunctionCall

      public ChatCompletionFunctionCall()

  • Method Details

    • name

      @Nonnull public ChatCompletionFunctionCall name(@Nonnull String name)
      Set the name of this ChatCompletionFunctionCall instance and return the same instance.
      Parameters:
      name - The name of the function to call.
      Returns:
      The same instance of this ChatCompletionFunctionCall class

    • getName

      @Nonnull public String getName()
      The name of the function to call.
      Returns:
      name The name of this ChatCompletionFunctionCall instance.

    • setName

      public void setName(@Nonnull String name)
      Set the name of this ChatCompletionFunctionCall instance.
      Parameters:
      name - The name of the function to call.

    • arguments

      @Nonnull public ChatCompletionFunctionCall arguments(@Nonnull String arguments)
      Set the arguments of this ChatCompletionFunctionCall instance and return the same instance.
      Parameters:
      arguments - The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
      Returns:
      The same instance of this ChatCompletionFunctionCall class

    • getArguments

      @Nonnull public String getArguments()
      The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
      Returns:
      arguments The arguments of this ChatCompletionFunctionCall instance.

    • setArguments

      public void setArguments(@Nonnull String arguments)
      Set the arguments of this ChatCompletionFunctionCall instance.
      Parameters:
      arguments - The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the ChatCompletionFunctionCall.
      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 ChatCompletionFunctionCall 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 ChatCompletionFunctionCall 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 ChatCompletionFunctionCall 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