PyPI - nvidia-nat - Versions diffs - 1.2.0rc5__py3-none-any.whl - Mend

nvidia-nat 1.2.0rc5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (435) hide show

aiq/agent/__init__.py +0 -0
aiq/agent/base.py +239 -0
aiq/agent/dual_node.py +67 -0
aiq/agent/react_agent/__init__.py +0 -0
aiq/agent/react_agent/agent.py +355 -0
aiq/agent/react_agent/output_parser.py +104 -0
aiq/agent/react_agent/prompt.py +41 -0
aiq/agent/react_agent/register.py +149 -0
aiq/agent/reasoning_agent/__init__.py +0 -0
aiq/agent/reasoning_agent/reasoning_agent.py +225 -0
aiq/agent/register.py +23 -0
aiq/agent/rewoo_agent/__init__.py +0 -0
aiq/agent/rewoo_agent/agent.py +411 -0
aiq/agent/rewoo_agent/prompt.py +108 -0
aiq/agent/rewoo_agent/register.py +158 -0
aiq/agent/tool_calling_agent/__init__.py +0 -0
aiq/agent/tool_calling_agent/agent.py +119 -0
aiq/agent/tool_calling_agent/register.py +106 -0
aiq/authentication/__init__.py +14 -0
aiq/authentication/api_key/__init__.py +14 -0
aiq/authentication/api_key/api_key_auth_provider.py +96 -0
aiq/authentication/api_key/api_key_auth_provider_config.py +124 -0
aiq/authentication/api_key/register.py +26 -0
aiq/authentication/exceptions/__init__.py +14 -0
aiq/authentication/exceptions/api_key_exceptions.py +38 -0
aiq/authentication/http_basic_auth/__init__.py +0 -0
aiq/authentication/http_basic_auth/http_basic_auth_provider.py +81 -0
aiq/authentication/http_basic_auth/register.py +30 -0
aiq/authentication/interfaces.py +93 -0
aiq/authentication/oauth2/__init__.py +14 -0
aiq/authentication/oauth2/oauth2_auth_code_flow_provider.py +107 -0
aiq/authentication/oauth2/oauth2_auth_code_flow_provider_config.py +39 -0
aiq/authentication/oauth2/register.py +25 -0
aiq/authentication/register.py +21 -0
aiq/builder/__init__.py +0 -0
aiq/builder/builder.py +285 -0
aiq/builder/component_utils.py +316 -0
aiq/builder/context.py +264 -0
aiq/builder/embedder.py +24 -0
aiq/builder/eval_builder.py +161 -0
aiq/builder/evaluator.py +29 -0
aiq/builder/framework_enum.py +24 -0
aiq/builder/front_end.py +73 -0
aiq/builder/function.py +344 -0
aiq/builder/function_base.py +380 -0
aiq/builder/function_info.py +627 -0
aiq/builder/intermediate_step_manager.py +174 -0
aiq/builder/llm.py +25 -0
aiq/builder/retriever.py +25 -0
aiq/builder/user_interaction_manager.py +74 -0
aiq/builder/workflow.py +148 -0
aiq/builder/workflow_builder.py +1117 -0
aiq/cli/__init__.py +14 -0
aiq/cli/cli_utils/__init__.py +0 -0
aiq/cli/cli_utils/config_override.py +231 -0
aiq/cli/cli_utils/validation.py +37 -0
aiq/cli/commands/__init__.py +0 -0
aiq/cli/commands/configure/__init__.py +0 -0
aiq/cli/commands/configure/channel/__init__.py +0 -0
aiq/cli/commands/configure/channel/add.py +28 -0
aiq/cli/commands/configure/channel/channel.py +36 -0
aiq/cli/commands/configure/channel/remove.py +30 -0
aiq/cli/commands/configure/channel/update.py +30 -0
aiq/cli/commands/configure/configure.py +33 -0
aiq/cli/commands/evaluate.py +139 -0
aiq/cli/commands/info/__init__.py +14 -0
aiq/cli/commands/info/info.py +39 -0
aiq/cli/commands/info/list_channels.py +32 -0
aiq/cli/commands/info/list_components.py +129 -0
aiq/cli/commands/info/list_mcp.py +213 -0
aiq/cli/commands/registry/__init__.py +14 -0
aiq/cli/commands/registry/publish.py +88 -0
aiq/cli/commands/registry/pull.py +118 -0
aiq/cli/commands/registry/registry.py +38 -0
aiq/cli/commands/registry/remove.py +108 -0
aiq/cli/commands/registry/search.py +155 -0
aiq/cli/commands/sizing/__init__.py +14 -0
aiq/cli/commands/sizing/calc.py +297 -0
aiq/cli/commands/sizing/sizing.py +27 -0
aiq/cli/commands/start.py +246 -0
aiq/cli/commands/uninstall.py +81 -0
aiq/cli/commands/validate.py +47 -0
aiq/cli/commands/workflow/__init__.py +14 -0
aiq/cli/commands/workflow/templates/__init__.py.j2 +0 -0
aiq/cli/commands/workflow/templates/config.yml.j2 +16 -0
aiq/cli/commands/workflow/templates/pyproject.toml.j2 +22 -0
aiq/cli/commands/workflow/templates/register.py.j2 +5 -0
aiq/cli/commands/workflow/templates/workflow.py.j2 +36 -0
aiq/cli/commands/workflow/workflow.py +37 -0
aiq/cli/commands/workflow/workflow_commands.py +313 -0
aiq/cli/entrypoint.py +135 -0
aiq/cli/main.py +44 -0
aiq/cli/register_workflow.py +488 -0
aiq/cli/type_registry.py +1000 -0
aiq/data_models/__init__.py +14 -0
aiq/data_models/api_server.py +694 -0
aiq/data_models/authentication.py +231 -0
aiq/data_models/common.py +171 -0
aiq/data_models/component.py +54 -0
aiq/data_models/component_ref.py +168 -0
aiq/data_models/config.py +406 -0
aiq/data_models/dataset_handler.py +123 -0
aiq/data_models/discovery_metadata.py +335 -0
aiq/data_models/embedder.py +27 -0
aiq/data_models/evaluate.py +127 -0
aiq/data_models/evaluator.py +26 -0
aiq/data_models/front_end.py +26 -0
aiq/data_models/function.py +30 -0
aiq/data_models/function_dependencies.py +72 -0
aiq/data_models/interactive.py +246 -0
aiq/data_models/intermediate_step.py +302 -0
aiq/data_models/invocation_node.py +38 -0
aiq/data_models/llm.py +27 -0
aiq/data_models/logging.py +26 -0
aiq/data_models/memory.py +27 -0
aiq/data_models/object_store.py +44 -0
aiq/data_models/profiler.py +54 -0
aiq/data_models/registry_handler.py +26 -0
aiq/data_models/retriever.py +30 -0
aiq/data_models/retry_mixin.py +35 -0
aiq/data_models/span.py +187 -0
aiq/data_models/step_adaptor.py +64 -0
aiq/data_models/streaming.py +33 -0
aiq/data_models/swe_bench_model.py +54 -0
aiq/data_models/telemetry_exporter.py +26 -0
aiq/data_models/ttc_strategy.py +30 -0
aiq/embedder/__init__.py +0 -0
aiq/embedder/langchain_client.py +41 -0
aiq/embedder/nim_embedder.py +59 -0
aiq/embedder/openai_embedder.py +43 -0
aiq/embedder/register.py +24 -0
aiq/eval/__init__.py +14 -0
aiq/eval/config.py +60 -0
aiq/eval/dataset_handler/__init__.py +0 -0
aiq/eval/dataset_handler/dataset_downloader.py +106 -0
aiq/eval/dataset_handler/dataset_filter.py +52 -0
aiq/eval/dataset_handler/dataset_handler.py +254 -0
aiq/eval/evaluate.py +506 -0
aiq/eval/evaluator/__init__.py +14 -0
aiq/eval/evaluator/base_evaluator.py +73 -0
aiq/eval/evaluator/evaluator_model.py +45 -0
aiq/eval/intermediate_step_adapter.py +99 -0
aiq/eval/rag_evaluator/__init__.py +0 -0
aiq/eval/rag_evaluator/evaluate.py +178 -0
aiq/eval/rag_evaluator/register.py +143 -0
aiq/eval/register.py +23 -0
aiq/eval/remote_workflow.py +133 -0
aiq/eval/runners/__init__.py +14 -0
aiq/eval/runners/config.py +39 -0
aiq/eval/runners/multi_eval_runner.py +54 -0
aiq/eval/runtime_event_subscriber.py +52 -0
aiq/eval/swe_bench_evaluator/__init__.py +0 -0
aiq/eval/swe_bench_evaluator/evaluate.py +215 -0
aiq/eval/swe_bench_evaluator/register.py +36 -0
aiq/eval/trajectory_evaluator/__init__.py +0 -0
aiq/eval/trajectory_evaluator/evaluate.py +75 -0
aiq/eval/trajectory_evaluator/register.py +40 -0
aiq/eval/tunable_rag_evaluator/__init__.py +0 -0
aiq/eval/tunable_rag_evaluator/evaluate.py +245 -0
aiq/eval/tunable_rag_evaluator/register.py +52 -0
aiq/eval/usage_stats.py +41 -0
aiq/eval/utils/__init__.py +0 -0
aiq/eval/utils/output_uploader.py +140 -0
aiq/eval/utils/tqdm_position_registry.py +40 -0
aiq/eval/utils/weave_eval.py +184 -0
aiq/experimental/__init__.py +0 -0
aiq/experimental/decorators/__init__.py +0 -0
aiq/experimental/decorators/experimental_warning_decorator.py +130 -0
aiq/experimental/test_time_compute/__init__.py +0 -0
aiq/experimental/test_time_compute/editing/__init__.py +0 -0
aiq/experimental/test_time_compute/editing/iterative_plan_refinement_editor.py +147 -0
aiq/experimental/test_time_compute/editing/llm_as_a_judge_editor.py +204 -0
aiq/experimental/test_time_compute/editing/motivation_aware_summarization.py +107 -0
aiq/experimental/test_time_compute/functions/__init__.py +0 -0
aiq/experimental/test_time_compute/functions/execute_score_select_function.py +105 -0
aiq/experimental/test_time_compute/functions/its_tool_orchestration_function.py +205 -0
aiq/experimental/test_time_compute/functions/its_tool_wrapper_function.py +146 -0
aiq/experimental/test_time_compute/functions/plan_select_execute_function.py +224 -0
aiq/experimental/test_time_compute/models/__init__.py +0 -0
aiq/experimental/test_time_compute/models/editor_config.py +132 -0
aiq/experimental/test_time_compute/models/scoring_config.py +112 -0
aiq/experimental/test_time_compute/models/search_config.py +120 -0
aiq/experimental/test_time_compute/models/selection_config.py +154 -0
aiq/experimental/test_time_compute/models/stage_enums.py +43 -0
aiq/experimental/test_time_compute/models/strategy_base.py +66 -0
aiq/experimental/test_time_compute/models/tool_use_config.py +41 -0
aiq/experimental/test_time_compute/models/ttc_item.py +48 -0
aiq/experimental/test_time_compute/register.py +36 -0
aiq/experimental/test_time_compute/scoring/__init__.py +0 -0
aiq/experimental/test_time_compute/scoring/llm_based_agent_scorer.py +168 -0
aiq/experimental/test_time_compute/scoring/llm_based_plan_scorer.py +168 -0
aiq/experimental/test_time_compute/scoring/motivation_aware_scorer.py +111 -0
aiq/experimental/test_time_compute/search/__init__.py +0 -0
aiq/experimental/test_time_compute/search/multi_llm_planner.py +128 -0
aiq/experimental/test_time_compute/search/multi_query_retrieval_search.py +122 -0
aiq/experimental/test_time_compute/search/single_shot_multi_plan_planner.py +128 -0
aiq/experimental/test_time_compute/selection/__init__.py +0 -0
aiq/experimental/test_time_compute/selection/best_of_n_selector.py +63 -0
aiq/experimental/test_time_compute/selection/llm_based_agent_output_selector.py +131 -0
aiq/experimental/test_time_compute/selection/llm_based_output_merging_selector.py +159 -0
aiq/experimental/test_time_compute/selection/llm_based_plan_selector.py +128 -0
aiq/experimental/test_time_compute/selection/threshold_selector.py +58 -0
aiq/front_ends/__init__.py +14 -0
aiq/front_ends/console/__init__.py +14 -0
aiq/front_ends/console/authentication_flow_handler.py +233 -0
aiq/front_ends/console/console_front_end_config.py +32 -0
aiq/front_ends/console/console_front_end_plugin.py +96 -0
aiq/front_ends/console/register.py +25 -0
aiq/front_ends/cron/__init__.py +14 -0
aiq/front_ends/fastapi/__init__.py +14 -0
aiq/front_ends/fastapi/auth_flow_handlers/__init__.py +0 -0
aiq/front_ends/fastapi/auth_flow_handlers/http_flow_handler.py +27 -0
aiq/front_ends/fastapi/auth_flow_handlers/websocket_flow_handler.py +107 -0
aiq/front_ends/fastapi/fastapi_front_end_config.py +234 -0
aiq/front_ends/fastapi/fastapi_front_end_controller.py +68 -0
aiq/front_ends/fastapi/fastapi_front_end_plugin.py +116 -0
aiq/front_ends/fastapi/fastapi_front_end_plugin_worker.py +1092 -0
aiq/front_ends/fastapi/html_snippets/__init__.py +14 -0
aiq/front_ends/fastapi/html_snippets/auth_code_grant_success.py +35 -0
aiq/front_ends/fastapi/intermediate_steps_subscriber.py +80 -0
aiq/front_ends/fastapi/job_store.py +183 -0
aiq/front_ends/fastapi/main.py +72 -0
aiq/front_ends/fastapi/message_handler.py +298 -0
aiq/front_ends/fastapi/message_validator.py +345 -0
aiq/front_ends/fastapi/register.py +25 -0
aiq/front_ends/fastapi/response_helpers.py +195 -0
aiq/front_ends/fastapi/step_adaptor.py +321 -0
aiq/front_ends/mcp/__init__.py +14 -0
aiq/front_ends/mcp/mcp_front_end_config.py +32 -0
aiq/front_ends/mcp/mcp_front_end_plugin.py +93 -0
aiq/front_ends/mcp/register.py +27 -0
aiq/front_ends/mcp/tool_converter.py +242 -0
aiq/front_ends/register.py +22 -0
aiq/front_ends/simple_base/__init__.py +14 -0
aiq/front_ends/simple_base/simple_front_end_plugin_base.py +54 -0
aiq/llm/__init__.py +0 -0
aiq/llm/aws_bedrock_llm.py +57 -0
aiq/llm/nim_llm.py +46 -0
aiq/llm/openai_llm.py +46 -0
aiq/llm/register.py +23 -0
aiq/llm/utils/__init__.py +14 -0
aiq/llm/utils/env_config_value.py +94 -0
aiq/llm/utils/error.py +17 -0
aiq/memory/__init__.py +20 -0
aiq/memory/interfaces.py +183 -0
aiq/memory/models.py +112 -0
aiq/meta/module_to_distro.json +3 -0
aiq/meta/pypi.md +58 -0
aiq/object_store/__init__.py +20 -0
aiq/object_store/in_memory_object_store.py +76 -0
aiq/object_store/interfaces.py +84 -0
aiq/object_store/models.py +36 -0
aiq/object_store/register.py +20 -0
aiq/observability/__init__.py +14 -0
aiq/observability/exporter/__init__.py +14 -0
aiq/observability/exporter/base_exporter.py +449 -0
aiq/observability/exporter/exporter.py +78 -0
aiq/observability/exporter/file_exporter.py +33 -0
aiq/observability/exporter/processing_exporter.py +322 -0
aiq/observability/exporter/raw_exporter.py +52 -0
aiq/observability/exporter/span_exporter.py +265 -0
aiq/observability/exporter_manager.py +335 -0
aiq/observability/mixin/__init__.py +14 -0
aiq/observability/mixin/batch_config_mixin.py +26 -0
aiq/observability/mixin/collector_config_mixin.py +23 -0
aiq/observability/mixin/file_mixin.py +288 -0
aiq/observability/mixin/file_mode.py +23 -0
aiq/observability/mixin/resource_conflict_mixin.py +134 -0
aiq/observability/mixin/serialize_mixin.py +61 -0
aiq/observability/mixin/type_introspection_mixin.py +183 -0
aiq/observability/processor/__init__.py +14 -0
aiq/observability/processor/batching_processor.py +310 -0
aiq/observability/processor/callback_processor.py +42 -0
aiq/observability/processor/intermediate_step_serializer.py +28 -0
aiq/observability/processor/processor.py +71 -0
aiq/observability/register.py +96 -0
aiq/observability/utils/__init__.py +14 -0
aiq/observability/utils/dict_utils.py +236 -0
aiq/observability/utils/time_utils.py +31 -0
aiq/plugins/.namespace +1 -0
aiq/profiler/__init__.py +0 -0
aiq/profiler/calc/__init__.py +14 -0
aiq/profiler/calc/calc_runner.py +627 -0
aiq/profiler/calc/calculations.py +288 -0
aiq/profiler/calc/data_models.py +188 -0
aiq/profiler/calc/plot.py +345 -0
aiq/profiler/callbacks/__init__.py +0 -0
aiq/profiler/callbacks/agno_callback_handler.py +295 -0
aiq/profiler/callbacks/base_callback_class.py +20 -0
aiq/profiler/callbacks/langchain_callback_handler.py +290 -0
aiq/profiler/callbacks/llama_index_callback_handler.py +205 -0
aiq/profiler/callbacks/semantic_kernel_callback_handler.py +238 -0
aiq/profiler/callbacks/token_usage_base_model.py +27 -0
aiq/profiler/data_frame_row.py +51 -0
aiq/profiler/data_models.py +24 -0
aiq/profiler/decorators/__init__.py +0 -0
aiq/profiler/decorators/framework_wrapper.py +131 -0
aiq/profiler/decorators/function_tracking.py +254 -0
aiq/profiler/forecasting/__init__.py +0 -0
aiq/profiler/forecasting/config.py +18 -0
aiq/profiler/forecasting/model_trainer.py +75 -0
aiq/profiler/forecasting/models/__init__.py +22 -0
aiq/profiler/forecasting/models/forecasting_base_model.py +40 -0
aiq/profiler/forecasting/models/linear_model.py +196 -0
aiq/profiler/forecasting/models/random_forest_regressor.py +268 -0
aiq/profiler/inference_metrics_model.py +28 -0
aiq/profiler/inference_optimization/__init__.py +0 -0
aiq/profiler/inference_optimization/bottleneck_analysis/__init__.py +0 -0
aiq/profiler/inference_optimization/bottleneck_analysis/nested_stack_analysis.py +460 -0
aiq/profiler/inference_optimization/bottleneck_analysis/simple_stack_analysis.py +258 -0
aiq/profiler/inference_optimization/data_models.py +386 -0
aiq/profiler/inference_optimization/experimental/__init__.py +0 -0
aiq/profiler/inference_optimization/experimental/concurrency_spike_analysis.py +468 -0
aiq/profiler/inference_optimization/experimental/prefix_span_analysis.py +405 -0
aiq/profiler/inference_optimization/llm_metrics.py +212 -0
aiq/profiler/inference_optimization/prompt_caching.py +163 -0
aiq/profiler/inference_optimization/token_uniqueness.py +107 -0
aiq/profiler/inference_optimization/workflow_runtimes.py +72 -0
aiq/profiler/intermediate_property_adapter.py +102 -0
aiq/profiler/profile_runner.py +473 -0
aiq/profiler/utils.py +184 -0
aiq/registry_handlers/__init__.py +0 -0
aiq/registry_handlers/local/__init__.py +0 -0
aiq/registry_handlers/local/local_handler.py +176 -0
aiq/registry_handlers/local/register_local.py +37 -0
aiq/registry_handlers/metadata_factory.py +60 -0
aiq/registry_handlers/package_utils.py +567 -0
aiq/registry_handlers/pypi/__init__.py +0 -0
aiq/registry_handlers/pypi/pypi_handler.py +251 -0
aiq/registry_handlers/pypi/register_pypi.py +40 -0
aiq/registry_handlers/register.py +21 -0
aiq/registry_handlers/registry_handler_base.py +157 -0
aiq/registry_handlers/rest/__init__.py +0 -0
aiq/registry_handlers/rest/register_rest.py +56 -0
aiq/registry_handlers/rest/rest_handler.py +237 -0
aiq/registry_handlers/schemas/__init__.py +0 -0
aiq/registry_handlers/schemas/headers.py +42 -0
aiq/registry_handlers/schemas/package.py +68 -0
aiq/registry_handlers/schemas/publish.py +63 -0
aiq/registry_handlers/schemas/pull.py +82 -0
aiq/registry_handlers/schemas/remove.py +36 -0
aiq/registry_handlers/schemas/search.py +91 -0
aiq/registry_handlers/schemas/status.py +47 -0
aiq/retriever/__init__.py +0 -0
aiq/retriever/interface.py +37 -0
aiq/retriever/milvus/__init__.py +14 -0
aiq/retriever/milvus/register.py +81 -0
aiq/retriever/milvus/retriever.py +228 -0
aiq/retriever/models.py +74 -0
aiq/retriever/nemo_retriever/__init__.py +14 -0
aiq/retriever/nemo_retriever/register.py +60 -0
aiq/retriever/nemo_retriever/retriever.py +190 -0
aiq/retriever/register.py +22 -0
aiq/runtime/__init__.py +14 -0
aiq/runtime/loader.py +215 -0
aiq/runtime/runner.py +190 -0
aiq/runtime/session.py +158 -0
aiq/runtime/user_metadata.py +130 -0
aiq/settings/__init__.py +0 -0
aiq/settings/global_settings.py +318 -0
aiq/test/.namespace +1 -0
aiq/tool/__init__.py +0 -0
aiq/tool/chat_completion.py +74 -0
aiq/tool/code_execution/README.md +151 -0
aiq/tool/code_execution/__init__.py +0 -0
aiq/tool/code_execution/code_sandbox.py +267 -0
aiq/tool/code_execution/local_sandbox/.gitignore +1 -0
aiq/tool/code_execution/local_sandbox/Dockerfile.sandbox +60 -0
aiq/tool/code_execution/local_sandbox/__init__.py +13 -0
aiq/tool/code_execution/local_sandbox/local_sandbox_server.py +198 -0
aiq/tool/code_execution/local_sandbox/sandbox.requirements.txt +6 -0
aiq/tool/code_execution/local_sandbox/start_local_sandbox.sh +50 -0
aiq/tool/code_execution/register.py +74 -0
aiq/tool/code_execution/test_code_execution_sandbox.py +414 -0
aiq/tool/code_execution/utils.py +100 -0
aiq/tool/datetime_tools.py +42 -0
aiq/tool/document_search.py +141 -0
aiq/tool/github_tools/__init__.py +0 -0
aiq/tool/github_tools/create_github_commit.py +133 -0
aiq/tool/github_tools/create_github_issue.py +87 -0
aiq/tool/github_tools/create_github_pr.py +106 -0
aiq/tool/github_tools/get_github_file.py +106 -0
aiq/tool/github_tools/get_github_issue.py +166 -0
aiq/tool/github_tools/get_github_pr.py +256 -0
aiq/tool/github_tools/update_github_issue.py +100 -0
aiq/tool/mcp/__init__.py +14 -0
aiq/tool/mcp/exceptions.py +142 -0
aiq/tool/mcp/mcp_client.py +255 -0
aiq/tool/mcp/mcp_tool.py +96 -0
aiq/tool/memory_tools/__init__.py +0 -0
aiq/tool/memory_tools/add_memory_tool.py +79 -0
aiq/tool/memory_tools/delete_memory_tool.py +67 -0
aiq/tool/memory_tools/get_memory_tool.py +72 -0
aiq/tool/nvidia_rag.py +95 -0
aiq/tool/register.py +38 -0
aiq/tool/retriever.py +89 -0
aiq/tool/server_tools.py +66 -0
aiq/utils/__init__.py +0 -0
aiq/utils/data_models/__init__.py +0 -0
aiq/utils/data_models/schema_validator.py +58 -0
aiq/utils/debugging_utils.py +43 -0
aiq/utils/dump_distro_mapping.py +32 -0
aiq/utils/exception_handlers/__init__.py +0 -0
aiq/utils/exception_handlers/automatic_retries.py +289 -0
aiq/utils/exception_handlers/mcp.py +211 -0
aiq/utils/exception_handlers/schemas.py +114 -0
aiq/utils/io/__init__.py +0 -0
aiq/utils/io/model_processing.py +28 -0
aiq/utils/io/yaml_tools.py +119 -0
aiq/utils/log_utils.py +37 -0
aiq/utils/metadata_utils.py +74 -0
aiq/utils/optional_imports.py +142 -0
aiq/utils/producer_consumer_queue.py +178 -0
aiq/utils/reactive/__init__.py +0 -0
aiq/utils/reactive/base/__init__.py +0 -0
aiq/utils/reactive/base/observable_base.py +65 -0
aiq/utils/reactive/base/observer_base.py +55 -0
aiq/utils/reactive/base/subject_base.py +79 -0
aiq/utils/reactive/observable.py +59 -0
aiq/utils/reactive/observer.py +76 -0
aiq/utils/reactive/subject.py +131 -0
aiq/utils/reactive/subscription.py +49 -0
aiq/utils/settings/__init__.py +0 -0
aiq/utils/settings/global_settings.py +197 -0
aiq/utils/string_utils.py +38 -0
aiq/utils/type_converter.py +290 -0
aiq/utils/type_utils.py +484 -0
aiq/utils/url_utils.py +27 -0
nvidia_nat-1.2.0rc5.dist-info/METADATA +363 -0
nvidia_nat-1.2.0rc5.dist-info/RECORD +435 -0
nvidia_nat-1.2.0rc5.dist-info/WHEEL +5 -0
nvidia_nat-1.2.0rc5.dist-info/entry_points.txt +20 -0
nvidia_nat-1.2.0rc5.dist-info/licenses/LICENSE-3rd-party.txt +3686 -0
nvidia_nat-1.2.0rc5.dist-info/licenses/LICENSE.md +201 -0
nvidia_nat-1.2.0rc5.dist-info/top_level.txt +1 -0

