Class RunTree

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

Implements

Constructors

constructor

Properties

child_execution_order child_runs client dotted_order execution_order extra id inputs name project_name run_type serialized start_time trace_id attachments? end_time? error? events? outputs? parent_run? reference_example_id? tags? tracingEnabled?

Methods

createChild end patchRun postRun toHeaders toJSON fromDottedOrder fromHeaders fromRunnableConfig

Constructors

constructor

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. *

Optionalattachments

attachments?: Attachments

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

Optionalend_time

end_time?: number

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

Optionalerror

error?: string

Error message, captured if the run faces any issues.

Optionalevents

events?: KVMap[]

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

Optionaloutputs

outputs?: KVMap

Outputs produced by the run, if any.

Optionalparent_run

parent_run?: RunTree

Optionalreference_example_id

reference_example_id?: string

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

Optionaltags

tags?: string[]

Tags for further categorizing or annotating the run.

OptionaltracingEnabled

tracingEnabled?: boolean

Methods

createChild

end

  • end(
        outputs?: KVMap,
        error?: string,
        endTime?: number,
        metadata?: KVMap,
    ): Promise<void>

  • Parameters

    • Optionaloutputs: KVMap
    • Optionalerror: string
    • endTime: number = ...
    • Optionalmetadata: KVMap

    Returns Promise<void>

patchRun

postRun

  • postRun(excludeChildRuns?: boolean): Promise<void>

  • Parameters

    • excludeChildRuns: boolean = true

    Returns Promise<void>

toHeaders

  • toHeaders(headers?: HeadersLike): { baggage: string; "langsmith-trace": string }

  • Parameters

    • Optionalheaders: HeadersLike

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

toJSON

StaticfromDottedOrder

StaticfromHeaders

StaticfromRunnableConfig

Settings

Member Visibility

On This Page

Constructors
Properties
Methods