ExtractionCapability
Agent-level extraction: collects structured data across turns using a
single submit_extracted_data tool. Distinct from flow-node extraction in
per-node extraction — this is for standalone agents, not flow nodes.
Implements
Section titled “Implements”CapabilityExtractionStrategy
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ExtractionCapability(config): ExtractionCapability;Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
Returns
Section titled “Returns”ExtractionCapability
Properties
Section titled “Properties”readonly name: "extraction-capability" = 'extraction-capability';Human-readable name used in telemetry and diagnostics.
Implementation of
Section titled “Implementation of”ExtractionStrategy.nameAccessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get data(): Record<string, unknown>;Read the data collected so far.
Returns
Section titled “Returns”Record<string, unknown>
Methods
Section titled “Methods”getPromptSections()
Section titled “getPromptSections()”getPromptSections(): CapabilityPromptSection[];What does this capability contribute to the system prompt?
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”getTools()
Section titled “getTools()”getTools(): ToolDeclaration<unknown, unknown>[];What tools does this capability expose for the current state?
Returns
Section titled “Returns”ToolDeclaration<unknown, unknown>[]
Implementation of
Section titled “Implementation of”processToolResult()
Section titled “processToolResult()”processToolResult( toolName, args, result): CapabilityAction | null;A tool was called and executed. Does this capability handle the result?
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
|
|
|
The name of the tool that was called |
|
|
|
The arguments passed to the tool |
|
|
|
The result returned by the tool’s execute() |
Returns
Section titled “Returns”CapabilityAction | null
An action telling the host what to do, or null if this capability doesn’t handle this tool.
Implementation of
Section titled “Implementation of”runExtractionPass()
Section titled “runExtractionPass()”runExtractionPass(params): Promise<ExtractionPassResult>;ExtractionStrategy impl — merges params.currentData into capability
state and returns the resulting snapshot. Does not run an LLM call;
LLM-driven extraction for this capability happens through the
submit_extracted_data tool and processToolResult.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
|
|
|
Returns
Section titled “Returns”Promise<ExtractionPassResult>
Implementation of
Section titled “Implementation of”ExtractionStrategy.runExtractionPass