​

Class: BaseStep

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

​

Extended by

• BaseSpan
• RetrieverSpan
• ToolSpan

​

Constructors

​

Constructor

new BaseStep(type: StepType, data: BaseStepOptions): BaseStep;

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

​

Parameters

type

StepType

data

BaseStepOptions

​

Returns

BaseStep

​

Properties

​

createdAt

createdAt: Date;

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

​

datasetInput?

optional datasetInput: string;

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

​

datasetMetadata?

optional datasetMetadata: Record<string, string> = {};

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

​

datasetOutput?

optional datasetOutput: string;

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

​

externalId?

optional externalId: string;

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

​

input?

optional input: StepAllowedInputType;

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

​

metrics

metrics: Metrics;

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

​

name

name: string = "";

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

​

output?

optional output: StepAllowedOutputType;

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

​

statusCode?

optional statusCode: number;

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

​

stepNumber?

optional stepNumber: number;

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

​

tags?

optional tags: string[];

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

​

type

type: StepType;

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

​

userMetadata

userMetadata: Record<string, string> = {};

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

​

Methods

​

toJSON()

toJSON(): Record<string, any>;

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

​

Returns

Record<string, any>

​

validateInputOutputSerializable()

validateInputOutputSerializable<T>(val: T): T;

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

​

Type Parameters

T

T = | string | string[] | Document | Message | Record<string, string> | Message[] | Record<string, string>[] | Record<string, string>[] | Document[]

​

Parameters

val

T

​

Returns

T