Hierarchy
-
SpanBase↳SubAgent
Table of contents
Accessors
Methods
Accessors
model
•get model(): string
Returns
string
Defined in
src/genai/subagent.ts:78name
•get name(): string
Returns
string
Defined in
src/genai/subagent.ts:74Methods
addEvent
▸ 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.
Parameters
| Name | Type |
|---|---|
name | string |
attributes? | Attributes |
startTime? | TimeInput |
Returns
this
Inherited from
SpanBase.addEventDefined in
src/genai/spanBase.ts:82end
▸ 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.
Parameters
| Name | Type |
|---|---|
opts? | SpanEndOptions |
Returns
void
Defined in
src/genai/subagent.ts:153record
▸ record(opts): this
Bulk-set any fields. Replaces (does not merge).
Parameters
| Name | Type |
|---|---|
opts | Object |
opts.agentDescription? | string |
opts.agentId? | string |
opts.agentVersion? | string |
opts.model? | string |
opts.name? | string |
opts.systemInstructions? | string[] |
Returns
this
Defined in
src/genai/subagent.ts:117setAttributes
▸ 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).
Parameters
| Name | Type |
|---|---|
attributes | Attributes |
Returns
this
Example
Inherited from
SpanBase.setAttributesDefined in
src/genai/spanBase.ts:63create
▸ create(opts): SubAgent
Parameters
| Name | Type |
|---|---|
opts | SubAgentInit & ChildSpanContext |
Returns
SubAgent