Skip to content

Variable: universalSearchRequestSchema

const universalSearchRequestSchema: ZodObject<{ indexes: ZodOptional<ZodArray<ZodString>>; limit: ZodOptional<ZodNumber>; mode: ZodOptional<ZodEnum<{ hybrid: "hybrid"; keyword: "keyword"; vector: "vector"; }>>; query: ZodString; }, $strip>

Schema for a universal (federated) search across several indexes at once.

  • query: What to search for across every configured index.
  • indexes (optional): Which indexes to search. Defaults to every index the plugin knows about.
  • limit (optional): Maximum hits PER index before results are merged and re-ranked.
  • mode (optional): Match strategy: ‘hybrid’ fuses semantic similarity with keyword ranking (default, best for most searches), ‘vector’ is pure semantic, ‘keyword’ is pure full-text.