build_index

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

list[str] | NoneDefaults to None

Glob patterns to exclude.

languages

list[str] | NoneDefaults to None

Language codes. Defaults to ["en"].

Returns

None

Example

from signalwire.search import IndexBuilder
builder = IndexBuilder()
builder.build_index(
    source_dir="./docs",
    output_file="docs.swsearch",
    file_types=["md", "txt"],
)