Documentation

validator

Query validation utilities.

Validates generated search queries by executing them on a lightweight corpus before using them for full benchmarking.

Classes

class

QueryValidator

Validates search queries by executing them on a corpus.

Validates search queries by executing them on a corpus. Ensures queries are syntactically correct and execute without errors before using them for latency benchmarking.

Attributes

NameTypeDescription
S——
api——
max_results——
timeout_ms——

Methods

__init__(self, api: Any, timeout_ms: float = 5000.0, max_results: int = 1000)

Initialize query validator.

Parameters
  • api: Any
  • timeout_ms: float= 5000.0
  • max_results: int= 1000
filter_valid_queries(self, report: ValidationReport) → list[SearchQuery]

Extract only validated queries from a report.

Parameters
  • report: ValidationReport
validate_queries(self, queries: list[SearchQuery], corpus_name: str = 'unknown') → ValidationReport

Validate a list of queries.

Parameters
  • queries: list[SearchQuery]
  • corpus_name: str= 'unknown'
validate_query(self, query: SearchQuery) → SearchQuery

Validate a single query by executing it.

Parameters
  • query: SearchQuery

Functions

function
format_validation_report(report: ValidationReport) → str

Format validation report as human-readable text.

Format validation report as human-readable text. Args: report: ValidationReport to format Returns: Formatted string
Parameters
  • report: ValidationReport
function
validate_queries_on_corpus(queries: list[SearchQuery], api: Any, corpus_name: str = 'unknown', timeout_ms: float = 5000.0) → ValidationReport

Convenience function to validate queries on a corpus.

Convenience function to validate queries on a corpus. Args: queries: Queries to validate api: Text-Fabric or Context-Fabric API object corpus_name: Name of the validation corpus timeout_ms: Maximum execution time per query Returns: ValidationReport with results
Parameters
  • queries: list[SearchQuery]
  • api: Any
  • corpus_name: str= 'unknown'
  • timeout_ms: float= 5000.0