RegexSearch module
RegexSearch
Bases: Module
Regex matching against a single KB table.
LM-driven wrapper around KnowledgeBase.regex_search. An
embedded Generator turns the module's inputs into a
RegexSearchInput query (the regex_search field),
which is then matched against the table. Use this when you want
exact-shape textual matching without the vector branch (e.g.
matching log lines, SKU codes, or any other structured text).
Regex uses RE2 (DuckDB's engine), so patterns are linear-time and not vulnerable to catastrophic backtracking — safe even when the pattern comes from an untrusted source.
Single-table only: to retrieve from multiple tables, compose
several RegexSearch modules in the program DAG and merge
their outputs explicitly.
Example:
import synalinks
import asyncio
class LogLine(synalinks.DataModel):
id: str = synalinks.Field(description="Log id")
text: str = synalinks.Field(description="Log line")
class Query(synalinks.DataModel):
query: str = synalinks.Field(description="The user question")
async def main():
kb = synalinks.KnowledgeBase(
uri="duckdb://logs.db",
data_models=[LogLine],
)
lm = synalinks.LanguageModel(model="ollama/mistral")
inputs = synalinks.Input(data_model=Query)
outputs = await synalinks.RegexSearch(
knowledge_base=kb,
language_model=lm,
data_model=LogLine,
k=5,
)(inputs)
program = synalinks.Program(inputs=inputs, outputs=outputs)
result = await program(Query(query="find error codes in the logs"))
print(result.get("result"))
asyncio.run(main())
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
knowledge_base
|
KnowledgeBase
|
The knowledge base to search. Required. |
None
|
language_model
|
LanguageModel
|
The language model used to
generate the |
None
|
schema
|
dict
|
JSON schema of the table's row. Used to infer
|
None
|
data_model
|
DataModel | SymbolicDataModel
|
Data model
providing |
None
|
table_name
|
str
|
Target table. Defaults to the schema's
|
None
|
k
|
int
|
Maximum number of results to return. Defaults to 10. |
10
|
fields
|
list
|
Field names to match against. Defaults to every string field on the schema. Names are snake_case-normalized to match stored column names. |
None
|
case_sensitive
|
bool
|
When |
True
|
output_format
|
str
|
How the underlying adapter renders rows.
|
'json'
|
prompt_template
|
str
|
Custom prompt template for the query generator. |
None
|
examples
|
list
|
Example inputs/outputs for few-shot learning. |
None
|
instructions
|
str
|
Custom instructions for the query generator. |
None
|
seed_instructions
|
str
|
Seed instructions for variability. |
None
|
temperature
|
float
|
Temperature for the language model. Defaults to 0.0. |
0.0
|
use_inputs_schema
|
bool
|
Whether to include the input schema in the prompt. Defaults to False. |
False
|
use_outputs_schema
|
bool
|
Whether to include the output schema in the prompt. Defaults to False. |
False
|
return_inputs
|
bool
|
Whether to include the original inputs in the output. Defaults to True. |
True
|
return_query
|
bool
|
Whether to include the generated query in the output. Defaults to True. |
True
|
name
|
str
|
Module name. |
None
|
description
|
str
|
Module description. |
None
|
trainable
|
bool
|
Whether the module's variables should be trainable. |
True
|
Source code in synalinks/src/modules/retrievers/regex_search.py
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | |
RegexSearchInput
Bases: DataModel
Input shape for RegexSearch.