aiq/front_ends/fastapi/html_snippets/__init__.py ADDED Viewed

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

aiq/front_ends/fastapi/html_snippets/auth_code_grant_success.py ADDED Viewed

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+AUTH_REDIRECT_SUCCESS_HTML = """
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Authentication Complete</title>
+    <script>
+        (function () {
+            window.history.replaceState(null, "", window.location.pathname);
+            window.opener?.postMessage({ type: 'AUTH_SUCCESS' }, '*');
+            window.close();
+        })();
+    </script>
+</head>
+<body>
+    <p>Authentication complete. You may now close this window.</p>
+</body>
+</html>
+"""

aiq/front_ends/fastapi/intermediate_steps_subscriber.py ADDED Viewed

@@ -0,0 +1,80 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import asyncio
+import logging
+from aiq.builder.context import AIQContext
+from aiq.data_models.api_server import AIQResponseIntermediateStep
+from aiq.data_models.intermediate_step import IntermediateStep
+logger = logging.getLogger(__name__)
+async def pull_intermediate(_q, adapter):
+    """
+    Subscribes to the runner's event stream (which is now a simplified Observable)
+    using direct callbacks. Processes each event with the adapter and enqueues
+    results to `_q`.
+    """
+    intermediate_done = asyncio.Event()
+    context = AIQContext.get()
+    loop = asyncio.get_running_loop()
+    async def set_intermediate_done():
+        intermediate_done.set()
+    def on_next_cb(item: IntermediateStep):
+        """
+        Synchronously called whenever the runner publishes an event.
+        We process it, then place it into the async queue (via a small async task).
+        If adapter is None, convert the raw IntermediateStep into the complete
+        AIQResponseIntermediateStep and place it into the queue.
+        """
+        if adapter is None:
+            adapted = AIQResponseIntermediateStep(id=item.UUID,
+                                                  type=item.event_type,
+                                                  name=item.name or "",
+                                                  parent_id=item.parent_id,
+                                                  payload=item.payload.model_dump_json())
+        else:
+            adapted = adapter.process(item)
+        if adapted is not None:
+            loop.create_task(_q.put(adapted))
+    def on_error_cb(exc: Exception):
+        """
+        Called if the runner signals an error. We log it and unblock our wait.
+        """
+        logger.error("Hit on_error: %s", exc)
+        loop.create_task(set_intermediate_done())
+    def on_complete_cb():
+        """
+        Called once the runner signals no more items. We unblock our wait.
+        """
+        logger.debug("Completed reading intermediate steps")
+        loop.create_task(set_intermediate_done())
+    # Subscribe to the runner's "reactive_event_stream" (now a simple Observable)
+    _ = context.intermediate_step_manager.subscribe(on_next=on_next_cb,
+                                                    on_error=on_error_cb,
+                                                    on_complete=on_complete_cb)
+    # Wait until on_complete or on_error sets intermediate_done
+    return intermediate_done

