aiqtoolkit 1.1.0a20250429__py3-none-any.whl → 1.1.0a20250501__py3-none-any.whl

aiq/registry_handlers/schemas/search.py

@@ -42,12 +42,12 @@ class VisualizeFields(str, Enum):
 
 
 class SearchQuery(BaseModel):
-    """Represents the search criteria that will be used to discover useful AgentIQ components.
+    """Represents the search criteria that will be used to discover useful AIQ Toolkit components.
 
     Args:
-        query (str): A query string used to find useful AgentIQ components.
+        query (str): A query string used to find useful AIQ Toolkit components.
         fields (list[SearchFields]): The list of fields used when applying the query string.
-        component_types (list[AIQComponentEnum]): AgentIQ components types to filter search results.
+        component_types (list[AIQComponentEnum]): AIQ Toolkit components types to filter search results.
         top_k (int): Specifies the number of search results to provide.
     """
 
@@ -61,10 +61,10 @@ class SearchResponseItem(BaseModel):
     """Represents an individual item in the search response, including elements of it's discovery metadata.
 
     Args:
-        package (str): The name of the AgentIQ package that includes the component.
-        version (str): The version of the AgentIQ package that includes the component.
-        component_type (AIQComponentEnum): Type of AgentIQ component this item represents.
-        description (str): A description of this AgentIQ component.
+        package (str): The name of the AIQ Toolkit package that includes the component.
+        version (str): The version of the AIQ Toolkit package that includes the component.
+        component_type (AIQComponentEnum): Type of AIQ Toolkit component this item represents.
+        description (str): A description of this AIQ Toolkit component.
         developer_notes (str): Additional details that would help a developer use this component.
     """
 

aiq/retriever/models.py

@@ -26,7 +26,7 @@ from aiq.utils.type_converter import GlobalTypeConverter
 
 class AIQDocument(BaseModel):
     """
-    Object representing a retrieved document/chunk from a standard AgentIQ Retriever.
+    Object representing a retrieved document/chunk from a standard AIQ Toolkit Retriever.
     """
     page_content: str = Field(description="Primary content of the document to insert or retrieve")
     metadata: dict[str, Any] = Field(description="Metadata dictionary attached to the AIQDocument")

aiq/runtime/loader.py

@@ -53,7 +53,7 @@ class PluginTypes(IntFlag):
     # Convenience flag for groups of plugin types
     CONFIG_OBJECT = COMPONENT | FRONT_END | EVALUATOR
     """
-    Any plugin that can be specified in the AgentIQ configuration file.
+    Any plugin that can be specified in the AIQ Toolkit configuration file.
     """
     ALL = COMPONENT | FRONT_END | EVALUATOR | REGISTRY_HANDLER
     """
@@ -63,8 +63,8 @@ class PluginTypes(IntFlag):
 
 def load_config(config_file: StrPath) -> AIQConfig:
     """
-    This is the primary entry point for loading an AgentIQ configuration file. It ensures that all plugins are loaded
-    and then validates the configuration file against the AIQConfig schema.
+    This is the primary entry point for loading an AIQ Toolkit configuration file. It ensures that all plugins are
+    loaded and then validates the configuration file against the AIQConfig schema.
 
     Parameters
     ----------
@@ -82,7 +82,7 @@ def load_config(config_file: StrPath) -> AIQConfig:
 
     config_yaml = yaml_load(config_file)
 
-    # Validate configuration adheres to AgentIQ schemas
+    # Validate configuration adheres to AIQ Toolkit schemas
     validated_aiq_config = validate_schema(config_yaml, AIQConfig)
 
     return validated_aiq_config
@@ -91,8 +91,8 @@ def load_config(config_file: StrPath) -> AIQConfig:
 @asynccontextmanager
 async def load_workflow(config_file: StrPath, max_concurrency: int = -1):
     """
-    Load the AgentIQ configuration file and create an AIQRunner object. This is the primary entry point for running
-    AgentIQ workflows.
+    Load the AIQ Toolkit configuration file and create an AIQRunner object. This is the primary entry point for running
+    AIQ Toolkit workflows.
 
     Parameters
     ----------

aiq/tool/mcp/mcp_tool.py

