nat.builder.child_builder#

Classes#

ChildBuilder

Module Contents#

class ChildBuilder(workflow_builder: nat.builder.builder.Builder)#

Bases: nat.builder.builder.Builder

_workflow_builder#
_dependencies#
property sync_builder: nat.builder.sync_builder.SyncBuilder#
property dependencies: nat.data_models.function_dependencies.FunctionDependencies#
async add_function(
name: str,
config: nat.data_models.function.FunctionBaseConfig,
) → nat.builder.function.Function#
async add_function_group(
name: str,
config: nat.data_models.function.FunctionGroupBaseConfig,
) → nat.builder.function.FunctionGroup#
async get_function(name: str) → nat.builder.function.Function#
async get_function_group(name: str) → nat.builder.function.FunctionGroup#
get_function_config(
name: str,
) → nat.data_models.function.FunctionBaseConfig#
get_function_group_config(
name: str,
) → nat.data_models.function.FunctionGroupBaseConfig#
async set_workflow(
config: nat.data_models.function.FunctionBaseConfig,
) → nat.builder.function.Function#
get_workflow() → nat.builder.function.Function#
get_workflow_config() → nat.data_models.function.FunctionBaseConfig#
async get_tools(
tool_names: collections.abc.Sequence[str | nat.data_models.component_ref.FunctionRef | nat.data_models.component_ref.FunctionGroupRef],
wrapper_type: nat.builder.framework_enum.LLMFrameworkEnum | str,
) → list[Any]#
async get_tool(
fn_name: str | nat.data_models.component_ref.FunctionRef,
wrapper_type: nat.builder.framework_enum.LLMFrameworkEnum | str,
)#
async add_llm(name: str, config: nat.data_models.llm.LLMBaseConfig) → None#
async add_auth_provider(
name: str,
config: nat.data_models.authentication.AuthProviderBaseConfig,
) → nat.authentication.interfaces.AuthProviderBase#
async get_auth_provider(auth_provider_name: str)#
async get_llm(
llm_name: str,
wrapper_type: nat.builder.framework_enum.LLMFrameworkEnum | str,
) → Any#
get_llm_config(llm_name: str) → nat.data_models.llm.LLMBaseConfig#
async add_embedder(
name: str,
config: nat.data_models.embedder.EmbedderBaseConfig,
) → None#
async get_embedder(
embedder_name: str,
wrapper_type: nat.builder.framework_enum.LLMFrameworkEnum | str,
) → Any#
get_embedder_config(
embedder_name: str,
) → nat.data_models.embedder.EmbedderBaseConfig#
async add_memory_client(
name: str,
config: nat.data_models.memory.MemoryBaseConfig,
) → nat.memory.interfaces.MemoryEditor#
async get_memory_client(
memory_name: str,
) → nat.memory.interfaces.MemoryEditor#

Return the instantiated memory client for the given name.

get_memory_client_config(
memory_name: str,
) → nat.data_models.memory.MemoryBaseConfig#
async add_object_store(
name: str,
config: nat.data_models.object_store.ObjectStoreBaseConfig,
)#
async get_object_store_client(
object_store_name: str,
) → nat.object_store.interfaces.ObjectStore#

Return the instantiated object store client for the given name.