aiq/front_ends/fastapi/job_store.py ADDED Viewed

@@ -0,0 +1,183 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import logging
+import os
+import shutil
+import threading
+from datetime import UTC
+from datetime import datetime
+from datetime import timedelta
+from enum import Enum
+from uuid import uuid4
+from pydantic import BaseModel
+logger = logging.getLogger(__name__)
+class JobStatus(str, Enum):
+    SUBMITTED = "submitted"
+    RUNNING = "running"
+    SUCCESS = "success"
+    FAILURE = "failure"
+    INTERRUPTED = "interrupted"
+    NOT_FOUND = "not_found"
+# pydantic model for the job status
+class JobInfo(BaseModel):
+    job_id: str
+    status: JobStatus
+    config_file: str | None
+    error: str | None
+    output_path: str | None
+    created_at: datetime
+    updated_at: datetime
+    expiry_seconds: int
+    output: BaseModel | None = None
+class JobStore:
+    MIN_EXPIRY = 600  # 10 minutes
+    MAX_EXPIRY = 86400  # 24 hours
+    DEFAULT_EXPIRY = 3600  # 1 hour
+    # active jobs are exempt from expiry
+    ACTIVE_STATUS = {"running", "submitted"}
+    def __init__(self):
+        self._jobs = {}
+        self._lock = threading.Lock()  # Ensure thread safety for job operations
+    def create_job(self,
+                   config_file: str | None = None,
+                   job_id: str | None = None,
+                   expiry_seconds: int = DEFAULT_EXPIRY) -> str:
+        if job_id is None:
+            job_id = str(uuid4())
+        clamped_expiry = max(self.MIN_EXPIRY, min(expiry_seconds, self.MAX_EXPIRY))
+        if expiry_seconds != clamped_expiry:
+            logger.info("Clamped expiry_seconds from %d to %d for job %s", expiry_seconds, clamped_expiry, job_id)
+        job = JobInfo(job_id=job_id,
+                      status=JobStatus.SUBMITTED,
+                      config_file=config_file,
+                      created_at=datetime.now(UTC),
+                      updated_at=datetime.now(UTC),
+                      error=None,
+                      output_path=None,
+                      expiry_seconds=clamped_expiry)
+        with self._lock:
+            self._jobs[job_id] = job
+        logger.info("Created new job %s with config %s", job_id, config_file)
+        return job_id
+    def update_status(self,
+                      job_id: str,
+                      status: str,
+                      error: str | None = None,
+                      output_path: str | None = None,
+                      output: BaseModel | None = None):
+        if job_id not in self._jobs:
+            raise ValueError(f"Job {job_id} not found")
+        with self._lock:
+            job = self._jobs[job_id]
+            job.status = status
+            job.error = error
+            job.output_path = output_path
+            job.updated_at = datetime.now(UTC)
+            job.output = output
+    def get_status(self, job_id: str) -> JobInfo | None:
+        with self._lock:
+            return self._jobs.get(job_id)
+    def list_jobs(self):
+        with self._lock:
+            return self._jobs
+    def get_job(self, job_id: str) -> JobInfo | None:
+        """Get a job by its ID."""
+        with self._lock:
+            return self._jobs.get(job_id)
+    def get_last_job(self) -> JobInfo | None:
+        """Get the last created job."""
+        with self._lock:
+            if not self._jobs:
+                logger.info("No jobs found in job store")
+                return None
+            last_job = max(self._jobs.values(), key=lambda job: job.created_at)
+            logger.info("Retrieved last job %s created at %s", last_job.job_id, last_job.created_at)
+            return last_job
+    def get_jobs_by_status(self, status: str) -> list[JobInfo]:
+        """Get all jobs with the specified status."""
+        with self._lock:
+            return [job for job in self._jobs.values() if job.status == status]
+    def get_all_jobs(self) -> list[JobInfo]:
+        """Get all jobs in the store."""
+        with self._lock:
+            return list(self._jobs.values())
+    def get_expires_at(self, job: JobInfo) -> datetime | None:
+        """Get the time for a job to expire."""
+        if job.status in self.ACTIVE_STATUS:
+            return None
+        return job.updated_at + timedelta(seconds=job.expiry_seconds)
+    def cleanup_expired_jobs(self):
+        """
+        Cleanup expired jobs, keeping the most recent one.
+        Updated_at is used instead of created_at to determine the most recent job.
+        This is because jobs may not be processed in the order they are created.
+        """
+        now = datetime.now(UTC)
+        # Filter out active jobs
+        with self._lock:
+            finished_jobs = {job_id: job for job_id, job in self._jobs.items() if job.status not in self.ACTIVE_STATUS}
+        # Sort finished jobs by updated_at descending
+        sorted_finished = sorted(finished_jobs.items(), key=lambda item: item[1].updated_at, reverse=True)
+        # Always keep the most recent finished job
+        jobs_to_check = sorted_finished[1:]
+        expired_ids = []
+        for job_id, job in jobs_to_check:
+            expires_at = self.get_expires_at(job)
+            if expires_at and now > expires_at:
+                expired_ids.append(job_id)
+                # cleanup output dir if present
+                if job.output_path:
+                    logger.info("Cleaning up output directory for job %s at %s", job_id, job.output_path)
+                    # If it is a file remove it
+                    if os.path.isfile(job.output_path):
+                        os.remove(job.output_path)
+                    # If it is a directory remove it
+                    elif os.path.isdir(job.output_path):
+                        shutil.rmtree(job.output_path)
+        with self._lock:
+            for job_id in expired_ids:
+                del self._jobs[job_id]