@@ -29,7 +29,8 @@ logger = logging.getLogger(__name__)
 
 class MCPToolConfig(FunctionBaseConfig, name="mcp_tool_wrapper"):
     """
-    Function which connects to a Model Context Protocol (MCP) server and wraps the selected tool as an AgentIQ function.
+    Function which connects to a Model Context Protocol (MCP) server and wraps the selected tool as an AIQ Toolkit
+    function.
     """
     # Add your custom configuration parameters here
     url: HttpUrl = Field(description="The URL of the MCP server")
@@ -44,7 +45,7 @@ class MCPToolConfig(FunctionBaseConfig, name="mcp_tool_wrapper"):
 @register_function(config_type=MCPToolConfig)
 async def mcp_tool(config: MCPToolConfig, builder: Builder):
     """
-    Generate an AgentIQ Function that wraps a tool provided by the MCP server.
+    Generate an AIQ Toolkit Function that wraps a tool provided by the MCP server.
     """
 
     from aiq.tool.mcp.mcp_client import MCPBuilder

aiq/tool/retriever.py

@@ -58,7 +58,7 @@ def _get_description_from_config(config: AIQRetrieverConfig) -> str:
 @register_function(config_type=AIQRetrieverConfig)
 async def aiq_retriever_tool(config: AIQRetrieverConfig, builder: Builder):
     """
-    Configure an AgentIQ Retriever Tool which supports different clients such as Milvus and Nemo Retriever.
+    Configure an AIQ Toolkit Retriever Tool which supports different clients such as Milvus and Nemo Retriever.
 
     Args:
         config: A config object with required parameters 'client' and 'client_config'

aiq/utils/io/yaml_tools.py

@@ -14,37 +14,106 @@
 # limitations under the License.
 
 import io
+import logging
 import typing
 
+import expandvars
 import yaml
 
 from aiq.utils.type_utils import StrPath
 
+logger = logging.getLogger(__name__)
+
+
+def _interpolate_variables(value: str | int | float | bool | None) -> str | int | float | bool | None:
+    """
+    Interpolate variables in a string with the format ${VAR:-default_value}.
+    If the variable is not set, the default value will be used.
+    If no default value is provided, an empty string will be used.
+
+    Args:
+        value (str | int | float | bool | None): The value to interpolate variables in.
+
+    Returns:
+        str | int | float | bool | None: The value with variables interpolated.
+    """
+
+    if not isinstance(value, str):
+        return value
+
+    return expandvars.expandvars(value)
+
 
 def yaml_load(config_path: StrPath) -> dict:
+    """
+    Load a YAML file and interpolate variables in the format
+    ${VAR:-default_value}.
+
+    Args:
+        config_path (StrPath): The path to the YAML file to load.
+
+    Returns:
+        dict: The processed configuration dictionary.
+    """
 
     # Read YAML file
-    with open(config_path, 'r', encoding="utf-8") as stream:
-        config_data = yaml.safe_load(stream)
+    with open(config_path, "r", encoding="utf-8") as stream:
+        config_str = stream.read()
 
-    return config_data
+    return yaml_loads(config_str)
 
 
 def yaml_loads(config: str) -> dict:
+    """
+    Load a YAML string and interpolate variables in the format
+    ${VAR:-default_value}.
 
-    stream = io.StringIO(config)
+    Args:
+        config (str): The YAML string to load.
+
+    Returns:
+        dict: The processed configuration dictionary.
+    """
+
+    interpolated_config_str = _interpolate_variables(config)
+    assert isinstance(interpolated_config_str, str), "Config must be a string"
+
+    stream = io.StringIO(interpolated_config_str)
     stream.seek(0)
 
-    return yaml.safe_load(stream)
+    # Load the YAML data
+    try:
+        config_data = yaml.safe_load(stream)
+    except yaml.YAMLError as e:
+        logger.error("Error loading YAML: %s", interpolated_config_str, exc_info=True)
+        raise ValueError(f"Error loading YAML: {e}") from e
+
+    assert isinstance(config_data, dict)
+
+    return config_data
 
 
 def yaml_dump(config: dict, fp: typing.TextIO) -> None:
+    """
+    Dump a configuration dictionary to a YAML file.
 
