PyPI - vectara-agentic - Versions diffs - 0.1.12__tar.gz → 0.1.14__tar.gz - Mend

vectara-agentic 0.1.12tar.gz → 0.1.14tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of vectara-agentic might be problematic. Click here for more details.

Files changed (24) hide show

{vectara_agentic-0.1.12/vectara_agentic.egg-info → vectara_agentic-0.1.14}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vectara_agentic
-Version: 0.1.12
+Version: 0.1.14
 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
@@ -32,8 +32,11 @@ Requires-Dist: llama-index-tools-arxiv==0.2.0
 Requires-Dist: llama-index-tools-database==0.2.0
 Requires-Dist: llama-index-tools-google==0.2.0
 Requires-Dist: llama-index-tools-tavily_research==0.2.0
+Requires-Dist: tavily-python==0.5.0
+Requires-Dist: yahoo-finance==1.4.0
+Requires-Dist: llama-index-tools-neo4j==0.2.0
 Requires-Dist: openinference-instrumentation-llama-index==3.0.2
-Requires-Dist: opentelemetry-proto==1.16.0
+Requires-Dist: arize-phoenix==4.35.1
 Requires-Dist: arize-phoenix-otel==0.5.1
 Requires-Dist: tokenizers>=0.20
 Requires-Dist: pydantic==2.9.2
@@ -43,47 +46,57 @@ Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: tiktoken==0.7.0
 Requires-Dist: dill==0.3.8