aiq/front_ends/fastapi/main.py ADDED Viewed

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import importlib
+import logging
+import os
+from aiq.front_ends.fastapi.fastapi_front_end_plugin_worker import FastApiFrontEndPluginWorkerBase
+from aiq.runtime.loader import load_config
+logger = logging.getLogger(__name__)
+def get_app():
+    config_file_path = os.getenv("AIQ_CONFIG_FILE")
+    front_end_worker_full_name = os.getenv("AIQ_FRONT_END_WORKER")
+    if (not config_file_path):
+        raise ValueError("Config file not found in environment variable AIQ_CONFIG_FILE.")
+    if (not front_end_worker_full_name):
+        raise ValueError("Front end worker not found in environment variable AIQ_FRONT_END_WORKER.")
+    # Try to import the front end worker class
+    try:
+        # Split the package from the class
+        front_end_worker_parts = front_end_worker_full_name.split(".")
+        front_end_worker_module_name = ".".join(front_end_worker_parts[:-1])
+        front_end_worker_class_name = front_end_worker_parts[-1]
+        front_end_worker_module = importlib.import_module(front_end_worker_module_name)
+        if not hasattr(front_end_worker_module, front_end_worker_class_name):
+            raise ValueError(f"Front end worker {front_end_worker_full_name} not found.")
+        front_end_worker_class: type[FastApiFrontEndPluginWorkerBase] = getattr(front_end_worker_module,
+                                                                                front_end_worker_class_name)
+        if (not issubclass(front_end_worker_class, FastApiFrontEndPluginWorkerBase)):
+            raise ValueError(
+                f"Front end worker {front_end_worker_full_name} is not a subclass of FastApiFrontEndPluginWorker.")
+        # Load the config
+        abs_config_file_path = os.path.abspath(config_file_path)
+        config = load_config(abs_config_file_path)
+        # Create an instance of the front end worker class
+        front_end_worker = front_end_worker_class(config)
+        aiq_app = front_end_worker.build_app()
+        return aiq_app
+    except ImportError as e:
+        raise ValueError(f"Front end worker {front_end_worker_full_name} not found.") from e
+    except Exception as e:
+        raise ValueError(f"Error loading front end worker {front_end_worker_full_name}: {e}") from e

