build_index

Build the RAG vector index over OpenFOAM tutorials, source headers, and docs.

Functions

build_index()	Main index building function.
chunk_text(text, filepath)	Split text into chunks with overlap.
collect_files()	Collect all files to index from both OpenFOAM versions.
get_metadata(filepath, version, context)	Build metadata for a file chunk.
should_index_file(filepath, context)	Decide whether to index this file.
should_skip_dir(dirname)
walk_directory(root, context)	Walk a directory tree, respecting skip rules.

build_index.should_skip_dir(dirname)

Parameters:

dirname (str)

Return type:

bool

build_index.should_index_file(filepath, context)

Decide whether to index this file.

Parameters:

• filepath (Path)

• context (str)

Return type:

bool

build_index.chunk_text(text, filepath)

Split text into chunks with overlap.

Parameters:

• text (str)

• filepath (Path)

Return type:

list[str]

build_index.get_metadata(filepath, version, context)

Build metadata for a file chunk.

Parameters:

• filepath (Path)

• version (str)

• context (str)

Return type:

dict

build_index.walk_directory(root, context)

Walk a directory tree, respecting skip rules.

Parameters:

• root (Path)

• context (str)

Return type:

list[tuple[Path, str]]

build_index.collect_files()

Collect all files to index from both OpenFOAM versions.

Return type:

list[tuple[Path, str, str]]

build_index.build_index()

Main index building function.