build_index | SignalWire

Build a search index from a single directory. This is a convenience wrapper around build_index_from_sources() for the common case of indexing one directory.

Parameters

source_dir

strRequired

Directory to scan for documents.

output_file

strRequired

Output .swsearch file path.

file_types

list[str]Required

File extensions to include.

exclude_patterns

Optional[list[str]]

Glob patterns to exclude.

languages

Optional[list[str]]

Language codes. Defaults to ["en"].

Returns

None

Example

1 from signalwire.search import IndexBuilder
2 
3 builder = IndexBuilder()
4 builder.build_index(
5     source_dir="./docs",
6     output_file="docs.swsearch",
7     file_types=["md", "txt"],
8 )