Skip to content

Schema

Pydantic models for the gllm-memory public client contracts.

This module contains backend-neutral request models used throughout the library, providing data validation and serialization.

GetMemoryParams

Bases: BaseModel

Get memory parameters for memory retrieval operations.

This model represents the parameters used for retrieving memories, including version, pagination options, and filter conditions.

Attributes:

Name Type Description
page int | None

Page number for pagination.

page_size int | None

Number of items per page.

filters dict[str, Any]

Filter conditions for the search.

version str

API version to use.

SearchParams

Bases: BaseModel

Search parameters for memory retrieval operations.

This model represents the parameters used for searching memories, including query, version, filters, and pagination options.

Attributes:

Name Type Description
query str

Search query string.

version str

API version to use.

top_k int | None

Maximum number of results to return.

threshold float | None

Minimum similarity threshold for results.

filters dict[str, Any]

Filter conditions for the search.

rerank bool

Whether to apply re-ranking to search results.