API Reference

This page contains auto-generated API reference documentation [1].

• nat
  • nat.agent
    • nat.agent.base
    • nat.agent.dual_node
    • nat.agent.react_agent
      • nat.agent.react_agent.agent
      • nat.agent.react_agent.output_parser
      • nat.agent.react_agent.prompt
      • nat.agent.react_agent.register
    • nat.agent.reasoning_agent
      • nat.agent.reasoning_agent.reasoning_agent
    • nat.agent.register
    • nat.agent.rewoo_agent
      • nat.agent.rewoo_agent.agent
      • nat.agent.rewoo_agent.prompt
      • nat.agent.rewoo_agent.register
    • nat.agent.tool_calling_agent
      • nat.agent.tool_calling_agent.agent
      • nat.agent.tool_calling_agent.register
  • nat.authentication
    • nat.authentication.api_key
      • nat.authentication.api_key.api_key_auth_provider
      • nat.authentication.api_key.api_key_auth_provider_config
      • nat.authentication.api_key.register
    • nat.authentication.exceptions
      • nat.authentication.exceptions.api_key_exceptions
    • nat.authentication.http_basic_auth
      • nat.authentication.http_basic_auth.http_basic_auth_provider
      • nat.authentication.http_basic_auth.register
    • nat.authentication.interfaces
    • nat.authentication.oauth2
      • nat.authentication.oauth2.oauth2_auth_code_flow_provider
      • nat.authentication.oauth2.oauth2_auth_code_flow_provider_config
      • nat.authentication.oauth2.register
    • nat.authentication.register
  • nat.builder
    • nat.builder.builder
    • nat.builder.component_utils
    • nat.builder.context
    • nat.builder.embedder
    • nat.builder.eval_builder
    • nat.builder.evaluator
    • nat.builder.framework_enum
    • nat.builder.front_end
    • nat.builder.function
    • nat.builder.function_base
    • nat.builder.function_info
    • nat.builder.intermediate_step_manager
    • nat.builder.llm
    • nat.builder.retriever
    • nat.builder.user_interaction_manager
    • nat.builder.workflow
    • nat.builder.workflow_builder
  • nat.cli
    • nat.cli.cli_utils
      • nat.cli.cli_utils.config_override
      • nat.cli.cli_utils.validation
    • nat.cli.commands
      • nat.cli.commands.configure
        • nat.cli.commands.configure.channel
          • nat.cli.commands.configure.channel.add
          • nat.cli.commands.configure.channel.channel
          • nat.cli.commands.configure.channel.remove
          • nat.cli.commands.configure.channel.update
        • nat.cli.commands.configure.configure
      • nat.cli.commands.evaluate
      • nat.cli.commands.info
        • nat.cli.commands.info.info
        • nat.cli.commands.info.list_channels
        • nat.cli.commands.info.list_components
        • nat.cli.commands.info.list_mcp
      • nat.cli.commands.registry
        • nat.cli.commands.registry.publish
        • nat.cli.commands.registry.pull
        • nat.cli.commands.registry.registry
        • nat.cli.commands.registry.remove
        • nat.cli.commands.registry.search
      • nat.cli.commands.sizing
        • nat.cli.commands.sizing.calc
        • nat.cli.commands.sizing.sizing
      • nat.cli.commands.start
      • nat.cli.commands.uninstall
      • nat.cli.commands.validate
      • nat.cli.commands.workflow
        • nat.cli.commands.workflow.workflow
        • nat.cli.commands.workflow.workflow_commands
    • nat.cli.entrypoint
    • nat.cli.main
    • nat.cli.register_workflow
    • nat.cli.type_registry
  • nat.data_models
    • nat.data_models.api_server
    • nat.data_models.authentication
    • nat.data_models.common
    • nat.data_models.component
    • nat.data_models.component_ref
    • nat.data_models.config
    • nat.data_models.dataset_handler
    • nat.data_models.discovery_metadata
    • nat.data_models.embedder
    • nat.data_models.evaluate
    • nat.data_models.evaluator
    • nat.data_models.front_end
    • nat.data_models.function
    • nat.data_models.function_dependencies
    • nat.data_models.interactive
    • nat.data_models.intermediate_step
    • nat.data_models.invocation_node
    • nat.data_models.llm
    • nat.data_models.logging
    • nat.data_models.memory
    • nat.data_models.object_store
    • nat.data_models.profiler
    • nat.data_models.registry_handler
    • nat.data_models.retriever
    • nat.data_models.retry_mixin
    • nat.data_models.span
    • nat.data_models.step_adaptor
    • nat.data_models.streaming
    • nat.data_models.swe_bench_model
    • nat.data_models.telemetry_exporter
    • nat.data_models.ttc_strategy
  • nat.embedder
    • nat.embedder.nim_embedder
    • nat.embedder.openai_embedder
    • nat.embedder.register
  • nat.eval
    • nat.eval.config
    • nat.eval.dataset_handler
      • nat.eval.dataset_handler.dataset_downloader
      • nat.eval.dataset_handler.dataset_filter
      • nat.eval.dataset_handler.dataset_handler
    • nat.eval.evaluate
    • nat.eval.evaluator
      • nat.eval.evaluator.base_evaluator
      • nat.eval.evaluator.evaluator_model
    • nat.eval.intermediate_step_adapter
    • nat.eval.rag_evaluator
      • nat.eval.rag_evaluator.evaluate
      • nat.eval.rag_evaluator.register
    • nat.eval.register
    • nat.eval.remote_workflow
    • nat.eval.runners
      • nat.eval.runners.config
      • nat.eval.runners.multi_eval_runner
    • nat.eval.runtime_event_subscriber
    • nat.eval.swe_bench_evaluator
      • nat.eval.swe_bench_evaluator.evaluate
      • nat.eval.swe_bench_evaluator.register
    • nat.eval.trajectory_evaluator
      • nat.eval.trajectory_evaluator.evaluate
      • nat.eval.trajectory_evaluator.register
    • nat.eval.tunable_rag_evaluator
      • nat.eval.tunable_rag_evaluator.evaluate
      • nat.eval.tunable_rag_evaluator.register
    • nat.eval.usage_stats
    • nat.eval.utils
      • nat.eval.utils.output_uploader
      • nat.eval.utils.tqdm_position_registry
      • nat.eval.utils.weave_eval
  • nat.experimental
    • nat.experimental.decorators
      • nat.experimental.decorators.experimental_warning_decorator
    • nat.experimental.test_time_compute
      • nat.experimental.test_time_compute.editing
        • nat.experimental.test_time_compute.editing.iterative_plan_refinement_editor
        • nat.experimental.test_time_compute.editing.llm_as_a_judge_editor
        • nat.experimental.test_time_compute.editing.motivation_aware_summarization
      • nat.experimental.test_time_compute.functions
        • nat.experimental.test_time_compute.functions.execute_score_select_function
        • nat.experimental.test_time_compute.functions.plan_select_execute_function
        • nat.experimental.test_time_compute.functions.ttc_tool_orchestration_function
        • nat.experimental.test_time_compute.functions.ttc_tool_wrapper_function
      • nat.experimental.test_time_compute.models
        • nat.experimental.test_time_compute.models.editor_config
        • nat.experimental.test_time_compute.models.scoring_config
        • nat.experimental.test_time_compute.models.search_config
        • nat.experimental.test_time_compute.models.selection_config
        • nat.experimental.test_time_compute.models.stage_enums
        • nat.experimental.test_time_compute.models.strategy_base
        • nat.experimental.test_time_compute.models.tool_use_config
        • nat.experimental.test_time_compute.models.ttc_item
      • nat.experimental.test_time_compute.register
      • nat.experimental.test_time_compute.scoring
        • nat.experimental.test_time_compute.scoring.llm_based_agent_scorer
        • nat.experimental.test_time_compute.scoring.llm_based_plan_scorer
        • nat.experimental.test_time_compute.scoring.motivation_aware_scorer
      • nat.experimental.test_time_compute.search
        • nat.experimental.test_time_compute.search.multi_llm_planner
        • nat.experimental.test_time_compute.search.multi_query_retrieval_search
        • nat.experimental.test_time_compute.search.single_shot_multi_plan_planner
      • nat.experimental.test_time_compute.selection
        • nat.experimental.test_time_compute.selection.best_of_n_selector
        • nat.experimental.test_time_compute.selection.llm_based_agent_output_selector
        • nat.experimental.test_time_compute.selection.llm_based_output_merging_selector
        • nat.experimental.test_time_compute.selection.llm_based_plan_selector
        • nat.experimental.test_time_compute.selection.threshold_selector
  • nat.front_ends
    • nat.front_ends.console
      • nat.front_ends.console.authentication_flow_handler
      • nat.front_ends.console.console_front_end_config
      • nat.front_ends.console.console_front_end_plugin
      • nat.front_ends.console.register
    • nat.front_ends.cron
    • nat.front_ends.fastapi
      • nat.front_ends.fastapi.auth_flow_handlers
        • nat.front_ends.fastapi.auth_flow_handlers.http_flow_handler
        • nat.front_ends.fastapi.auth_flow_handlers.websocket_flow_handler
      • nat.front_ends.fastapi.fastapi_front_end_config
      • nat.front_ends.fastapi.fastapi_front_end_controller
      • nat.front_ends.fastapi.fastapi_front_end_plugin
      • nat.front_ends.fastapi.fastapi_front_end_plugin_worker
      • nat.front_ends.fastapi.html_snippets
        • nat.front_ends.fastapi.html_snippets.auth_code_grant_success
      • nat.front_ends.fastapi.intermediate_steps_subscriber
      • nat.front_ends.fastapi.job_store
      • nat.front_ends.fastapi.main
      • nat.front_ends.fastapi.message_handler
      • nat.front_ends.fastapi.message_validator
      • nat.front_ends.fastapi.register
      • nat.front_ends.fastapi.response_helpers
      • nat.front_ends.fastapi.step_adaptor
    • nat.front_ends.mcp
      • nat.front_ends.mcp.mcp_front_end_config
      • nat.front_ends.mcp.mcp_front_end_plugin
      • nat.front_ends.mcp.mcp_front_end_plugin_worker
      • nat.front_ends.mcp.register
      • nat.front_ends.mcp.tool_converter
    • nat.front_ends.register
    • nat.front_ends.simple_base
      • nat.front_ends.simple_base.simple_front_end_plugin_base
  • nat.llm
    • nat.llm.aws_bedrock_llm
    • nat.llm.nim_llm
    • nat.llm.openai_llm
    • nat.llm.register
    • nat.llm.utils
      • nat.llm.utils.env_config_value
      • nat.llm.utils.error
  • nat.memory
    • nat.memory.interfaces
    • nat.memory.models
  • nat.object_store
    • nat.object_store.in_memory_object_store
    • nat.object_store.interfaces
    • nat.object_store.models
    • nat.object_store.register
  • nat.observability
    • nat.observability.exporter
      • nat.observability.exporter.base_exporter
      • nat.observability.exporter.exporter
      • nat.observability.exporter.file_exporter
      • nat.observability.exporter.processing_exporter
      • nat.observability.exporter.raw_exporter
      • nat.observability.exporter.span_exporter
    • nat.observability.exporter_manager
    • nat.observability.mixin
      • nat.observability.mixin.batch_config_mixin
      • nat.observability.mixin.collector_config_mixin
      • nat.observability.mixin.file_mixin
      • nat.observability.mixin.file_mode
      • nat.observability.mixin.resource_conflict_mixin
      • nat.observability.mixin.serialize_mixin
      • nat.observability.mixin.type_introspection_mixin
    • nat.observability.processor
      • nat.observability.processor.batching_processor
      • nat.observability.processor.callback_processor
      • nat.observability.processor.intermediate_step_serializer
      • nat.observability.processor.processor
    • nat.observability.register
    • nat.observability.utils
      • nat.observability.utils.dict_utils
      • nat.observability.utils.time_utils
  • nat.profiler
    • nat.profiler.calc
      • nat.profiler.calc.calc_runner
      • nat.profiler.calc.calculations
      • nat.profiler.calc.data_models
      • nat.profiler.calc.plot
    • nat.profiler.callbacks
      • nat.profiler.callbacks.agno_callback_handler
      • nat.profiler.callbacks.base_callback_class
      • nat.profiler.callbacks.langchain_callback_handler
      • nat.profiler.callbacks.llama_index_callback_handler
      • nat.profiler.callbacks.semantic_kernel_callback_handler
      • nat.profiler.callbacks.token_usage_base_model
    • nat.profiler.data_frame_row
    • nat.profiler.data_models
    • nat.profiler.decorators
      • nat.profiler.decorators.framework_wrapper
      • nat.profiler.decorators.function_tracking
    • nat.profiler.forecasting
      • nat.profiler.forecasting.config
      • nat.profiler.forecasting.model_trainer
      • nat.profiler.forecasting.models
        • nat.profiler.forecasting.models.forecasting_base_model
        • nat.profiler.forecasting.models.linear_model
        • nat.profiler.forecasting.models.random_forest_regressor
    • nat.profiler.inference_metrics_model
    • nat.profiler.inference_optimization
      • nat.profiler.inference_optimization.bottleneck_analysis
        • nat.profiler.inference_optimization.bottleneck_analysis.nested_stack_analysis
        • nat.profiler.inference_optimization.bottleneck_analysis.simple_stack_analysis
      • nat.profiler.inference_optimization.data_models
      • nat.profiler.inference_optimization.experimental
        • nat.profiler.inference_optimization.experimental.concurrency_spike_analysis
        • nat.profiler.inference_optimization.experimental.prefix_span_analysis
      • nat.profiler.inference_optimization.llm_metrics
      • nat.profiler.inference_optimization.prompt_caching
      • nat.profiler.inference_optimization.token_uniqueness
      • nat.profiler.inference_optimization.workflow_runtimes
    • nat.profiler.intermediate_property_adapter
    • nat.profiler.profile_runner
    • nat.profiler.utils
  • nat.registry_handlers
    • nat.registry_handlers.local
      • nat.registry_handlers.local.local_handler
      • nat.registry_handlers.local.register_local
    • nat.registry_handlers.metadata_factory
    • nat.registry_handlers.package_utils
    • nat.registry_handlers.pypi
      • nat.registry_handlers.pypi.pypi_handler
      • nat.registry_handlers.pypi.register_pypi
    • nat.registry_handlers.register
    • nat.registry_handlers.registry_handler_base
    • nat.registry_handlers.rest
      • nat.registry_handlers.rest.register_rest
      • nat.registry_handlers.rest.rest_handler
    • nat.registry_handlers.schemas
      • nat.registry_handlers.schemas.headers
      • nat.registry_handlers.schemas.package
      • nat.registry_handlers.schemas.publish
      • nat.registry_handlers.schemas.pull
      • nat.registry_handlers.schemas.remove
      • nat.registry_handlers.schemas.search
      • nat.registry_handlers.schemas.status
  • nat.retriever
    • nat.retriever.interface
    • nat.retriever.milvus
      • nat.retriever.milvus.register
      • nat.retriever.milvus.retriever
    • nat.retriever.models
    • nat.retriever.nemo_retriever
      • nat.retriever.nemo_retriever.register
      • nat.retriever.nemo_retriever.retriever
    • nat.retriever.register
  • nat.runtime
    • nat.runtime.loader
    • nat.runtime.runner
    • nat.runtime.session
    • nat.runtime.user_metadata
  • nat.settings
    • nat.settings.global_settings
  • nat.tool
    • nat.tool.chat_completion
    • nat.tool.code_execution
      • nat.tool.code_execution.code_sandbox
      • nat.tool.code_execution.local_sandbox
        • nat.tool.code_execution.local_sandbox.local_sandbox_server
      • nat.tool.code_execution.register
      • nat.tool.code_execution.test_code_execution_sandbox
      • nat.tool.code_execution.utils
    • nat.tool.datetime_tools
    • nat.tool.document_search
    • nat.tool.github_tools
      • nat.tool.github_tools.create_github_commit
      • nat.tool.github_tools.create_github_issue
      • nat.tool.github_tools.create_github_pr
      • nat.tool.github_tools.get_github_file
      • nat.tool.github_tools.get_github_issue
      • nat.tool.github_tools.get_github_pr
      • nat.tool.github_tools.update_github_issue
    • nat.tool.mcp
      • nat.tool.mcp.exceptions
      • nat.tool.mcp.mcp_client
      • nat.tool.mcp.mcp_tool
    • nat.tool.memory_tools
      • nat.tool.memory_tools.add_memory_tool
      • nat.tool.memory_tools.delete_memory_tool
      • nat.tool.memory_tools.get_memory_tool
    • nat.tool.nvidia_rag
    • nat.tool.register
    • nat.tool.retriever
    • nat.tool.server_tools
  • nat.utils
    • nat.utils.data_models
      • nat.utils.data_models.schema_validator
    • nat.utils.debugging_utils
    • nat.utils.dump_distro_mapping
    • nat.utils.exception_handlers
      • nat.utils.exception_handlers.automatic_retries
      • nat.utils.exception_handlers.mcp
      • nat.utils.exception_handlers.schemas
    • nat.utils.io
      • nat.utils.io.model_processing
      • nat.utils.io.yaml_tools
    • nat.utils.log_utils
    • nat.utils.metadata_utils
    • nat.utils.optional_imports
    • nat.utils.producer_consumer_queue
    • nat.utils.reactive
      • nat.utils.reactive.base
        • nat.utils.reactive.base.observable_base
        • nat.utils.reactive.base.observer_base
        • nat.utils.reactive.base.subject_base
      • nat.utils.reactive.observable
      • nat.utils.reactive.observer
      • nat.utils.reactive.subject
      • nat.utils.reactive.subscription
    • nat.utils.settings
      • nat.utils.settings.global_settings
    • nat.utils.string_utils
    • nat.utils.type_converter
    • nat.utils.type_utils
    • nat.utils.url_utils

[1]

Created with sphinx-autoapi