autorag.nodes.generator package

Submodules

autorag.nodes.generator.base module

class autorag.nodes.generator.base.BaseGenerator(project_dir: str, llm: str, *args, **kwargs)

Bases: BaseModule

abstract async astream(prompt: str, **kwargs)

cast_to_run(previous_result: DataFrame, *args, **kwargs)

This function is for cast function (a.k.a decorator) only for pure function in the whole node.

abstract stream(prompt: str, **kwargs)

structured_output(prompts: List[str], output_cls)

autorag.nodes.generator.base.generator_node(func)

autorag.nodes.generator.llama_index_llm module

class autorag.nodes.generator.llama_index_llm.LlamaIndexLLM(project_dir: str, llm: str, batch: int = 16, *args, **kwargs)

Bases: BaseGenerator

async astream(prompt: str, **kwargs)

pure(previous_result: DataFrame, *args, **kwargs)

stream(prompt: str, **kwargs)

autorag.nodes.generator.openai_llm module

class autorag.nodes.generator.openai_llm.OpenAILLM(project_dir, llm: str, batch: int = 16, *args, **kwargs)

Bases: BaseGenerator

async astream(prompt: str, **kwargs)

async get_result(prompt: str, **kwargs)

async get_result_o1(prompt: str, **kwargs)

async get_structured_result(prompt: str, output_cls, **kwargs)

pure(previous_result: DataFrame, *args, **kwargs)

stream(prompt: str, **kwargs)

structured_output(prompts: List[str], output_cls, **kwargs)

autorag.nodes.generator.openai_llm.truncate_by_token(prompt: str, tokenizer: Encoding, max_token_size: int)

autorag.nodes.generator.run module

autorag.nodes.generator.run.evaluate_generator_node(result_df: DataFrame, metric_inputs: List[MetricInput], metrics: List[str] | List[Dict])

autorag.nodes.generator.run.run_generator_node(modules: List, module_params: List[Dict], previous_result: DataFrame, node_line_dir: str, strategies: Dict) → DataFrame

Run evaluation and select the best module among generator node results. And save the results and summary to generator node directory.

Parameters:

• modules – Generator modules to run.

• module_params – Generator module parameters. Including node parameters, which is used for every module in this node.

• previous_result – Previous result dataframe. Could be prompt maker node’s result.

• node_line_dir – This node line’s directory.

• strategies – Strategies for generator node.

Returns:

The best result dataframe. It contains previous result columns and generator node’s result columns.

autorag.nodes.generator.vllm module

class autorag.nodes.generator.vllm.Vllm(project_dir: str, llm: str, **kwargs)

Bases: BaseGenerator

async astream(prompt: str, **kwargs)

pure(previous_result: DataFrame, *args, **kwargs)

stream(prompt: str, **kwargs)

Module contents