aiqtoolkit 1.2.0a20250707__py3-none-any.whl → 1.2.0a20250730__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.

Potentially problematic release.


This version of aiqtoolkit might be problematic. Click here for more details.

Files changed (197) hide show
  1. aiq/agent/base.py +171 -8
  2. aiq/agent/dual_node.py +1 -1
  3. aiq/agent/react_agent/agent.py +113 -113
  4. aiq/agent/react_agent/register.py +31 -14
  5. aiq/agent/rewoo_agent/agent.py +36 -35
  6. aiq/agent/rewoo_agent/register.py +2 -2
  7. aiq/agent/tool_calling_agent/agent.py +3 -7
  8. aiq/authentication/__init__.py +14 -0
  9. aiq/authentication/api_key/__init__.py +14 -0
  10. aiq/authentication/api_key/api_key_auth_provider.py +92 -0
  11. aiq/authentication/api_key/api_key_auth_provider_config.py +124 -0
  12. aiq/authentication/api_key/register.py +26 -0
  13. aiq/authentication/exceptions/__init__.py +14 -0
  14. aiq/authentication/exceptions/api_key_exceptions.py +38 -0
  15. aiq/authentication/exceptions/auth_code_grant_exceptions.py +86 -0
  16. aiq/authentication/exceptions/call_back_exceptions.py +38 -0
  17. aiq/authentication/exceptions/request_exceptions.py +54 -0
  18. aiq/authentication/http_basic_auth/__init__.py +0 -0
  19. aiq/authentication/http_basic_auth/http_basic_auth_provider.py +81 -0
  20. aiq/authentication/http_basic_auth/register.py +30 -0
  21. aiq/authentication/interfaces.py +93 -0
  22. aiq/authentication/oauth2/__init__.py +14 -0
  23. aiq/authentication/oauth2/oauth2_auth_code_flow_provider.py +107 -0
  24. aiq/authentication/oauth2/oauth2_auth_code_flow_provider_config.py +39 -0
  25. aiq/authentication/oauth2/register.py +25 -0
  26. aiq/authentication/register.py +21 -0
  27. aiq/builder/builder.py +64 -2
  28. aiq/builder/component_utils.py +16 -3
  29. aiq/builder/context.py +26 -0
  30. aiq/builder/eval_builder.py +43 -2
  31. aiq/builder/function.py +32 -4
  32. aiq/builder/function_base.py +1 -1
  33. aiq/builder/intermediate_step_manager.py +6 -8
  34. aiq/builder/user_interaction_manager.py +3 -0
  35. aiq/builder/workflow.py +23 -18
  36. aiq/builder/workflow_builder.py +420 -73
  37. aiq/cli/commands/info/list_mcp.py +103 -16
  38. aiq/cli/commands/sizing/__init__.py +14 -0
  39. aiq/cli/commands/sizing/calc.py +294 -0
  40. aiq/cli/commands/sizing/sizing.py +27 -0
  41. aiq/cli/commands/start.py +1 -0
  42. aiq/cli/entrypoint.py +2 -0
  43. aiq/cli/register_workflow.py +80 -0
  44. aiq/cli/type_registry.py +151 -30
  45. aiq/data_models/api_server.py +117 -11
  46. aiq/data_models/authentication.py +231 -0
  47. aiq/data_models/common.py +35 -7
  48. aiq/data_models/component.py +17 -9
  49. aiq/data_models/component_ref.py +33 -0
  50. aiq/data_models/config.py +60 -3
  51. aiq/data_models/embedder.py +1 -0
  52. aiq/data_models/function_dependencies.py +8 -0
  53. aiq/data_models/interactive.py +10 -1
  54. aiq/data_models/intermediate_step.py +15 -5
  55. aiq/data_models/its_strategy.py +30 -0
  56. aiq/data_models/llm.py +1 -0
  57. aiq/data_models/memory.py +1 -0
  58. aiq/data_models/object_store.py +44 -0
  59. aiq/data_models/retry_mixin.py +35 -0
  60. aiq/data_models/span.py +187 -0
  61. aiq/data_models/telemetry_exporter.py +2 -2
  62. aiq/embedder/nim_embedder.py +2 -1
  63. aiq/embedder/openai_embedder.py +2 -1
  64. aiq/eval/config.py +19 -1
  65. aiq/eval/dataset_handler/dataset_handler.py +75 -1
  66. aiq/eval/evaluate.py +53 -10
  67. aiq/eval/rag_evaluator/evaluate.py +23 -12
  68. aiq/eval/remote_workflow.py +7 -2
  69. aiq/eval/runners/__init__.py +14 -0
  70. aiq/eval/runners/config.py +39 -0
  71. aiq/eval/runners/multi_eval_runner.py +54 -0
  72. aiq/eval/usage_stats.py +6 -0
  73. aiq/eval/utils/weave_eval.py +5 -1
  74. aiq/experimental/__init__.py +0 -0
  75. aiq/experimental/decorators/__init__.py +0 -0
  76. aiq/experimental/decorators/experimental_warning_decorator.py +130 -0
  77. aiq/experimental/inference_time_scaling/__init__.py +0 -0
  78. aiq/experimental/inference_time_scaling/editing/__init__.py +0 -0
  79. aiq/experimental/inference_time_scaling/editing/iterative_plan_refinement_editor.py +147 -0
  80. aiq/experimental/inference_time_scaling/editing/llm_as_a_judge_editor.py +204 -0
  81. aiq/experimental/inference_time_scaling/editing/motivation_aware_summarization.py +107 -0
  82. aiq/experimental/inference_time_scaling/functions/__init__.py +0 -0
  83. aiq/experimental/inference_time_scaling/functions/execute_score_select_function.py +105 -0
  84. aiq/experimental/inference_time_scaling/functions/its_tool_orchestration_function.py +205 -0
  85. aiq/experimental/inference_time_scaling/functions/its_tool_wrapper_function.py +146 -0
  86. aiq/experimental/inference_time_scaling/functions/plan_select_execute_function.py +224 -0
  87. aiq/experimental/inference_time_scaling/models/__init__.py +0 -0
  88. aiq/experimental/inference_time_scaling/models/editor_config.py +132 -0
  89. aiq/experimental/inference_time_scaling/models/its_item.py +48 -0
  90. aiq/experimental/inference_time_scaling/models/scoring_config.py +112 -0
  91. aiq/experimental/inference_time_scaling/models/search_config.py +120 -0
  92. aiq/experimental/inference_time_scaling/models/selection_config.py +154 -0
  93. aiq/experimental/inference_time_scaling/models/stage_enums.py +43 -0
  94. aiq/experimental/inference_time_scaling/models/strategy_base.py +66 -0
  95. aiq/experimental/inference_time_scaling/models/tool_use_config.py +41 -0
  96. aiq/experimental/inference_time_scaling/register.py +36 -0
  97. aiq/experimental/inference_time_scaling/scoring/__init__.py +0 -0
  98. aiq/experimental/inference_time_scaling/scoring/llm_based_agent_scorer.py +168 -0
  99. aiq/experimental/inference_time_scaling/scoring/llm_based_plan_scorer.py +168 -0
  100. aiq/experimental/inference_time_scaling/scoring/motivation_aware_scorer.py +111 -0
  101. aiq/experimental/inference_time_scaling/search/__init__.py +0 -0
  102. aiq/experimental/inference_time_scaling/search/multi_llm_planner.py +128 -0
  103. aiq/experimental/inference_time_scaling/search/multi_query_retrieval_search.py +122 -0
  104. aiq/experimental/inference_time_scaling/search/single_shot_multi_plan_planner.py +128 -0
  105. aiq/experimental/inference_time_scaling/selection/__init__.py +0 -0
  106. aiq/experimental/inference_time_scaling/selection/best_of_n_selector.py +63 -0
  107. aiq/experimental/inference_time_scaling/selection/llm_based_agent_output_selector.py +131 -0
  108. aiq/experimental/inference_time_scaling/selection/llm_based_output_merging_selector.py +159 -0
  109. aiq/experimental/inference_time_scaling/selection/llm_based_plan_selector.py +128 -0
  110. aiq/experimental/inference_time_scaling/selection/threshold_selector.py +58 -0
  111. aiq/front_ends/console/authentication_flow_handler.py +233 -0
  112. aiq/front_ends/console/console_front_end_plugin.py +11 -2
  113. aiq/front_ends/fastapi/auth_flow_handlers/__init__.py +0 -0
  114. aiq/front_ends/fastapi/auth_flow_handlers/http_flow_handler.py +27 -0
  115. aiq/front_ends/fastapi/auth_flow_handlers/websocket_flow_handler.py +107 -0
  116. aiq/front_ends/fastapi/fastapi_front_end_config.py +20 -0
  117. aiq/front_ends/fastapi/fastapi_front_end_controller.py +68 -0
  118. aiq/front_ends/fastapi/fastapi_front_end_plugin.py +14 -1
  119. aiq/front_ends/fastapi/fastapi_front_end_plugin_worker.py +353 -31
  120. aiq/front_ends/fastapi/html_snippets/__init__.py +14 -0
  121. aiq/front_ends/fastapi/html_snippets/auth_code_grant_success.py +35 -0
  122. aiq/front_ends/fastapi/main.py +2 -0
  123. aiq/front_ends/fastapi/message_handler.py +102 -84
  124. aiq/front_ends/fastapi/step_adaptor.py +2 -1
  125. aiq/llm/aws_bedrock_llm.py +2 -1
  126. aiq/llm/nim_llm.py +2 -1
  127. aiq/llm/openai_llm.py +2 -1
  128. aiq/object_store/__init__.py +20 -0
  129. aiq/object_store/in_memory_object_store.py +74 -0
  130. aiq/object_store/interfaces.py +84 -0
  131. aiq/object_store/models.py +36 -0
  132. aiq/object_store/register.py +20 -0
  133. aiq/observability/__init__.py +14 -0
  134. aiq/observability/exporter/__init__.py +14 -0
  135. aiq/observability/exporter/base_exporter.py +449 -0
  136. aiq/observability/exporter/exporter.py +78 -0
  137. aiq/observability/exporter/file_exporter.py +33 -0
  138. aiq/observability/exporter/processing_exporter.py +269 -0
  139. aiq/observability/exporter/raw_exporter.py +52 -0
  140. aiq/observability/exporter/span_exporter.py +264 -0
  141. aiq/observability/exporter_manager.py +335 -0
  142. aiq/observability/mixin/__init__.py +14 -0
  143. aiq/observability/mixin/batch_config_mixin.py +26 -0
  144. aiq/observability/mixin/collector_config_mixin.py +23 -0
  145. aiq/observability/mixin/file_mixin.py +288 -0
  146. aiq/observability/mixin/file_mode.py +23 -0
  147. aiq/observability/mixin/resource_conflict_mixin.py +134 -0
  148. aiq/observability/mixin/serialize_mixin.py +61 -0
  149. aiq/observability/mixin/type_introspection_mixin.py +183 -0
  150. aiq/observability/processor/__init__.py +14 -0
  151. aiq/observability/processor/batching_processor.py +316 -0
  152. aiq/observability/processor/intermediate_step_serializer.py +28 -0
  153. aiq/observability/processor/processor.py +68 -0
  154. aiq/observability/register.py +32 -116
  155. aiq/observability/utils/__init__.py +14 -0
  156. aiq/observability/utils/dict_utils.py +236 -0
  157. aiq/observability/utils/time_utils.py +31 -0
  158. aiq/profiler/calc/__init__.py +14 -0
  159. aiq/profiler/calc/calc_runner.py +623 -0
  160. aiq/profiler/calc/calculations.py +288 -0
  161. aiq/profiler/calc/data_models.py +176 -0
  162. aiq/profiler/calc/plot.py +345 -0
  163. aiq/profiler/data_models.py +2 -0
  164. aiq/profiler/profile_runner.py +16 -13
  165. aiq/runtime/loader.py +8 -2
  166. aiq/runtime/runner.py +23 -9
  167. aiq/runtime/session.py +16 -5
  168. aiq/tool/chat_completion.py +74 -0
  169. aiq/tool/code_execution/README.md +152 -0
  170. aiq/tool/code_execution/code_sandbox.py +151 -72
  171. aiq/tool/code_execution/local_sandbox/.gitignore +1 -0
  172. aiq/tool/code_execution/local_sandbox/local_sandbox_server.py +139 -24
  173. aiq/tool/code_execution/local_sandbox/sandbox.requirements.txt +3 -1
  174. aiq/tool/code_execution/local_sandbox/start_local_sandbox.sh +27 -2
  175. aiq/tool/code_execution/register.py +7 -3
  176. aiq/tool/code_execution/test_code_execution_sandbox.py +414 -0
  177. aiq/tool/mcp/exceptions.py +142 -0
  178. aiq/tool/mcp/mcp_client.py +17 -3
  179. aiq/tool/mcp/mcp_tool.py +1 -1
  180. aiq/tool/register.py +1 -0
  181. aiq/tool/server_tools.py +2 -2
  182. aiq/utils/exception_handlers/automatic_retries.py +289 -0
  183. aiq/utils/exception_handlers/mcp.py +211 -0
  184. aiq/utils/io/model_processing.py +28 -0
  185. aiq/utils/log_utils.py +37 -0
  186. aiq/utils/string_utils.py +38 -0
  187. aiq/utils/type_converter.py +18 -2
  188. aiq/utils/type_utils.py +87 -0
  189. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/METADATA +37 -9
  190. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/RECORD +195 -80
  191. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/entry_points.txt +3 -0
  192. aiq/front_ends/fastapi/websocket.py +0 -153
  193. aiq/observability/async_otel_listener.py +0 -470
  194. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/WHEEL +0 -0
  195. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/licenses/LICENSE-3rd-party.txt +0 -0
  196. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/licenses/LICENSE.md +0 -0
  197. {aiqtoolkit-1.2.0a20250707.dist-info → aiqtoolkit-1.2.0a20250730.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,54 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+
17
+ class BaseUrlValidationError(Exception):
18
+ """Raised when HTTP Base URL validation fails unexpectedly."""
19
+
20
+ def __init__(self, error_code: str, message: str, *args):
21
+ self.error_code = error_code
22
+ super().__init__(f"[{error_code}] {message}", *args)
23
+
24
+
25
+ class HTTPMethodValidationError(Exception):
26
+ """Raised when HTTP Method validation fails unexpectedly."""
27
+
28
+ def __init__(self, error_code: str, message: str, *args):
29
+ self.error_code = error_code
30
+ super().__init__(f"[{error_code}] {message}", *args)
31
+
32
+
33
+ class QueryParameterValidationError(Exception):
34
+ """Raised when HTTP Query Parameter validation fails unexpectedly."""
35
+
36
+ def __init__(self, error_code: str, message: str, *args):
37
+ self.error_code = error_code
38
+ super().__init__(f"[{error_code}] {message}", *args)
39
+
40
+
41
+ class HTTPHeaderValidationError(Exception):
42
+ """Raised when HTTP Header validation fails unexpectedly."""
43
+
44
+ def __init__(self, error_code: str, message: str, *args):
45
+ self.error_code = error_code
46
+ super().__init__(f"[{error_code}] {message}", *args)
47
+
48
+
49
+ class BodyValidationError(Exception):
50
+ """Raised when HTTP Body validation fails unexpectedly."""
51
+
52
+ def __init__(self, error_code: str, message: str, *args):
53
+ self.error_code = error_code
54
+ super().__init__(f"[{error_code}] {message}", *args)
File without changes
@@ -0,0 +1,81 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ from pydantic import SecretStr
17
+
18
+ from aiq.authentication.interfaces import AuthProviderBase
19
+ from aiq.builder.context import AIQContext
20
+ from aiq.data_models.authentication import AuthenticatedContext
21
+ from aiq.data_models.authentication import AuthFlowType
22
+ from aiq.data_models.authentication import AuthProviderBaseConfig
23
+ from aiq.data_models.authentication import AuthResult
24
+ from aiq.data_models.authentication import BasicAuthCred
25
+ from aiq.data_models.authentication import BearerTokenCred
26
+
27
+
28
+ class HTTPBasicAuthProvider(AuthProviderBase):
29
+ """
30
+ Abstract base class for HTTP Basic Authentication exchangers.
31
+ """
32
+
33
+ def __init__(self, config: AuthProviderBaseConfig):
34
+ """
35
+ Initialize the HTTP Basic Auth Exchanger with the given configuration.
36
+ """
37
+ super().__init__(config)
38
+
39
+ self._authenticated_tokens: dict[str, AuthResult] = {}
40
+
41
+ async def authenticate(self, user_id: str | None = None) -> AuthResult:
42
+ """
43
+ Performs simple HTTP Authentication using the provided user ID.
44
+ """
45
+
46
+ context = AIQContext.get()
47
+
48
+ if user_id is None and hasattr(context, "metadata") and hasattr(
49
+ context.metadata, "cookies") and context.metadata.cookies is not None:
50
+ session_id = context.metadata.cookies.get("aiqtoolkit-session", None)
51
+ if not session_id:
52
+ raise RuntimeError("Authentication failed. No session ID found. Cannot identify user.")
53
+
54
+ user_id = session_id
55
+
56
+ if user_id and user_id in self._authenticated_tokens:
57
+ return self._authenticated_tokens[user_id]
58
+
59
+ auth_callback = context.user_auth_callback
60
+
61
+ try:
62
+ auth_context: AuthenticatedContext = await auth_callback(self.config, AuthFlowType.HTTP_BASIC)
63
+ except RuntimeError as e:
64
+ raise RuntimeError(f"Authentication callback failed: {str(e)}. Did you forget to set a "
65
+ f"callback handler for your frontend?") from e
66
+
67
+ basic_auth_credentials = BasicAuthCred(username=SecretStr(auth_context.metadata.get("username", "")),
68
+ password=SecretStr(auth_context.metadata.get("password", "")))
69
+
70
+ # Get the auth token from the headers of auth context
71
+ bearer_token = auth_context.headers.get("Authorization", "").split(" ")[-1]
72
+ if not bearer_token:
73
+ raise RuntimeError("Authentication failed: No Authorization header found in the response.")
74
+
75
+ bearer_token_cred = BearerTokenCred(token=SecretStr(bearer_token), scheme="Basic")
76
+
77
+ auth_result = AuthResult(credentials=[basic_auth_credentials, bearer_token_cred])
78
+
79
+ self._authenticated_tokens[user_id] = auth_result
80
+
81
+ return auth_result
@@ -0,0 +1,30 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ from aiq.builder.builder import Builder
17
+ from aiq.cli.register_workflow import register_auth_provider
18
+ from aiq.data_models.authentication import AuthProviderBaseConfig
19
+
20
+
21
+ class HTTPBasicAuthProviderConfig(AuthProviderBaseConfig, name="http_basic"):
22
+ pass
23
+
24
+
25
+ @register_auth_provider(config_type=HTTPBasicAuthProviderConfig)
26
+ async def http_basic_auth_provider(config: HTTPBasicAuthProviderConfig, builder: Builder):
27
+
28
+ from aiq.authentication.http_basic_auth.http_basic_auth_provider import HTTPBasicAuthProvider
29
+
30
+ yield HTTPBasicAuthProvider(config)
@@ -0,0 +1,93 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ import typing
17
+ from abc import ABC
18
+ from abc import abstractmethod
19
+
20
+ from aiq.data_models.authentication import AuthenticatedContext
21
+ from aiq.data_models.authentication import AuthFlowType
22
+ from aiq.data_models.authentication import AuthProviderBaseConfig
23
+ from aiq.data_models.authentication import AuthProviderBaseConfigT
24
+ from aiq.data_models.authentication import AuthResult
25
+
26
+ AUTHORIZATION_HEADER = "Authorization"
27
+
28
+
29
+ class AuthProviderBase(typing.Generic[AuthProviderBaseConfigT], ABC):
30
+ """
31
+ Base class for authenticating to API services.
32
+ This class provides an interface for authenticating to API services.
33
+ """
34
+
35
+ def __init__(self, config: AuthProviderBaseConfigT):
36
+ """
37
+ Initialize the AuthProviderBase with the given configuration.
38
+
39
+ Args:
40
+ config (AuthProviderBaseConfig): Configuration items for authentication.
41
+ """
42
+ self._config = config
43
+
44
+ @property
45
+ def config(self) -> AuthProviderBaseConfigT:
46
+ """
47
+ Returns the auth provider configuration object.
48
+
49
+ Returns
50
+ -------
51
+ AuthProviderBaseConfigT
52
+ The auth provider configuration object.
53
+ """
54
+ return self._config
55
+
56
+ @abstractmethod
57
+ async def authenticate(self, user_id: str | None = None) -> AuthResult:
58
+ """
59
+ Perform the authentication process for the client.
60
+
61
+ This method handles the necessary steps to authenticate the client with the
62
+ target API service, which may include obtaining tokens, refreshing credentials,
63
+ or completing multi-step authentication flows.
64
+
65
+ Raises:
66
+ NotImplementedError: Must be implemented by subclasses.
67
+ """
68
+ # This method will call the frontend FlowHandlerBase `authenticate` method
69
+ pass
70
+
71
+
72
+ class FlowHandlerBase(ABC):
73
+ """
74
+ Handles front-end specifc flows for authentication clients.
75
+
76
+ Each front end will define a FlowHandler that will implement the authenticate method.
77
+
78
+ The `authenticate` method will be stored as the callback in the AIQContextState.user_auth_callback
79
+ """
80
+
81
+ @abstractmethod
82
+ async def authenticate(self, config: AuthProviderBaseConfig, method: AuthFlowType) -> AuthenticatedContext:
83
+ """
84
+ Perform the authentication process for the client.
85
+
86
+ This method handles the necessary steps to authenticate the client with the
87
+ target API service, which may include obtaining tokens, refreshing credentials,
88
+ or completing multistep authentication flows.
89
+
90
+ Raises:
91
+ NotImplementedError: Must be implemented by subclasses.
92
+ """
93
+ pass
@@ -0,0 +1,14 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
@@ -0,0 +1,107 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ from datetime import datetime
17
+ from datetime import timezone
18
+
19
+ from authlib.integrations.httpx_client import OAuth2Client as AuthlibOAuth2Client
20
+ from pydantic import SecretStr
21
+
22
+ from aiq.authentication.interfaces import AuthProviderBase
23
+ from aiq.authentication.oauth2.oauth2_auth_code_flow_provider_config import OAuth2AuthCodeFlowProviderConfig
24
+ from aiq.builder.context import AIQContext
25
+ from aiq.data_models.authentication import AuthFlowType
26
+ from aiq.data_models.authentication import AuthResult
27
+ from aiq.data_models.authentication import BearerTokenCred
28
+
29
+
30
+ class OAuth2AuthCodeFlowProvider(AuthProviderBase[OAuth2AuthCodeFlowProviderConfig]):
31
+
32
+ def __init__(self, config: OAuth2AuthCodeFlowProviderConfig):
33
+ super().__init__(config)
34
+ self._authenticated_tokens: dict[str, AuthResult] = {}
35
+ self._context = AIQContext.get()
36
+
37
+ async def _attempt_token_refresh(self, user_id: str, auth_result: AuthResult) -> AuthResult | None:
38
+ refresh_token = auth_result.raw.get("refresh_token")
39
+ if not isinstance(refresh_token, str):
40
+ return None
41
+
42
+ with AuthlibOAuth2Client(
43
+ client_id=self.config.client_id,
44
+ client_secret=self.config.client_secret,
45
+ ) as client:
46
+ try:
47
+ new_token_data = client.refresh_token(self.config.token_url, refresh_token=refresh_token)
48
+ except Exception:
49
+ # On any failure, we'll fall back to the full auth flow.
50
+ return None
51
+
52
+ expires_at_ts = new_token_data.get("expires_at")
53
+ new_expires_at = datetime.fromtimestamp(expires_at_ts, tz=timezone.utc) if expires_at_ts else None
54
+
55
+ new_auth_result = AuthResult(
56
+ credentials=[BearerTokenCred(token=SecretStr(new_token_data["access_token"]))],
57
+ token_expires_at=new_expires_at,
58
+ raw=new_token_data,
59
+ )
60
+
61
+ self._authenticated_tokens[user_id] = new_auth_result
62
+
63
+ return new_auth_result
64
+
65
+ async def authenticate(self, user_id: str | None = None) -> AuthResult:
66
+ if user_id is None and hasattr(AIQContext.get(), "metadata") and hasattr(
67
+ AIQContext.get().metadata, "cookies") and AIQContext.get().metadata.cookies is not None:
68
+ session_id = AIQContext.get().metadata.cookies.get("aiqtoolkit-session", None)
69
+ if not session_id:
70
+ raise RuntimeError("Authentication failed. No session ID found. Cannot identify user.")
71
+
72
+ user_id = session_id
73
+
74
+ if user_id and user_id in self._authenticated_tokens:
75
+ auth_result = self._authenticated_tokens[user_id]
76
+ if not auth_result.is_expired():
77
+ return auth_result
78
+
79
+ refreshed_auth_result = await self._attempt_token_refresh(user_id, auth_result)
80
+ if refreshed_auth_result:
81
+ return refreshed_auth_result
82
+
83
+ auth_callback = self._context.user_auth_callback
84
+ if not auth_callback:
85
+ raise RuntimeError("Authentication callback not set on AIQContext.")
86
+
87
+ try:
88
+ authenticated_context = await auth_callback(self.config, AuthFlowType.OAUTH2_AUTHORIZATION_CODE)
89
+ except Exception as e:
90
+ raise RuntimeError(f"Authentication callback failed: {e}") from e
91
+
92
+ auth_header = authenticated_context.headers.get("Authorization", "")
93
+ if not auth_header.startswith("Bearer "):
94
+ raise RuntimeError("Invalid Authorization header")
95
+
96
+ token = auth_header.split(" ")[1]
97
+
98
+ auth_result = AuthResult(
99
+ credentials=[BearerTokenCred(token=SecretStr(token))],
100
+ token_expires_at=authenticated_context.metadata.get("expires_at"),
101
+ raw=authenticated_context.metadata.get("raw_token"),
102
+ )
103
+
104
+ if user_id:
105
+ self._authenticated_tokens[user_id] = auth_result
106
+
107
+ return auth_result
@@ -0,0 +1,39 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2024-2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ from pydantic import Field
17
+
18
+ from aiq.data_models.authentication import AuthProviderBaseConfig
19
+
20
+
21
+ class OAuth2AuthCodeFlowProviderConfig(AuthProviderBaseConfig, name="oauth2_auth_code_flow"):
22
+
23
+ client_id: str = Field(description="The client ID for OAuth 2.0 authentication.")
24
+ client_secret: str = Field(description="The secret associated with the client_id.")
25
+ authorization_url: str = Field(description="The authorization URL for OAuth 2.0 authentication.")
26
+ token_url: str = Field(description="The token URL for OAuth 2.0 authentication.")
27
+ token_endpoint_auth_method: str | None = Field(
28
+ description=("The authentication method for the token endpoint. "
29
+ "Usually one of `client_secret_post` or `client_secret_basic`."),
30
+ default=None)
31
+ redirect_uri: str = Field(description="The redirect URI for OAuth 2.0 authentication. Must match the registered "
32
+ "redirect URI with the OAuth provider.")
33
+ scopes: list[str] = Field(description="The scopes for OAuth 2.0 authentication.", default_factory=list)
34
+ use_pkce: bool = Field(default=False,
35
+ description="Whether to use PKCE (Proof Key for Code Exchange) in the OAuth 2.0 flow.")
36
+
37
+ authorization_kwargs: dict[str, str] | None = Field(description=("Additional keyword arguments for the "
38
+ "authorization request."),
39
+ default=None)
@@ -0,0 +1,25 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ from aiq.authentication.oauth2.oauth2_auth_code_flow_provider_config import OAuth2AuthCodeFlowProviderConfig
17
+ from aiq.builder.builder import Builder
18
+ from aiq.cli.register_workflow import register_auth_provider
19
+
20
+
21
+ @register_auth_provider(config_type=OAuth2AuthCodeFlowProviderConfig)
22
+ async def oauth2_client(authentication_provider: OAuth2AuthCodeFlowProviderConfig, builder: Builder):
23
+ from aiq.authentication.oauth2.oauth2_auth_code_flow_provider import OAuth2AuthCodeFlowProvider
24
+
25
+ yield OAuth2AuthCodeFlowProvider(authentication_provider)
@@ -0,0 +1,21 @@
1
+ # SPDX-FileCopyrightText: Copyright (c) 2025, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+
16
+ # pylint: disable=unused-import
17
+ # flake8: noqa
18
+
19
+ from aiq.authentication.api_key import register as register_api_key
20
+ from aiq.authentication.http_basic_auth import register as register_http_basic_auth
21
+ from aiq.authentication.oauth2 import register as register_oauth2
aiq/builder/builder.py CHANGED
@@ -20,22 +20,32 @@ from abc import abstractmethod
20
20
  from collections.abc import Sequence
21
21
  from pathlib import Path
22
22
 
23
+ from aiq.authentication.interfaces import AuthProviderBase
23
24
  from aiq.builder.context import AIQContext
24
25
  from aiq.builder.framework_enum import LLMFrameworkEnum
25
26
  from aiq.builder.function import Function
27
+ from aiq.data_models.authentication import AuthProviderBaseConfig
28
+ from aiq.data_models.component_ref import AuthenticationRef
26
29
  from aiq.data_models.component_ref import EmbedderRef
27
30
  from aiq.data_models.component_ref import FunctionRef
31
+ from aiq.data_models.component_ref import ITSStrategyRef
28
32
  from aiq.data_models.component_ref import LLMRef
29
33
  from aiq.data_models.component_ref import MemoryRef
34
+ from aiq.data_models.component_ref import ObjectStoreRef
30
35
  from aiq.data_models.component_ref import RetrieverRef
31
36
  from aiq.data_models.embedder import EmbedderBaseConfig
32
37
  from aiq.data_models.evaluator import EvaluatorBaseConfig
33
38
  from aiq.data_models.function import FunctionBaseConfig
34
39
  from aiq.data_models.function_dependencies import FunctionDependencies
40
+ from aiq.data_models.its_strategy import ITSStrategyBaseConfig
35
41
  from aiq.data_models.llm import LLMBaseConfig
36
42
  from aiq.data_models.memory import MemoryBaseConfig
43
+ from aiq.data_models.object_store import ObjectStoreBaseConfig
37
44
  from aiq.data_models.retriever import RetrieverBaseConfig
45
+ from aiq.experimental.inference_time_scaling.models.stage_enums import PipelineTypeEnum
46
+ from aiq.experimental.inference_time_scaling.models.stage_enums import StageTypeEnum
38
47
  from aiq.memory.interfaces import MemoryEditor
48
+ from aiq.object_store.interfaces import ObjectStore
39
49
  from aiq.retriever.interface import AIQRetriever
40
50
 
41
51
 
@@ -91,6 +101,10 @@ class Builder(ABC): # pylint: disable=too-many-public-methods
91
101
  async def add_llm(self, name: str | LLMRef, config: LLMBaseConfig):
92
102
  pass
93
103
 
104
+ @abstractmethod
105
+ async def get_llm(self, llm_name: str | LLMRef, wrapper_type: LLMFrameworkEnum | str) -> typing.Any:
106
+ pass
107
+
94
108
  async def get_llms(self, llm_names: Sequence[str | LLMRef],
95
109
  wrapper_type: LLMFrameworkEnum | str) -> list[typing.Any]:
96
110
 
@@ -101,11 +115,41 @@ class Builder(ABC): # pylint: disable=too-many-public-methods
101
115
  return list(llms)
102
116
 
103
117
  @abstractmethod
104
- async def get_llm(self, llm_name: str | LLMRef, wrapper_type: LLMFrameworkEnum | str) -> typing.Any:
118
+ def get_llm_config(self, llm_name: str | LLMRef) -> LLMBaseConfig:
105
119
  pass
106
120
 
107
121
  @abstractmethod
108
- def get_llm_config(self, llm_name: str | LLMRef) -> LLMBaseConfig:
122
+ async def add_auth_provider(self, name: str | AuthenticationRef, config: AuthProviderBaseConfig):
123
+ pass
124
+
125
+ @abstractmethod
126
+ async def get_auth_provider(self, auth_provider_name: str | AuthenticationRef) -> AuthProviderBase:
127
+ pass
128
+
129
+ async def get_auth_providers(self, auth_provider_names: list[str | AuthenticationRef]):
130
+
131
+ coros = [self.get_auth_provider(auth_provider_name=n) for n in auth_provider_names]
132
+
133
+ auth_providers = await asyncio.gather(*coros, return_exceptions=False)
134
+
135
+ return list(auth_providers)
136
+
137
+ @abstractmethod
138
+ async def add_object_store(self, name: str | ObjectStoreRef, config: ObjectStoreBaseConfig):
139
+ pass
140
+
141
+ async def get_object_store_clients(self, object_store_names: Sequence[str | ObjectStoreRef]) -> list[ObjectStore]:
142
+ """
143
+ Return a list of all object store clients.
144
+ """
145
+ return list(await asyncio.gather(*[self.get_object_store_client(name) for name in object_store_names]))
146
+
147
+ @abstractmethod
148
+ async def get_object_store_client(self, object_store_name: str | ObjectStoreRef) -> ObjectStore:
149
+ pass
150
+
151
+ @abstractmethod
152
+ def get_object_store_config(self, object_store_name: str | ObjectStoreRef) -> ObjectStoreBaseConfig:
109
153
  pass
110
154
 
111
155
  @abstractmethod
@@ -187,6 +231,24 @@ class Builder(ABC): # pylint: disable=too-many-public-methods
187
231
  async def get_retriever_config(self, retriever_name: str | RetrieverRef) -> RetrieverBaseConfig:
188
232
  pass
189
233
 
234
+ @abstractmethod
235
+ async def add_its_strategy(self, name: str | str, config: ITSStrategyBaseConfig):
236
+ pass
237
+
238
+ @abstractmethod
239
+ async def get_its_strategy(self,
240
+ strategy_name: str | ITSStrategyRef,
241
+ pipeline_type: PipelineTypeEnum,
242
+ stage_type: StageTypeEnum):
243
+ pass
244
+
245
+ @abstractmethod
246
+ async def get_its_strategy_config(self,
247
+ strategy_name: str | ITSStrategyRef,
248
+ pipeline_type: PipelineTypeEnum,
249
+ stage_type: StageTypeEnum) -> ITSStrategyBaseConfig:
250
+ pass
251
+
190
252
  @abstractmethod
191
253
  def get_user_manager(self) -> UserManagerHolder:
192
254
  pass
@@ -21,6 +21,7 @@ from collections.abc import Iterable
21
21
  import networkx as nx
22
22
  from pydantic import BaseModel
23
23
 
24
+ from aiq.data_models.authentication import AuthProviderBaseConfig
24
25
  from aiq.data_models.common import TypedBaseModel
25
26
  from aiq.data_models.component import ComponentGroup
26
27
  from aiq.data_models.component_ref import ComponentRef
@@ -29,8 +30,10 @@ from aiq.data_models.component_ref import generate_instance_id
29
30
  from aiq.data_models.config import AIQConfig
30
31
  from aiq.data_models.embedder import EmbedderBaseConfig
31
32
  from aiq.data_models.function import FunctionBaseConfig
33
+ from aiq.data_models.its_strategy import ITSStrategyBaseConfig
32
34
  from aiq.data_models.llm import LLMBaseConfig
33
35
  from aiq.data_models.memory import MemoryBaseConfig
36
+ from aiq.data_models.object_store import ObjectStoreBaseConfig
34
37
  from aiq.data_models.retriever import RetrieverBaseConfig
35
38
  from aiq.utils.type_utils import DecomposedType
36
39
 
@@ -38,11 +41,14 @@ logger = logging.getLogger(__name__)
38
41
 
39
42
  # Order in which we want to process the component groups
40
43
  _component_group_order = [
44
+ ComponentGroup.AUTHENTICATION,
41
45
  ComponentGroup.EMBEDDERS,
42
46
  ComponentGroup.LLMS,
43
47
  ComponentGroup.MEMORY,
48
+ ComponentGroup.OBJECT_STORES,
44
49
  ComponentGroup.RETRIEVERS,
45
- ComponentGroup.FUNCTIONS
50
+ ComponentGroup.ITS_STRATEGIES,
51
+ ComponentGroup.FUNCTIONS,
46
52
  ]
47
53
 
48
54
 
@@ -95,6 +101,8 @@ def group_from_component(component: TypedBaseModel) -> ComponentGroup | None:
95
101
  component is not a valid runtime instance, None is returned.
96
102
  """
97
103
 
104
+ if (isinstance(component, AuthProviderBaseConfig)):
105
+ return ComponentGroup.AUTHENTICATION
98
106
  if (isinstance(component, EmbedderBaseConfig)):
99
107
  return ComponentGroup.EMBEDDERS
100
108
  if (isinstance(component, FunctionBaseConfig)):
@@ -103,8 +111,12 @@ def group_from_component(component: TypedBaseModel) -> ComponentGroup | None:
103
111
  return ComponentGroup.LLMS
104
112
  if (isinstance(component, MemoryBaseConfig)):
105
113
  return ComponentGroup.MEMORY
114
+ if (isinstance(component, ObjectStoreBaseConfig)):
115
+ return ComponentGroup.OBJECT_STORES
106
116
  if (isinstance(component, RetrieverBaseConfig)):
107
117
  return ComponentGroup.RETRIEVERS
118
+ if (isinstance(component, ITSStrategyBaseConfig)):
119
+ return ComponentGroup.ITS_STRATEGIES
108
120
 
109
121
  return None
110
122
 
@@ -142,7 +154,7 @@ def recursive_componentref_discovery(cls: TypedBaseModel, value: typing.Any,
142
154
  yield from recursive_componentref_discovery(cls, field_data, field_info.annotation)
143
155
  if (decomposed_type.is_union):
144
156
  for arg in decomposed_type.args:
145
- if (isinstance(value, DecomposedType(arg).root)):
157
+ if arg is typing.Any or (isinstance(value, DecomposedType(arg).root)):
146
158
  yield from recursive_componentref_discovery(cls, value, arg)
147
159
  else:
148
160
  for arg in decomposed_type.args:
@@ -243,7 +255,8 @@ def build_dependency_sequence(config: "AIQConfig") -> list[ComponentInstanceData
243
255
  """
244
256
 
245
257
  total_node_count = len(config.embedders) + len(config.functions) + len(config.llms) + len(config.memory) + len(
246
- config.retrievers) + 1 # +1 for the workflow
258
+ config.object_stores) + len(config.retrievers) + len(config.its_strategies) + len(
259
+ config.authentication) + 1 # +1 for the workflow
247
260
 
248
261
  dependency_map: dict
249
262
  dependency_graph: nx.DiGraph