aixplain
diff --git a/‎.github/workflows/docs.yaml‎
Lines changed: 45 additions & 0 deletions b/‎.github/workflows/docs.yaml‎
Lines changed: 45 additions & 0 deletions
diff --git a/‎aixplain/factories/agent_factory/__init__.py‎
Lines changed: 15 additions & 8 deletions b/‎aixplain/factories/agent_factory/__init__.py‎
Lines changed: 15 additions & 8 deletions
diff --git a/‎aixplain/factories/team_agent_factory/__init__.py‎
Lines changed: 38 additions & 7 deletions b/‎aixplain/factories/team_agent_factory/__init__.py‎
Lines changed: 38 additions & 7 deletions
diff --git a/‎aixplain/factories/team_agent_factory/utils.py‎
Lines changed: 3 additions & 2 deletions b/‎aixplain/factories/team_agent_factory/utils.py‎
Lines changed: 3 additions & 2 deletions
@@ -0,0 +1,45 @@
+name: Generate API docs
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          pip install pydoc-markdown
+
+      - name: Run pydoc-markdown
+        run: |
+          pydoc-markdown pydoc-markdown.yml
+          
+      - name: Create Pull Request if docs changed
+        uses: peter-evans/create-pull-request@v7
+        with:
+          branch: docs/regenerate-api-docs
+          commit-message: "chore(docs): regenerate API docs"
+          title: "chore(docs): regenerate API docs"
+          body: |
+            This PR was automatically generated by the workflow to regenerate the API documentation.
+          add-paths: |
+            docs/api-reference/python/**
+          delete-branch: true
@@ -75,7 +75,6 @@ def create(
         description: Text,
         instructions: Optional[Text] = None,
         llm: Optional[Union[LLM, Text]] = None,
-        llm_id: Optional[Text] = None,
         tools: Optional[List[Union[Tool, Model]]] = None,
         api_key: Text = config.TEAM_API_KEY,
         supplier: Union[Dict, Text, Supplier, int] = "aiXplain",
@@ -84,6 +83,7 @@ def create(
         workflow_tasks: Optional[List[WorkflowTask]] = None,
         output_format: Optional[OutputFormat] = None,
         expected_output: Optional[Union[BaseModel, Text, dict]] = None,
+        **kwargs,
     ) -> Agent:
         """Create a new agent in the platform.
 
@@ -97,7 +97,6 @@ def create(
             description (Text): description of the agent instructions.
             instructions (Text): instructions of the agent.
             llm (Optional[Union[LLM, Text]], optional): LLM instance to use as an object or as an ID.
-            llm_id (Optional[Text], optional): ID of LLM to use if no LLM instance provided. Defaults to None.
             tools (List[Union[Tool, Model]], optional): list of tool for the agent. Defaults to [].
             api_key (Text, optional): team/user API key. Defaults to config.TEAM_API_KEY.
             supplier (Union[Dict, Text, Supplier, int], optional): owner of the agent. Defaults to "aiXplain".
@@ -106,14 +105,24 @@ def create(
             workflow_tasks (List[WorkflowTask], optional): list of tasks for the agent. Defaults to [].
             output_format (OutputFormat, optional): default output format for agent responses. Defaults to OutputFormat.TEXT.
             expected_output (Union[BaseModel, Text, dict], optional): expected output. Defaults to None.
-
+            **kwargs: Additional keyword arguments.
         Returns:
             Agent: created Agent
         """
         tools = [] if tools is None else list(tools)
         workflow_tasks = [] if workflow_tasks is None else list(workflow_tasks)
         from aixplain.utils.llm_utils import get_llm_instance
 
+        # Extract llm_id from kwargs if present (deprecated parameter)
+        llm_id = kwargs.get("llm_id", None)
+        if llm_id is not None:
+            warnings.warn(
+                "The 'llm_id' parameter is deprecated and will be removed in a future version. "
+                "Use the 'llm' parameter instead by passing the LLM ID or LLM instance directly.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
         if llm is None and llm_id is not None:
             llm = get_llm_instance(llm_id, api_key=api_key, use_cache=True)
         elif llm is None:
@@ -126,9 +135,7 @@ def create(
             ), "'expected_output' must be a Pydantic BaseModel or a JSON object when 'output_format' is JSON."
 
         warnings.warn(
-            "Use `llm` to define the large language model (aixplain.modules.model.llm_model.LLM) to be used as agent. "
-            "Use `llm_id` to provide the model ID of the large language model to be used as agent. "
-            "Note: In upcoming releases, `llm` will become a required parameter.",
+            "Deprecating 'llm_id', use `llm` to define the large language model in agents.",
             UserWarning,
         )
         from aixplain.factories.agent_factory.utils import (
@@ -159,8 +166,8 @@ def create(
         payload = {
             "name": name,
             "assets": [build_tool_payload(tool) for tool in tools],
-            "description": to_literal_text(description),
-            "instructions": to_literal_text(instructions) if instructions is not None else description,
+            "description": description,
+            "instructions": instructions if instructions is not None else description,
             "supplier": supplier,
             "version": version,
             "llmId": llm_id,
 
@@ -23,6 +23,7 @@
 
 import json
 import logging
+import warnings
 from typing import Dict, List, Optional, Text, Union
 from urllib.parse import urljoin
 
@@ -54,15 +55,12 @@ def create(
         cls,
         name: Text,
         agents: List[Union[Text, Agent]],
-        llm_id: Text = "669a63646eb56306647e1091",
         llm: Optional[Union[LLM, Text]] = None,
         supervisor_llm: Optional[Union[LLM, Text]] = None,
-        mentalist_llm: Optional[Union[LLM, Text]] = None,
         description: Text = "",
         api_key: Text = config.TEAM_API_KEY,
         supplier: Union[Dict, Text, Supplier, int] = "aiXplain",
         version: Optional[Text] = None,
-        use_mentalist: bool = True,
         inspectors: List[Inspector] = [],
         inspector_targets: List[Union[InspectorTarget, Text]] = [InspectorTarget.STEPS],
         instructions: Optional[Text] = None,
@@ -75,24 +73,57 @@ def create(
         Args:
             name: The name of the team agent.
             agents: A list of agents to be added to the team.
-            llm_id: The ID of the LLM to be used for the team agent.
             llm (Optional[Union[LLM, Text]], optional): The LLM to be used for the team agent.
             supervisor_llm (Optional[Union[LLM, Text]], optional): Main supervisor LLM. Defaults to None.
-            mentalist_llm (Optional[Union[LLM, Text]], optional): LLM for planning. Defaults to None.
             description: The description of the team agent to be displayed in the aiXplain platform.
             api_key: The API key to be used for the team agent.
             supplier: The supplier of the team agent.
             version: The version of the team agent.
-            use_mentalist: Whether to use the mentalist agent.
             inspectors: A list of inspectors to be added to the team.
             inspector_targets: Which stages to be inspected during an execution of the team agent. (steps, output)
-            use_mentalist_and_inspector: Whether to use the mentalist and inspector agents. (legacy)
             instructions: The instructions to guide the team agent (i.e. appended in the prompt of the team agent).
             output_format: The output format to be used for the team agent.
             expected_output: The expected output to be used for the team agent.
         Returns:
             A new team agent instance.
+            
+        Deprecated Args:
+            llm_id: DEPRECATED. Use 'llm' parameter instead. The ID of the LLM to be used for the team agent.
+            mentalist_llm: DEPRECATED. LLM for planning.
+            use_mentalist: DEPRECATED. Whether to use the mentalist agent.
         """
+        # Handle deprecated parameters from kwargs
+        if "llm_id" in kwargs:
+            llm_id = kwargs.pop("llm_id")
+            warnings.warn(
+                "Parameter 'llm_id' is deprecated and will be removed in a future version. "
+                "Please use 'llm' parameter instead.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        else:
+            llm_id = "669a63646eb56306647e1091"
+        
+        if "mentalist_llm" in kwargs:
+            mentalist_llm = kwargs.pop("mentalist_llm")
+            warnings.warn(
+                "Parameter 'mentalist_llm' is deprecated and will be removed in a future version.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        else:
+            mentalist_llm = None
+        
+        if "use_mentalist" in kwargs:
+            use_mentalist = kwargs.pop("use_mentalist")
+            warnings.warn(
+                "Parameter 'use_mentalist' is deprecated and will be removed in a future version.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+        else:
+            use_mentalist = True
+        
         # legacy params
         if "use_mentalist_and_inspector" in kwargs:
             logging.warning(
 
@@ -173,7 +173,8 @@ def process_response(model_response: ModelResponse, input_content: str) -> Inspe
                 name="QualityCheckInspector",
                 model_id=resolved_model_id,
                 model_params={"prompt": "Analyze content to ensure correctness of response"},
-                policy=process_response
+                policy=process_response,
+                auto=InspectorAuto.ALIGNMENT
             )
 
             inspectors = [default_inspector] + inspectors
@@ -395,6 +396,6 @@ def build_team_agent_from_yaml(yaml_code: str, llm_id: str, api_key: str, team_i
         agents=agent_objs,
         llm=llm,
         api_key=api_key,
-        use_mentalist=True,
         inspectors=[],
+        use_mentalist=True,  # Deprecated parameter
     )