waldiez 0.6.0__py3-none-any.whl → 0.6.1__py3-none-any.whl

waldiez/models/agents/rag_user_proxy/retrieve_config.py

@@ -1,10 +1,13 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
+
+# pylint: disable=invalid-name
+# pyright: reportArgumentType=false
+
 """RAG user agent retrieve config."""
 
 import os
 from pathlib import Path
-from typing import Optional, Union
 
 from pydantic import Field, model_validator
 from typing_extensions import Annotated, Literal, Self
@@ -89,7 +92,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
         updates existing documents and adds new ones. Default is True.
         Document id is used to determine if a document is new or existing.
         By default, the id is the hash value of the content.
-    model : Optional[str]
+    model : str | None
         The model to use for the retrieve chat. If key not provided, a default
         model gpt-4 will be used.
     chunk_token_size : Optional[int]
@@ -98,7 +101,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
     context_max_tokens : Optional[int]
         The context max token size for the retrieve chat. If key not provided,
         a default size max_tokens * 0.8 will be used.
-    chunk_mode : Optional[str]
+    chunk_mode : str | None
         The chunk mode for the retrieve chat. Possible values are 'multi_lines'
         and 'one_line'. If key not provided, a default mode multi_lines will be
         used.
@@ -108,22 +111,22 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
     use_custom_embedding: bool
         Whether to use custom embedding for the retrieve chat. Default is False.
         If True, the embedding_function should be provided.
-    embedding_function : Optional[str]
+    embedding_function : str | None
         The embedding function for creating the vector db. Default is None,
         SentenceTransformer with the given embedding_model will be used. If
         you want to use OpenAI, Cohere, HuggingFace or other embedding
         functions, you can pass it here, follow the examples in
         https://docs.trychroma.com/guides/embeddings.
-    customized_prompt : Optional[str]
+    customized_prompt : str | None
         The customized prompt for the retrieve chat. Default is None.
-    customized_answer_prefix : Optional[str]
+    customized_answer_prefix : str | None
         The customized answer prefix for the retrieve chat. Default is ''. If
         not '' and the customized_answer_prefix is not in the answer, Update
         Context will be triggered.
     update_context : bool
         If False, will not apply Update Context for interactive retrieval.
         Default is True.
-    collection_name : Optional[str]
+    collection_name : str | None
         The name of the collection. If key not provided, a default name
         autogen-docs will be used.
     get_or_create : bool
@@ -139,7 +142,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
         Whether to use custom token count function for the retrieve chat.
         Default is False. If True, the custom_token_count_function should be
         provided.
-    custom_token_count_function : Optional[str]
+    custom_token_count_function : str | None
         A custom function to count the number of tokens in a string. The
         function should take (text:str, model:str) as input and return the
         token_count(int). the retrieve_config['model'] will be passed in the
@@ -148,7 +151,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
     use_custom_text_split: bool
         Whether to use custom text split function for the retrieve chat. Default
         is False. If True, the custom_text_split_function should be provided.
-    custom_text_split_function : Optional[str]
+    custom_text_split_function : str | None
         A custom function to split a string into a list of strings. Default is
         None, will use the default function in autogen.retrieve_utils.
         split_text_to_chunks.
@@ -181,7 +184,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "the response."
             ),
         ),
-    ] = "default"
+    ]
     vector_db: Annotated[
         WaldiezRagUserProxyVectorDb,
         Field(
@@ -189,7 +192,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
             title="Vector DB",
             description="The vector db for the retrieve chat.",
         ),
-    ] = "chroma"
+    ]
     db_config: Annotated[
         WaldiezRagUserProxyVectorDbConfig,
         Field(
@@ -199,7 +202,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
         ),
     ]
     docs_path: Annotated[
-        Optional[Union[str, list[str]]],
+        str | list[str] | None,
         Field(
             default=None,
             title="Docs Path",
@@ -210,7 +213,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "only if the collection is already created."
             ),
         ),
-    ] = None
+    ]
     new_docs: Annotated[
         bool,
         Field(
@@ -224,9 +227,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "hash value of the content."
             ),
         ),
-    ] = True
+    ]
     model: Annotated[
-        Optional[str],
+        str | None,
         Field(
             default=None,
             title="Model",
@@ -235,9 +238,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "we check for models linked to the agent."
             ),
         ),
-    ] = None
+    ]
     chunk_token_size: Annotated[
-        Optional[int],
+        int | None,
         Field(
             default=None,
             title="Chunk Token Size",
@@ -247,9 +250,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "will be used."
             ),
         ),
-    ] = None
+    ]
     context_max_tokens: Annotated[
-        Optional[int],
+        int | None,
         Field(
             default=None,
             title="Context Max Tokens",
@@ -259,7 +262,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "will be used."
             ),
         ),
