Interface Run

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

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

Hierarchy (View Summary)

Properties

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

Properties

id

id: string

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

inputs

inputs: KVMap

Inputs that were used to initiate the run.

name

name: string

A human-readable name for the run.

run_type

run_type: string

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

Optionalapp_path

app_path?: string

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

Optionalattachments

attachments?: Attachments

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

Optionalchild_run_ids

child_run_ids?: string[]

IDs of any child runs spawned by this run.

Optionalchild_runs

child_runs?: Run[]

Child runs, loaded explicitly via a heavier query.

Optionalcompletion_tokens

completion_tokens?: number

Number of tokens generated in the completion.

Optionaldotted_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

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.

Optionalextra

extra?: KVMap

Any additional metadata or settings for the run.

Optionalfeedback_stats

feedback_stats?: KVMap

Stats capturing feedback for this run.

Optionalfirst_token_time

first_token_time?: number

Time when the first token was processed.

Optionalin_dataset

in_dataset?: boolean

Whether the run is included in a dataset.

Optionalinputs_s3_urls

inputs_s3_urls?: S3URL

The input S3 URLs

Optionalmanifest_id

manifest_id?: string

The manifest ID that correlates with this run.

Optionaloutputs

outputs?: KVMap

Outputs produced by the run, if any.

Optionaloutputs_s3_urls

outputs_s3_urls?: S3URL

The output S3 URLs

Optionalparent_run_id

parent_run_id?: string

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

Optionalparent_run_ids

parent_run_ids?: string[]

IDs of parent runs, if multiple exist.

Optionalprompt_tokens

prompt_tokens?: number

Number of tokens used in the prompt.

Optionalreference_example_id

reference_example_id?: string

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

Optionalserialized

serialized?: object

Serialized state of the run for potential future use.

Optionalsession_id

session_id?: string

The ID of the project that owns this run.

Optionalstart_time

start_time?: number

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

Optionalstatus

status?: string

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

Optionaltags

tags?: string[]

Tags for further categorizing or annotating the run.

Optionaltotal_tokens

total_tokens?: number

Total token count, combining prompt and completion.

Optionaltrace_id

trace_id?: string

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

Settings

Member Visibility

On This Page

Properties