Interface: Run
schemas.Run
Describes properties of a run when loaded from the database. Extends the BaseRun interface.
Hierarchy
↳
Run
Properties
id
• id: string
A unique identifier for the run, mandatory when loaded from DB.
Overrides
Defined in
inputs
• inputs: KVMap
Inputs that were used to initiate the run.
Inherited from
Defined in
name
• name: string
A human-readable name for the run.
Inherited from
Defined in
run_type
• run_type: string
Specifies the type of run (tool, chain, llm, etc.).
Inherited from
Defined in
app_path
• Optional app_path: string
The URL path where this run is accessible within the app.
Defined in
child_run_ids
• Optional child_run_ids: string[]
IDs of any child runs spawned by this run.
Defined in
child_runs
• Optional child_runs: Run[]
Child runs, loaded explicitly via a heavier query.
Defined in
completion_tokens
• Optional completion_tokens: number
Number of tokens generated in the completion.
Defined in
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
Inherited from
Defined in
end_time
• Optional end_time: number
The epoch time at which the run ended, if applicable.
Inherited from
Defined in
error
• Optional error: string
Error message, captured if the run faces any issues.
Inherited from
Defined in
events
• Optional events: KVMap[]
Events like 'start', 'end' linked to the run.
Inherited from
Defined in
extra
• Optional extra: KVMap
Any additional metadata or settings for the run.
Inherited from
Defined in
feedback_stats
• Optional feedback_stats: KVMap
Stats capturing feedback for this run.
Defined in
first_token_time
• Optional first_token_time: number
Time when the first token was processed.
Defined in
in_dataset
• Optional in_dataset: boolean
Whether the run is included in a dataset.
Defined in
inputs_s3_urls
• Optional inputs_s3_urls: S3URL
The input S3 URLs
Defined in
manifest_id
• Optional manifest_id: string
The manifest ID that correlates with this run.
Defined in
outputs
• Optional outputs: KVMap
Outputs produced by the run, if any.
Inherited from
Defined in
outputs_s3_urls
• Optional outputs_s3_urls: S3URL
The output S3 URLs
Defined in
parent_run_id
• Optional parent_run_id: string
ID of a parent run, if this run is part of a larger operation.
Inherited from
Defined in
parent_run_ids
• Optional parent_run_ids: string[]
IDs of parent runs, if multiple exist.
Defined in
prompt_tokens
• Optional prompt_tokens: number
Number of tokens used in the prompt.
Defined in
reference_example_id
• Optional reference_example_id: string
ID of an example that might be related to this run.
Inherited from
Defined in
serialized
• Optional serialized: object
Serialized state of the run for potential future use.
Inherited from
Defined in
session_id
• Optional session_id: string
The ID of the project that owns this run.
Defined in
start_time
• Optional start_time: number
The epoch time at which the run started, if available.
Inherited from
Defined in
status
• Optional status: string
The current status of the run, such as 'success'.
Defined in
tags
• Optional tags: string[]
Tags for further categorizing or annotating the run.
Inherited from
Defined in
total_tokens
• Optional total_tokens: number
Total token count, combining prompt and completion.
Defined in
trace_id
• Optional trace_id: string
Unique ID assigned to every run within this nested trace. *