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

Class ChatCompletionRequestToolMessage

java.lang.Object

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

All Implemented Interfaces:

ChatCompletionRequestMessage

public class ChatCompletionRequestToolMessage
extends Object
implements ChatCompletionRequestMessage

ChatCompletionRequestToolMessage

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ChatCompletionRequestToolMessage.RoleEnum	The role of the messages author, in this case `tool`.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequestToolMessage()

Method Summary

Modifier and Type	Method	Description
ChatCompletionRequestToolMessage	content(ChatCompletionRequestToolMessageContent content)	Set the content of this ChatCompletionRequestToolMessage instance and return the same instance.
boolean	equals(Object o)
ChatCompletionRequestToolMessageContent	getContent()	Get content
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionRequestToolMessage.
ChatCompletionRequestToolMessage.RoleEnum	getRole()	The role of the messages author, in this case `tool`.
String	getToolCallId()	Tool call that this message is responding to.
int	hashCode()
ChatCompletionRequestToolMessage	role(ChatCompletionRequestToolMessage.RoleEnum role)	Set the role of this ChatCompletionRequestToolMessage instance and return the same instance.
void	setContent(ChatCompletionRequestToolMessageContent content)	Set the content of this ChatCompletionRequestToolMessage instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionRequestToolMessage instance.
void	setRole(ChatCompletionRequestToolMessage.RoleEnum role)	Set the role of this ChatCompletionRequestToolMessage instance.
void	setToolCallId(String toolCallId)	Set the toolCallId of this ChatCompletionRequestToolMessage instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionRequestToolMessage instance including unrecognized properties.
ChatCompletionRequestToolMessage	toolCallId(String toolCallId)	Set the toolCallId of this ChatCompletionRequestToolMessage instance and return the same instance.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionRequestToolMessage

public ChatCompletionRequestToolMessage()

Method Details

role

@Nonnull
public ChatCompletionRequestToolMessage role(@Nonnull
 ChatCompletionRequestToolMessage.RoleEnum role)

Set the role of this ChatCompletionRequestToolMessage instance and return the same instance.

Parameters:

role - The role of the messages author, in this case `tool`.

Returns:

The same instance of this ChatCompletionRequestToolMessage class

getRole

@Nonnull
public ChatCompletionRequestToolMessage.RoleEnum getRole()

The role of the messages author, in this case `tool`.

Returns:

role The role of this ChatCompletionRequestToolMessage instance.

setRole

public void setRole(@Nonnull
 ChatCompletionRequestToolMessage.RoleEnum role)

Set the role of this ChatCompletionRequestToolMessage instance.

Parameters:

role - The role of the messages author, in this case `tool`.

content

@Nonnull
public ChatCompletionRequestToolMessage content(@Nonnull
 ChatCompletionRequestToolMessageContent content)

Set the content of this ChatCompletionRequestToolMessage instance and return the same instance.

Parameters:

content - The content of this ChatCompletionRequestToolMessage

Returns:

The same instance of this ChatCompletionRequestToolMessage class

getContent

@Nonnull
public ChatCompletionRequestToolMessageContent getContent()

Get content

Returns:

content The content of this ChatCompletionRequestToolMessage instance.

setContent

public void setContent(@Nonnull
 ChatCompletionRequestToolMessageContent content)

Set the content of this ChatCompletionRequestToolMessage instance.

Parameters:

content - The content of this ChatCompletionRequestToolMessage

toolCallId

@Nonnull
public ChatCompletionRequestToolMessage toolCallId(@Nonnull
 String toolCallId)

Set the toolCallId of this ChatCompletionRequestToolMessage instance and return the same instance.

Parameters:

toolCallId - Tool call that this message is responding to.

Returns:

The same instance of this ChatCompletionRequestToolMessage class

getToolCallId

@Nonnull
public String getToolCallId()

Tool call that this message is responding to.

Returns:

toolCallId The toolCallId of this ChatCompletionRequestToolMessage instance.

setToolCallId

public void setToolCallId(@Nonnull
 String toolCallId)

Set the toolCallId of this ChatCompletionRequestToolMessage instance.

Parameters:

toolCallId - Tool call that this message is responding to.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionRequestToolMessage.

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