redis_openai_agents.create_redis_file_search_tool#

create_redis_file_search_tool(service, name='redis_file_search', description=None, default_k=5, default_min_score=0.0)[source]#

Factory function to create a Redis file search tool.

This function creates a callable tool that wraps a HybridSearchService for use with the OpenAI Agents SDK.

Parameters:

  • service (HybridSearchService) – The HybridSearchService instance to use for searching.

  • name (str) – Custom tool name (default: “redis_file_search”).

  • description (str | None) – Custom tool description for LLM context.

  • default_k (int) – Default number of results to return.

  • default_min_score (float) – Default minimum similarity score for filtering.

Returns:

A RedisFileSearchTool instance that can be used with OpenAI agents.

Return type:

RedisFileSearchTool

Example

>>> service = HybridSearchService(redis_url="redis://localhost:6379", index_name="docs")
>>> tool = create_redis_file_search_tool(service, name="search_docs", default_k=10)
>>> result = await tool(query="Redis performance")