chore: Change IOMapper name to AgentIOMapper. Add minimal docs.

Author: jnapper7

Diff for: agntcy_iomapper/__init__.py

@@ -8,7 +8,7 @@
     IOModelSettings,
 )
 from .iomapper import (
-    IOMapper,
+    AgentIOMapper,
     IOMapperConfig,
     IOModelArgs,
 )

Diff for: agntcy_iomapper/iomapper.py

@@ -75,7 +75,7 @@ def _validate_obj(self) -> Self:
         return self
 
 
-class IOMapper(BaseIOMapper):
+class AgentIOMapper(BaseIOMapper):
     _json_search_pattern: ClassVar[re.Pattern] = re.compile(r"```json\n(.*?)\n```", re.DOTALL)
 
     def __init__(
@@ -160,7 +160,6 @@ def _get_agent(
             raise ValueError(f"requested model {model_name} not found")
 
         return get_supported_agent(
-            is_async,
             model_name,
             model_args=self.config.models[model_name],
             system_prompt=system_prompt,
@@ -273,7 +272,7 @@ async def main():
     input = IOMapperInput.model_validate_json(inputs)
     logging.info(f"Loaded input from {args.inputfile}: {input.model_dump_json()}")
 
-    p = IOMapper(config, jinja_env)
+    p = AgentIOMapper(config, jinja_env)
     output = await p.ainvoke(input)
     outputs = output.model_dump_json()
 

Diff for: agntcy_iomapper/supported_agents.py

@@ -17,17 +17,31 @@
 
 
 def get_supported_agent(
-    is_async: bool,
     model_name: SupportedModelName,
     model_args: dict[str, Any] = {},
     **kwargs,
 ) -> Agent:
+    """
+    Creates and returns an `Agent` instance for the given model.
+
+    Args:
+        model_name (SupportedModelName): The name of the model to be used.
+            If the name starts with "azure:", an `AsyncAzureOpenAI` client is used.
+        model_args (dict[str, Any], optional): Additional arguments for model 
+            initialization. Defaults to an empty dictionary.
+        **kwargs: Additional keyword arguments passed to the `Agent` constructor.
+
+    Returns:
+        Agent: An instance of the `Agent` class configured with the specified model.
+
+    Notes:
+        - The `pydantic-ai` package does not currently pass `model_args` to the 
+          inferred model in the constructor, but this behavior might change in 
+          the future.
+    """
     if model_name.startswith("azure:"):
-        # Note: the client is always async even if you call run_sync
         client = AsyncAzureOpenAI(**model_args)
         model = OpenAIModel(model_name[6:], openai_client=client)
         return Agent(model, **kwargs)
 
-    # Note: The constructor (in pydantic-ai package) does not pass any model args
-    # to the inferred model. This might change in the future.
     return Agent(model_name, **kwargs)

Diff for: pyproject.toml

@@ -4,7 +4,8 @@ version = "0.1.0"
 license = "Apache-2.0"
 description = "A tool to transform output from one agent to the input of another."
 readme = "README.md"
-maintainers = ["Reginaldo Costa (regcosta) <[email protected]>"]
+authors = ["Jeff Napper <[email protected]>", "Reginaldo Costa <[email protected]>"]
+maintainers = ["Jeff Napper <[email protected]>", "Reginaldo Costa <[email protected]>"]
 
 [tool.poetry.dependencies]
 python = "^3.12"

Diff for: tests/test_simple.py

@@ -4,7 +4,7 @@
 import pytest
 from openapi_pydantic import DataType, Schema
 
-from agntcy_iomapper import IOMapper, IOMapperInput, IOMapperOutput
+from agntcy_iomapper import AgentIOMapper, IOMapperInput, IOMapperOutput
 from agntcy_iomapper.base import ArgumentsDescription
 from utils import compare_outputs, compare_outputs_async
 
@@ -109,7 +109,7 @@
 )
 @pytest.mark.llm
 async def test_simple_mapping_async(llm_iomapper_config, jinja_env_async, input, expected_output):
-    llmIOMapper = IOMapper(llm_iomapper_config, jinja_env_async=jinja_env_async)
+    llmIOMapper = AgentIOMapper(llm_iomapper_config, jinja_env_async=jinja_env_async)
     output = await llmIOMapper.ainvoke(input)
     if isinstance(output.data, str):        
         equalp = await compare_outputs_async(llmIOMapper, output.data, expected_output.data)
@@ -126,7 +126,7 @@ async def test_simple_mapping_async(llm_iomapper_config, jinja_env_async, input,
 )
 @pytest.mark.llm
 def test_simple_mapping(llm_iomapper_config, jinja_env, input, expected_output):
-    llmIOMapper = IOMapper(llm_iomapper_config, jinja_env=jinja_env)
+    llmIOMapper = AgentIOMapper(llm_iomapper_config, jinja_env=jinja_env)
     output = llmIOMapper.invoke(input)
     if isinstance(output.data, str):        
         equalp = compare_outputs(llmIOMapper, output.data, expected_output.data)

Diff for: tests/utils.py

@@ -1,6 +1,6 @@
 # SPDX-FileCopyrightText: Copyright (c) 2025 Cisco and/or its affiliates.
 # SPDX-License-Identifier: Apache-2.0
-from agntcy_iomapper import IOMapper
+from agntcy_iomapper import AgentIOMapper
 from agntcy_iomapper.supported_agents import get_supported_agent
 import re
 
@@ -24,10 +24,9 @@
 Reasoning
 """
 
-async def compare_outputs_async(iomapper: IOMapper, text1: str, text2: str) -> bool:
+async def compare_outputs_async(iomapper: AgentIOMapper, text1: str, text2: str) -> bool:
     model_name = iomapper.config.default_model
     agent = get_supported_agent(
-        True, 
         model_name, 
         system_prompt=__COMPARE_SYSTEM_PROMPT, 
         model_args=iomapper.config.models[model_name],
@@ -38,10 +37,9 @@ async def compare_outputs_async(iomapper: IOMapper, text1: str, text2: str) -> b
     match = matches.group(1)
     return match is not None and match.startswith("t")
 
-def compare_outputs(iomapper: IOMapper, text1: str, text2: str) -> bool:
+def compare_outputs(iomapper: AgentIOMapper, text1: str, text2: str) -> bool:
     model_name = iomapper.config.default_model
     agent = get_supported_agent(
-        False, 
         model_name, 
         system_prompt=__COMPARE_SYSTEM_PROMPT, 
         model_args=iomapper.config.models[model_name],