Package io.camunda.client.protocol.rest

Class AgentInstanceHistoryItemRequest

java.lang.Object

io.camunda.client.protocol.rest.AgentInstanceHistoryItemRequest

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

Request to append a single history item to an agent instance's conversation history.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CONTENT
static final String	JSON_PROPERTY_ELEMENT_INSTANCE_KEY
static final String	JSON_PROPERTY_JOB_KEY
static final String	JSON_PROPERTY_JOB_LEASE
static final String	JSON_PROPERTY_LOOP_ITERATION
static final String	JSON_PROPERTY_METRICS
static final String	JSON_PROPERTY_PRODUCED_AT
static final String	JSON_PROPERTY_ROLE
static final String	JSON_PROPERTY_TOOL_CALLS

Constructor Summary

Constructors

Constructor	Description
AgentInstanceHistoryItemRequest()

Method Summary

Modifier and Type	Method	Description
AgentInstanceHistoryItemRequest	addContentItem(AgentInstanceMessageContent contentItem)
AgentInstanceHistoryItemRequest	addToolCallsItem(AgentInstanceToolCall toolCallsItem)
AgentInstanceHistoryItemRequest	content(List<AgentInstanceMessageContent> content)
AgentInstanceHistoryItemRequest	elementInstanceKey(String elementInstanceKey)
boolean	equals(Object o)
List<AgentInstanceMessageContent>	getContent()	The content blocks of this history item.
String	getElementInstanceKey()	The key of the currently-active element instance.
String	getJobKey()	The key of the current job activation during which this history item was produced.
String	getJobLease()	Opaque lease token received from the job activation response.
Integer	getLoopIteration()	The loopIteration this item belongs to.
AgentInstanceHistoryItemMetrics	getMetrics()	Per-call token and latency metrics.
String	getProducedAt()	The connector-side timestamp of when this message was produced.
AgentInstanceHistoryRoleEnum	getRole()	The role of this history item in the conversation.
List<AgentInstanceToolCall>	getToolCalls()	Tool calls associated with this history item.
int	hashCode()
AgentInstanceHistoryItemRequest	jobKey(String jobKey)
AgentInstanceHistoryItemRequest	jobLease(String jobLease)
AgentInstanceHistoryItemRequest	loopIteration(Integer loopIteration)
AgentInstanceHistoryItemRequest	metrics(AgentInstanceHistoryItemMetrics metrics)
AgentInstanceHistoryItemRequest	producedAt(String producedAt)
AgentInstanceHistoryItemRequest	role(AgentInstanceHistoryRoleEnum role)
void	setContent(List<AgentInstanceMessageContent> content)
void	setElementInstanceKey(String elementInstanceKey)
void	setJobKey(String jobKey)
void	setJobLease(String jobLease)
void	setLoopIteration(Integer loopIteration)
void	setMetrics(AgentInstanceHistoryItemMetrics metrics)
void	setProducedAt(String producedAt)
void	setRole(AgentInstanceHistoryRoleEnum role)
void	setToolCalls(List<AgentInstanceToolCall> toolCalls)
AgentInstanceHistoryItemRequest	toolCalls(List<AgentInstanceToolCall> toolCalls)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_ELEMENT_INSTANCE_KEY

public static final String JSON_PROPERTY_ELEMENT_INSTANCE_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_JOB_KEY

public static final String JSON_PROPERTY_JOB_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_JOB_LEASE

public static final String JSON_PROPERTY_JOB_LEASE

See Also:

• Constant Field Values

JSON_PROPERTY_LOOP_ITERATION

public static final String JSON_PROPERTY_LOOP_ITERATION

See Also:

• Constant Field Values

JSON_PROPERTY_ROLE

public static final String JSON_PROPERTY_ROLE

See Also:

• Constant Field Values

JSON_PROPERTY_CONTENT

public static final String JSON_PROPERTY_CONTENT

See Also:

• Constant Field Values

JSON_PROPERTY_TOOL_CALLS

public static final String JSON_PROPERTY_TOOL_CALLS

See Also:

• Constant Field Values

JSON_PROPERTY_METRICS