-# vectara-agentic
+# <img src=".github/assets/Vectara-logo.png" alt="Vectara Logo" width="30" height="30" style="vertical-align: middle;"> vectara-agentic
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/vectara/py-vectara-agentic/graphs/commit-activity)
-[![Twitter](https://img.shields.io/twitter/follow/vectara.svg?style=social&label=Follow%20%40Vectara)](https://twitter.com/vectara)
-[![Discord](https://img.shields.io/badge/Discord-Join%20Us-blue?style=social&logo=discord)](https://discord.com/invite/GFb8gMz6UH)
+<p align="center">
+  <a href="https://vectara.github.io/vectara-agentic-docs">Documentation</a> ·
+  <a href="#examples">Examples</a> ·
+  <a href="https://discord.gg/S9dwgCNEFs">Discord</a>
+</p>
-## Overview
+<p align="center">
+  <a href="https://opensource.org/licenses/Apache-2.0">
+    <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License">
+  </a>
+  <a href="https://github.com/vectara/py-vectara-agentic/graphs/commit-activity">
+    <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="Maintained">
+  </a>
+  <a href="https://twitter.com/vectara">
+    <img src="https://img.shields.io/twitter/follow/vectara.svg?style=social&label=Follow%20%40Vectara" alt="Twitter">
+  </a>
+</p>
+## ✨ Overview
 `vectara-agentic` is a Python library for developing powerful AI assistants using Vectara and Agentic-RAG. It leverages the LlamaIndex Agent framework, customized for use with Vectara.
-### Key Features
+###  Key Features
-- Supports `ReAct` and `OpenAIAgent` agent types.
+- Supports `ReAct`, `OpenAIAgent` and `LLMCompiler` agent types.
 - Includes pre-built tools for various domains (e.g., finance, legal).
 - Enables easy creation of custom AI assistants and agents.
-## Important Links
-- Documentation: [https://vectara.github.io/vectara-agentic-docs/](https://vectara.github.io/vectara-agentic-docs/)
-## Prerequisites
+###  Prerequisites
 - [Vectara account](https://console.vectara.com/signup/?utm_source=github&utm_medium=code&utm_term=DevRel&utm_content=vectara-agentic&utm_campaign=github-code-DevRel-vectara-agentic)
 - A Vectara corpus with an [API key](https://docs.vectara.com/docs/api-keys)
 - [Python 3.10 or higher](https://www.python.org/downloads/)
-- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Fireworks AI, Cohere, GEMINI or GROQ)
+- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Fireworks AI, Cohere, GEMINI or GROQ, if you choose to use them)
-## Installation
+###  Installation
 ```bash
 pip install vectara-agentic
 ```
-## Quick Start
+## 🚀 Quick Start
-1. **Create a Vectara RAG tool**
+### 1. Create a Vectara RAG tool
 ```python
 import os
 from vectara_agentic import VectaraToolFactory
+from pydantic import BaseModel, Field
 vec_factory = VectaraToolFactory(
     vectara_api_key=os.environ['VECTARA_API_KEY'],
@@ -92,108 +105,109 @@ vec_factory = VectaraToolFactory(
 )
 class QueryFinancialReportsArgs(BaseModel):
-        query: str = Field(..., description="The user query.")
-        year: int = Field(..., description=f"The year. An integer between {min(years)} and {max(years)}.")
-        ticker: str = Field(..., description=f"The company ticker. Must be a valid ticket symbol from the list {tickers.keys()}.")
+    query: str = Field(..., description="The user query.")
+    year: int = Field(..., description="The year. An integer between {min(years)} and {max(years)}.")
+    ticker: str = Field(..., description="The company ticker. Must be a valid ticket symbol from the list {tickers.keys()}.")
-query_financial_reports = vec_factory.create_rag_tool(
+query_financial_reports_tool = vec_factory.create_rag_tool(
     tool_name="query_financial_reports",
     tool_description="Query financial reports for a company and year",
     tool_args_schema=QueryFinancialReportsArgs,
 )
 ```
-Note that `VECTARA_CORPUS_ID` can be a single ID or a comma-separated list of IDs.
-2. **Create other tools (optional)**
+### 2. Create other tools (optional)
 In addition to RAG tools, you can generate a lot of other types of tools the agent can use. These could be mathematical tools, tools
 that call other APIs to get more information, or any other type of tool.
-See [Tools](#agent-tools) for more information.
+See [Agent Tools](#agent-tools) for more information.
-3. **Create your agent**
+### 3. Create your agent
 ```python
+from vectara_agentic import Agent
 agent = Agent(
-    tools = [query_financial_reports],
-    topic = topic_of_expertise,
-    custom_instructions = financial_bot_instructions,
+    tools=[query_financial_reports_tool],
+    topic="10-K financial reports",
+    custom_instructions="""
+        - You are a helpful financial assistant in conversation with a user. Use your financial expertise when crafting a query to the tool, to ensure you get the most accurate information.
+        - You can answer questions, provide insights, or summarize any information from financial reports.
+        - A user may refer to a company's ticker instead of its full name - consider those the same when a user is asking about a company.
+        - When calculating a financial metric, make sure you have all the information from tools to complete the calculation.
+        - In many cases you may need to query tools on each sub-metric separately before computing the final metric.
+        - When using a tool to obtain financial data, consider the fact that information for a certain year may be reported in the following year's report.
+        - Report financial data in a consistent manner. For example if you report revenue in thousands, always report revenue in thousands.
+    """
 )
 ```
-- `tools` is the list of tools you want to provide to the agent. In this example it's just a single tool.
-- `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.
-For example, for a financial agent we might use:
+### 4. Run your agent
 ```python
-topic_of_expertise = "10-K financial reports",
-financial_bot_instructions = """
-    - You are a helpful financial assistant in conversation with a user. Use your financial expertise when crafting a query to the tool, to ensure you get the most accurate information.
-    - You can answer questions, provide insights, or summarize any information from financial reports.
-    - A user may refer to a company's ticker instead of its full name - consider those the same when a user is asking about a company.
-    - When calculating a financial metric, make sure you have all the information from tools to complete the calculation.
-    - In many cases you may need to query tools on each sub-metric separately before computing the final metric.
-    - When using a tool to obtain financial data, consider the fact that information for a certain year may be reported in the the following year's report.
-    - Report financial data in a consistent manner. For example if you report revenue in thousands, always report revenue in thousands.
-    """
+response = agent.chat("What was the revenue for Apple in 2021?")
+print(response)
 ```
-## Configuration
-Configure `vectara-agentic` using environment variables:
-- `VECTARA_AGENTIC_AGENT_TYPE`: valid values are `REACT`, `LLMCOMPILER` or `OPENAI` (default: `OPENAI`)
-- `VECTARA_AGENTIC_MAIN_LLM_PROVIDER`: valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `GEMINI` or `FIREWORKS` (default: `OPENAI`)
-- `VECTARA_AGENTIC_MAIN_MODEL_NAME`: agent model name (default depends on provider)
-- `VECTARA_AGENTIC_TOOL_LLM_PROVIDER`: tool LLM provider (default: `OPENAI`)
-- `VECTARA_AGENTIC_TOOL_MODEL_NAME`: tool model name (default depends on provider)
-## Agent Tools
+## 🛠️ Agent Tools
 `vectara-agentic` provides a few tools out of the box:
-1. Standard tools:
+1. **Standard tools**:
 - `summarize_text`: a tool to summarize a long text into a shorter summary (uses LLM)
 - `rephrase_text`: a tool to rephrase a given text, given a set of rephrase instructions (uses LLM)
-2. Legal tools: a set of tools for the legal vertical, such as:
+2. **Legal tools**: a set of tools for the legal vertical, such as:
 - `summarize_legal_text`: summarize legal text with a certain point of view
 - `critique_as_judge`: critique a legal text as a judge, providing their perspective
-3. Financial tools: based on tools from Yahoo Finance:
+3. **Financial tools**: based on tools from Yahoo! Finance:
 - tools to understand the financials of a public company like: `balance_sheet`, `income_statement`, `cash_flow`
 - `stock_news`: provides news about a company
 - `stock_analyst_recommendations`: provides stock analyst recommendations for a company.
-4. database_tools: providing a few tools to inspect and query a database
+1. **Database tools**: providing tools to inspect and query a database
 - `list_tables`: list all tables in the database
 - `describe_tables`: describe the schema of tables in the database
 - `load_data`: returns data based on a SQL query
-More tools coming soon.
+More tools coming soon...
-You can create your own tool directly from a Python function using the `create_tool()` method of the `ToolsFactor` class:
+You can create your own tool directly from a Python function using the `create_tool()` method of the `ToolsFactory` class:
-```Python
+```python
 def mult_func(x, y):
-    return x*y
+    return x * y
 mult_tool = ToolsFactory().create_tool(mult_func)
 ```
-## Agent Diagnostics
+## 🛠️ Configuration
+Configure `vectara-agentic` using environment variables:
+- `VECTARA_AGENTIC_AGENT_TYPE`: valid values are `REACT`, `LLMCOMPILER` or `OPENAI` (default: `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_LLM_PROVIDER`: valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `GEMINI` or `FIREWORKS` (default: `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_MODEL_NAME`: agent model name (default depends on provider)
+- `VECTARA_AGENTIC_TOOL_LLM_PROVIDER`: tool LLM provider (default: `OPENAI`)
+- `VECTARA_AGENTIC_TOOL_MODEL_NAME`: tool model name (default depends on provider)
+- `VECTARA_AGENTIC_OBSERVER_TYPE`: valid values are `ARIZE_PHOENIX` or `NONE` (default: `NONE`)
+When creating a VectaraToolFactory, you can pass in a `vectara_api_key`, `vectara_customer_id`, and `vectara_corpus_id` to the factory. If not passed in, it will be taken from the environment variables. Note that `VECTARA_CORPUS_ID` can be a single ID or a comma-separated list of IDs (if you want to query multiple corpora).
+## ℹ️ Additional Information
+###  Agent Diagnostics
 The `Agent` class defines a few helpful methods to help you understand the internals of your application.
 * The `report()` method prints out the agent object’s type, the tools, and the LLMs used for the main agent and tool calling.
 * The `token_counts()` method tells you how many tokens you have used in the current session for both the main agent and tool calling LLMs. This can be helpful if you want to track spend by token.
-## Serialization
+###  Serialization
 The `Agent` class supports serialization. Use the `dumps()` to serialize and `loads()` to read back from a serialized stream.
-## Observability
+###  Observability
 vectara-agentic supports observability via the existing integration of LlamaIndex and Arize Phoenix.
 First, set `os["VECTARA_AGENTIC_OBSERVER_TYPE"] = "ARIZE_PHOENIX"`.
@@ -208,10 +222,9 @@ Then you can use Arize Phoenix in three ways:
    3. To view the traces go to `https://app.phoenix.arize.com`.
 Now when you run your agent, all call traces are sent to Phoenix and recorded.
-In addition, vectara-agentic also records `FCS` values into Arize for every Vectara RAG call. You can see those results in the `Feedback` column of the arize UI.
+In addition, vectara-agentic also records `FCS` (factual consistency score, aka HHEM) values into Arize for every Vectara RAG call. You can see those results in the `Feedback` column of the arize UI.
-## About Custom Instructions
+### About Custom Instructions
 The custom instructions you provide to the agent guide its behavior.
 Here are some guidelines when creating your instructions:
@@ -219,7 +232,7 @@ Here are some guidelines when creating your instructions:
 - Consider edge cases and unusual or atypical scenarios.
 - Be cautious to not over-specify behavior based on your primary use-case, as it may limit the agent's ability to behave properly in others.
-## Examples
+## 📚 Examples
 Check out our example AI assistants:
@@ -227,16 +240,15 @@ Check out our example AI assistants:
 - [Justice Harvard Teaching Assistant](https://huggingface.co/spaces/vectara/Justice-Harvard)
 - [Legal Assistant](https://huggingface.co/spaces/vectara/legal-agent)
-## Contributing
+## 🤝 Contributing
 We welcome contributions! Please see our [contributing guide](https://github.com/vectara/py-vectara-agentic/blob/main/CONTRIBUTING.md) for more information.
-## License
+## 📝 License
 This project is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/vectara/py-vectara-agentic/blob/master/LICENSE) file for details.
-## Contact
+## 📞 Contact
 - Website: [vectara.com](https://vectara.com)
 - Twitter: [@vectara](https://twitter.com/vectara)

{vectara_agentic-0.1.12 → vectara_agentic-0.1.14}/README.md RENAMED Viewed

@@ -1,44 +1,54 @@
-# vectara-agentic
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-[![Maintained](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/vectara/py-vectara-agentic/graphs/commit-activity)
-[![Twitter](https://img.shields.io/twitter/follow/vectara.svg?style=social&label=Follow%20%40Vectara)](https://twitter.com/vectara)
-[![Discord](https://img.shields.io/badge/Discord-Join%20Us-blue?style=social&logo=discord)](https://discord.com/invite/GFb8gMz6UH)
-## Overview
+# <img src=".github/assets/Vectara-logo.png" alt="Vectara Logo" width="30" height="30" style="vertical-align: middle;"> vectara-agentic
+<p align="center">
+  <a href="https://vectara.github.io/vectara-agentic-docs">Documentation</a> ·
+  <a href="#examples">Examples</a> ·
+  <a href="https://discord.gg/S9dwgCNEFs">Discord</a>
+</p>
+<p align="center">
+  <a href="https://opensource.org/licenses/Apache-2.0">
+    <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License">
+  </a>
+  <a href="https://github.com/vectara/py-vectara-agentic/graphs/commit-activity">
+    <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" alt="Maintained">
+  </a>
+  <a href="https://twitter.com/vectara">
+    <img src="https://img.shields.io/twitter/follow/vectara.svg?style=social&label=Follow%20%40Vectara" alt="Twitter">
+  </a>
+</p>
+## ✨ Overview
 `vectara-agentic` is a Python library for developing powerful AI assistants using Vectara and Agentic-RAG. It leverages the LlamaIndex Agent framework, customized for use with Vectara.
-### Key Features
+###  Key Features
-- Supports `ReAct` and `OpenAIAgent` agent types.
+- Supports `ReAct`, `OpenAIAgent` and `LLMCompiler` agent types.
 - Includes pre-built tools for various domains (e.g., finance, legal).
 - Enables easy creation of custom AI assistants and agents.
-## Important Links
-- Documentation: [https://vectara.github.io/vectara-agentic-docs/](https://vectara.github.io/vectara-agentic-docs/)
-## Prerequisites
+###  Prerequisites
 - [Vectara account](https://console.vectara.com/signup/?utm_source=github&utm_medium=code&utm_term=DevRel&utm_content=vectara-agentic&utm_campaign=github-code-DevRel-vectara-agentic)
 - A Vectara corpus with an [API key](https://docs.vectara.com/docs/api-keys)
 - [Python 3.10 or higher](https://www.python.org/downloads/)
-- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Fireworks AI, Cohere, GEMINI or GROQ)
+- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Fireworks AI, Cohere, GEMINI or GROQ, if you choose to use them)
-## Installation
+###  Installation
 ```bash
 pip install vectara-agentic
 ```
-## Quick Start
+## 🚀 Quick Start
-1. **Create a Vectara RAG tool**
+### 1. Create a Vectara RAG tool
 ```python
 import os
 from vectara_agentic import VectaraToolFactory
+from pydantic import BaseModel, Field
 vec_factory = VectaraToolFactory(
     vectara_api_key=os.environ['VECTARA_API_KEY'],
@@ -47,108 +57,109 @@ vec_factory = VectaraToolFactory(
 )
 class QueryFinancialReportsArgs(BaseModel):
-        query: str = Field(..., description="The user query.")
-        year: int = Field(..., description=f"The year. An integer between {min(years)} and {max(years)}.")
-        ticker: str = Field(..., description=f"The company ticker. Must be a valid ticket symbol from the list {tickers.keys()}.")
+    query: str = Field(..., description="The user query.")
+    year: int = Field(..., description="The year. An integer between {min(years)} and {max(years)}.")
+    ticker: str = Field(..., description="The company ticker. Must be a valid ticket symbol from the list {tickers.keys()}.")
-query_financial_reports = vec_factory.create_rag_tool(
+query_financial_reports_tool = vec_factory.create_rag_tool(
     tool_name="query_financial_reports",
     tool_description="Query financial reports for a company and year",
     tool_args_schema=QueryFinancialReportsArgs,
 )
 ```
-Note that `VECTARA_CORPUS_ID` can be a single ID or a comma-separated list of IDs.
-2. **Create other tools (optional)**
+### 2. Create other tools (optional)
 In addition to RAG tools, you can generate a lot of other types of tools the agent can use. These could be mathematical tools, tools
 that call other APIs to get more information, or any other type of tool.
-See [Tools](#agent-tools) for more information.
+See [Agent Tools](#agent-tools) for more information.
-3. **Create your agent**
+### 3. Create your agent
 ```python
+from vectara_agentic import Agent
 agent = Agent(
-    tools = [query_financial_reports],
-    topic = topic_of_expertise,
-    custom_instructions = financial_bot_instructions,
+    tools=[query_financial_reports_tool],
+    topic="10-K financial reports",
+    custom_instructions="""
+        - You are a helpful financial assistant in conversation with a user. Use your financial expertise when crafting a query to the tool, to ensure you get the most accurate information.
+        - You can answer questions, provide insights, or summarize any information from financial reports.
+        - A user may refer to a company's ticker instead of its full name - consider those the same when a user is asking about a company.
+        - When calculating a financial metric, make sure you have all the information from tools to complete the calculation.
+        - In many cases you may need to query tools on each sub-metric separately before computing the final metric.
+        - When using a tool to obtain financial data, consider the fact that information for a certain year may be reported in the following year's report.
+        - Report financial data in a consistent manner. For example if you report revenue in thousands, always report revenue in thousands.
+    """
 )
 ```
-- `tools` is the list of tools you want to provide to the agent. In this example it's just a single tool.
-- `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.
-For example, for a financial agent we might use:
+### 4. Run your agent
 ```python
-topic_of_expertise = "10-K financial reports",
-financial_bot_instructions = """
-    - You are a helpful financial assistant in conversation with a user. Use your financial expertise when crafting a query to the tool, to ensure you get the most accurate information.
-    - You can answer questions, provide insights, or summarize any information from financial reports.
-    - A user may refer to a company's ticker instead of its full name - consider those the same when a user is asking about a company.
-    - When calculating a financial metric, make sure you have all the information from tools to complete the calculation.
-    - In many cases you may need to query tools on each sub-metric separately before computing the final metric.
-    - When using a tool to obtain financial data, consider the fact that information for a certain year may be reported in the the following year's report.
-    - Report financial data in a consistent manner. For example if you report revenue in thousands, always report revenue in thousands.
-    """
+response = agent.chat("What was the revenue for Apple in 2021?")
+print(response)
 ```
-## Configuration
-Configure `vectara-agentic` using environment variables:
-- `VECTARA_AGENTIC_AGENT_TYPE`: valid values are `REACT`, `LLMCOMPILER` or `OPENAI` (default: `OPENAI`)
-- `VECTARA_AGENTIC_MAIN_LLM_PROVIDER`: valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `GEMINI` or `FIREWORKS` (default: `OPENAI`)
-- `VECTARA_AGENTIC_MAIN_MODEL_NAME`: agent model name (default depends on provider)
-- `VECTARA_AGENTIC_TOOL_LLM_PROVIDER`: tool LLM provider (default: `OPENAI`)
-- `VECTARA_AGENTIC_TOOL_MODEL_NAME`: tool model name (default depends on provider)
-## Agent Tools
+## 🛠️ Agent Tools
 `vectara-agentic` provides a few tools out of the box:
-1. Standard tools:
+1. **Standard tools**:
 - `summarize_text`: a tool to summarize a long text into a shorter summary (uses LLM)
 - `rephrase_text`: a tool to rephrase a given text, given a set of rephrase instructions (uses LLM)
-2. Legal tools: a set of tools for the legal vertical, such as:
+2. **Legal tools**: a set of tools for the legal vertical, such as:
 - `summarize_legal_text`: summarize legal text with a certain point of view
 - `critique_as_judge`: critique a legal text as a judge, providing their perspective
-3. Financial tools: based on tools from Yahoo Finance:
+3. **Financial tools**: based on tools from Yahoo! Finance:
 - tools to understand the financials of a public company like: `balance_sheet`, `income_statement`, `cash_flow`
 - `stock_news`: provides news about a company
 - `stock_analyst_recommendations`: provides stock analyst recommendations for a company.
-4. database_tools: providing a few tools to inspect and query a database
+1. **Database tools**: providing tools to inspect and query a database
 - `list_tables`: list all tables in the database
 - `describe_tables`: describe the schema of tables in the database
 - `load_data`: returns data based on a SQL query
-More tools coming soon.
+More tools coming soon...
-You can create your own tool directly from a Python function using the `create_tool()` method of the `ToolsFactor` class:
+You can create your own tool directly from a Python function using the `create_tool()` method of the `ToolsFactory` class:
-```Python
+```python
 def mult_func(x, y):
-    return x*y
+    return x * y
 mult_tool = ToolsFactory().create_tool(mult_func)
 ```
-## Agent Diagnostics
+## 🛠️ Configuration
+Configure `vectara-agentic` using environment variables:
+- `VECTARA_AGENTIC_AGENT_TYPE`: valid values are `REACT`, `LLMCOMPILER` or `OPENAI` (default: `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_LLM_PROVIDER`: valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `GEMINI` or `FIREWORKS` (default: `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_MODEL_NAME`: agent model name (default depends on provider)
+- `VECTARA_AGENTIC_TOOL_LLM_PROVIDER`: tool LLM provider (default: `OPENAI`)
+- `VECTARA_AGENTIC_TOOL_MODEL_NAME`: tool model name (default depends on provider)
+- `VECTARA_AGENTIC_OBSERVER_TYPE`: valid values are `ARIZE_PHOENIX` or `NONE` (default: `NONE`)
+When creating a VectaraToolFactory, you can pass in a `vectara_api_key`, `vectara_customer_id`, and `vectara_corpus_id` to the factory. If not passed in, it will be taken from the environment variables. Note that `VECTARA_CORPUS_ID` can be a single ID or a comma-separated list of IDs (if you want to query multiple corpora).
+## ℹ️ Additional Information
+###  Agent Diagnostics
 The `Agent` class defines a few helpful methods to help you understand the internals of your application.
 * The `report()` method prints out the agent object’s type, the tools, and the LLMs used for the main agent and tool calling.
 * The `token_counts()` method tells you how many tokens you have used in the current session for both the main agent and tool calling LLMs. This can be helpful if you want to track spend by token.
-## Serialization
+###  Serialization
 The `Agent` class supports serialization. Use the `dumps()` to serialize and `loads()` to read back from a serialized stream.
-## Observability
+###  Observability
 vectara-agentic supports observability via the existing integration of LlamaIndex and Arize Phoenix.
 First, set `os["VECTARA_AGENTIC_OBSERVER_TYPE"] = "ARIZE_PHOENIX"`.
@@ -163,10 +174,9 @@ Then you can use Arize Phoenix in three ways:
    3. To view the traces go to `https://app.phoenix.arize.com`.
 Now when you run your agent, all call traces are sent to Phoenix and recorded.
-In addition, vectara-agentic also records `FCS` values into Arize for every Vectara RAG call. You can see those results in the `Feedback` column of the arize UI.
+In addition, vectara-agentic also records `FCS` (factual consistency score, aka HHEM) values into Arize for every Vectara RAG call. You can see those results in the `Feedback` column of the arize UI.
-## About Custom Instructions
+### About Custom Instructions
 The custom instructions you provide to the agent guide its behavior.
 Here are some guidelines when creating your instructions:
@@ -174,7 +184,7 @@ Here are some guidelines when creating your instructions:
 - Consider edge cases and unusual or atypical scenarios.
 - Be cautious to not over-specify behavior based on your primary use-case, as it may limit the agent's ability to behave properly in others.
-## Examples
+## 📚 Examples
 Check out our example AI assistants:
@@ -182,16 +192,15 @@ Check out our example AI assistants:
 - [Justice Harvard Teaching Assistant](https://huggingface.co/spaces/vectara/Justice-Harvard)
 - [Legal Assistant](https://huggingface.co/spaces/vectara/legal-agent)
-## Contributing
+## 🤝 Contributing
 We welcome contributions! Please see our [contributing guide](https://github.com/vectara/py-vectara-agentic/blob/main/CONTRIBUTING.md) for more information.
-## License
+## 📝 License
 This project is licensed under the Apache 2.0 License. See the [LICENSE](https://github.com/vectara/py-vectara-agentic/blob/master/LICENSE) file for details.
-## Contact
+## 📞 Contact
 - Website: [vectara.com](https://vectara.com)
 - Twitter: [@vectara](https://twitter.com/vectara)

{vectara_agentic-0.1.12 → vectara_agentic-0.1.14}/requirements.txt RENAMED Viewed

@@ -14,8 +14,11 @@ llama-index-tools-arxiv==0.2.0
 llama-index-tools-database==0.2.0
 llama-index-tools-google==0.2.0
 llama-index-tools-tavily_research==0.2.0
+tavily-python==0.5.0
+yahoo-finance==1.4.0
+llama-index-tools-neo4j==0.2.0
 openinference-instrumentation-llama-index==3.0.2
-opentelemetry-proto==1.16.0
+arize-phoenix==4.35.1
 arize-phoenix-otel==0.5.1
 tokenizers>=0.20
 pydantic==2.9.2

{vectara_agentic-0.1.12 → vectara_agentic-0.1.14}/setup.py RENAMED Viewed

@@ -8,7 +8,7 @@ def read_requirements():
 setup(
     name="vectara_agentic",
-    version="0.1.12",
+    version="0.1.14",
     author="Ofer Mendelevitch",
     author_email="ofer@vectara.com",
     description="A Python package for creating AI Assistants and AI Agents with Vectara",
@@ -25,7 +25,7 @@ setup(
         "Topic :: Scientific/Engineering :: Artificial Intelligence",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    keywords = ["LLM", "NLP", "RAG", "Agentic-RAG"],
+    keywords=["LLM", "NLP", "RAG", "Agentic-RAG"],
     project_urls={
         "Documentation": "https://vectara.github.io/vectara-agentic-docs/",
     },

vectara_agentic-0.1.14/tests/__init__.py ADDED Viewed

File without changes

{vectara_agentic-0.1.12 → vectara_agentic-0.1.14}/tests/test_tools.py RENAMED Viewed

@@ -76,7 +76,8 @@ class TestToolsPackage(unittest.TestCase):
             vectara_summarizer="mockingbird-1.0-2024-07-16"
         )
-        self.assertContains(agent.chat("What is Vectara?"), "Vectara is an end-to-end platform")
+        self.assertIn("Vectara is an end-to-end platform", agent.chat("What is Vectara?"))
 if __name__ == "__main__":
     unittest.main()

{vectara_agentic-0.1.12 → vectara_agentic-0.1.14}/vectara_agentic/__init__.py RENAMED Viewed

@@ -3,7 +3,7 @@ vectara_agentic package.
 """
 # Define the package version
-__version__ = "0.1.12"
+__version__ = "0.1.14"
 # Import classes and functions from modules
 # from .module1 import Class1, function1

vectara-agentic 0.1.12__tar.gz → 0.1.14__tar.gz

Potentially problematic release.

vectara-agentic 0.1.12tar.gz → 0.1.14tar.gz