aiq/front_ends/fastapi/message_handler.py ADDED Viewed

@@ -0,0 +1,298 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import asyncio
+import logging
+import typing
+import uuid
+from typing import Any
+from fastapi import WebSocket
+from pydantic import BaseModel
+from pydantic import ValidationError
+from starlette.websockets import WebSocketDisconnect
+from aiq.authentication.interfaces import FlowHandlerBase
+from aiq.data_models.api_server import AIQChatResponse
+from aiq.data_models.api_server import AIQResponsePayloadOutput
+from aiq.data_models.api_server import AIQResponseSerializable
+from aiq.data_models.api_server import Error
+from aiq.data_models.api_server import ErrorTypes
+from aiq.data_models.api_server import SystemResponseContent
+from aiq.data_models.api_server import TextContent
+from aiq.data_models.api_server import WebSocketMessageStatus
+from aiq.data_models.api_server import WebSocketMessageType
+from aiq.data_models.api_server import WebSocketSystemInteractionMessage
+from aiq.data_models.api_server import WebSocketSystemIntermediateStepMessage
+from aiq.data_models.api_server import WebSocketSystemResponseTokenMessage
+from aiq.data_models.api_server import WebSocketUserInteractionResponseMessage
+from aiq.data_models.api_server import WebSocketUserMessage
+from aiq.data_models.interactive import HumanPromptNotification
+from aiq.data_models.interactive import HumanResponse
+from aiq.data_models.interactive import HumanResponseNotification
+from aiq.data_models.interactive import InteractionPrompt
+from aiq.front_ends.fastapi.message_validator import MessageValidator
+from aiq.front_ends.fastapi.response_helpers import generate_streaming_response
+from aiq.front_ends.fastapi.step_adaptor import StepAdaptor
+from aiq.runtime.session import AIQSessionManager
+logger = logging.getLogger(__name__)
+class WebSocketMessageHandler:
+    def __init__(self, socket: WebSocket, session_manager: AIQSessionManager, step_adaptor: StepAdaptor):
+        self._socket: WebSocket = socket
+        self._session_manager: AIQSessionManager = session_manager
+        self._step_adaptor: StepAdaptor = step_adaptor
+        self._message_validator: MessageValidator = MessageValidator()
+        self._running_workflow_task: asyncio.Task | None = None
+        self._message_parent_id: str = "default_id"
+        self._workflow_schema_type: str = None
+        self._user_interaction_response: asyncio.Future[HumanResponse] | None = None
+        self._flow_handler: FlowHandlerBase | None = None
+    def set_flow_handler(self, flow_handler: FlowHandlerBase) -> None:
+        self._flow_handler = flow_handler
+    async def __aenter__(self) -> "WebSocketMessageHandler":
+        await self._socket.accept()
+        return self
+    async def __aexit__(self, exc_type, exc_value, traceback) -> None:
+        # TODO: Handle the exit
+        pass
+    async def run(self) -> None:
+        """
+        Processes received messages from websocket and routes them appropriately.
+        """
+        while True:
+            try:
+                message: dict[str, Any] = await self._socket.receive_json()
+                validated_message: BaseModel = await self._message_validator.validate_message(message)
+                # Received a request to start a workflow
+                if (isinstance(validated_message, WebSocketUserMessage)):
+                    await self.process_workflow_request(validated_message)
+                elif isinstance(
+                        validated_message,
+                    (  # noqa: E131
+                        WebSocketSystemResponseTokenMessage,
+                        WebSocketSystemIntermediateStepMessage,
+                        WebSocketSystemInteractionMessage)):
+                    # These messages are already handled by self.create_websocket_message(data_model=value, …)
+                    # No further processing is needed here.
+                    pass
+                elif (isinstance(validated_message, WebSocketUserInteractionResponseMessage)):
+                    user_content = await self.process_user_message_content(validated_message)
+                    self._user_interaction_response.set_result(user_content)
+            except (asyncio.CancelledError, WebSocketDisconnect):
+                # TODO: Handle the disconnect
+                break
+        return None
+    async def process_user_message_content(
+            self, user_content: WebSocketUserMessage | WebSocketUserInteractionResponseMessage) -> BaseModel | None:
+        """
+        Processes the contents of a user message.
+        :param user_content: Incoming content data model.
+        :return: A validated Pydantic user content model or None if not found.
+        """
+        for user_message in user_content.content.messages[::-1]:
+            if (user_message.role == "user"):
+                for attachment in user_message.content:
+                    if isinstance(attachment, TextContent):
+                        return attachment
+        return None
+    async def process_workflow_request(self, user_message_as_validated_type: WebSocketUserMessage) -> None:
+        """
+        Process user messages and routes them appropriately.
+        :param user_message_as_validated_type: A WebSocketUserMessage Data Model instance.
+        """
+        try:
+            self._message_parent_id = user_message_as_validated_type.id
+            self._workflow_schema_type = user_message_as_validated_type.schema_type
+            conversation_id: str = user_message_as_validated_type.conversation_id
+            content: BaseModel | None = await self.process_user_message_content(user_message_as_validated_type)
+            if content is None:
+                raise ValueError(f"User message content could not be found: {user_message_as_validated_type}")
+            if isinstance(content, TextContent) and (self._running_workflow_task is None):
+                def _done_callback(task: asyncio.Task):
+                    self._running_workflow_task = None
+                # await self._process_response()
+                self._running_workflow_task = asyncio.create_task(
+                    self._run_workflow(content.text, conversation_id,
+                                       result_type=AIQChatResponse)).add_done_callback(_done_callback)
+        except ValueError as e:
+            logger.error("User message content not found: %s", str(e), exc_info=True)
+            await self.create_websocket_message(data_model=Error(code=ErrorTypes.INVALID_USER_MESSAGE_CONTENT,
+                                                                 message="User message content could not be found",
+                                                                 details=str(e)),
+                                                message_type=WebSocketMessageType.ERROR_MESSAGE,
+                                                status=WebSocketMessageStatus.IN_PROGRESS)
+    async def create_websocket_message(self,
+                                       data_model: BaseModel,
+                                       message_type: str | None = None,
+                                       status: str = WebSocketMessageStatus.IN_PROGRESS) -> None:
+        """
+        Creates a websocket message that will be ready for routing based on message type or data model.
+        :param data_model: Message content model.
+        :param message_type: Message content model.
+        :param status: Message content model.
+        """
+        try:
+            message: BaseModel | None = None
+            if message_type is None:
+                message_type = await self._message_validator.resolve_message_type_by_data(data_model)
+            message_schema: type[BaseModel] = await self._message_validator.get_message_schema_by_type(message_type)
+            if 'id' in data_model.model_fields:
+                message_id: str = data_model.id
+            else:
+                message_id = str(uuid.uuid4())
+            content: BaseModel = await self._message_validator.convert_data_to_message_content(data_model)
+            if issubclass(message_schema, WebSocketSystemResponseTokenMessage):
+                message = await self._message_validator.create_system_response_token_message(
+                    message_id=message_id, parent_id=self._message_parent_id, content=content, status=status)
+            elif issubclass(message_schema, WebSocketSystemIntermediateStepMessage):
+                message = await self._message_validator.create_system_intermediate_step_message(
+                    message_id=message_id,
+                    parent_id=await self._message_validator.get_intermediate_step_parent_id(data_model),
+                    content=content,
+                    status=status)
+            elif issubclass(message_schema, WebSocketSystemInteractionMessage):
+                message = await self._message_validator.create_system_interaction_message(
+                    message_id=message_id, parent_id=self._message_parent_id, content=content, status=status)
+            elif isinstance(content, Error):
+                raise ValidationError(f"Invalid input data creating websocket message. {data_model.model_dump_json()}")
+            elif issubclass(message_schema, Error):
+                raise TypeError(f"Invalid message type: {message_type}")
+            elif (message is None):
+                raise ValueError(
+                    f"Message type could not be resolved by input data model: {data_model.model_dump_json()}")
+        except (ValidationError, TypeError, ValueError) as e:
+            logger.error("A data vaidation error ocurred creating websocket message: %s", str(e), exc_info=True)
+            message = await self._message_validator.create_system_response_token_message(
+                message_type=WebSocketMessageType.ERROR_MESSAGE,
+                content=Error(code=ErrorTypes.UNKNOWN_ERROR, message="default", details=str(e)))
+        finally:
+            if (message is not None):
+                await self._socket.send_json(message.model_dump())
+    async def human_interaction_callback(self, prompt: InteractionPrompt) -> HumanResponse:
+        """
+        Registered human interaction callback that processes human interactions and returns
+        responses from websocket connection.
+        :param prompt: Incoming interaction content data model.
+        :return: A Text Content Base Pydantic model.
+        """
+        # First create a future from the loop for the human response
+        human_response_future: asyncio.Future[HumanResponse] = asyncio.get_running_loop().create_future()
+        # Then add the future to the outstanding human prompts dictionary
+        self._user_interaction_response = human_response_future
+        try:
+            await self.create_websocket_message(data_model=prompt.content,
+                                                message_type=WebSocketMessageType.SYSTEM_INTERACTION_MESSAGE,
+                                                status=WebSocketMessageStatus.IN_PROGRESS)
+            if (isinstance(prompt.content, HumanPromptNotification)):
+                return HumanResponseNotification()
+            # Wait for the human response future to complete
+            interaction_response: HumanResponse = await human_response_future
+            interaction_response: HumanResponse = await self._message_validator.convert_text_content_to_human_response(
+                interaction_response, prompt.content)
+            return interaction_response
+        finally:
+            # Delete the future from the outstanding human prompts dictionary
+            self._user_interaction_response = None
+    async def _run_workflow(self,
+                            payload: typing.Any,
+                            conversation_id: str | None = None,
+                            result_type: type | None = None,
+                            output_type: type | None = None) -> None:
+        try:
+            async with self._session_manager.session(
+                    conversation_id=conversation_id,
+                    request=self._socket,
+                    user_input_callback=self.human_interaction_callback,
+                    user_authentication_callback=(self._flow_handler.authenticate
+                                                  if self._flow_handler else None)) as session:
+                async for value in generate_streaming_response(payload,
+                                                               session_manager=session,
+                                                               streaming=True,
+                                                               step_adaptor=self._step_adaptor,
+                                                               result_type=result_type,
+                                                               output_type=output_type):
+                    if not isinstance(value, AIQResponseSerializable):
+                        value = AIQResponsePayloadOutput(payload=value)
+                    await self.create_websocket_message(data_model=value, status=WebSocketMessageStatus.IN_PROGRESS)
+        finally:
+            await self.create_websocket_message(data_model=SystemResponseContent(),
+                                                message_type=WebSocketMessageType.RESPONSE_MESSAGE,
+                                                status=WebSocketMessageStatus.COMPLETE)