vectara-agentic 0.1.23__py3-none-any.whl → 0.1.25__py3-none-any.whl

{vectara_agentic-0.1.23.dist-info → vectara_agentic-0.1.25.dist-info}/METADATA

@@ -1,12 +1,12 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: vectara_agentic
-Version: 0.1.23
+Version: 0.1.25
 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
 Author-email: ofer@vectara.com
 Project-URL: Documentation, https://vectara.github.io/vectara-agentic-docs/
-Keywords: LLM,NLP,RAG,Agentic-RAG
+Keywords: LLM,NLP,RAG,Agentic-RAG,AI assistant,AI Agent,Vectara
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
@@ -16,43 +16,54 @@ 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.7
+Requires-Dist: llama-index==0.12.11
 Requires-Dist: llama-index-indices-managed-vectara==0.3.1
 Requires-Dist: llama-index-agent-llm-compiler==0.3.0
 Requires-Dist: llama-index-agent-lats==0.3.0
-Requires-Dist: llama-index-agent-openai==0.4.1
-Requires-Dist: llama-index-llms-openai==0.3.12
-Requires-Dist: llama-index-llms-anthropic==0.6.3
+Requires-Dist: llama-index-agent-openai==0.4.3
+Requires-Dist: llama-index-llms-openai==0.3.16
+Requires-Dist: llama-index-llms-anthropic==0.6.4
 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.0
+Requires-Dist: llama-index-llms-fireworks==0.3.1
 Requires-Dist: llama-index-llms-cohere==0.4.0
-Requires-Dist: llama-index-llms-gemini==0.4.2
+Requires-Dist: llama-index-llms-gemini==0.4.4
+Requires-Dist: llama-index-llms-bedrock==0.3.3
 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.0
 Requires-Dist: llama-index-tools-tavily_research==0.3.0
 Requires-Dist: llama-index-tools-neo4j==0.3.0
-Requires-Dist: llama-index-graph-stores-kuzu==0.5.0
+Requires-Dist: llama-index-graph-stores-kuzu==0.6.0
 Requires-Dist: llama-index-tools-slack==0.3.0
 Requires-Dist: llama-index-tools-exa==0.3.0
 Requires-Dist: tavily-python==0.5.0
-Requires-Dist: exa-py==1.7.0
+Requires-Dist: exa-py==1.8.5
 Requires-Dist: yahoo-finance==1.4.0
-Requires-Dist: openinference-instrumentation-llama-index==3.0.3
+Requires-Dist: openinference-instrumentation-llama-index==3.1.4
 Requires-Dist: opentelemetry-proto==1.26.0
-Requires-Dist: arize-phoenix==5.7.0
+Requires-Dist: arize-phoenix==7.11.0
 Requires-Dist: arize-phoenix-otel==0.6.1
 Requires-Dist: protobuf==4.25.5
 Requires-Dist: tokenizers>=0.20
-Requires-Dist: pydantic==2.9.2
+Requires-Dist: pydantic==2.10.3
 Requires-Dist: retrying==1.3.4
-Requires-Dist: pymongo==4.10.1
 Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: tiktoken==0.8.0
 Requires-Dist: dill>=0.3.7
 Requires-Dist: httpx==0.27.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # <img src="https://raw.githubusercontent.com/vectara/py-vectara-agentic/main/.github/assets/Vectara-logo.png" alt="Vectara Logo" width="30" height="30" style="vertical-align: middle;"> vectara-agentic
 
@@ -76,7 +87,7 @@ Requires-Dist: httpx==0.27.2
 
 ## ✨ Overview
 
-`vectara-agentic` is a Python library for developing powerful AI assistants and agents using Vectara and Agentic-RAG. It leverages the LlamaIndex Agent framework, customized for use with Vectara.
+`vectara-agentic` is a Python library for developing powerful AI assistants and agents using Vectara and Agentic-RAG. It leverages the LlamaIndex Agent framework and provides helper functions to quickly create tools that connect to Vectara corpora.
 
 <p align="center">
 <img src="https://raw.githubusercontent.com/vectara/py-vectara-agentic/main/.github/assets/diagram1.png" alt="Agentic RAG diagram" width="100%" style="vertical-align: middle;">
