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

Class ChatCompletionFunctionCallOption

java.lang.Object

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

public class ChatCompletionFunctionCallOption
extends Object

Specifying a particular function via `{\"name\": \"my_function\"}` forces the model to call that function.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionFunctionCallOption()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionFunctionCallOption.
String	getName()	The name of the function to call.
int	hashCode()
ChatCompletionFunctionCallOption	name(String name)	Set the name of this ChatCompletionFunctionCallOption instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionFunctionCallOption instance.
void	setName(String name)	Set the name of this ChatCompletionFunctionCallOption instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionFunctionCallOption instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChatCompletionFunctionCallOption

public ChatCompletionFunctionCallOption()

Method Details

name

@Nonnull
public ChatCompletionFunctionCallOption name(@Nonnull
 String name)

Set the name of this ChatCompletionFunctionCallOption instance and return the same instance.

Parameters:

name - The name of the function to call.

Returns:

The same instance of this ChatCompletionFunctionCallOption class

getName

@Nonnull
public String getName()

The name of the function to call.

Returns:

name The name of this ChatCompletionFunctionCallOption instance.

setName

public void setName(@Nonnull
 String name)

Set the name of this ChatCompletionFunctionCallOption instance.

Parameters:

name - The name of the function to call.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionFunctionCallOption.

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 ChatCompletionFunctionCallOption 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 ChatCompletionFunctionCallOption 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 ChatCompletionFunctionCallOption 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