Class: RetrieverSpan

Defined in: src/types/logging/span.types.ts:215

Extends

Constructors

Constructor

new RetrieverSpan(data: RetrieverSpanOptions): RetrieverSpan;
Defined in: src/types/logging/span.types.ts:222

Parameters

data
RetrieverSpanOptions

Returns

RetrieverSpan

Overrides

BaseStep.constructor

Properties

createdAt

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

Inherited from

BaseStep.createdAt

datasetInput?

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

Inherited from

BaseStep.datasetInput

datasetMetadata?

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

Inherited from

BaseStep.datasetMetadata

datasetOutput?

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

Inherited from

BaseStep.datasetOutput

externalId?

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

Inherited from

BaseStep.externalId

input

input: string;
Defined in: src/types/logging/span.types.ts:217

Overrides

BaseStep.input

metrics

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

Inherited from

BaseStep.metrics

name

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

Inherited from

BaseStep.name

output

output: Document[] = [];
Defined in: src/types/logging/span.types.ts:219

Overrides

BaseStep.output

redactedInput?

optional redactedInput: string;
Defined in: src/types/logging/span.types.ts:218

Overrides

BaseStep.redactedInput

redactedOutput?

optional redactedOutput: Document[];
Defined in: src/types/logging/span.types.ts:220

Overrides

BaseStep.redactedOutput

statusCode?

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

Inherited from

BaseStep.statusCode

stepNumber?

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

Inherited from

BaseStep.stepNumber

tags?

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

Inherited from

BaseStep.tags

type

type: StepType = StepType.retriever;
Defined in: src/types/logging/span.types.ts:216

Overrides

BaseStep.type

userMetadata

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

Inherited from

BaseStep.userMetadata

Methods

toJSON()

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

Returns

Record<string, any>

Overrides

BaseStep.toJSON

validateInputOutputSerializable()

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

Type Parameters

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

Parameters

val
T

Returns

T

Inherited from

BaseStep.validateInputOutputSerializable