Class: RunTree
run_trees.RunTree
A run can represent either a trace (root run) or a child run (~span).
Implements
Constructors
constructor
• new RunTree(originalConfig): RunTree
Parameters
| Name | Type |
|---|---|
originalConfig | RunTreeConfig |
Returns
Defined in
Properties
child_runs
• child_runs: RunTree[]
Defined in
client
• client: Client
Defined in
dotted_order
• dotted_order: string
The dotted order for the run.
This is a string composed of {time}{run-uuid}.* so that a trace can be sorted in the order it was executed.
Example:
- Parent: 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8
- Children:
- 20230914T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155649Z809ed3a2-0172-4f4d-8a02-a64e9b7a0f8a
- 20230915T223155647Z1b64098b-4ab7-43f6-afee-992304f198d8.20230914T223155650Zc8d9f4c5-6c5a-4b2d-9b1c-3d9d7a7c5c7c
Implementation of
Defined in
extra
• extra: KVMap
Any additional metadata or settings for the run.
Implementation of
Defined in
id
• id: string
Optionally, a unique identifier for the run.
Implementation of
Defined in
inputs
• inputs: KVMap
Inputs that were used to initiate the run.
Implementation of
Defined in
name
• name: string
A human-readable name for the run.
Implementation of
Defined in
project_name
• project_name: string
Defined in
run_type
• run_type: string
Specifies the type of run (tool, chain, llm, etc.).
Implementation of
Defined in
serialized
• serialized: object
Serialized state of the run for potential future use.
Implementation of
Defined in
start_time
• start_time: number
The epoch time at which the run started, if available.
Implementation of
Defined in
trace_id
• trace_id: string
Unique ID assigned to every run within this nested trace. *
Implementation of
Defined in
end_time
• Optional end_time: number
The epoch time at which the run ended, if applicable.
Implementation of
Defined in
error
• Optional error: string
Error message, captured if the run faces any issues.
Implementation of
Defined in
events
• Optional events: KVMap[]
Events like 'start', 'end' linked to the run.
Implementation of
Defined in
outputs
• Optional outputs: KVMap
Outputs produced by the run, if any.
Implementation of
Defined in
parent_run
• Optional parent_run: BaseRun
Defined in
reference_example_id
• Optional reference_example_id: string
ID of an example that might be related to this run.
Implementation of
Defined in
tags
• Optional tags: string[]
Tags for further categorizing or annotating the run.
Implementation of
Defined in
Methods
createChild
▸ createChild(config): RunTree
Parameters
| Name | Type |
|---|---|
config | RunTreeConfig |
Returns
Defined in
end
▸ end(outputs?, error?, endTime?): Promise<void>
Parameters
| Name | Type |
|---|---|
outputs? | KVMap |
error? | string |
endTime | number |
Returns
Promise<void>
Defined in
patchRun
▸ patchRun(): Promise<void>
Returns
Promise<void>
Defined in
postRun
▸ postRun(excludeChildRuns?): Promise<void>
Parameters
| Name | Type | Default value |
|---|---|---|
excludeChildRuns | boolean | true |
Returns
Promise<void>
Defined in
fromRunnableConfig
▸ fromRunnableConfig(config, props): RunTree
Parameters
| Name | Type |
|---|---|
config | RunnableConfigLike |
props | Object |
props.name | string |
props.metadata? | KVMap |
props.tags? | string[] |