AxAgentActorTurnCallbackArgs Generated TypeScript API reference. typescript api api/reference build/apidocs/TypeAlias.AxAgentActorTurnCallbackArgs.md type AxAgentActorTurnCallbackArgs

AxAgentActorTurnCallbackArgs

TypeScript
type AxAgentActorTurnCallbackArgs = object;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L263

Properties

actionLogEntryCount

TypeScript
actionLogEntryCount: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L269

Number of action log entries recorded after processing this turn.


chatLogMessages?

TypeScript
optional chatLogMessages: ReadonlyArray<{
  content: string;
  role: string;
}>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L292

Raw ChatML conversation for this turn (system, user, assistant). Only populated when an actor turn callback is set.


code

TypeScript
code: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L275

Normalized runtime code that was executed for this turn.


executorResult

TypeScript
executorResult: Record<string, unknown>;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L273

Full actor AxGen output for the turn, including the runtime code field and any actor fields.


guidanceLogEntryCount

TypeScript
guidanceLogEntryCount: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L271

Number of guidance log entries recorded after processing this turn.


isError

TypeScript
isError: boolean;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L284

True when the turn recorded an error output.


model?

TypeScript
optional model: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L290

Model used for this turn, when explicitly set via executorModelPolicy.


output

TypeScript
output: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L282

Action-log-safe runtime output string after formatting/truncation.


result

TypeScript
result: unknown;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L280

Raw runtime execution result before formatting or truncation. For policy-violation turns and completion-signal turns, this is undefined.


stage

TypeScript
stage: AxAgentContextStage;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L265

Actor stage that produced this turn.


thought?

TypeScript
optional thought: string;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L286

Thought text returned by the actor AxGen when available.


turn

TypeScript
turn: number;

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L267

1-based actor turn number.


usage?

TypeScript
optional usage: AxProgramUsage[];

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/agent/agentInternal/agentStateTypes.ts#L288

Token usage for this turn only.

Docs