@@ -85,10 +96,10 @@ Requires-Dist: httpx==0.27.2
 ###  Features
 
 - Enables easy creation of custom AI assistants and agents.
-- Create a Vectara RAG tool with a single line of code.
-- Supports `ReAct`, `OpenAIAgent`, `LATS' and `LLMCompiler` agent types.
+- Create a Vectara RAG tool or search tool with a single line of code.
+- Supports `ReAct`, `OpenAIAgent`, `LATS` and `LLMCompiler` agent types.
 - Includes pre-built tools for various domains (e.g., finance, legal).
-- Integrates with various LLM inference services like OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere and Fireworks
+- Integrates with various LLM inference services like OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere, Bedrock and Fireworks
 - Built-in support for observability with Arize Phoenix
 
 ### 📚 Example AI Assistants
@@ -98,14 +109,14 @@ Check out our example AI assistants:
 - [Financial Assistant](https://huggingface.co/spaces/vectara/finance-chat)
 - [Justice Harvard Teaching Assistant](https://huggingface.co/spaces/vectara/Justice-Harvard)
 - [Legal Assistant](https://huggingface.co/spaces/vectara/legal-agent)
-
+- [EV Assistant](https://huggingface.co/spaces/vectara/ev-assistant)
 
 ###  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, if you choose to use them)
+- OpenAI API key (or API keys for Anthropic, TOGETHER.AI, Fireworks AI, Bedrock, Cohere, GEMINI or GROQ, if you choose to use them)
 
 ###  Installation
 
@@ -115,18 +126,25 @@ pip install vectara-agentic
 
 ## 🚀 Quick Start
 
-### 1. Create a Vectara RAG tool
+### 1. Initialize the Vectara tool factory
 
 ```python
 import os
 from vectara_agentic.tools import VectaraToolFactory
-from pydantic import BaseModel, Field
 
 vec_factory = VectaraToolFactory(
     vectara_api_key=os.environ['VECTARA_API_KEY'],
     vectara_customer_id=os.environ['VECTARA_CUSTOMER_ID'],
     vectara_corpus_id=os.environ['VECTARA_CORPUS_ID']
 )
+```
+
+### 2. Create a Vectara RAG Tool
+
+A RAG tool calls the full Vectara RAG pipeline to provide summarized responses to queries grounded in data.
+
+```python
+from pydantic import BaseModel, Field
 
 years = list(range(2020, 2024))
 tickers = {
@@ -145,17 +163,22 @@ 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,
+    lambda_val=0.005,
+    summary_num_results=7, 
+    # Additional arguments
 )
 ```
 
-### 2. Create other tools (optional)
+See the [docs](https://vectara.github.io/vectara-agentic-docs/) for additional arguments to customize your Vectara RAG tool.
+
+### 3. 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 [Agent Tools](#agent-tools) for more information.
 
-### 3. Create your agent
+### 4. Create your agent
 
 ```python
 from vectara_agentic import Agent
@@ -175,14 +198,72 @@ agent = Agent(
 )
 ```
 
-### 4. Run your agent
+See the [docs](https://vectara.github.io/vectara-agentic-docs/) for additional arguments, including `agent_progress_callback` and `query_logging_callback`.
+
+### 5. Run your agent
 
 ```python