-    ] = None
+    ]
     chunk_mode: Annotated[
         WaldiezRagUserProxyChunkMode,
         Field(
@@ -271,7 +274,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "a default mode multi_lines will be used."
             ),
         ),
-    ] = "multi_lines"
+    ]
     must_break_at_empty_line: Annotated[
         bool,
         Field(
@@ -282,7 +285,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "If chunk_mode is 'one_line', this parameter will be ignored."
             ),
         ),
-    ] = True
+    ]
     use_custom_embedding: Annotated[
         bool,
         Field(
@@ -294,9 +297,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "provided."
             ),
         ),
-    ] = False
+    ]
     embedding_function: Annotated[
-        Optional[str],
+        str | None,
         Field(
             default=None,
             title="Embedding Function",
@@ -309,9 +312,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "https://docs.trychroma.com/guides/embeddings."
             ),
         ),
-    ] = None
+    ]
     customized_prompt: Annotated[
-        Optional[str],
+        str | None,
         Field(
             default=None,
             title="Customized Prompt",
@@ -319,9 +322,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "The customized prompt for the retrieve chat. Default is None."
             ),
         ),
-    ] = None
+    ]
     customized_answer_prefix: Annotated[
-        Optional[str],
+        str | None,
         Field(
             default="",
             title="Customized Answer Prefix",
@@ -331,7 +334,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "not in the answer, Update Context will be triggered."
             ),
         ),
-    ] = ""
+    ]
     update_context: Annotated[
         bool,
         Field(
@@ -342,7 +345,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "retrieval. Default is True."
             ),
         ),
-    ] = True
+    ]
     collection_name: Annotated[
         str,
         Field(
@@ -353,7 +356,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "a default name autogen-docs will be used."
             ),
         ),
-    ] = "autogen-docs"
+    ]
     get_or_create: Annotated[
         bool,
         Field(
@@ -363,7 +366,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "Whether to get the collection if it exists. Default is False."
             ),
         ),
-    ] = False
+    ]
     overwrite: Annotated[
         bool,
         Field(
@@ -381,7 +384,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 " otherwise it raise a ValueError."
             ),
         ),
-    ] = False
+    ]
     use_custom_token_count: Annotated[
         bool,
         Field(
@@ -393,9 +396,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "custom_token_count_function should be provided."
             ),
         ),
-    ] = False
+    ]
     custom_token_count_function: Annotated[
-        Optional[str],
+        str | None,
         Field(
             default=None,
             title="Custom Token Count Function",
@@ -408,7 +411,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "tiktoken, which may not be accurate for non-OpenAI models."
             ),
         ),
-    ] = None
+    ]
     use_custom_text_split: Annotated[
         bool,
         Field(
@@ -420,9 +423,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "custom_text_split_function should be provided."
             ),
         ),
-    ] = False
+    ]
     custom_text_split_function: Annotated[
-        Optional[str],
+        str | None,
         Field(
             default=None,
             title="Custom Text Split Function",
@@ -432,9 +435,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "autogen.retrieve_utils.split_text_to_chunks."
             ),
         ),
-    ] = None
+    ]
     custom_text_types: Annotated[
-        Optional[list[str]],
+        list[str] | None,
         Field(
             default=None,
             title="Custom Text Types",
@@ -446,7 +449,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "chunked regardless of their types."
             ),
         ),
-    ] = None
+    ]
     recursive: Annotated[
         bool,
         Field(
@@ -457,7 +460,7 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "Default is True."
             ),
         ),
-    ] = True
+    ]
     distance_threshold: Annotated[
         float,
         Field(
@@ -469,9 +472,9 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "Will be ignored if < 0. Default is -1."
             ),
         ),
-    ] = -1
+    ]
     n_results: Annotated[
-        Optional[int],
+        int | None,
         Field(
             default=None,
             title="Number of Results",
@@ -481,50 +484,50 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
                 "Use None or <1 to return all results."
             ),
         ),
-    ] = None
-    _embedding_function_string: Optional[str] = None
+    ]
+    _embedding_function_string: str | None = None
 
-    _token_count_function_string: Optional[str] = None
+    _token_count_function_string: str | None = None
 
-    _text_split_function_string: Optional[str] = None
+    _text_split_function_string: str | None = None
 
     @property
-    def embedding_function_string(self) -> Optional[str]:
+    def embedding_function_string(self) -> str | None:
         """Get the embedding function string.
 
         Returns
         -------
-        Optional[str]
+        str | None
             The embedding function string.
         """
         return self._embedding_function_string
 
     @property
-    def token_count_function_string(self) -> Optional[str]:
+    def token_count_function_string(self) -> str | None:
         """Get the token count function string.
 
         Returns
         -------
-        Optional[str]
+        str | None
             The token count function string.
         """
         return self._token_count_function_string
 
     @property
