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

Class ChatCompletionMessageToolCallChunk

java.lang.Object

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

public class ChatCompletionMessageToolCallChunk
extends Object

ChatCompletionMessageToolCallChunk

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ChatCompletionMessageToolCallChunk()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ChatCompletionMessageToolCallChunk	function(ChatCompletionMessageToolCallChunkFunction function)	Set the function of this ChatCompletionMessageToolCallChunk 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 ChatCompletionMessageToolCallChunk.
ChatCompletionMessageToolCallChunkFunction	getFunction()	Get function
String	getId()	The ID of the tool call.
Integer	getIndex()	Get index
ChatCompletionMessageToolCallChunk.TypeEnum	getType()	The type of the tool.
int	hashCode()
ChatCompletionMessageToolCallChunk	id(String id)	Set the id of this ChatCompletionMessageToolCallChunk instance and return the same instance.
ChatCompletionMessageToolCallChunk	index(Integer index)	Set the index of this ChatCompletionMessageToolCallChunk instance and return the same instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionMessageToolCallChunk instance.
void	setFunction(ChatCompletionMessageToolCallChunkFunction function)	Set the function of this ChatCompletionMessageToolCallChunk instance.
void	setId(String id)	Set the id of this ChatCompletionMessageToolCallChunk instance.
void	setIndex(Integer index)	Set the index of this ChatCompletionMessageToolCallChunk instance.
void	setType(ChatCompletionMessageToolCallChunk.TypeEnum type)	Set the type of this ChatCompletionMessageToolCallChunk instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionMessageToolCallChunk instance including unrecognized properties.
String	toString()
ChatCompletionMessageToolCallChunk	type(ChatCompletionMessageToolCallChunk.TypeEnum type)	Set the type of this ChatCompletionMessageToolCallChunk instance and return the same instance.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionMessageToolCallChunk

public ChatCompletionMessageToolCallChunk()

Method Details

index

@Nonnull
public ChatCompletionMessageToolCallChunk index(@Nonnull
 Integer index)

Set the index of this ChatCompletionMessageToolCallChunk instance and return the same instance.

Parameters:

index - The index of this ChatCompletionMessageToolCallChunk

Returns:

The same instance of this ChatCompletionMessageToolCallChunk class

getIndex

@Nonnull
public Integer getIndex()

Get index

Returns:

index The index of this ChatCompletionMessageToolCallChunk instance.

setIndex

public void setIndex(@Nonnull
 Integer index)

Set the index of this ChatCompletionMessageToolCallChunk instance.

Parameters:

index - The index of this ChatCompletionMessageToolCallChunk

id

@Nonnull
public ChatCompletionMessageToolCallChunk id(@Nullable
 String id)

Set the id of this ChatCompletionMessageToolCallChunk instance and return the same instance.

Parameters:

id - The ID of the tool call.

Returns:

The same instance of this ChatCompletionMessageToolCallChunk class

getId

@Nonnull
public String getId()

The ID of the tool call.

Returns:

id The id of this ChatCompletionMessageToolCallChunk instance.

setId

public void setId(@Nullable
 String id)

Set the id of this ChatCompletionMessageToolCallChunk instance.

Parameters:

id - The ID of the tool call.

type

@Nonnull
public ChatCompletionMessageToolCallChunk type(@Nullable
 ChatCompletionMessageToolCallChunk.TypeEnum type)

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

Parameters:

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

Returns:

The same instance of this ChatCompletionMessageToolCallChunk class

getType

@Nonnull
public ChatCompletionMessageToolCallChunk.TypeEnum getType()

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

Returns:

type The type of this ChatCompletionMessageToolCallChunk instance.

setType

public void setType(@Nullable
 ChatCompletionMessageToolCallChunk.TypeEnum type)

Set the type of this ChatCompletionMessageToolCallChunk instance.

Parameters:

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

function

@Nonnull
public ChatCompletionMessageToolCallChunk function(@Nullable
 ChatCompletionMessageToolCallChunkFunction function)

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

Parameters:

function - The function of this ChatCompletionMessageToolCallChunk

Returns:

The same instance of this ChatCompletionMessageToolCallChunk class

getFunction

@Nonnull
public ChatCompletionMessageToolCallChunkFunction getFunction()

Get function

Returns:

function The function of this ChatCompletionMessageToolCallChunk instance.

setFunction

public void setFunction(@Nullable
 ChatCompletionMessageToolCallChunkFunction function)

Set the function of this ChatCompletionMessageToolCallChunk instance.

Parameters:

function - The function of this ChatCompletionMessageToolCallChunk

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionMessageToolCallChunk.

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