-response = agent.chat("What was the revenue for Apple in 2021?")
-print(response)
+res = agent.chat("What was the revenue for Apple in 2021?")
+print(res.response)
+```
+
+Note that:
+1. `vectara-agentic` also supports `achat()` and two streaming variants `stream_chat()` and `astream_chat()`.
+2. The response types from `chat()` and `achat()` are of type `AgentResponse`. If you just need the actual string
+   response it's available as the `response` variable, or just use `str()`. For advanced use-cases you can look 
+   at other `AgentResponse` variables [such as `sources`](https://github.com/run-llama/llama_index/blob/659f9faaafbecebb6e6c65f42143c0bf19274a37/llama-index-core/llama_index/core/chat_engine/types.py#L53).
+
+## 🧰 Vectara tools
+
+`vectara-agentic` provides two helper functions to connect with Vectara RAG
+* `create_rag_tool()` to create an agent tool that connects with a Vectara corpus for querying. 
+* `create_search_tool()` to create a tool to search a Vectara corpus and return a list of matching documents.
+
+See the documentation for the full list of arguments for `create_rag_tool()` and `create_search_tool()`, 
+to understand how to configure Vectara query performed by those tools.
+
+### Creating a Vectara RAG tool
+
+A Vectara RAG tool is often the main workhorse for any Agentic RAG application, and enables the agent to query 
+one or more Vectara RAG corpora. 
+
+The tool generated always includes the `query` argument, followed by 1 or more optional arguments used for 
+metadata filtering, defined by `tool_args_schema`.
+
+For example, in the quickstart example the schema is:
+
 ```
+class QueryFinancialReportsArgs(BaseModel):
+    query: str = Field(..., description="The user query.")
+    year: int | str = Field(..., description=f"The year this query relates to. An integer between {min(years)} and {max(years)} or a string specifying a condition on the year (example: '>2020').")
+    ticker: str = Field(..., description=f"The company ticker. Must be a valid ticket symbol from the list {tickers.keys()}.")
+```
+
+The `query` is required and is always the query string.
+The other arguments are optional and will be interpreted as Vectara metadata filters.
 
-## 🛠️ Agent Tools
+For example, in the example above, the agent may call the `query_financial_reports_tool` tool with 
+query='what is the revenue?', year=2022 and ticker='AAPL'. Subsequently the RAG tool will issue
+a Vectara RAG query with the same query, but with metadata filtering (doc.year=2022 and doc.ticker='AAPL').
+
+There are also additional cool features supported here:
+* An argument can be a condition, for example year='>2022' translates to the correct metadata 
+  filtering condition doc.year>2022
+* if `fixed_filter` is defined in the RAG tool, it provides a constant metadata filtering that is always applied.
+  For example, if fixed_filter=`doc.filing_type='10K'` then a query with query='what is the reveue', year=2022
+  and ticker='AAPL' would translate into query='what is the revenue' with metadata filtering condition of
+  "doc.year=2022 AND doc.ticker='AAPL' and doc.filing_type='10K'"
+
+Note that `tool_args_type` is an optional dictionary that indicates the level at which metadata filtering
+is applied for each argument (`doc` or `part`)
+
+### Creating a Vectara search tool
+
+The Vectara search tool allows the agent to list documents that match a query.
+This can be helpful to the agent to answer queries like "how many documents discuss the iPhone?" or other
+similar queries that require a response in terms of a list of matching documents.
+
+## 🛠️ Agent Tools at a Glance
 
 `vectara-agentic` provides a few tools out of the box:
 1. **Standard tools**: 
@@ -206,10 +287,9 @@ print(response)
 - `load_unique_values`: returns the top unique values for a given column
 
 In addition, we include various other tools from LlamaIndex ToolSpecs:
-* Tavily search
-* EXA.AI
+* Tavily search and EXA.AI
 * arxiv
-* neo4j & Kuzu for Graph integration
+* neo4j & Kuzu for Graph DB integration
 * Google tools (including gmail, calendar, and search)
 * Slack
 
@@ -226,16 +306,19 @@ mult_tool = ToolsFactory().create_tool(mult_func)
 
 ## 🛠️ Configuration
 
-Configure `vectara-agentic` using environment variables:
-
+The main way to control the behavior of `vectara-agentic` is by passing an `AgentConfig` object to your `Agent` when creating it.
+This object will include the following items:
 - `VECTARA_AGENTIC_AGENT_TYPE`: valid values are `REACT`, `LLMCOMPILER`, `LATS` 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_LLM_PROVIDER`: valid values are `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, `COHERE`, `BEDROCK`, `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`)
+- `VECTARA_AGENTIC_API_KEY`: a secret key if using the API endpoint option (defaults to `dev-api-key`)
 
-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).
+If any of these are not provided, `AgentConfig` first tries to read the values from the OS environment.
+
+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 (`VECTARA_API_KEY`, `VECTARA_CUSTOMER_ID` and `VECTARA_CORPUS_ID`). 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
 
@@ -260,7 +343,8 @@ The `Agent` class supports serialization. Use the `dumps()` to serialize and `lo
 ###  Observability
 
 vectara-agentic supports observability via the existing integration of LlamaIndex and Arize Phoenix.