public static final String JSON_PROPERTY_METRICS

See Also:

• Constant Field Values

JSON_PROPERTY_PRODUCED_AT

public static final String JSON_PROPERTY_PRODUCED_AT

See Also:

• Constant Field Values

Constructor Details

AgentInstanceHistoryItemRequest

public AgentInstanceHistoryItemRequest()

Method Details

elementInstanceKey

public AgentInstanceHistoryItemRequest elementInstanceKey(@Nonnull
 String elementInstanceKey)

getElementInstanceKey

@Nonnull
public String getElementInstanceKey()

The key of the currently-active element instance.

Returns:

elementInstanceKey

setElementInstanceKey

public void setElementInstanceKey(@Nonnull
 String elementInstanceKey)

jobKey

public AgentInstanceHistoryItemRequest jobKey(@Nonnull
 String jobKey)

getJobKey

@Nonnull
public String getJobKey()

The key of the current job activation during which this history item was produced.

Returns:

jobKey

setJobKey

public void setJobKey(@Nonnull
 String jobKey)

jobLease

public AgentInstanceHistoryItemRequest jobLease(@Nonnull
 String jobLease)

getJobLease

@Nonnull
public String getJobLease()

Opaque lease token received from the job activation response.

Returns:

jobLease

setJobLease

public void setJobLease(@Nonnull
 String jobLease)

loopIteration

public AgentInstanceHistoryItemRequest loopIteration(@Nullable
 Integer loopIteration)

getLoopIteration

@Nullable
public Integer getLoopIteration()

The loopIteration this item belongs to. A loopIteration is one pass through the agent feedback loop: one LLM call, its tool dispatches, and their results. Omit if not grouping items by loopIteration. minimum: 1

Returns:

loopIteration

setLoopIteration

public void setLoopIteration(@Nullable
 Integer loopIteration)

role

public AgentInstanceHistoryItemRequest role(@Nonnull
 AgentInstanceHistoryRoleEnum role)

getRole

@Nonnull
public AgentInstanceHistoryRoleEnum getRole()

The role of this history item in the conversation.

Returns:

role

setRole

public void setRole(@Nonnull
 AgentInstanceHistoryRoleEnum role)

content

public AgentInstanceHistoryItemRequest content(@Nonnull
 List<AgentInstanceMessageContent> content)

addContentItem

public AgentInstanceHistoryItemRequest addContentItem(AgentInstanceMessageContent contentItem)

getContent

@Nonnull
public List<AgentInstanceMessageContent> getContent()

The content blocks of this history item.

Returns:

content

setContent

public void setContent(@Nonnull
 List<AgentInstanceMessageContent> content)

toolCalls

public AgentInstanceHistoryItemRequest toolCalls(@Nullable
 List<AgentInstanceToolCall> toolCalls)

addToolCallsItem

public AgentInstanceHistoryItemRequest addToolCallsItem(AgentInstanceToolCall toolCallsItem)

getToolCalls

@Nullable
public List<AgentInstanceToolCall> getToolCalls()

Tool calls associated with this history item. For ASSISTANT items: tool calls dispatched by this LLM response, with arguments populated. For TOOL_RESULT items: single-entry array referencing the originating tool call, with arguments null. Omit for USER items.

Returns:

toolCalls

setToolCalls

public void setToolCalls(@Nullable
 List<AgentInstanceToolCall> toolCalls)

metrics

public AgentInstanceHistoryItemRequest metrics(@Nullable
 AgentInstanceHistoryItemMetrics metrics)

getMetrics

@Nullable
public AgentInstanceHistoryItemMetrics getMetrics()

Per-call token and latency metrics. Present on ASSISTANT items only.

Returns:

metrics

setMetrics

public void setMetrics(@Nullable
 AgentInstanceHistoryItemMetrics metrics)

producedAt

public AgentInstanceHistoryItemRequest producedAt(@Nonnull
 String producedAt)

getProducedAt

@Nonnull
public String getProducedAt()

The connector-side timestamp of when this message was produced.

Returns:

producedAt

setProducedAt

public void setProducedAt(@Nonnull
 String producedAt)

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