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

Class SchemasChatCompletionTool

java.lang.Object

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

public class SchemasChatCompletionTool
extends Object

SchemasChatCompletionTool

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SchemasChatCompletionTool	cacheControl(CacheControl cacheControl)	Set the cacheControl of this SchemasChatCompletionTool instance and return the same instance.
static SchemasChatCompletionTool.Builder	create()	Create a type-safe, fluent-api builder object to construct a new SchemasChatCompletionTool instance with all required arguments.
boolean	equals(Object o)
SchemasChatCompletionTool	function(FunctionObject function)	Set the function of this SchemasChatCompletionTool instance and return the same instance.
CacheControl	getCacheControl()	Get cacheControl
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the SchemasChatCompletionTool.
FunctionObject	getFunction()	Get function
SchemasChatCompletionTool.TypeEnum	getType()	The type of the tool.
int	hashCode()
void	setCacheControl(CacheControl cacheControl)	Set the cacheControl of this SchemasChatCompletionTool instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this SchemasChatCompletionTool instance.
void	setFunction(FunctionObject function)	Set the function of this SchemasChatCompletionTool instance.
void	setType(SchemasChatCompletionTool.TypeEnum type)	Set the type of this SchemasChatCompletionTool instance.
Map<String,Object>	toMap()	Get the value of all properties of this SchemasChatCompletionTool instance including unrecognized properties.
String	toString()
SchemasChatCompletionTool	type(SchemasChatCompletionTool.TypeEnum type)	Set the type of this SchemasChatCompletionTool instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

SchemasChatCompletionTool

protected SchemasChatCompletionTool()

Default constructor for SchemasChatCompletionTool.

Method Details

type

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

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

Parameters:

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

Returns:

The same instance of this SchemasChatCompletionTool class

getType

@Nonnull
public SchemasChatCompletionTool.TypeEnum getType()

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

Returns:

type The type of this SchemasChatCompletionTool instance.

setType

public void setType(@Nonnull
 SchemasChatCompletionTool.TypeEnum type)

Set the type of this SchemasChatCompletionTool instance.

Parameters:

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

function

@Nonnull
public SchemasChatCompletionTool function(@Nonnull
 FunctionObject function)

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

Parameters:

function - The function of this SchemasChatCompletionTool

Returns:

The same instance of this SchemasChatCompletionTool class

getFunction

@Nonnull
public FunctionObject getFunction()

Get function

Returns:

function The function of this SchemasChatCompletionTool instance.

setFunction

public void setFunction(@Nonnull
 FunctionObject function)

Set the function of this SchemasChatCompletionTool instance.

Parameters:

function - The function of this SchemasChatCompletionTool

cacheControl

@Nonnull
public SchemasChatCompletionTool cacheControl(@Nullable
 CacheControl cacheControl)

Set the cacheControl of this SchemasChatCompletionTool instance and return the same instance.

Parameters:

cacheControl - The cacheControl of this SchemasChatCompletionTool

Returns:

The same instance of this SchemasChatCompletionTool class

getCacheControl

@Nonnull
public CacheControl getCacheControl()

Get cacheControl

Returns:

cacheControl The cacheControl of this SchemasChatCompletionTool instance.

setCacheControl

public void setCacheControl(@Nullable
 CacheControl cacheControl)

Set the cacheControl of this SchemasChatCompletionTool instance.

Parameters:

cacheControl - The cacheControl of this SchemasChatCompletionTool

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the SchemasChatCompletionTool.

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

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