Skip to main content

Class: RetrieverSpan

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

Extends

Constructors

Constructor

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

Parameters

data
RetrieverSpanOptions

Returns

RetrieverSpan

Overrides

BaseStep.constructor

Properties

createdAt

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

Inherited from

BaseStep.createdAt

datasetInput?

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

Inherited from

BaseStep.datasetInput

datasetMetadata?

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

Inherited from

BaseStep.datasetMetadata

datasetOutput?

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

Inherited from

BaseStep.datasetOutput

externalId?

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

Inherited from

BaseStep.externalId

input

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

Overrides

BaseStep.input

metrics

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

Inherited from

BaseStep.metrics

name

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

Inherited from

BaseStep.name

output

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

Overrides

BaseStep.output

redactedInput?

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

Overrides

BaseStep.redactedInput

redactedOutput?

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

Overrides

BaseStep.redactedOutput

statusCode?

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

Inherited from

BaseStep.statusCode

stepNumber?

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

Inherited from

BaseStep.stepNumber

tags?

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

Inherited from

BaseStep.tags

type

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

Overrides

BaseStep.type

userMetadata

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

Inherited from

BaseStep.userMetadata

Methods

toJSON()

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

Returns

Record<string, any>

Overrides

BaseStep.toJSON

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

Inherited from

BaseStep.validateInputOutputSerializable