Skip to content

Fulltext

Redis implementation of fulltext search and CRUD capability.

This module provides a Redis implementation of the FulltextCapability protocol using Redis's native data structures and search capabilities.

RedisFulltextCapability(index_name, client, encryption=None, default_batch_size=None)

Bases: BaseFulltextCapability

Redis implementation of FulltextCapability protocol.

Attributes:

Name Type Description
index_name str

Name of the Redis index.

client Redis

Redis client instance.

Initialize the Redis fulltext capability.

Schema will be automatically inferred from chunks when creating a new index, or auto-detected from an existing index when performing operations.

Parameters:

Name Type Description Default
index_name str

Name of the Redis index.

required
client Redis

Redis client instance.

required
encryption EncryptionCapability | None

Encryption capability for field-level encryption. Defaults to None.

None
default_batch_size int | None

Default batch size for create/update/delete. Defaults to None.

None