langchain.js
    Preparing search index...

    Interface Run

    Describes properties of a run when loaded from the database. Extends the BaseRun interface.

    interface Run {
        app_path?: string;
        attachments?: Attachments;
        child_run_ids?: string[];
        child_runs?: Run[];
        completion_tokens?: number;
        dotted_order?: string;
        end_time?: string | number;
        error?: string;
        events?: KVMap[];
        extra?: KVMap;
        feedback_stats?: KVMap;
        first_token_time?: number;
        id: string;
        in_dataset?: boolean;
        inputs: KVMap;
        inputs_s3_urls?: S3URL;
        manifest_id?: string;
        name: string;
        outputs?: KVMap;
        outputs_s3_urls?: S3URL;
        parent_run_id?: string;
        parent_run_ids?: string[];
        prompt_tokens?: number;
        reference_example_id?: string;
        run_type: string;
        serialized?: object;
        session_id?: string;
        start_time?: string | number;
        status?: string;
        tags?: string[];
        total_tokens?: number;
        trace_id?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    app_path? attachments? child_run_ids? child_runs? completion_tokens? dotted_order? end_time? error? events? extra? feedback_stats? first_token_time? id in_dataset? inputs inputs_s3_urls? manifest_id? name outputs? outputs_s3_urls? parent_run_id? parent_run_ids? prompt_tokens? reference_example_id? run_type serialized? session_id? start_time? status? tags? total_tokens? trace_id?

    Properties

    app_path?: string

    The URL path where this run is accessible within the app.

    attachments?: Attachments

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

    child_run_ids?: string[]

    IDs of any child runs spawned by this run.

    child_runs?: Run[]

    Child runs, loaded explicitly via a heavier query.

    completion_tokens?: number

    Number of tokens generated in the completion.

    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.

    feedback_stats?: KVMap

    Stats capturing feedback for this run.

    first_token_time?: number

    Time when the first token was processed.

    id: string

    A unique identifier for the run, mandatory when loaded from DB.

    in_dataset?: boolean

    Whether the run is included in a dataset.

    inputs: KVMap

    Inputs that were used to initiate the run.

    inputs_s3_urls?: S3URL

    The input S3 URLs

    manifest_id?: string

    The manifest ID that correlates with this run.

    name: string

    A human-readable name for the run.

    outputs?: KVMap

    Outputs produced by the run, if any.

    outputs_s3_urls?: S3URL

    The output S3 URLs

    parent_run_id?: string

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

    parent_run_ids?: string[]

    IDs of parent runs, if multiple exist.

    prompt_tokens?: number

    Number of tokens used in the prompt.

    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.

    session_id?: string

    The ID of the project that owns this run.

    start_time?: string | number

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

    status?: string

    The current status of the run, such as 'success'.

    tags?: string[]

    Tags for further categorizing or annotating the run.

    total_tokens?: number

    Total token count, combining prompt and completion.

    trace_id?: string

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

    Settings

    Member Visibility

    On This Page

    Properties