Skip to main content
Defined in: src/genai/subagent.ts:84

​
Extends

  • SpanBase

​
Accessors

​
model

​
Get Signature

get model(): string
Defined in: src/genai/subagent.ts:101
Returns
string

​
name

​
Get Signature

get name(): string
Defined in: src/genai/subagent.ts:97
Returns
string

​
Methods

​
addEvent()

Deprecated. Record this data via setAttributes instead. OpenTelemetry is phasing out the Span Event API (Span.addEvent). This method still works and existing span-event data stays valid. See https://opentelemetry.io/blog/2026/deprecating-span-events/
addEvent(name, attributes?, startTime?): this
Add a named event to the span. Useful for marking non-span moments such as context compaction, tool-loop detection, or guardrail trips. Warns and no-ops after end(). Mirrors OTel Span.addEvent. Defined in: src/genai/spanBase.ts:84

​
Parameters

name
string
attributes?
Attributes
startTime?
TimeInput

​
Returns

this

​
Example

​
Inherited from

SpanBase.addEvent

​
end()

end(opts?): void
Read current field values (to reflect mutations made via record() since start) and close the span. Idempotent. Pass error to mark it as failed; pass endTime to backdate the close. Defined in: src/genai/subagent.ts:218

​
Parameters

opts?
endTime?
TimeInput
error?
Error

​
Returns

void

​
record()

record(opts): this
Bulk-set any subset of the mutable fields. Replaces (does not merge). Input and output messages are serialized when the span ends. Defined in: src/genai/subagent.ts:174

​
Parameters

opts
agentDescription?
string
agentId?
string
agentVersion?
string
messages?
Message[]
model?
string
name?
string
outputMessages?
Message[]
systemInstructions?
string[]

​
Returns

this

​
setAttributes()

setAttributes(attributes): this
Set multiple attributes on the span at once. Warns and no-ops after end(). Mirrors OTel Span.setAttributes (and the Python SDK’s set_attributes). Defined in: src/genai/spanBase.ts:65

​
Parameters

attributes
Attributes

​
Returns

this

​
Example

​
Inherited from

SpanBase.setAttributes

​
startLLM()

startLLM(opts): LLM
Start a child LLM span nested under this SubAgent. Defined in: src/genai/subagent.ts:141

​
Parameters

opts
LLMInit

​
Returns

LLM

​
startSubagent()

startSubagent(opts): SubAgent
Start a nested SubAgent span under this SubAgent. Defined in: src/genai/subagent.ts:161

​
Parameters

opts
SubAgentInit

​
Returns

SubAgent

​
startTool()

startTool(opts): Tool
Start a child Tool span nested under this SubAgent. Defined in: src/genai/subagent.ts:151

​
Parameters

opts
ToolInit

​
Returns

Tool