Skip to main content

​
Class: Retrieval

Defined in: src/lib/logger/components/retrieval.ts:40 Represents a retrieval. Retrieval operations capture the process of searching, querying, or fetching relevant information from databases, vector stores, knowledge bases, or other data sources. Essential for RAG (Retrieval-Augmented Generation) applications. Retrieval

​
Example

const retrieval = container.retrieval({
  id: 'faq-search-001',
  name: 'FAQ Knowledge Search',
});

// Set the search query
retrieval.input('How do I reset my password?');

// Record the retrieved documents
retrieval.output([
  'To reset your password, go to Settings > Security...',
  'Password requirements: minimum 8 characters...',
  'If you forgot your password, click "Forgot Password"...'
]);

​
Extends

​
Constructors

​
Constructor

new Retrieval(config, writer): Retrieval
Defined in: src/lib/logger/components/retrieval.ts:52 Creates a new retrieval log entry.

​
Parameters

config
RetrievalConfig Configuration object defining the retrieval
writer
LogWriter Log writer instance for persisting retrieval data

​
Returns

Retrieval

​
Example

const retrieval = container.retrieval({
  id: 'knowledge-search-001',
  name: 'Product Knowledge Base Search',
});

​
Overrides

EvaluatableBaseContainer.constructor

​
Accessors

​
evaluate

​
Get Signature

get evaluate(): EvaluateContainer
Defined in: src/lib/logger/components/base.ts:248 Gets the evaluation methods for this container.
Example
container.evaluate.withEvaluators('bias', 'toxicity');
Returns
EvaluateContainer Evaluation methods for configuring and triggering evaluations

​
Inherited from

EvaluatableBaseContainer.evaluate

​
id

​
Get Signature

get id(): string
Defined in: src/lib/logger/components/base.ts:80 Gets the unique identifier for this container.
Returns
string The container’s unique ID

​
Inherited from

EvaluatableBaseContainer.id

​
Methods

​
addMetadata()

addMetadata(metadata): void
Defined in: src/lib/logger/components/base.ts:124 Adds metadata to this container for additional context and debugging. Any data type could be added as the value in the metadata record.

​
Parameters

metadata
Record<string, unknown> Key-value pairs of metadata

​
Returns

void void

​
Example

container.addMetadata({
  requestId: 'req-123',
  userAgent: 'Mozilla/5.0...',
  processingTime: 1500
});

​
Inherited from

EvaluatableBaseContainer.addMetadata

​
addTag()

addTag(key, value): void
Defined in: src/lib/logger/components/base.ts:94 Adds a tag to this container for categorization and filtering.

​
Parameters

key
string The tag key
value
string The tag value

​
Returns

void void

​
Example

container.addTag('environment', 'production');
container.addTag('user_type', 'premium');

​
Inherited from

EvaluatableBaseContainer.addTag

​
data()

data(): any
Defined in: src/lib/logger/components/base.ts:191 Returns the current data state of this container.

​
Returns

any The container’s data.

​
Inherited from

EvaluatableBaseContainer.data

​
end()

end(): void
Defined in: src/lib/logger/components/base.ts:163 Marks this container as ended and records the end timestamp.

​
Returns

void void

​
Example

// End a container when processing is complete
container.end();

​
Inherited from

EvaluatableBaseContainer.end

​
input()

input(query): void
Defined in: src/lib/logger/components/retrieval.ts:64 Sets the input query for this retrieval operation.

​
Parameters

query
string The search query or input text

​
Returns

void void

​
Example

retrieval.input('How do I troubleshoot connection issues?');

​
output()

output(docs): void
Defined in: src/lib/logger/components/retrieval.ts:97 Sets the output results for this retrieval operation and ends it.

​
Parameters

docs
Retrieved documents as a single string or array string | string[]

​
Returns

void void

​
Examples

// Single result
retrieval.output('Connection troubleshooting guide: First, check cables...');

// Multiple results
retrieval.output([
  'Document 1: Basic troubleshooting steps...',
  'Document 2: Advanced network diagnostics...',
  'Document 3: Common error codes and solutions...'
]);

​
addMetadata_()

static addMetadata_(writer, entity, id, metadata): void
Defined in: src/lib/logger/components/base.ts:144 Static method to add metadata to any container by ID.

​
Parameters

writer
LogWriter The log writer instance
entity
Entity The entity type
id
string The container ID
metadata
Record<string, unknown> The metadata to add

​
Returns

void void

​
Inherited from

EvaluatableBaseContainer.addMetadata_

​
addTag_()

static addTag_(writer, entity, id, key, value): void
Defined in: src/lib/logger/components/base.ts:108 Static method to add a tag to any container by ID.

​
Parameters

writer
LogWriter The log writer instance
entity
Entity The entity type
id
string The container ID
key
string The tag key
value
string The tag value

​
Returns

void void

​
Inherited from

EvaluatableBaseContainer.addTag_

​
end_()

static end_(writer, entity, id, data?): void
Defined in: src/lib/logger/components/base.ts:177 Static method to end any container by ID.

​
Parameters

writer
LogWriter The log writer instance
entity
Entity The entity type
id
string The container ID
data?
any Optional additional data to include with the end event

​
Returns

void void

​
Inherited from

EvaluatableBaseContainer.end_

​
evaluate_()

static evaluate_(writer, entity, id): EvaluateContainer
Defined in: src/lib/logger/components/base.ts:260 Static method to get evaluation methods for any evaluatable container by ID.

​
Parameters

writer
LogWriter The log writer instance
entity
Entity The entity type
id
string The container ID

​
Returns

EvaluateContainer Evaluation methods for configuring and triggering evaluations

​
Inherited from

EvaluatableBaseContainer.evaluate_

​
input_()

static input_(writer, id, query): void
Defined in: src/lib/logger/components/retrieval.ts:76 Static method to set input for any retrieval by ID.

​
Parameters

writer
LogWriter The log writer instance
id
string The retrieval ID
query
string The search query or input text

​
Returns

void void

​
output_()

static output_(writer, id, docs): void
Defined in: src/lib/logger/components/retrieval.ts:113 Static method to set output for any retrieval by ID.

​
Parameters

writer
LogWriter The log writer instance
id
string The retrieval ID
docs
Retrieved documents as a single string or array string | string[]

​
Returns

void void