get_object_store_config(
object_store_name: str,
) → nat.data_models.object_store.ObjectStoreBaseConfig#
async add_trainer(
name: str | nat.data_models.component_ref.TrainerRef,
config: nat.data_models.finetuning.TrainerConfig,
) → nat.finetuning.interfaces.finetuning_runner.Trainer#
async add_trainer_adapter(
name: str | nat.data_models.component_ref.TrainerAdapterRef,
config: nat.data_models.finetuning.TrainerAdapterConfig,
) → nat.finetuning.interfaces.trainer_adapter.TrainerAdapter#
async add_trajectory_builder(
name: str | nat.data_models.component_ref.TrajectoryBuilderRef,
config: nat.data_models.finetuning.TrajectoryBuilderConfig,
) → nat.finetuning.interfaces.trajectory_builder.TrajectoryBuilder#
async get_trainer(
trainer_name: str | nat.data_models.component_ref.TrainerRef,
trajectory_builder: nat.finetuning.interfaces.trajectory_builder.TrajectoryBuilder,
trainer_adapter: nat.finetuning.interfaces.trainer_adapter.TrainerAdapter,
) → nat.finetuning.interfaces.finetuning_runner.Trainer#
async get_trainer_config(
trainer_name: str | nat.data_models.component_ref.TrainerRef,
) → nat.data_models.finetuning.TrainerConfig#
async get_trainer_adapter_config(
trainer_adapter_name: str | nat.data_models.component_ref.TrainerAdapterRef,
) → nat.data_models.finetuning.TrainerAdapterConfig#
async get_trajectory_builder_config(
trajectory_builder_name: str | nat.data_models.component_ref.TrajectoryBuilderRef,
) → nat.data_models.finetuning.TrajectoryBuilderConfig#
async get_trainer_adapter(
trainer_adapter_name: str | nat.data_models.component_ref.TrainerAdapterRef,
) → nat.finetuning.interfaces.trainer_adapter.TrainerAdapter#
async get_trajectory_builder(
trajectory_builder_name: str | nat.data_models.component_ref.TrajectoryBuilderRef,
) → nat.finetuning.interfaces.trajectory_builder.TrajectoryBuilder#
async add_ttc_strategy(
name: str,
config: nat.data_models.ttc_strategy.TTCStrategyBaseConfig,
) → None#
async get_ttc_strategy(
strategy_name: str | nat.data_models.component_ref.TTCStrategyRef,
pipeline_type: nat.experimental.test_time_compute.models.stage_enums.PipelineTypeEnum,
stage_type: nat.experimental.test_time_compute.models.stage_enums.StageTypeEnum,
) → nat.experimental.test_time_compute.models.strategy_base.StrategyBase#
async get_ttc_strategy_config(
strategy_name: str | nat.data_models.component_ref.TTCStrategyRef,
pipeline_type: nat.experimental.test_time_compute.models.stage_enums.PipelineTypeEnum,
stage_type: nat.experimental.test_time_compute.models.stage_enums.StageTypeEnum,
) → nat.data_models.ttc_strategy.TTCStrategyBaseConfig#
async add_retriever(
name: str,
config: nat.data_models.retriever.RetrieverBaseConfig,
) → None#
async get_retriever(
retriever_name: str,
wrapper_type: nat.builder.framework_enum.LLMFrameworkEnum | str | None = None,
) → nat.retriever.interface.Retriever#
async get_retriever_config(
retriever_name: str,
) → nat.data_models.retriever.RetrieverBaseConfig#
get_user_manager() → nat.builder.builder.UserManagerHolder#
get_function_dependencies(
fn_name: str,
) → nat.data_models.function_dependencies.FunctionDependencies#
get_function_group_dependencies(
fn_name: str,
) → nat.data_models.function_dependencies.FunctionDependencies#
async add_middleware(
name: str | nat.data_models.component_ref.MiddlewareRef,
config: nat.data_models.middleware.MiddlewareBaseConfig,
) → nat.middleware.middleware.Middleware#

Add middleware to the builder.

async get_middleware(
middleware_name: str | nat.data_models.component_ref.MiddlewareRef,
) → nat.middleware.middleware.Middleware#

Get built middleware by name.

get_middleware_config(
middleware_name: str | nat.data_models.component_ref.MiddlewareRef,
) → nat.data_models.middleware.MiddlewareBaseConfig#

Get the configuration for middleware.

static use(
config: nat.data_models.common.TypedBaseModel,
builder: nat.builder.builder.Builder,
) → collections.abc.Generator[ChildBuilder, None, None]#

Context manager for temporarily setting the Builder object.

Parameters#

configTypedBaseModel

The configuration to use within the context. Note: Not used for now, but required by the interface and will be used in the future.

builderBuilder

The Builder instance to use within the context.

Yields#

ChildBuilder

The Builder instance that was set.

Examples#

>>> with ChildBuilder.use(config, my_builder) as builder:
...     # builder is active in this context
...     assert Builder.current() == builder
>>> # Original builder is restored here