Skip to main content

Interface: BaseRun

schemas.BaseRun

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

Hierarchy​

Implemented by​

Properties​

inputs​

• inputs: KVMap

Inputs that were used to initiate the run.

Defined in​

schemas.ts:98

name​

• name: string

A human-readable name for the run.

Defined in​

schemas.ts:74

run_type​

• run_type: string

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

Defined in​

schemas.ts:80

dotted_order​

• Optional 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

Defined in​

schemas.ts:127

end_time​

• Optional end_time: number

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

Defined in​

schemas.ts:83

error​

• Optional error: string

Error message, captured if the run faces any issues.

Defined in​

schemas.ts:89

events​

• Optional events: KVMap[]

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

Defined in​

schemas.ts:95

extra​

• Optional extra: KVMap

Any additional metadata or settings for the run.

Defined in​

schemas.ts:86

id​

• Optional id: string

Optionally, a unique identifier for the run.

Defined in​

schemas.ts:71

outputs​

• Optional outputs: KVMap

Outputs produced by the run, if any.

Defined in​

schemas.ts:101

parent_run_id​

• Optional parent_run_id: string

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

Defined in​

schemas.ts:107

reference_example_id​

• Optional reference_example_id: string

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

Defined in​

schemas.ts:104

serialized​

• Optional serialized: object

Serialized state of the run for potential future use.

Defined in​

schemas.ts:92

start_time​

• Optional start_time: number

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

Defined in​

schemas.ts:77

tags​

• Optional tags: string[]

Tags for further categorizing or annotating the run.

Defined in​

schemas.ts:110

trace_id​

• Optional trace_id: string

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

Defined in​

schemas.ts:113

Was this page helpful?