redis_openai_agents.RedisFileSearchTool#

class RedisFileSearchTool(_service, name='redis_file_search', description='Search documents using semantic similarity and keyword matching. Use this tool to find relevant information from the knowledge base.', default_k=5, default_min_score=0.0, parameters=<factory>)[source]#

A callable tool for searching documents using Redis hybrid search.

This tool wraps a HybridSearchService to provide RAG capabilities for OpenAI Agents SDK agents.

Parameters:
  • _service (HybridSearchService)

  • name (str)

  • description (str)

  • default_k (int)

  • default_min_score (float)

  • parameters (dict[str, Any])

name#

Tool name for registration with agents.

Type:

str

description#

Tool description for LLM context.

Type:

str

parameters#

JSON schema for function calling parameters.

Type:

dict[str, Any]

default_k#

Default number of results to return.

Type:

int

__init__(_service, name='redis_file_search', description='Search documents using semantic similarity and keyword matching. Use this tool to find relevant information from the knowledge base.', default_k=5, default_min_score=0.0, parameters=<factory>)#
Parameters:
  • _service (HybridSearchService)

  • name (str)

  • description (str)

  • default_k (int)

  • default_min_score (float)

  • parameters (dict[str, Any])

Return type:

None

Methods

__init__(_service[, name, description, ...])

Attributes

default_k

default_min_score

description

name

parameters