redis_openai_agents.RedisFullTextSearch

class RedisFullTextSearch(name, redis_url='redis://localhost:6379')

Full-text search using Redis 8’s FT.SEARCH.

Provides BM25-based keyword search, complementing vector search for cases where exact keyword matching is preferred.

Example

>>> fts = RedisFullTextSearch(name="articles", redis_url="redis://localhost:6379")
>>> fts.add_documents([{"title": "Redis Guide", "content": "Learn Redis"}])
>>> results = fts.search(query="Redis", k=5)

Parameters:

• name (str) – Index name in Redis

• redis_url (str) – Redis connection URL

Initialize the full-text search index.

Parameters:

• name (str) – Index name in Redis

• redis_url (str) – Redis connection URL

__init__(name, redis_url='redis://localhost:6379')

Initialize the full-text search index.

Parameters:

• name (str) – Index name in Redis

• redis_url (str) – Redis connection URL

Return type:

None

Methods

__init__(name[, redis_url])	Initialize the full-text search index.
add_documents(documents)	Add documents to the search index.
count()	Count documents in the index.
delete(ids)	Delete documents by ID.
delete_all()	Delete all documents and recreate the index.
search(query[, k, filter])	Search documents using full-text search.

Attributes

name	Index name in Redis.