vectara-agentic 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

vectara_agentic/_callback.py

@@ -11,13 +11,15 @@ from .types import AgentStatusType
 
 
 class AgentCallbackHandler(BaseCallbackHandler):
-    """Callback handler to track agent status
+    """
+    Callback handler to track agent status
 
     This handler simply keeps track of event starts/ends, separated by event types.
     You can use this callback handler to keep track of agent progress.
 
     Args:
-    - fn: callable function agent will call back to report on agent progress
+    
+        fn: callable function agent will call back to report on agent progress
     """
 
     def __init__(self, fn: Callable = None) -> None:

vectara_agentic/agent.py

@@ -1,4 +1,4 @@
-""""
+"""
 This module contains the Agent class for handling different types of agents and their interactions.
 """
 
@@ -26,9 +26,11 @@ load_dotenv(override=True)
 
 
 def get_prompt(prompt_template: str, topic: str, custom_instructions: str):
-    """Generate a prompt by replacing placeholders with topic and date.
+    """
+    Generate a prompt by replacing placeholders with topic and date.
 
     Args:
+
         prompt_template (str): The template for the prompt.
         topic (str): The topic to be included in the prompt.
 
@@ -50,7 +52,9 @@ def retry_if_exception(exception):
 
 
 class Agent:
-    """Agent class for handling different types of agents and their interactions."""
+    """
+    Agent class for handling different types of agents and their interactions.
+    """
 
     def __init__(
         self,
@@ -59,13 +63,15 @@ class Agent:
         custom_instructions: str = "",
         update_func: Optional[Callable[[AgentStatusType, str], None]] = None,
     ):
-        """Initialize the agent with the specified type, tools, topic, and system message.
+        """
+        Initialize the agent with the specified type, tools, topic, and system message.
 
         Args:
-        - tools (list[FunctionTool]): A list of tools to be used by the agent.
-        - topic (str, optional): The topic for the agent. Defaults to 'general'.
-        - custom_instructions (str, optional): custom instructions for the agent. Defaults to ''.
-        - update_func (Callable): a callback function the code calls on any agent updates
+
+            tools (list[FunctionTool]): A list of tools to be used by the agent.
+            topic (str, optional): The topic for the agent. Defaults to 'general'.
+            custom_instructions (str, optional): custom instructions for the agent. Defaults to ''.
+            update_func (Callable): a callback function the code calls on any agent updates.
         """
         self.agent_type = AgentType(os.getenv("VECTARA_AGENTIC_AGENT_TYPE", "OPENAI"))
         self.tools = tools
@@ -110,21 +116,24 @@ class Agent:
         custom_instructions: str = "",
         update_func: Optional[Callable[[AgentStatusType, str], None]] = None,
     ) -> "Agent":
-        """Create an agent from tools, agent type, and language model.
+        """
+        Create an agent from tools, agent type, and language model.
 
         Args:
-        - tools (list[FunctionTool]): A list of tools to be used by the agent.
-        - topic (str, optional): The topic for the agent. Defaults to 'general'.
-        - custom_instructions (str, optional): custom instructions for the agent. Defaults to ''.
-        - llm (LLM): The language model to be used by the agent.
+
+            tools (list[FunctionTool]): A list of tools to be used by the agent.
+            topic (str, optional): The topic for the agent. Defaults to 'general'.
+            custom_instructions (str, optional): custom instructions for the agent. Defaults to ''.
+            llm (LLM): The language model to be used by the agent.
 
         Returns:
-        - Agent: An instance of the Agent class.
+            Agent: An instance of the Agent class.
         """
         return cls(tools, topic, custom_instructions, update_func)
 
     def report(self) -> str:
-        """Get a report from the agent.
+        """
+        Get a report from the agent.
 
         Returns:
             str: The report from the agent.
@@ -144,7 +153,8 @@ class Agent:
         wait_fixed=2000,
     )
     def chat(self, prompt: str) -> str:
-        """Interact with the agent using a chat prompt.
+        """
+        Interact with the agent using a chat prompt.
 
         Args:
             prompt (str): The chat prompt.

vectara_agentic/tools.py

