Package io.camunda.client.protocol.rest

Class AgentInstanceToolCall

java.lang.Object

io.camunda.client.protocol.rest.AgentInstanceToolCall

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class AgentInstanceToolCall
extends Object

A tool call associated with a history item. Used in both ASSISTANT and TOOL_RESULT items. ASSISTANT items carry arguments; TOOL_RESULT items carry arguments as null.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ARGUMENTS
static final String	JSON_PROPERTY_ELEMENT_ID
static final String	JSON_PROPERTY_TOOL_CALL_ID
static final String	JSON_PROPERTY_TOOL_NAME

Constructor Summary

Constructors

Constructor	Description
AgentInstanceToolCall()

Method Summary

Modifier and Type	Method	Description
AgentInstanceToolCall	arguments(Map<String,Object> arguments)
AgentInstanceToolCall	elementId(String elementId)
boolean	equals(Object o)
Map<String,Object>	getArguments()	The tool call arguments as provided by the LLM.
String	getElementId()	The BPMN element ID handling this tool.
String	getToolCallId()	The LLM-assigned tool call ID.
String	getToolName()	The LLM-visible tool name.
int	hashCode()
AgentInstanceToolCall	putArgumentsItem(String key, Object argumentsItem)
void	setArguments(Map<String,Object> arguments)
void	setElementId(String elementId)
void	setToolCallId(String toolCallId)
void	setToolName(String toolName)
AgentInstanceToolCall	toolCallId(String toolCallId)
AgentInstanceToolCall	toolName(String toolName)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_TOOL_CALL_ID

public static final String JSON_PROPERTY_TOOL_CALL_ID

See Also:

• Constant Field Values

JSON_PROPERTY_TOOL_NAME

public static final String JSON_PROPERTY_TOOL_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENT_ID

public static final String JSON_PROPERTY_ELEMENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_ARGUMENTS

public static final String JSON_PROPERTY_ARGUMENTS

See Also:

• Constant Field Values

Constructor Details

AgentInstanceToolCall

public AgentInstanceToolCall()

Method Details

toolCallId

public AgentInstanceToolCall toolCallId(@Nonnull
 String toolCallId)

getToolCallId

@Nonnull
public String getToolCallId()

The LLM-assigned tool call ID. Correlates ASSISTANT items to their matching TOOL_RESULT items.

Returns:

toolCallId

setToolCallId

public void setToolCallId(@Nonnull
 String toolCallId)

toolName

public AgentInstanceToolCall toolName(@Nonnull
 String toolName)

getToolName

@Nonnull
public String getToolName()

The LLM-visible tool name.

Returns:

toolName

setToolName

public void setToolName(@Nonnull
 String toolName)

elementId

public AgentInstanceToolCall elementId(@Nullable
 String elementId)

getElementId

@Nullable
public String getElementId()

The BPMN element ID handling this tool.

Returns:

elementId

setElementId

public void setElementId(@Nullable
 String elementId)

arguments

public AgentInstanceToolCall arguments(@Nullable
 Map<String,Object> arguments)

putArgumentsItem

public AgentInstanceToolCall putArgumentsItem(String key,
 Object argumentsItem)

getArguments

@Nullable
public Map<String,Object> getArguments()

The tool call arguments as provided by the LLM. Null on TOOL_RESULT items.

Returns:

arguments

setArguments

public void setArguments(@Nullable
 Map<String,Object> arguments)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object