+    Args:
+        config (dict): The configuration dictionary to dump.
+        fp (typing.TextIO): The file pointer to write the YAML to.
+    """
     yaml.dump(config, stream=fp, indent=2, sort_keys=False)
-
     fp.flush()
 
 
 def yaml_dumps(config: dict) -> str:
+    """
+    Dump a configuration dictionary to a YAML string.
+
+    Args:
+        config (dict): The configuration dictionary to dump.
+
+    Returns:
+        str: The YAML string.
+    """
 
     return yaml.dump(config, indent=2)

aiq/utils/settings/global_settings.py

@@ -66,7 +66,7 @@ def configure_registry_channel(config_type: RegistryHandlerBaseConfig, channel_n
 
 
 def add_channel_interative(channel_type: str) -> None:
-    """Add a remote registry channel to publish/search/pull AgentIQ plugin packages.
+    """Add a remote registry channel to publish/search/pull AIQ Toolkit plugin packages.
 
     Args:
         channel_type (str): They type of channel to configure.

{aiqtoolkit-1.1.0a20250429.dist-info → aiqtoolkit-1.1.0a20250501.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiqtoolkit
-Version: 1.1.0a20250429
+Version: 1.1.0a20250501
 Summary: Agent Intelligence Toolkit (AIQ Toolkit)
 Author: NVIDIA Corporation
 Maintainer: NVIDIA Corporation
@@ -207,7 +207,7 @@ License:                                  Apache License
            limitations under the License.
 Keywords: ai,rag,agents
 Classifier: Programming Language :: Python
-Requires-Python: >=3.11
+Requires-Python: <3.13,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE-3rd-party.txt
 License-File: LICENSE.md
@@ -215,6 +215,7 @@ Requires-Dist: aioboto3>=11.0.0
 Requires-Dist: arize-phoenix~=6.1
 Requires-Dist: click~=8.1
 Requires-Dist: colorama~=0.4.6
+Requires-Dist: expandvars~=1.0
 Requires-Dist: fastapi~=0.115.5
 Requires-Dist: httpx~=0.27
 Requires-Dist: jinja2~=3.1
@@ -228,7 +229,7 @@ Requires-Dist: opentelemetry-api~=1.2
 Requires-Dist: opentelemetry-sdk~=1.3
 Requires-Dist: pkginfo~=1.12
 Requires-Dist: platformdirs~=4.3
-Requires-Dist: pydantic~=2.10
+Requires-Dist: pydantic==2.10.*
 Requires-Dist: pymilvus~=2.4
 Requires-Dist: PyYAML~=6.0
 Requires-Dist: ragas~=0.2.14
@@ -273,7 +274,7 @@ 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
+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,
@@ -282,39 +283,39 @@ See the License for the specific language governing permissions and
 limitations under the License.
 -->
 
-![NVIDIA AgentIQ](https://media.githubusercontent.com/media/NVIDIA/AgentIQ/refs/heads/main/docs/source/_static/agentiq_banner.png "AgentIQ banner image")
+![NVIDIA Agent Intelligence Toolkit](https://media.githubusercontent.com/media/NVIDIA/AIQToolkit/refs/heads/main/docs/source/_static/aiqtoolkit_banner.png "AIQ Toolkit banner image")
 
-# NVIDIA AgentIQ
+# NVIDIA Agent Intelligence Toolkit
 
-AgentIQ is a flexible library designed to seamlessly integrate your enterprise agents—regardless of framework—with various data sources and tools. By treating agents, tools, and agentic workflows as simple function calls, AgentIQ enables true composability: build once and reuse anywhere.
+AIQ Toolkit is a flexible library designed to seamlessly integrate your enterprise agents—regardless of framework—with various data sources and tools. By treating agents, tools, and agentic workflows as simple function calls, AIQ Toolkit enables true composability: build once and reuse anywhere.
 
 ## Key Features
 
-- [**Framework Agnostic:**](https://docs.nvidia.com/agentiq/latest/concepts/plugins.html) Works with any agentic framework, so you can use your current technology stack without replatforming.
-- [**Reusability:**](https://docs.nvidia.com/agentiq/latest/guides/sharing-workflows-and-tools.html) Every agent, tool, or workflow can be combined and repurposed, allowing developers to leverage existing work in new scenarios.
-- [**Rapid Development:**](https://docs.nvidia.com/agentiq/latest/guides/create-customize-workflows.html) Start with a pre-built agent, tool, or workflow, and customize it to your needs.
-- [**Profiling:**](https://docs.nvidia.com/agentiq/latest/guides/profiler.html) Profile entire workflows down to the tool and agent level, track input/output tokens and timings, and identify bottlenecks.
-- [**Observability:**](https://docs.nvidia.com/agentiq/latest/guides/observe-workflow-with-phoenix.html) Monitor and debug your workflows with any OpenTelemetry-compatible observability tool.
-- [**Evaluation System:**](https://docs.nvidia.com/agentiq/latest/guides/evaluate.html) Validate and maintain accuracy of agentic workflows with built-in evaluation tools.
-- [**User Interface:**](https://docs.nvidia.com/agentiq/latest/guides/using-agentiq-ui-and-server.html) Use the AgentIQ UI chat interface to interact with your agents, visualize output, and debug workflows.
-- [**MCP Compatibility**](https://docs.nvidia.com/agentiq/latest/components/mcp.html) Compatible with Model Context Protocol (MCP), allowing tools served by MCP Servers to be used as AgentIQ functions.
+- [**Framework Agnostic:**](https://docs.nvidia.com/aiqtoolkit/latest/concepts/plugins.html) Works with any agentic framework, so you can use your current technology stack without replatforming.
+- [**Reusability:**](https://docs.nvidia.com/aiqtoolkit/latest/guides/sharing-workflows-and-tools.html) Every agent, tool, or workflow can be combined and repurposed, allowing developers to leverage existing work in new scenarios.
+- [**Rapid Development:**](https://docs.nvidia.com/aiqtoolkit/latest/guides/create-customize-workflows.html) Start with a pre-built agent, tool, or workflow, and customize it to your needs.
+- [**Profiling:**](https://docs.nvidia.com/aiqtoolkit/latest/guides/profiler.html) Profile entire workflows down to the tool and agent level, track input/output tokens and timings, and identify bottlenecks.
+- [**Observability:**](https://docs.nvidia.com/aiqtoolkit/latest/guides/observe-workflow-with-phoenix.html) Monitor and debug your workflows with any OpenTelemetry-compatible observability tool.
+- [**Evaluation System:**](https://docs.nvidia.com/aiqtoolkit/latest/guides/evaluate.html) Validate and maintain accuracy of agentic workflows with built-in evaluation tools.
+- [**User Interface:**](https://docs.nvidia.com/aiqtoolkit/latest/guides/using-aiqtoolkit-ui-and-server.html) Use the AIQ Toolkit UI chat interface to interact with your agents, visualize output, and debug workflows.
+- [**MCP Compatibility**](https://docs.nvidia.com/aiqtoolkit/latest/components/mcp.html) Compatible with Model Context Protocol (MCP), allowing tools served by MCP Servers to be used as AIQ Toolkit functions.
 
-With AgentIQ, you can move quickly, experiment freely, and ensure reliability across all your agent-driven projects.
+With AIQ Toolkit, you can move quickly, experiment freely, and ensure reliability across all your agent-driven projects.
 
 ## Links
- * [Documentation](https://docs.nvidia.com/agentiq/latest/index.html): Explore the full documentation for AgentIQ.
- * [About AgentIQ](https://docs.nvidia.com/agentiq/latest/intro/why-agentiq.html): Learn more about the benefits of using AgentIQ.
+ * [Documentation](https://docs.nvidia.com/aiqtoolkit/latest/index.html): Explore the full documentation for AIQ Toolkit.
+ * [About AIQ Toolkit](https://docs.nvidia.com/aiqtoolkit/latest/intro/why-aiqtoolkit.html): Learn more about the benefits of using AIQ Toolkit.
 
 ## First time user?
- If this is your first time using AgentIQ, it is recommended to install the latest version from the [source repository](https://github.com/NVIDIA/AgentIQ?tab=readme-ov-file#get-started) on GitHub. This package is intended for users who are familiar with AgentIQ applications and need to add AgentIQ as a dependency to their project.
+ If this is your first time using AIQ Toolkit, it is recommended to install the latest version from the [source repository](https://github.com/NVIDIA/AIQToolkit?tab=readme-ov-file#get-started) on GitHub. This package is intended for users who are familiar with AIQ Toolkit applications and need to add AIQ Toolkit as a dependency to their project.
 
 ## Feedback
 
-We would love to hear from you! Please file an issue on [GitHub](https://github.com/NVIDIA/AgentIQ/issues) if you have any feedback or feature requests.
+We would love to hear from you! Please file an issue on [GitHub](https://github.com/NVIDIA/AIQToolkit/issues) if you have any feedback or feature requests.
 
 ## Acknowledgements
 
-We would like to thank the following open source projects that made AgentIQ possible:
+We would like to thank the following open source projects that made AIQ Toolkit possible:
 
 - [CrewAI](https://github.com/crewAIInc/crewAI)
 - [FastAPI](https://github.com/tiangolo/fastapi)