Interface RunCreate2

interface RunCreate2 {
    attachments?: Attachments;
    child_runs?: RunCreate2[];
    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;
    revision_id?: string;
    run_type: string;
    serialized?: object;
    session_name?: string;
    start_time?: string | number;
    tags?: string[];
    trace_id?: string;
}

Hierarchy

  • RunCreate
    • RunCreate2

Properties

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

Properties

Optionalattachments

attachments?: Attachments

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

Optionalchild_runs

child_runs?: RunCreate2[]

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?: string | 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.

Optionalid

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.

Optionaloutputs

outputs?: KVMap

Outputs produced by the run, if any.

Optionalparent_run_id

parent_run_id?: string

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

Optionalreference_example_id

reference_example_id?: string

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

Optionalrevision_id

revision_id?: string

run_type

run_type: string

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

Optionalserialized

serialized?: object

Serialized state of the run for potential future use.

Optionalsession_name

session_name?: string

Optionalstart_time

start_time?: string | number

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

Optionaltags

tags?: string[]

Tags for further categorizing or annotating the run.

Optionaltrace_id

trace_id?: string

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

Settings

Member Visibility

On This Page

Properties