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

Class ChatCompletionNamedToolChoice

java.lang.Object

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

public class ChatCompletionNamedToolChoice
extends Object

Specifies a tool the model should use. Use to force the model to call a specific function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatCompletionNamedToolChoice.TypeEnum	The type of the tool.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionNamedToolChoice()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ChatCompletionNamedToolChoice	function(ChatCompletionNamedToolChoiceFunction function)	Set the function of this ChatCompletionNamedToolChoice instance and return the same instance.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionNamedToolChoice.
ChatCompletionNamedToolChoiceFunction	getFunction()	Get function
ChatCompletionNamedToolChoice.TypeEnum	getType()	The type of the tool.
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionNamedToolChoice instance.
void	setFunction(ChatCompletionNamedToolChoiceFunction function)	Set the function of this ChatCompletionNamedToolChoice instance.
void	setType(ChatCompletionNamedToolChoice.TypeEnum type)	Set the type of this ChatCompletionNamedToolChoice instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionNamedToolChoice instance including unrecognized properties.
String	toString()
ChatCompletionNamedToolChoice	type(ChatCompletionNamedToolChoice.TypeEnum type)	Set the type of this ChatCompletionNamedToolChoice instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionNamedToolChoice

public ChatCompletionNamedToolChoice()

Method Details

type

@Nonnull
public ChatCompletionNamedToolChoice type(@Nonnull
 ChatCompletionNamedToolChoice.TypeEnum type)

Set the type of this ChatCompletionNamedToolChoice instance and return the same instance.

Parameters:

type - The type of the tool. Currently, only `function` is supported.

Returns:

The same instance of this ChatCompletionNamedToolChoice class

getType

@Nonnull
public ChatCompletionNamedToolChoice.TypeEnum getType()

The type of the tool. Currently, only `function` is supported.

Returns:

type The type of this ChatCompletionNamedToolChoice instance.

setType

public void setType(@Nonnull
 ChatCompletionNamedToolChoice.TypeEnum type)

Set the type of this ChatCompletionNamedToolChoice instance.

Parameters:

type - The type of the tool. Currently, only `function` is supported.

function

@Nonnull
public ChatCompletionNamedToolChoice function(@Nonnull
 ChatCompletionNamedToolChoiceFunction function)

Set the function of this ChatCompletionNamedToolChoice instance and return the same instance.

Parameters:

function - The function of this ChatCompletionNamedToolChoice

Returns:

The same instance of this ChatCompletionNamedToolChoice class

getFunction

@Nonnull
public ChatCompletionNamedToolChoiceFunction getFunction()

Get function

Returns:

function The function of this ChatCompletionNamedToolChoice instance.

setFunction

public void setFunction(@Nonnull
 ChatCompletionNamedToolChoiceFunction function)

Set the function of this ChatCompletionNamedToolChoice instance.

Parameters:

function - The function of this ChatCompletionNamedToolChoice

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionNamedToolChoice.

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