Skip to main content

Class: BaseStep

Defined in: src/types/logging/step.types.ts

Extended by

Constructors

Constructor

new BaseStep(type: "agent" | "llm" | "retriever" | "tool" | "workflow" | "trace" | "session", data: BaseStepOptions): BaseStep;
Defined in: src/types/logging/step.types.ts

Parameters

type
"agent" | "llm" | "retriever" | "tool" | "workflow" | "trace" | "session"
data
BaseStepOptions

Returns

BaseStep

Properties

createdAt

createdAt: Date;
Defined in: src/types/logging/step.types.ts

datasetInput?

optional datasetInput: string;
Defined in: src/types/logging/step.types.ts

datasetMetadata?

optional datasetMetadata: Record<string, string> = {};
Defined in: src/types/logging/step.types.ts

datasetOutput?

optional datasetOutput: string;
Defined in: src/types/logging/step.types.ts

externalId?

optional externalId: string;
Defined in: src/types/logging/step.types.ts

input?

optional input: StepAllowedInputType;
Defined in: src/types/logging/step.types.ts

metrics

metrics: Metrics;
Defined in: src/types/logging/step.types.ts

name

name: string = "";
Defined in: src/types/logging/step.types.ts

output?

optional output: StepAllowedOutputType;
Defined in: src/types/logging/step.types.ts

redactedInput?

optional redactedInput: StepAllowedInputType;
Defined in: src/types/logging/step.types.ts

redactedOutput?

optional redactedOutput: StepAllowedOutputType;
Defined in: src/types/logging/step.types.ts

statusCode?

optional statusCode: number;
Defined in: src/types/logging/step.types.ts

stepNumber?

optional stepNumber: number;
Defined in: src/types/logging/step.types.ts

tags?

optional tags: string[];
Defined in: src/types/logging/step.types.ts

type

type: "agent" | "llm" | "retriever" | "tool" | "workflow" | "trace" | "session";
Defined in: src/types/logging/step.types.ts

userMetadata

userMetadata: Record<string, string> = {};
Defined in: src/types/logging/step.types.ts

Methods

toJSON()

toJSON(): Record<string, any>;
Defined in: src/types/logging/step.types.ts

Returns

Record<string, any>

validateInputOutputSerializable()

validateInputOutputSerializable<T>(val: T): T;
Defined in: src/types/logging/step.types.ts

Type Parameters

T
T = | string | { content: string; role: | "function" | "agent" | "tool" | "user" | "assistant" | "developer" | "system"; tool_call_id?: null | string; tool_calls?: null | object[]; } | string[] | Document | Record<string, string> | Document[] | Record<string, string>[] | object[] | Record<string, string>[]

Parameters

val
T

Returns

T