-First, set `os["VECTARA_AGENTIC_OBSERVER_TYPE"] = "ARIZE_PHOENIX"`.
+First, set `VECTARA_AGENTIC_OBSERVER_TYPE` to `ARIZE_PHOENIX` in `AgentConfig` (or env variable).
+
 Then you can use Arize Phoenix in three ways: 
 1. **Locally**. 
    1. If you have a local phoenix server that you've run using e.g. `python -m phoenix.server.main serve`, vectara-agentic will send all traces to it.
@@ -268,7 +352,7 @@ Then you can use Arize Phoenix in three ways:
    3. In both cases, traces will be sent to the local instance, and you can see the dashboard at `http://localhost:6006`
 2. **Hosted Instance**. In this case the traces are sent to the Phoenix instances hosted on Arize.
    1. Go to `https://app.phoenix.arize.com`, setup an account if you don't have one.
-   2. create an API key and put it in the `PHOENIX_API_KEY` variable. This variable indicates you want to use the hosted version.
+   2. create an API key and put it in the `PHOENIX_API_KEY` environment variable - this indicates you want to use the hosted version.
    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. 

vectara_agentic-0.1.25.dist-info/RECORD

@@ -0,0 +1,21 @@
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_agent.py,sha256=8LQlny0rIuVa13LGtebG0vatES6Ln7gmenbSwX-ctrY,4260
+tests/test_tools.py,sha256=2ofZYz3Q-YMSxjpiEg1VNUlA9gMjvNAcJAO2Ucd0eVE,2969
+vectara_agentic/__init__.py,sha256=ADH4fPKLbpGNYYYszv3c3QDOjPToPE_qh3LpkH_seCU,430
+vectara_agentic/_callback.py,sha256=OBiHk_OJZTS3iKz_LigfEjnl_p5V90XYsQC0vEYVSPo,8782
+vectara_agentic/_observability.py,sha256=HeQYJIkqPLW3EWHiXHatkaJzo08IQGESKujdeWTuRgk,3805
+vectara_agentic/_prompts.py,sha256=mgGx3zUJPtpS1epBLtl0BnoLeE7wb6AX1SX6dFNaTTQ,6368
+vectara_agentic/_version.py,sha256=90Cr_yLyeFeoJ2YK_LHwWc15gk11Emy9cx1xS0hlwtc,66
+vectara_agentic/agent.py,sha256=1-dno6FrC5sMuJ2nei9o2r3E53sg0dM6p-zn25hxRN0,25979
+vectara_agentic/agent_config.py,sha256=9P9lyFAAXLX1ft2dBQ6tYN7dKzp7SC7B-h-DnhUHsSg,2941
+vectara_agentic/agent_endpoint.py,sha256=QIMejCLlpW2qzXxeDAxv3anF46XMDdVMdKGWhJh3azY,1996
+vectara_agentic/db_tools.py,sha256=kCEENzmnorm8i-k4Kpd4KLJt1QWh_ZlAyX1aG-tzET0,3619
+vectara_agentic/tools.py,sha256=8FNnlTj57VTCYCaUfNWCongg38_lwnEoWdc2idCX6Jw,34087
+vectara_agentic/tools_catalog.py,sha256=DDHoPuA88jiixZjNSuGIuZCB7NSsQXdbbhrbVrtR2Ec,4141
+vectara_agentic/types.py,sha256=00wm3YsJRyddvIBzeVjF3qklA38NuTkCvy_B-e68v6c,1589
+vectara_agentic/utils.py,sha256=eDEOUpCkb0r216LxSLkamll2NmJhu76Z1TgQFbAVq7A,4690
+vectara_agentic-0.1.25.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+vectara_agentic-0.1.25.dist-info/METADATA,sha256=TtClmE0CpgC9qcJlSWxFnTywur0fFK3UkIKnmyZIkGs,19469
+vectara_agentic-0.1.25.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+vectara_agentic-0.1.25.dist-info/top_level.txt,sha256=Y7TQTFdOYGYodQRltUGRieZKIYuzeZj2kHqAUpfCUfg,22
+vectara_agentic-0.1.25.dist-info/RECORD,,