-    def text_split_function_string(self) -> Optional[str]:
+    def text_split_function_string(self) -> str | None:
         """Get the text split function string.
 
         Returns
         -------
-        Optional[str]
+        str | None
             The text split function string.
         """
         return self._text_split_function_string
 
     def get_custom_embedding_function(
         self,
-        name_prefix: Optional[str] = None,
-        name_suffix: Optional[str] = None,
+        name_prefix: str | None = None,
+        name_suffix: str | None = None,
     ) -> tuple[str, str]:
         """Generate the custom embedding function.
 
@@ -557,8 +560,8 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
 
     def get_custom_token_count_function(
         self,
-        name_prefix: Optional[str] = None,
-        name_suffix: Optional[str] = None,
+        name_prefix: str | None = None,
+        name_suffix: str | None = None,
     ) -> tuple[str, str]:
         """Generate the custom token count function.
 
@@ -591,8 +594,8 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
 
     def get_custom_text_split_function(
         self,
-        name_prefix: Optional[str] = None,
-        name_suffix: Optional[str] = None,
+        name_prefix: str | None = None,
+        name_suffix: str | None = None,
     ) -> tuple[str, str]:
         """Generate the custom text split function.
 
@@ -633,10 +636,11 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
         """
         if self.use_custom_embedding:
             if not self.embedding_function:
-                raise ValueError(
+                msg = (
                     "The embedding_function is required "
                     "if use_custom_embedding is True."
                 )
+                raise ValueError(msg)
             valid, error_or_content = check_function(
                 code_string=self.embedding_function,
                 function_name=CUSTOM_EMBEDDING_FUNCTION,
@@ -656,10 +660,11 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
         """
         if self.use_custom_token_count:
             if not self.custom_token_count_function:
-                raise ValueError(
+                msg = (
                     "The custom_token_count_function is required "
                     "if use_custom_token_count is True."
                 )
+                raise ValueError(msg)
             valid, error_or_content = check_function(
                 code_string=self.custom_token_count_function,
                 function_name=CUSTOM_TOKEN_COUNT_FUNCTION,
@@ -679,10 +684,11 @@ class WaldiezRagUserProxyRetrieveConfig(WaldiezBase):
         """
         if self.use_custom_text_split:
             if not self.custom_text_split_function:
-                raise ValueError(
+                msg = (
                     "The custom_text_split_function is required "
                     "if use_custom_text_split is True."
                 )
+                raise ValueError(msg)
             valid, error_or_content = check_function(
                 code_string=self.custom_text_split_function,
                 function_name=CUSTOM_TEXT_SPLIT_FUNCTION,

waldiez/models/agents/rag_user_proxy/vector_db_config.py

@@ -5,7 +5,7 @@
 """The vector db config for the RAG user agent."""
 
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any
 
 from pydantic import ConfigDict, Field, model_validator
 from pydantic.alias_generators import to_camel
@@ -26,14 +26,14 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
         Whether to use memory for the vector db (if `qdrant` is used).
     use_local_storage : bool
         Whether to use local storage for the db (if `qdrant` or `chroma` is used).
-    local_storage_path : Optional[str]
+    local_storage_path : str | None
         The path to the local storage for the vector db (if `qdrant` or `chroma` is used).
-    connection_url : Optional[str]
+    connection_url : str | None
         The connection url for the vector db.
-    wait_until_index_ready : Optional[float]
+    wait_until_index_ready : float | None
         Blocking call to wait until the database indexes are ready (if `mongodb` is used).
         None, the default, means no wait.
-    wait_until_document_ready : Optional[float]
+    wait_until_document_ready : float | None
         Blocking call to wait until the database documents are ready (if `mongodb` is used).
         None, the default, means no wait.
     metadata : Optional[dict[str, Any]]
@@ -50,13 +50,13 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
     )
 
     model: Annotated[
-        Optional[str],
+        str | None,
         Field(
             None,
             title="Model",
             description="The model to use for the vector db embeddings.",
         ),
-    ] = None
+    ]
     use_memory: Annotated[
         bool,
         Field(
@@ -66,7 +66,7 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
                 "Whether to use memory for the vector db (if qdrant is used)."
             ),
         ),
-    ] = True
+    ]
     use_local_storage: Annotated[
         bool,
         Field(
@@ -77,9 +77,9 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
                 "(if qdrant or chroma is used)."
             ),
         ),
-    ] = False
+    ]
     local_storage_path: Annotated[
-        Optional[str],
+        str | None,
         Field(
             None,
             title="Local Storage Path",
@@ -88,17 +88,17 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
                 "(if qdrant is used)."
             ),
         ),
