Package com.sap.ai.sdk.prompt.registry.model

Class ChatCompletionTool

java.lang.Object

com.sap.ai.sdk.prompt.registry.model.ChatCompletionTool

public class ChatCompletionTool
extends Object

ChatCompletionTool

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ChatCompletionTool.Builder	Builder helper class.
static interface	ChatCompletionTool.Builder1	Builder helper class.
static enum	ChatCompletionTool.TypeEnum	The type of the tool.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChatCompletionTool()	Default constructor for ChatCompletionTool.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionTool.Builder	create()	Create a type-safe, fluent-api builder object to construct a new ChatCompletionTool instance with all required arguments.
boolean	equals(Object o)
ChatCompletionTool	function(FunctionObject function)	Set the function of this ChatCompletionTool 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 ChatCompletionTool.
FunctionObject	getFunction()	Get function
ChatCompletionTool.TypeEnum	getType()	The type of the tool.
int	hashCode()
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionTool instance.
void	setFunction(FunctionObject function)	Set the function of this ChatCompletionTool instance.
void	setType(ChatCompletionTool.TypeEnum type)	Set the type of this ChatCompletionTool instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionTool instance including unrecognized properties.
String	toString()
ChatCompletionTool	type(ChatCompletionTool.TypeEnum type)	Set the type of this ChatCompletionTool instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionTool

protected ChatCompletionTool()

Default constructor for ChatCompletionTool.

Method Details

type

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

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

Parameters:

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

Returns:

The same instance of this ChatCompletionTool class

getType

@Nonnull
public ChatCompletionTool.TypeEnum getType()

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

Returns:

type The type of this ChatCompletionTool instance.

setType

public void setType(@Nonnull
 ChatCompletionTool.TypeEnum type)

Set the type of this ChatCompletionTool instance.

Parameters:

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

function

@Nonnull
public ChatCompletionTool function(@Nonnull
 FunctionObject function)

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

Parameters:

function - The function of this ChatCompletionTool

Returns:

The same instance of this ChatCompletionTool class

getFunction

@Nonnull
public FunctionObject getFunction()

Get function

Returns:

function The function of this ChatCompletionTool instance.

setFunction

public void setFunction(@Nonnull
 FunctionObject function)

Set the function of this ChatCompletionTool instance.

Parameters:

function - The function of this ChatCompletionTool

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionTool.

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 ChatCompletionTool 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 ChatCompletionTool 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 ChatCompletionTool 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 ChatCompletionTool.Builder create()

Create a type-safe, fluent-api builder object to construct a new ChatCompletionTool instance with all required arguments.