@@ -51,7 +51,7 @@ LI_packages = {
 
 class VectaraTool:
     """
-    A wrapper of FunctionTOol class for Vectara tools, adding the tool_type attribute.
+    A wrapper of FunctionTool class for Vectara tools, adding the tool_type attribute.
     """
 
     def __init__(self, function_tool: FunctionTool, tool_type: ToolType) -> None:
@@ -99,21 +99,25 @@ class VectaraToolFactory:
         """
         Creates a RAG (Retrieve and Generate) tool.
 
-        Parameters:
-        - tool_name (str): The name of the tool.
-        - tool_description (str): The description of the tool.
-        - tool_args_schema (BaseModel): The schema for the tool arguments.
-        - vectara_summarizer (str): The Vectara summarizer to use.
-        - summary_num_results (int): The number of summary results.
-        - summary_response_lang (str): The response language for the summary.
-        - n_sentences_before (int): Number of sentences before the summary.
-        - n_sentences_after (int): Number of sentences after the summary.
-        - lambda_val (float): Lambda value for the Vectara query.
-        - reranker (str): The reranker mode.
-        - rerank_k (int): Number of top-k documents for reranking.
-        - mmr_diversity_bias (float): MMR diversity bias.
-        - include_citations (bool): Whether to include citations in the response.
-        If True, uses MARKDOWN vectara citations that requires the Vectara scale plan.
+        Args:
+
+            tool_name (str): The name of the tool.
+            tool_description (str): The description of the tool.
+            tool_args_schema (BaseModel): The schema for the tool arguments.
+            vectara_summarizer (str): The Vectara summarizer to use.
+            summary_num_results (int): The number of summary results.
+            summary_response_lang (str): The response language for the summary.
+            n_sentences_before (int): Number of sentences before the summary.
+            n_sentences_after (int): Number of sentences after the summary.
+            lambda_val (float): Lambda value for the Vectara query.
+            reranker (str): The reranker mode.
+            rerank_k (int): Number of top-k documents for reranking.
+            mmr_diversity_bias (float): MMR diversity bias.
+            include_citations (bool): Whether to include citations in the response.
+                If True, uses MARKDOWN vectara citations that requires the Vectara scale plan.
+
+        Returns:
+            VectaraTool: A VectaraTool object.
         """
         vectara = VectaraIndex(
             vectara_api_key=self.vectara_api_key,
@@ -133,7 +137,9 @@ class VectaraToolFactory:
 
         # Dynamically generate the RAG function
         def rag_function(*args, **kwargs) -> dict[str, Any]:
-            """Dynamically generated function for RAG query with Vectara"""
+            """
+            Dynamically generated function for RAG query with Vectara.
+            """
             # Convert args to kwargs using the function signature
             sig = inspect.signature(rag_function)
             bound_args = sig.bind_partial(*args, **kwargs)
@@ -249,7 +255,7 @@ class VectaraToolFactory:
 
 class ToolsFactory:
     """
-    A factory class for creating agent tools
+    A factory class for creating agent tools.
     """
 
     def create_tool(
@@ -258,9 +264,12 @@ class ToolsFactory:
         """
         Create a tool from a function.
 
-        Parameters:
-        - function (Callable): a function to convert into a tool.
-        - tool_type (ToolType): the type of tool.
+        Args:
+            function (Callable): a function to convert into a tool.
+            tool_type (ToolType): the type of tool.
+
+        Returns:
+            List[FunctionTool]: A list of FunctionTool objects.
         """
         return VectaraTool(FunctionTool.from_defaults(function), tool_type)
 
@@ -275,10 +284,13 @@ class ToolsFactory:
         Get a tool from the llama_index hub.
 
         Parameters:
-        - tool_package_name (str): The name of the tool package.
-        - tool_spec_name (str): The name of the tool spec.
-        - tool_name_prefix (str): The prefix to add to the tool names (added to every tool in the spec).
-        - kwargs (dict): The keyword arguments to pass to the tool constructor (see Hub for tool specific details).
+            tool_package_name (str): The name of the tool package.
+            tool_spec_name (str): The name of the tool spec.
+            tool_name_prefix (str): The prefix to add to the tool names (added to every tool in the spec).
+            kwargs (dict): The keyword arguments to pass to the tool constructor (see Hub for tool specific details).
+
+        Returns:
+            list[FunctionTool]: A list of FunctionTool objects.
         """
         # Dynamically install and import the module
         if tool_package_name not in LI_packages.keys():
@@ -341,7 +353,7 @@ class ToolsFactory:
             text: str = Field(description="the original text."),
         ) -> str:
             """
-            critique the legal document.
+            Critique the legal document.
             """
             return critique_text(
                 text,
@@ -369,18 +381,23 @@ class ToolsFactory:
         dbname: str = "postgres",
     ) -> List[FunctionTool]:
         """
-        returns a list of database tools.
+        Returns a list of database tools.
+
         Args:
-        - tool_name_prefix (str, optional): The prefix to add to the tool names. Defaults to "".
-        - content_description (str, optional): The content description for the database. Defaults to None.
-        - sql_database (SQLDatabase, optional): The SQLDatabase object. Defaults to None.
-        - scheme (str, optional): The database scheme. Defaults to None.
-        - host (str, optional): The database host. Defaults to "localhost".
-        - port (str, optional): The database port. Defaults to "5432".
-        - user (str, optional): The database user. Defaults to "postgres".
-        - password (str, optional): The database password. Defaults to "Password".
-        - dbname (str, optional): The database name. Defaults to "postgres".
-        You must specify either the sql_database object or the scheme, host, port, user, password, and dbname.
+
+            tool_name_prefix (str, optional): The prefix to add to the tool names. Defaults to "".
+            content_description (str, optional): The content description for the database. Defaults to None.
+            sql_database (SQLDatabase, optional): The SQLDatabase object. Defaults to None.
+            scheme (str, optional): The database scheme. Defaults to None.
+            host (str, optional): The database host. Defaults to "localhost".
+            port (str, optional): The database port. Defaults to "5432".
+            user (str, optional): The database user. Defaults to "postgres".
+            password (str, optional): The database password. Defaults to "Password".
+            dbname (str, optional): The database name. Defaults to "postgres".
+               You must specify either the sql_database object or the scheme, host, port, user, password, and dbname.
+
+        Returns:
+            List[FunctionTool]: A list of FunctionTool objects.
         """
         if sql_database:
             tools = self.get_llama_index_tools(

vectara_agentic/tools_catalog.py

@@ -22,7 +22,6 @@ get_headers = {
 #
 # Standard Tools
 #
-
 def summarize_text(
     text: str = Field(description="the original text."),
     expertise: str = Field(
@@ -30,9 +29,16 @@ def summarize_text(
     ),
 ) -> str:
     """
-    This is a helper tool. It does not provide new information.
-    Use this tool to summarize text with no more than summary_max_length 
-    characters.
+    This is a helper tool. 
+    Use this tool to summarize text using a given expertise
+    with no more than summary_max_length characters.
+
+    Args:
+        text (str): The original text.
+        expertise (str): The expertise to apply to the summarization.
+    
+    Returns:
+        str: The summarized text.
     """
     expertise = "general" if len(expertise) < 3 else expertise.lower()
     prompt = f"As an expert in {expertise}, summarize the provided text"
@@ -50,9 +56,16 @@ def rephrase_text(
     ),
 ) -> str:
     """
-    This is a helper tool. It does not provide new information.
+    This is a helper tool. 
     Use this tool to rephrase the text according to the provided instructions.
     For example, instructions could be "as a 5 year old would say it."
+
+    Args:
+        text (str): The original text.
+        instructions (str): The specific instructions for how to rephrase the text.
+
+    Returns:    
+        str: The rephrased text.
     """
     prompt = f"""
     Rephrase the provided text according to the following instructions: {instructions}.
@@ -75,8 +88,16 @@ def critique_text(
     ),
 ) -> str:
     """
-    This is a helper tool. It does not provide new information.
+    This is a helper tool. 
     Critique the text from the specified point of view.
+
+    Args:
+        text (str): The original text.
+        role (str): The role of the person providing critique.
+        point_of_view (str): The point of view with which to provide critique.
+
+    Returns:
+        str: The critique of the text.
     """
     if role:
         prompt = f"As a {role}, critique the provided text from the point of view of {point_of_view}."
@@ -94,12 +115,16 @@ def critique_text(
 #
 # Guardrails tools
 #
-
-
 def guardrails_no_politics(text: str = Field(description="the original text.")) -> str:
     """
     A guardrails tool.
-    Can be used to rephrase text so that it does not have political content.
+    Given the input text, rephrases the text to ensure that the response avoids any specific political content.
+
+    Args:
+        text (str): The original text.
+
+    Returns:
+        str: The rephrased text.
     """
     return rephrase_text(text, "avoid any specific political content.")
 
@@ -107,6 +132,12 @@ def guardrails_no_politics(text: str = Field(description="the original text."))
 def guardrails_be_polite(text: str = Field(description="the original text.")) -> str:
     """
     A guardrails tool.
-    Can be used to rephrase the text so that the response is in a polite tone.
+    Given the input text, rephrases the text to ensure that the response is polite.
+
+    Args:
+        text (str): The original text.
+
+    Returns:
+        str: The rephrased text.
     """
     return rephrase_text(text, "Ensure the response is super polite.")

{vectara_agentic-0.1.0.dist-info → vectara_agentic-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: vectara-agentic
-Version: 0.1.0
+Name: vectara_agentic
+Version: 0.1.2
 Summary: A Python package for creating AI Assistants and AI Agents with Vectara
 Home-page: https://github.com/vectara/py-vectara-agentic
 Author: Ofer Mendelevitch
@@ -11,26 +11,27 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: llama-index (==0.10.64)
-Requires-Dist: llama-index-indices-managed-vectara (==0.1.7)
-Requires-Dist: llama-index-agent-llm-compiler (==0.1.0)
-Requires-Dist: llama-index-agent-openai (==0.2.9)
-Requires-Dist: llama-index-llms-openai (==0.1.29)
-Requires-Dist: llama-index-llms-anthropic (==0.1.17)
-Requires-Dist: llama-index-llms-together (==0.1.3)
-Requires-Dist: llama-index-llms-groq (==0.1.4)
-Requires-Dist: llama-index-tools-yahoo-finance (==0.1.1)
-Requires-Dist: llama-index-tools-arxiv (==0.1.3)
-Requires-Dist: llama-index-tools-database (==0.1.3)
-Requires-Dist: llama-index-tools-google (==0.1.6)
-Requires-Dist: llama-index-tools-tavily-research (==0.1.3)
-Requires-Dist: llama-index-llms-fireworks (==0.1.8)
-Requires-Dist: pydantic (==1.10.17)
-Requires-Dist: retrying (==1.3.4)
-Requires-Dist: mypy (==1.11.0)
-Requires-Dist: pylint (==3.2.6)
-Requires-Dist: flake8 (==7.1.0)
-Requires-Dist: pymongo (==4.6.1)
+Requires-Dist: llama-index ==0.10.64
+Requires-Dist: llama-index-indices-managed-vectara ==0.1.7
+Requires-Dist: llama-index-agent-llm-compiler ==0.1.0
+Requires-Dist: llama-index-agent-openai ==0.2.9
+Requires-Dist: llama-index-llms-openai ==0.1.29
+Requires-Dist: llama-index-llms-anthropic ==0.1.17
+Requires-Dist: llama-index-llms-together ==0.1.3
+Requires-Dist: llama-index-llms-groq ==0.1.4
+Requires-Dist: llama-index-tools-yahoo-finance ==0.1.1
+Requires-Dist: llama-index-tools-arxiv ==0.1.3
+Requires-Dist: llama-index-tools-database ==0.1.3
+Requires-Dist: llama-index-tools-google ==0.1.6
+Requires-Dist: llama-index-tools-tavily-research ==0.1.3
+Requires-Dist: llama-index-llms-fireworks ==0.1.8
+Requires-Dist: pydantic ==1.10.17
+Requires-Dist: retrying ==1.3.4
+Requires-Dist: mypy ==1.11.0
+Requires-Dist: pylint ==3.2.6
+Requires-Dist: flake8 ==7.1.0
+Requires-Dist: pymongo ==4.6.1
+Requires-Dist: python-dotenv ==1.0.1
 
 # vectara-agentic
 
@@ -138,15 +139,12 @@ mult_tool = ToolsFactory().create_tool(mult_func)
 
 ```python
 agent = Agent(
-    agent_type = agent_type,
     tools = tools,
     topic = topic_of_expertise
     custom_instructions = financial_bot_instructions,
     update_func = update_func
 )
 ```
-
-- `agent_type` is one of `AgentType.REACT` or `AgentTypeOpenAI`
 - `tools` is the list of tools you want to provide to the agent
 - `topic` is a string that defines the expertise you want the agent to specialize in.
 - `custom_instructions` is an optional string that defines special instructions to the agent
@@ -154,6 +152,8 @@ agent = Agent(
   The inputs to this function you provide are `status_type` of type AgentStatusType and 
   `msg` which is a string.
 
+Note that the Agent type (`OPENAI` or `REACT`) is defined as an environment variables `VECTARA_AGENTIC_AGENT_TYPE`.
+
 For example, for a financial agent we can use:
 
 ```python

vectara_agentic-0.1.2.dist-info/RECORD

@@ -0,0 +1,13 @@
+vectara_agentic/__init__.py,sha256=CRKtLZdGj_s9ynKBOVkT_Qqhm7WwxGpZGzyeHZG-1aI,432
+vectara_agentic/_callback.py,sha256=3phD394HQICg5BWpMTE3a7DUUVl5NWVIkdgCDytS0gc,3564
+vectara_agentic/_prompts.py,sha256=u8HqpfV42fdBUf3ZNjDm5kPJXNncLSTWU-4Js7-ipEA,4152
+vectara_agentic/agent.py,sha256=PXKsFe3IKHkypkErzQZclxgRVI_d_kRwy1KsBTjIhKc,5846
+vectara_agentic/tools.py,sha256=79dZX2BBJeML9KglFlXiGxzfyUaoyX63DLwuexAQ8NE,16250
+vectara_agentic/tools_catalog.py,sha256=Wc-j7p6LG4420KmM8SUKFtgI2b1IwryXqbALGDEvmAI,4266
+vectara_agentic/types.py,sha256=CFjjxaYhflsFDsE2ZNrZgWqman_r2HJQ-nOvuUiX3IY,804
+vectara_agentic/utils.py,sha256=8YqxRqgm6qbjoH-LotpeHRjKWRejn9VJoqM5BbsD0NU,2408
+vectara_agentic-0.1.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+vectara_agentic-0.1.2.dist-info/METADATA,sha256=asCd6Xyvvro5QwLslt9rk-2i6DlXXnnliFH1oY33LOk,10183
+vectara_agentic-0.1.2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
+vectara_agentic-0.1.2.dist-info/top_level.txt,sha256=qT7JB9Xz7byehzlPd_rY4WWEAvPMhs63WMWgPsFthxU,16
+vectara_agentic-0.1.2.dist-info/RECORD,,

{vectara_agentic-0.1.0.dist-info → vectara_agentic-0.1.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.40.0)
+Generator: setuptools (72.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

vectara_agentic-0.1.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-vectara_agentic/__init__.py,sha256=CRKtLZdGj_s9ynKBOVkT_Qqhm7WwxGpZGzyeHZG-1aI,432
-vectara_agentic/_callback.py,sha256=JQbkAnbhLOreTNkWXXhqr6aery-HxjXhlYUy9EotIC8,3552
-vectara_agentic/_prompts.py,sha256=u8HqpfV42fdBUf3ZNjDm5kPJXNncLSTWU-4Js7-ipEA,4152
-vectara_agentic/agent.py,sha256=CQNvRa9KmBfBMDIjB7NrXfvKuW0bqXEI01JXEZnjvAs,5774
-vectara_agentic/tools.py,sha256=22zFbW6MQd5M92AjD40raFY0266Ytc1BchXNhDjzcVw,15849
-vectara_agentic/tools_catalog.py,sha256=b5EYKs65v9ykZAPiSDzY3o6t5FMyt088Li0_FSCdx0Y,3518
-vectara_agentic/types.py,sha256=CFjjxaYhflsFDsE2ZNrZgWqman_r2HJQ-nOvuUiX3IY,804
-vectara_agentic/utils.py,sha256=8YqxRqgm6qbjoH-LotpeHRjKWRejn9VJoqM5BbsD0NU,2408
-vectara_agentic-0.1.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-vectara_agentic-0.1.0.dist-info/METADATA,sha256=4WiXFug8-GeNBjIX_OdifrlPg1Tasfh4xEzRIG2X7jA,10163
-vectara_agentic-0.1.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-vectara_agentic-0.1.0.dist-info/top_level.txt,sha256=qT7JB9Xz7byehzlPd_rY4WWEAvPMhs63WMWgPsFthxU,16
-vectara_agentic-0.1.0.dist-info/RECORD,,