-    ] = None
+    ]
     connection_url: Annotated[
-        Optional[str],
+        str | None,
         Field(
             None,
             title="Connection URL",
             description="The connection url for the vector db.",
         ),
-    ] = None
+    ]
     wait_until_index_ready: Annotated[
-        Optional[float],
+        float | None,
         Field(
             None,
             title="Wait Until Index Ready",
@@ -107,9 +107,9 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
                 "None, the default, means no wait."
             ),
         ),
-    ] = None
+    ]
     wait_until_document_ready: Annotated[
-        Optional[float],
+        float | None,
         Field(
             None,
             title="Wait Until Document Ready",
@@ -118,9 +118,9 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
                 "are ready. None, the default, means no wait."
             ),
         ),
-    ] = None
+    ]
     metadata: Annotated[
-        Optional[dict[str, Any]],
+        dict[str, Any] | None,
         Field(
             None,
             title="Metadata",
@@ -131,7 +131,7 @@ class WaldiezRagUserProxyVectorDbConfig(WaldiezBase):
                 '"hnsw:M": 32}'
             ),
         ),
-    ] = None
+    ]
 
     @model_validator(mode="after")
     def validate_vector_db_config(self) -> Self:

waldiez/models/agents/reasoning/reasoning_agent.py

@@ -1,5 +1,8 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
+
+# pyright: reportArgumentType=false,reportIncompatibleVariableOverride=false
+
 """Reasoning agent model."""
 
 from typing import Any
@@ -14,7 +17,7 @@ from .reasoning_agent_data import WaldiezReasoningAgentData
 class WaldiezReasoningAgent(WaldiezAgent):
     """Reasoning agent model."""
 
-    agent_type: Annotated[  # pyright: ignore
+    agent_type: Annotated[
         Literal["reasoning"],
         Field(
             "reasoning",
@@ -22,13 +25,13 @@ class WaldiezReasoningAgent(WaldiezAgent):
             description="The agent type in a graph: 'reasoning'",
             alias="agentType",
         ),
-    ] = "reasoning"
-    data: Annotated[  # pyright: ignore
+    ]
+    data: Annotated[
         WaldiezReasoningAgentData,
         Field(
             title="Data",
             description="The reasoning agent's data",
-            default_factory=WaldiezReasoningAgentData,  # pyright: ignore
+            default_factory=WaldiezReasoningAgentData,
         ),
     ]
 

waldiez/models/agents/reasoning/reasoning_agent_data.py

@@ -1,5 +1,6 @@
 # SPDX-License-Identifier: Apache-2.0.
 # Copyright (c) 2024 - 2025 Waldiez and contributors.
+# pyright: reportArgumentType=false
 """Reasoning agent data model."""
 
 from typing import Any
@@ -22,7 +23,7 @@ class WaldiezReasoningAgentData(WaldiezAgentData):
             description="The human input mode, Defaults to `NEVER`",
             alias="humanInputMode",
         ),
-    ] = "NEVER"
+    ]
     verbose: Annotated[
         bool,
         Field(
@@ -30,7 +31,7 @@ class WaldiezReasoningAgentData(WaldiezAgentData):
             title="Verbose",
             description="Whether to show intermediate steps",
         ),
-    ] = True
+    ]
     reason_config: Annotated[
         WaldiezReasoningAgentReasonConfig,
         Field(

waldiez/models/agents/reasoning/reasoning_agent_reason_config.py

@@ -43,7 +43,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Method",
             description="The search strategy to use.",
         ),
-    ] = "beam_search"
+    ]
     max_depth: Annotated[
         int,
         Field(
@@ -51,7 +51,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Maximum depth",
             description="Maximum depth of reasoning tree.",
         ),
-    ] = 3
+    ]
     forest_size: Annotated[
         int,
         Field(
@@ -59,7 +59,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Forest size",
             description="Number of independent trees to maintain.",
         ),
-    ] = 1
+    ]
     rating_scale: Annotated[
         int,
         Field(
@@ -67,7 +67,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Rating scale",
             description="Scale for grading responses, e.g. 1-10.",
         ),
-    ] = 10
+    ]
     beam_size: Annotated[
         int,
         Field(
@@ -75,7 +75,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Beam size",
             description="Number of parallel paths to maintain.",
         ),
-    ] = 3
+    ]
     answer_approach: Annotated[
         Literal["pool", "best"],
         Field(
@@ -83,7 +83,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Answer approach",
             description="How to select final answer.",
         ),
-    ] = "pool"
+    ]
     nsim: Annotated[
         int,
         Field(
@@ -91,7 +91,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Number of simulations",
             description="Number of simulations to run.",
         ),
-    ] = 3
+    ]
     exploration_constant: Annotated[
         float,
         Field(
@@ -99,7 +99,7 @@ class WaldiezReasoningAgentReasonConfig(WaldiezBase):
             title="Exploration constant",
             description="UCT exploration parameter.",
         ),
-    ] = 1.41
+    ]
 
 
 # reason_config (dict): Configuration for the reasoning method.