​

Class: RetrieverSpan

Defined in: src/types/log.types.ts:250

​

Extends

• BaseStep

​

Constructors

​

Constructor

new RetrieverSpan(data: object): RetrieverSpan;

Defined in: src/types/log.types.ts:256

​

Parameters

data

createdAtNs?

number

durationNs?

number

groundTruth?

string

input

StepIOType

metadata?

Record<string, string>

name?

string

output

RetrieverStepAllowedOutputType

parent?

StepWithChildSpans

statusCode?

number

tags?

string[]

​

Returns

RetrieverSpan

​

Overrides

BaseStep.constructor;

​

Properties

​

createdAtNs

createdAtNs: number;

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

​

Inherited from

BaseStep.createdAtNs;

​

durationNs

durationNs: number = 0;

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

​

Inherited from

BaseStep.durationNs;

​

externalId?

optional externalId: string;

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

​

Inherited from

BaseStep.externalId;

​

groundTruth?

optional groundTruth: string;

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

​

Inherited from

BaseStep.groundTruth;

​

input

input: string;

Defined in: src/types/log.types.ts:253

​

Overrides

BaseStep.input;

​

metrics

metrics: Metrics = {};

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

​

Inherited from

BaseStep.metrics;

​

modelConfig?

optional modelConfig: Record<string, any>;

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

​

Inherited from

BaseStep.modelConfig;

​

name

name: string = "";

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

​

Inherited from

BaseStep.name;

​

output

output: Document[] = [];

Defined in: src/types/log.types.ts:254

​

Overrides

BaseStep.output;

​

parent?

optional parent: StepWithChildSpans;

Defined in: src/types/log.types.ts:252

​

statusCode?

optional statusCode: number;

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

​

Inherited from

BaseStep.statusCode;

​

tags?

optional tags: string[];

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

​

Inherited from

BaseStep.tags;

​

type

type: NodeType = NodeType.retriever;

Defined in: src/types/log.types.ts:251

​

Overrides

BaseStep.type;

​

userMetadata

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

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

​

Inherited from

BaseStep.userMetadata;

​

Methods

​

toJSON()

toJSON(): Record<string, any>;

Defined in: src/types/log.types.ts:276

​

Returns

Record<string, any>

​

Overrides

BaseStep.toJSON;

​

validateInputOutputSerializable()

validateInputOutputSerializable(val: StepIOType): StepIOType;

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

​

Parameters

val

StepIOType

​

Returns

StepIOType

​

Inherited from

BaseStep.validateInputOutputSerializable;