vectara-agentic 0.3.3__tar.gz → 0.4.1__tar.gz

{vectara_agentic-0.3.3/vectara_agentic.egg-info → vectara_agentic-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vectara_agentic
-Version: 0.3.3
+Version: 0.4.1
 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
@@ -16,26 +16,24 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: llama-index==0.12.37
-Requires-Dist: llama-index-core==0.12.37
-Requires-Dist: llama-index-cli==0.4.1
+Requires-Dist: llama-index==0.12.52
+Requires-Dist: llama-index-core==0.12.52.post1
+Requires-Dist: llama-index-workflow==1.0.1
+Requires-Dist: llama-index-cli==0.4.4
 Requires-Dist: llama-index-indices-managed-vectara==0.4.5
-Requires-Dist: llama-index-agent-llm-compiler==0.3.1
-Requires-Dist: llama-index-agent-lats==0.3.0
-Requires-Dist: llama-index-agent-openai==0.4.8
-Requires-Dist: llama-index-llms-openai==0.3.44
-Requires-Dist: llama-index-llms-openai-like==0.3.5
-Requires-Dist: llama-index-llms-anthropic==0.6.19
-Requires-Dist: llama-index-llms-together==0.3.1
-Requires-Dist: llama-index-llms-groq==0.3.1
-Requires-Dist: llama-index-llms-fireworks==0.3.2
+Requires-Dist: llama-index-agent-openai==0.4.12
+Requires-Dist: llama-index-llms-openai==0.4.7
+Requires-Dist: llama-index-llms-openai-like==0.4.0
+Requires-Dist: llama-index-llms-anthropic==0.7.6
+Requires-Dist: llama-index-llms-together==0.3.2
+Requires-Dist: llama-index-llms-groq==0.3.2
 Requires-Dist: llama-index-llms-cohere==0.5.0
-Requires-Dist: llama-index-llms-google-genai==0.2.1
-Requires-Dist: llama-index-llms-bedrock-converse==0.7.1
+Requires-Dist: llama-index-llms-google-genai==0.2.5
+Requires-Dist: llama-index-llms-bedrock-converse==0.7.6
 Requires-Dist: llama-index-tools-yahoo-finance==0.3.0
 Requires-Dist: llama-index-tools-arxiv==0.3.0
 Requires-Dist: llama-index-tools-database==0.3.0
-Requires-Dist: llama-index-tools-google==0.3.1
+Requires-Dist: llama-index-tools-google==0.5.0
 Requires-Dist: llama-index-tools-tavily_research==0.3.0
 Requires-Dist: llama_index.tools.brave_search==0.3.0
 Requires-Dist: llama-index-tools-neo4j==0.3.0
@@ -44,21 +42,21 @@ Requires-Dist: llama-index-graph-stores-kuzu==0.7.0
 Requires-Dist: llama-index-tools-salesforce==0.3.0
 Requires-Dist: llama-index-tools-slack==0.3.0
 Requires-Dist: llama-index-tools-exa==0.3.0
-Requires-Dist: llama-index-tools-wikipedia==0.3.0
+Requires-Dist: llama-index-tools-wikipedia==0.3.1
 Requires-Dist: llama-index-tools-bing-search==0.3.0
-Requires-Dist: openai>=1.82.1
-Requires-Dist: tavily-python==0.7.3
-Requires-Dist: exa-py==1.13.1
+Requires-Dist: openai>=1.96.1
+Requires-Dist: tavily-python>=0.7.9
+Requires-Dist: exa-py>=1.14.8
 Requires-Dist: openinference-instrumentation-llama-index==4.3.1
 Requires-Dist: opentelemetry-proto>=1.31.0
 Requires-Dist: arize-phoenix==10.9.1
 Requires-Dist: arize-phoenix-otel==0.10.3
-Requires-Dist: protobuf==5.29.3
+Requires-Dist: protobuf==5.29.5
 Requires-Dist: tokenizers>=0.20
 Requires-Dist: pydantic==2.11.5
+Requires-Dist: pandas==2.2.3
 Requires-Dist: retrying==1.3.4
 Requires-Dist: python-dotenv==1.0.1
-Requires-Dist: tiktoken==0.9.0
 Requires-Dist: cloudpickle>=3.1.1
 Requires-Dist: httpx==0.28.1
 Requires-Dist: commonmark==0.9.1
@@ -108,6 +106,7 @@ Dynamic: summary
 - [Using Tools](#using-tools)
 - [Advanced Usage: Workflows](#advanced-usage-workflows)
 - [Configuration](#️-configuration)
+- [Migrating from v0.3.x](#-migrating-from-v03x)
 - [Contributing](#-contributing)
 - [License](#-license)
 
@@ -124,11 +123,11 @@ Dynamic: summary
 - **Rapid Tool Creation:**  
   Build Vectara RAG tools or search tools with a single line of code.
 - **Agent Flexibility:**  
-  Supports multiple agent types including `ReAct`, `OpenAIAgent`, `LATS`, and `LLMCompiler`.
+  Supports multiple agent types including `ReAct` and `Function Calling`.
 - **Pre-Built Domain Tools:**  
   Tools tailored for finance, legal, and other verticals.
 - **Multi-LLM Integration:**  
-  Seamless integration with OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere, Bedrock, and Fireworks.
+  Seamless integration with OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere, and Bedrock.
 - **Observability:**  
   Built-in support with Arize Phoenix for monitoring and feedback.
 - **Workflow Support:**  
@@ -148,7 +147,7 @@ Check out our example AI assistants:
 - [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, if you choose to use them).
+- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Cohere, GEMINI or GROQ, if you choose to use them).
   To use AWS Bedrock, make sure that
   * The Bedrock models you need are enabled on your account
   * Your environment includes `AWS_PROFILE` with your AWS profile name.
@@ -200,7 +199,8 @@ ask_finance = vec_factory.create_rag_tool(
     tool_description="Query financial reports for a company and year",
     tool_args_schema=QueryFinancialReportsArgs,
     lambda_val=0.005,
-    summary_num_results=7, 
+    summary_num_results=7,
+    vhc_eligible=True,  # RAG tools participate in VHC by default
     # Additional Vectara query arguments...
 )
 ```
@@ -480,6 +480,30 @@ def mult_func(x, y):
 mult_tool = ToolsFactory().create_tool(mult_func)
 ```
 
+#### VHC Eligibility
+
+When creating tools, you can control whether they participate in Vectara Hallucination Correction, by using the `vhc_eligible` parameter:
+
+```python
+# Tool that provides factual data - should participate in VHC
+data_tool = ToolsFactory().create_tool(get_company_data, vhc_eligible=True)
+
+# Utility tool that doesn't provide context - should not participate in VHC  
+summary_tool = ToolsFactory().create_tool(summarize_text, vhc_eligible=False)
+```
+
+**VHC-eligible tools** (default: `True`) are those that provide factual context for responses, such as:
+- Data retrieval tools
+- Search tools  
+- API calls that return factual information
+
+**Non-VHC-eligible tools** (`vhc_eligible=False`) are utility tools that don't contribute factual context:
+- Text summarization tools
+- Text rephrasing tools
+- Formatting or processing tools
+
+Built-in utility tools like `summarize_text`, `rephrase_text`, and `get_bad_topics` are automatically marked as non-VHC-eligible.
+
 #### Human-Readable Tool Output
 
 Tools can provide both raw data and human-readable formatted output using the `create_human_readable_output` utility:
@@ -504,7 +528,50 @@ Built-in formatters include `format_as_table`, `format_as_json`, and `format_as_
 > and not as nested functions. Nested functions are not supported if you use serialization 
 > (dumps/loads or from_dict/to_dict).
 
-The human-readable format, if available, is used when computing the factual consistency score.
+The human-readable format, if available, is used when using Vectara Hallucination Correction.
+
+## 🔍 Vectara Hallucination Correction (VHC)
+
+`vectara-agentic` provides built-in support for Vectara Hallucination Correction (VHC), which analyzes agent responses and corrects any detected hallucinations based on the factual content retrieved by VHC-eligible tools.
+
+### Computing VHC
+
+After a chat interaction, you can compute VHC to analyze and correct the agent's response:
+
+```python
+# Chat with the agent
+response = agent.chat("What was Apple's revenue in 2022?")
+print(response.response)
+
+# Compute VHC analysis
+vhc_result = agent.compute_vhc()
+
+# Access corrected text and corrections
+if vhc_result["corrected_text"]:
+    print("Original:", response.response)
+    print("Corrected:", vhc_result["corrected_text"])
+    print("Corrections:", vhc_result["corrections"])
+else:
+    print("No corrections needed or VHC not available")
+```
+
+### Async VHC Computation
+
+For async applications, use `acompute_vhc()`:
+
+```python
+# Async chat
+response = await agent.achat("What was Apple's revenue in 2022?")
+
+# Async VHC computation
+vhc_result = await agent.acompute_vhc()
+```
+
+### VHC Requirements
+
+- VHC requires a valid `VECTARA_API_KEY` environment variable
+- Only VHC-eligible tools (those marked with `vhc_eligible=True`) contribute to the analysis
+- VHC results are cached for each query/response pair to avoid redundant computation
 
 ### Tool Validation
 
@@ -719,12 +786,13 @@ agent = Agent(
 ```
 
 The `AgentConfig` object may include the following items:
-- `agent_type`: the agent type. Valid values are `REACT`, `LLMCOMPILER`, `LATS` or `OPENAI` (default: `OPENAI`).
-- `main_llm_provider` and `tool_llm_provider`: the LLM provider for main agent and for the tools. Valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `BEDROCK`, `GEMINI` or `FIREWORKS` (default: `OPENAI`).
-- `main_llm_model_name` and `tool_llm_model_name`: agent model name for agent and tools (default depends on provider).
+- `agent_type`: the agent type. Valid values are `REACT` or `FUNCTION_CALLING` (default: `FUNCTION_CALLING`).
+- `main_llm_provider` and `tool_llm_provider`: the LLM provider for main agent and for the tools. Valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `BEDROCK`, `GEMINI` (default: `OPENAI`).
+
+> **Note:** Fireworks AI support has been removed. If you were using Fireworks, please migrate to one of the supported providers listed above.
+- `main_llm_model_name` and `tool_llm_model_name`: agent model name for agent and tools (default depends on provider: OpenAI uses gpt-4.1, Gemini uses gemini-2.5-flash).
 - `observer`: the observer type; should be `ARIZE_PHOENIX` or if undefined no observation framework will be used.
 - `endpoint_api_key`: a secret key if using the API endpoint option (defaults to `dev-api-key`)
-- `max_reasoning_steps`: the maximum number of reasoning steps (iterations for React and function calls for OpenAI agent, respectively). Defaults to 50.
 
 If any of these are not provided, `AgentConfig` first tries to read the values from the OS environment.
 
@@ -759,3 +827,15 @@ agent = Agent(
 )
 ```
 
+## 🚀 Migrating from v0.3.x
+
+If you're upgrading from v0.3.x, please note the following breaking changes in v0.4.0:
+
+- **Fireworks LLM removed**: Migrate to OpenAI, Anthropic, Together.AI, GROQ, Cohere, Bedrock, or Gemini
+- **OPENAI AgentType removed**: Use the FUNCTION_CALLING AgentType instead, when using OpenAI for main_llm_provider
+- **StructuredPlanning deprecated**: Use standard Agent workflows or create custom workflows
+- **Token counting and compact_docstring removed**: Remove these from your configuration
+- **update_func removed**: This functionality is no longer available
+
+For detailed migration instructions, see [CHANGELOG.md](CHANGELOG.md).
+

{vectara_agentic-0.3.3 → vectara_agentic-0.4.1}/README.md

@@ -31,6 +31,7 @@
 - [Using Tools](#using-tools)
 - [Advanced Usage: Workflows](#advanced-usage-workflows)
 - [Configuration](#️-configuration)
+- [Migrating from v0.3.x](#-migrating-from-v03x)
 - [Contributing](#-contributing)
 - [License](#-license)
 
@@ -47,11 +48,11 @@
 - **Rapid Tool Creation:**  
   Build Vectara RAG tools or search tools with a single line of code.
 - **Agent Flexibility:**  
-  Supports multiple agent types including `ReAct`, `OpenAIAgent`, `LATS`, and `LLMCompiler`.
+  Supports multiple agent types including `ReAct` and `Function Calling`.
 - **Pre-Built Domain Tools:**  
   Tools tailored for finance, legal, and other verticals.
 - **Multi-LLM Integration:**  
-  Seamless integration with OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere, Bedrock, and Fireworks.
+  Seamless integration with OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere, and Bedrock.
 - **Observability:**  
   Built-in support with Arize Phoenix for monitoring and feedback.
 - **Workflow Support:**  
@@ -71,7 +72,7 @@ Check out our example AI assistants:
 - [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, if you choose to use them).
+- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Cohere, GEMINI or GROQ, if you choose to use them).
   To use AWS Bedrock, make sure that
   * The Bedrock models you need are enabled on your account
   * Your environment includes `AWS_PROFILE` with your AWS profile name.
@@ -123,7 +124,8 @@ ask_finance = vec_factory.create_rag_tool(
     tool_description="Query financial reports for a company and year",
     tool_args_schema=QueryFinancialReportsArgs,
     lambda_val=0.005,
-    summary_num_results=7, 
+    summary_num_results=7,
+    vhc_eligible=True,  # RAG tools participate in VHC by default
     # Additional Vectara query arguments...
 )
 ```
@@ -403,6 +405,30 @@ def mult_func(x, y):
 mult_tool = ToolsFactory().create_tool(mult_func)
 ```
 
+#### VHC Eligibility
+
+When creating tools, you can control whether they participate in Vectara Hallucination Correction, by using the `vhc_eligible` parameter:
+
+```python
+# Tool that provides factual data - should participate in VHC
+data_tool = ToolsFactory().create_tool(get_company_data, vhc_eligible=True)
+
+# Utility tool that doesn't provide context - should not participate in VHC  
+summary_tool = ToolsFactory().create_tool(summarize_text, vhc_eligible=False)
+```
+
+**VHC-eligible tools** (default: `True`) are those that provide factual context for responses, such as:
+- Data retrieval tools
+- Search tools  
+- API calls that return factual information
+
+**Non-VHC-eligible tools** (`vhc_eligible=False`) are utility tools that don't contribute factual context:
+- Text summarization tools
+- Text rephrasing tools
+- Formatting or processing tools
+
+Built-in utility tools like `summarize_text`, `rephrase_text`, and `get_bad_topics` are automatically marked as non-VHC-eligible.
+
 #### Human-Readable Tool Output
 
 Tools can provide both raw data and human-readable formatted output using the `create_human_readable_output` utility:
@@ -427,7 +453,50 @@ Built-in formatters include `format_as_table`, `format_as_json`, and `format_as_
 > and not as nested functions. Nested functions are not supported if you use serialization 
 > (dumps/loads or from_dict/to_dict).
 
-The human-readable format, if available, is used when computing the factual consistency score.
+The human-readable format, if available, is used when using Vectara Hallucination Correction.
+
+## 🔍 Vectara Hallucination Correction (VHC)
+
+`vectara-agentic` provides built-in support for Vectara Hallucination Correction (VHC), which analyzes agent responses and corrects any detected hallucinations based on the factual content retrieved by VHC-eligible tools.
+
+### Computing VHC
+
+After a chat interaction, you can compute VHC to analyze and correct the agent's response:
+
+```python
+# Chat with the agent
+response = agent.chat("What was Apple's revenue in 2022?")
+print(response.response)
+
+# Compute VHC analysis
+vhc_result = agent.compute_vhc()
+
+# Access corrected text and corrections
+if vhc_result["corrected_text"]:
+    print("Original:", response.response)
+    print("Corrected:", vhc_result["corrected_text"])
+    print("Corrections:", vhc_result["corrections"])
+else:
+    print("No corrections needed or VHC not available")
+```
+
+### Async VHC Computation
+
+For async applications, use `acompute_vhc()`:
+
+```python
+# Async chat
+response = await agent.achat("What was Apple's revenue in 2022?")
+
+# Async VHC computation
+vhc_result = await agent.acompute_vhc()
+```
+
+### VHC Requirements
+
+- VHC requires a valid `VECTARA_API_KEY` environment variable
+- Only VHC-eligible tools (those marked with `vhc_eligible=True`) contribute to the analysis
+- VHC results are cached for each query/response pair to avoid redundant computation
 
 ### Tool Validation
 
@@ -642,12 +711,13 @@ agent = Agent(
 ```
 
 The `AgentConfig` object may include the following items:
-- `agent_type`: the agent type. Valid values are `REACT`, `LLMCOMPILER`, `LATS` or `OPENAI` (default: `OPENAI`).
-- `main_llm_provider` and `tool_llm_provider`: the LLM provider for main agent and for the tools. Valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `BEDROCK`, `GEMINI` or `FIREWORKS` (default: `OPENAI`).
-- `main_llm_model_name` and `tool_llm_model_name`: agent model name for agent and tools (default depends on provider).
+- `agent_type`: the agent type. Valid values are `REACT` or `FUNCTION_CALLING` (default: `FUNCTION_CALLING`).
+- `main_llm_provider` and `tool_llm_provider`: the LLM provider for main agent and for the tools. Valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `BEDROCK`, `GEMINI` (default: `OPENAI`).
+
+> **Note:** Fireworks AI support has been removed. If you were using Fireworks, please migrate to one of the supported providers listed above.
+- `main_llm_model_name` and `tool_llm_model_name`: agent model name for agent and tools (default depends on provider: OpenAI uses gpt-4.1, Gemini uses gemini-2.5-flash).
 - `observer`: the observer type; should be `ARIZE_PHOENIX` or if undefined no observation framework will be used.
 - `endpoint_api_key`: a secret key if using the API endpoint option (defaults to `dev-api-key`)
-- `max_reasoning_steps`: the maximum number of reasoning steps (iterations for React and function calls for OpenAI agent, respectively). Defaults to 50.
 
 If any of these are not provided, `AgentConfig` first tries to read the values from the OS environment.
 
@@ -682,3 +752,15 @@ agent = Agent(
 )
 ```
 
+## 🚀 Migrating from v0.3.x
+
+If you're upgrading from v0.3.x, please note the following breaking changes in v0.4.0:
+
+- **Fireworks LLM removed**: Migrate to OpenAI, Anthropic, Together.AI, GROQ, Cohere, Bedrock, or Gemini
+- **OPENAI AgentType removed**: Use the FUNCTION_CALLING AgentType instead, when using OpenAI for main_llm_provider
+- **StructuredPlanning deprecated**: Use standard Agent workflows or create custom workflows
+- **Token counting and compact_docstring removed**: Remove these from your configuration
+- **update_func removed**: This functionality is no longer available
+
+For detailed migration instructions, see [CHANGELOG.md](CHANGELOG.md).
+

{vectara_agentic-0.3.3 → vectara_agentic-0.4.1}/requirements.txt

@@ -1,23 +1,21 @@
-llama-index==0.12.37
-llama-index-core==0.12.37
-llama-index-cli==0.4.1
+llama-index==0.12.52
+llama-index-core==0.12.52.post1
+llama-index-workflow==1.0.1
+llama-index-cli==0.4.4
 llama-index-indices-managed-vectara==0.4.5
-llama-index-agent-llm-compiler==0.3.1
-llama-index-agent-lats==0.3.0
-llama-index-agent-openai==0.4.8
-llama-index-llms-openai==0.3.44
-llama-index-llms-openai-like==0.3.5
-llama-index-llms-anthropic==0.6.19
-llama-index-llms-together==0.3.1
-llama-index-llms-groq==0.3.1
-llama-index-llms-fireworks==0.3.2
+llama-index-agent-openai==0.4.12
+llama-index-llms-openai==0.4.7
+llama-index-llms-openai-like==0.4.0
+llama-index-llms-anthropic==0.7.6
+llama-index-llms-together==0.3.2
+llama-index-llms-groq==0.3.2
 llama-index-llms-cohere==0.5.0
-llama-index-llms-google-genai==0.2.1
-llama-index-llms-bedrock-converse==0.7.1
+llama-index-llms-google-genai==0.2.5
+llama-index-llms-bedrock-converse==0.7.6
 llama-index-tools-yahoo-finance==0.3.0
 llama-index-tools-arxiv==0.3.0
 llama-index-tools-database==0.3.0
-llama-index-tools-google==0.3.1
+llama-index-tools-google==0.5.0
 llama-index-tools-tavily_research==0.3.0
 llama_index.tools.brave_search==0.3.0
 llama-index-tools-neo4j==0.3.0
@@ -26,21 +24,21 @@ llama-index-graph-stores-kuzu==0.7.0
 llama-index-tools-salesforce==0.3.0
 llama-index-tools-slack==0.3.0
 llama-index-tools-exa==0.3.0
-llama-index-tools-wikipedia==0.3.0
+llama-index-tools-wikipedia==0.3.1
 llama-index-tools-bing-search==0.3.0
-openai>=1.82.1
-tavily-python==0.7.3
-exa-py==1.13.1
+openai>=1.96.1
+tavily-python>=0.7.9
+exa-py>=1.14.8
 openinference-instrumentation-llama-index==4.3.1
 opentelemetry-proto>=1.31.0
 arize-phoenix==10.9.1
 arize-phoenix-otel==0.10.3
-protobuf==5.29.3
+protobuf==5.29.5
 tokenizers>=0.20
 pydantic==2.11.5
+pandas==2.2.3
 retrying==1.3.4
 python-dotenv==1.0.1
-tiktoken==0.9.0
 cloudpickle>=3.1.1
 httpx==0.28.1
 commonmark==0.9.1

vectara_agentic-0.4.1/tests/__init__.py

@@ -0,0 +1,7 @@
+"""
+Tests package for vectara_agentic.
+"""
+
+# Suppress external dependency warnings globally for all tests
+import warnings
+warnings.simplefilter("ignore", DeprecationWarning)