nat.retriever.models

Attributes

AIQDocument

Exceptions

RetrieverError

Common base class for all non-exit exceptions.

Classes

Document	Object representing a retrieved document/chunk from a standard NAT Retriever.
RetrieverOutput

Functions

retriever_output_to_dict(→ dict)
retriever_output_to_str(→ str)

Module Contents

class Document(/, **data: Any)

Bases: pydantic.BaseModel

Object representing a retrieved document/chunk from a standard NAT Retriever.

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.

page_content: str = None

metadata: dict[str, Any] = None

document_id: str | None = None

classmethod from_dict(data: dict[str, Any]) → Document

Deserialize an Document from a dictionary representation.

Args:

data (dict): A dictionary containing keys ‘page_content’, ‘metadata’, and optionally ‘document_id’.

Returns:

MemoryItem: A reconstructed MemoryItem instance.

class RetrieverOutput(/, **data: Any)

Bases: pydantic.BaseModel

results: list[Document] = None

exception RetrieverError

Bases: Exception

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

retriever_output_to_dict(obj: RetrieverOutput) → dict

retriever_output_to_str(obj: RetrieverOutput) → str

AIQDocument