NullMemory Class

Class for null memory.

Note: This class is marked as 'experimental' and may change in the future.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

NullMemory()

Methods

get	Nullifies behavior of SemanticTextMemoryBase get.
get_collections	Nullifies behavior of SemanticTextMemoryBase get_collections.
save_information	Nullifies behavior of SemanticTextMemoryBase save_information.
save_reference	Nullifies behavior of SemanticTextMemoryBase save_reference.
search	Nullifies behavior of SemanticTextMemoryBase search.

get

Nullifies behavior of SemanticTextMemoryBase get.

async get(collection: str, query: str) -> MemoryQueryResult | None

Parameters

Name	Description
collection Required
query Required

get_collections

Nullifies behavior of SemanticTextMemoryBase get_collections.

async get_collections() -> list[str]

save_information

Nullifies behavior of SemanticTextMemoryBase save_information.

async save_information(collection: str, text: str, id: str, description: str | None = None, additional_metadata: str | None = None) -> None

Parameters

Name	Description
collection Required
text Required
id Required
description	Default value: None
additional_metadata	Default value: None

save_reference

Nullifies behavior of SemanticTextMemoryBase save_reference.

async save_reference(collection: str, text: str, external_id: str, external_source_name: str, description: str | None = None, additional_metadata: str | None = None) -> None

Parameters

Name	Description
collection Required
text Required
external_id Required
external_source_name Required
description	Default value: None
additional_metadata	Default value: None

search

Nullifies behavior of SemanticTextMemoryBase search.

async search(collection: str, query: str, limit: int = 1, min_relevance_score: float = 0.7) -> list[MemoryQueryResult]

Parameters

Name	Description
collection Required
query Required
limit	Default value: 1
min_relevance_score	Default value: 0.7

Attributes

instance

instance = NullMemory()

is_experimental

is_experimental = True

stage_status

stage_status = 'experimental'