Class RunTree

A run can represent either a trace (root run) or a child run (~span).

Implements

BaseRun

Constructors

constructor

new RunTree(originalConfig: RunTreeConfig | RunTree): RunTree
Parameters
- originalConfig: RunTreeConfig | RunTree
Returns RunTree
- Defined in src/run_trees.ts:234

Properties

child_execution_order

child_execution_order: number

child_runs

child_runs: RunTree[]

client

client: Client

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

execution_order

execution_order: number

extra

extra: KVMap

Any additional metadata or settings for the run.

id

id: string

Optionally, a unique identifier for the run.

inputs

inputs: KVMap

Inputs that were used to initiate the run.

name

name: string

A human-readable name for the run.

project_name

project_name: string

run_type

run_type: string

Specifies the type of run (tool, chain, llm, etc.).

serialized

serialized: object

Serialized state of the run for potential future use.

start_time

start_time: number

The epoch time at which the run started, if available.

trace_id

trace_id: string

Unique ID assigned to every run within this nested trace. *

`Optional`attachments

attachments?: Attachments

Attachments associated with the run. Each entry is a tuple of [mime_type, bytes]

`Optional`end_time

end_time?: number

The epoch time at which the run ended, if applicable.

`Optional`error

error?: string

Error message, captured if the run faces any issues.

`Optional`events

events?: KVMap[]

Events like 'start', 'end' linked to the run.

`Optional`outputs

outputs?: KVMap

Outputs produced by the run, if any.

`Optional`parent_run

parent_run?: RunTree

`Optional`parent_run_id

parent_run_id?: string

ID of a parent run, if this run is part of a larger operation.

`Optional`reference_example_id

reference_example_id?: string

ID of an example that might be related to this run.

`Optional`replicas

replicas?: WriteReplica[]

Projects to replicate this run to with optional updates.

`Optional`tags

tags?: string[]

Tags for further categorizing or annotating the run.

`Optional`tracingEnabled

tracingEnabled?: boolean

Accessors

metadata

get metadata(): KVMap
Returns KVMap
- Defined in src/run_trees.ts:287
set metadata(metadata: KVMap): void
Parameters
- metadata: KVMap
Returns void
- Defined in src/run_trees.ts:277

Methods

addEvent

addEvent(event: string | RunEvent): void
Add an event to the run tree.
Parameters
- event: string | RunEvent
  A single event or string to add
Returns void
- Defined in src/run_trees.ts:627

createChild

createChild(config: RunTreeConfig): RunTree
Parameters
- config: RunTreeConfig
Returns RunTree
- Defined in src/run_trees.ts:315

end

end(
    outputs?: KVMap,
    error?: string,
    endTime?: number,
    metadata?: KVMap,
): Promise<void>
Parameters
- Optionaloutputs: KVMap
- Optionalerror: string
- endTime: number = ...
- Optionalmetadata: KVMap
Returns Promise<void>
- Defined in src/run_trees.ts:383

patchRun

patchRun(options?: { excludeInputs?: boolean }): Promise<void>
Parameters
- Optionaloptions: { excludeInputs?: boolean }
Returns Promise<void>
- Defined in src/run_trees.ts:557

postRun

postRun(excludeChildRuns?: boolean): Promise<void>
Parameters
- excludeChildRuns: boolean = true
Returns Promise<void>
- Defined in src/run_trees.ts:518

toHeaders

toHeaders(headers?: HeadersLike): { baggage: string; "langsmith-trace": string }
Parameters
- Optionalheaders: HeadersLike
Returns { baggage: string; "langsmith-trace": string }
- Defined in src/run_trees.ts:751

toJSON

toJSON(): RunCreate & { id: string }
Returns RunCreate & { id: string }
- Defined in src/run_trees.ts:619

`Static`fromDottedOrder

fromDottedOrder(dottedOrder: string): undefined | RunTree
Parameters
- dottedOrder: string
Returns undefined | RunTree
- Defined in src/run_trees.ts:703

`Static`fromHeaders

fromHeaders(
headers: HeadersLike | Record<string, string | string[]>,
inheritArgs?: Partial<RunTreeConfig>,
): undefined | RunTree
Parameters
- headers: HeadersLike | Record<string, string | string[]>
- OptionalinheritArgs: Partial<RunTreeConfig>
Returns undefined | RunTree
- Defined in src/run_trees.ts:707

`Static`fromRunnableConfig

fromRunnableConfig(
parentConfig: RunnableConfigLike,
props: RunTreeConfig,
): RunTree
Parameters
- parentConfig: RunnableConfigLike
- props: RunTreeConfig
Returns RunTree
- Defined in src/run_trees.ts:646

`Static`getSharedClient

getSharedClient(): Client
Returns Client
- Defined in src/run_trees.ts:308

Class RunTree

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RunTree

Properties

child_execution_order

child_runs

client

dotted_order

execution_order

extra

id

inputs

name

project_name

run_type

serialized

start_time

trace_id

Optionalattachments

Optionalend_time

Optionalerror

Optionalevents

Optionaloutputs

Optionalparent_run

Optionalparent_run_id

Optionalreference_example_id

Optionalreplicas

Optionaltags

OptionaltracingEnabled

Accessors

metadata

Returns KVMap

Parameters

Returns void

Methods

addEvent

Parameters

Returns void

createChild

Parameters

Returns RunTree

end

Parameters

Returns Promise<void>

patchRun

Parameters

Returns Promise<void>

postRun

Parameters

Returns Promise<void>

toHeaders

Parameters

Returns { baggage: string; "langsmith-trace": string }

toJSON

Returns RunCreate & { id: string }

StaticfromDottedOrder

Parameters

Returns undefined | RunTree

StaticfromHeaders

Parameters

Returns undefined | RunTree

StaticfromRunnableConfig

Parameters

Returns RunTree

StaticgetSharedClient

Returns Client

Settings

On This Page

`Optional`attachments

`Optional`end_time

`Optional`error

`Optional`events

`Optional`outputs

`Optional`parent_run

`Optional`parent_run_id

`Optional`reference_example_id

`Optional`replicas

`Optional`tags

`Optional`tracingEnabled

`Static`fromDottedOrder

`Static`fromHeaders

`Static`fromRunnableConfig

`Static`getSharedClient