{vectara_agentic-0.1.23.dist-info → vectara_agentic-0.1.25.dist-info}/WHEEL

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

vectara_agentic-0.1.23.dist-info/RECORD

@@ -1,19 +0,0 @@
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/test_agent.py,sha256=aQYYr_8hKlFiDgyI5Dd39TG5vkmDJe7F_nIzMTCLsTQ,2517
-tests/test_tools.py,sha256=hDAlXkWKuXHnAjeQwMuTLTwNdRsM-xR7muBzFkZRefw,2942
-vectara_agentic/__init__.py,sha256=qmbzN20Bl7PTIgDB5Wpn0uBKyqMZxR2744Yn1LlqgcM,508
-vectara_agentic/_callback.py,sha256=OBiHk_OJZTS3iKz_LigfEjnl_p5V90XYsQC0vEYVSPo,8782
-vectara_agentic/_observability.py,sha256=v0xxTk8KI8nVK2rpyGqOVhyva9ymqOmZK5brKqFOwMM,3828
-vectara_agentic/_prompts.py,sha256=N656x-bfy9I5j2Lw51gpaGq_8R6zpPelPQ2-KWHHpTk,6160
-vectara_agentic/agent.py,sha256=Vr8R4sR_ZxJfGI94Jjze4r_rCCWYNvJ9UqsfjlAReWM,22045
-vectara_agentic/agent_endpoint.py,sha256=I3zTEezbAiNeW5I41r0NjIaR8Ucn4oe1XVcALekakaA,1959
-vectara_agentic/db_tools.py,sha256=kCEENzmnorm8i-k4Kpd4KLJt1QWh_ZlAyX1aG-tzET0,3619
-vectara_agentic/tools.py,sha256=lXkf1cMrK1NNORArhM3urT9_UoibiEa268oOB_3_hGk,25346
-vectara_agentic/tools_catalog.py,sha256=5NlJypdu0IKa7mODxVOwo05lw3PqQJtSl_ZOsUDH_TA,3986
-vectara_agentic/types.py,sha256=siRh9VmFt3jhTu4uJzYpvNlLi60lyIH5_xqYHKpB24Q,1149
-vectara_agentic/utils.py,sha256=XzSo5tKSsQpgd6Kx3q-XREohbyIe7-UqlpUW-9y1KeQ,3998
-vectara_agentic-0.1.23.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-vectara_agentic-0.1.23.dist-info/METADATA,sha256=e_sISyt8xk1ip2LtKfaSIvV_3O2w30jwj907I8cgueE,14683
-vectara_agentic-0.1.23.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-vectara_agentic-0.1.23.dist-info/top_level.txt,sha256=Y7TQTFdOYGYodQRltUGRieZKIYuzeZj2kHqAUpfCUfg,22
-vectara_agentic-0.1.23.dist-info/RECORD,,