langchain.js
    Preparing search index...

    Interface BaseRun

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

    interface BaseRun {
        attachments?: Attachments;
        dotted_order?: string;
        end_time?: string | number;
        error?: string;
        events?: KVMap[];
        extra?: KVMap;
        id?: string;
        inputs: KVMap;
        name: string;
        outputs?: KVMap;
        parent_run_id?: string;
        reference_example_id?: string;
        run_type: string;
        serialized?: object;
        start_time?: string | number;
        tags?: string[];
        trace_id?: string;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    attachments? dotted_order? end_time? error? events? extra? id? inputs name outputs? parent_run_id? reference_example_id? run_type serialized? start_time? tags? trace_id?

    Properties

    attachments?: Attachments

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

    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
    end_time?: string | number

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

    error?: string

    Error message, captured if the run faces any issues.

    events?: KVMap[]

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

    extra?: KVMap

    Any additional metadata or settings for the run.

    id?: string

    Optionally, a unique identifier for the run.

    inputs: KVMap

    Inputs that were used to initiate the run.

    name: string

    A human-readable name for the run.

    outputs?: KVMap

    Outputs produced by the run, if any.

    parent_run_id?: string

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

    reference_example_id?: string

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

    run_type: string

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

    serialized?: object

    Serialized state of the run for potential future use.

    start_time?: string | number

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

    tags?: string[]

    Tags for further categorizing or annotating the run.

    trace_id?: string

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

    Settings

    Member Visibility

    On This Page

    Properties