@camunda8/orchestration-cluster-api
    Preparing search index...

    Type Alias AgentInstanceHistoryItemResult

    A single conversation history item belonging to an agent instance.

    type AgentInstanceHistoryItemResult = {
        agentInstanceKey: AgentInstanceKey;
        commitStatus: AgentInstanceHistoryCommitStatusEnum;
        content: AgentInstanceMessageContent[];
        elementInstanceKey: ElementInstanceKey;
        historyItemKey: AgentHistoryItemKey;
        iteration: IterationId | null;
        jobKey: JobKey;
        jobLease: string;
        metrics: AgentInstanceHistoryItemMetrics | null;
        producedAt: string;
        role: AgentInstanceHistoryRoleEnum;
        toolCalls: AgentInstanceToolCall[];
    }
    Index

    Properties

    agentInstanceKey commitStatus content elementInstanceKey historyItemKey iteration jobKey jobLease metrics producedAt role toolCalls

    Properties

    agentInstanceKey: AgentInstanceKey

    The key of the agent instance this item belongs to.

    commitStatus: AgentInstanceHistoryCommitStatusEnum

    The commit status of this history item.

    content

    content: AgentInstanceMessageContent[]

    The content blocks of this history item.

    elementInstanceKey: ElementInstanceKey

    The key of the AI Agent Task or ad-hoc sub-process element instance under which this item was produced.

    historyItemKey: AgentHistoryItemKey

    The unique key for this history item. Stable and sortable by creation order.

    iteration: IterationId | null

    The sequential iteration number this item belongs to. Null if not provided by the connector.

    jobKey: JobKey

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

    jobLease: string

    The lease token of the activation that produced this item.

    metrics: AgentInstanceHistoryItemMetrics | null

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

    producedAt: string

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

    role: AgentInstanceHistoryRoleEnum

    The role of this history item in the conversation.

    toolCalls: AgentInstanceToolCall[]

    Tool calls for this item. Empty for USER items and ASSISTANT items with no tool dispatches. ASSISTANT items: dispatched tool calls with arguments populated. TOOL_RESULT items: single-entry array referencing the originating tool call (arguments null).

    Settings

    Member Visibility

    On This Page

    Properties