vectara-agentic 0.1.14__py3-none-any.whl → 0.1.16__py3-none-any.whl

{vectara_agentic-0.1.14.dist-info → vectara_agentic-0.1.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: vectara_agentic
-Version: 0.1.14
+Version: 0.1.16
 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,17 +16,17 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: llama-index==0.11.13
+Requires-Dist: llama-index==0.11.18
 Requires-Dist: llama-index-indices-managed-vectara==0.2.2
 Requires-Dist: llama-index-agent-llm-compiler==0.2.0
 Requires-Dist: llama-index-agent-openai==0.3.4
-Requires-Dist: llama-index-llms-openai==0.2.9
-Requires-Dist: llama-index-llms-anthropic==0.3.1
+Requires-Dist: llama-index-llms-openai==0.2.15
+Requires-Dist: llama-index-llms-anthropic==0.3.6
 Requires-Dist: llama-index-llms-together==0.2.0
 Requires-Dist: llama-index-llms-groq==0.2.0
-Requires-Dist: llama-index-llms-fireworks==0.2.0
-Requires-Dist: llama-index-llms-cohere==0.3.0
-Requires-Dist: llama-index-llms-gemini==0.3.5
+Requires-Dist: llama-index-llms-fireworks==0.2.2
+Requires-Dist: llama-index-llms-cohere==0.3.1
+Requires-Dist: llama-index-llms-gemini==0.3.7
 Requires-Dist: llama-index-tools-yahoo-finance==0.2.0
 Requires-Dist: llama-index-tools-arxiv==0.2.0
 Requires-Dist: llama-index-tools-database==0.2.0
@@ -46,7 +46,7 @@ Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: tiktoken==0.7.0
 Requires-Dist: dill==0.3.8
 
-# <img src=".github/assets/Vectara-logo.png" alt="Vectara Logo" width="30" height="30" style="vertical-align: middle;"> vectara-agentic
+# <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
 
 <p align="center">
   <a href="https://vectara.github.io/vectara-agentic-docs">Documentation</a> ·
@@ -68,13 +68,29 @@ Requires-Dist: dill==0.3.8
 
 ## ✨ 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.
+`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.
 
-###  Key Features
+<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;">
+</p>
+
+###  Features
 
+- Enables easy creation of custom AI assistants and agents.
+- Create a Vectara RAG tool with a single line of code.
 - 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.
+- Integrates with various LLM inference services like OpenAI, Anthropic, Gemini, GROQ, Together.AI, Cohere and Fireworks
+- Built-in support for observability with Arize Phoenix
+
+### 📚 Example AI Assistants
+
+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)
+
 
 ###  Prerequisites
 
@@ -197,7 +213,15 @@ When creating a VectaraToolFactory, you can pass in a `vectara_api_key`, `vectar
 
 ## ℹ️ Additional Information
 
-###  Agent Diagnostics
+### About Custom Instructions for your Agent
+
+The custom instructions you provide to the agent guide its behavior.
+Here are some guidelines when creating your instructions:
+- Write precise and clear instructions, without overcomplicating.
+- 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.
+
+###  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.
@@ -224,21 +248,43 @@ Then you can use Arize Phoenix in three ways:
 Now when you run your agent, all call traces are sent to Phoenix and recorded. 
 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
+## 🌐 API Endpoint
 
-The custom instructions you provide to the agent guide its behavior.
-Here are some guidelines when creating your instructions:
-- Write precise and clear instructions, without overcomplicating.
-- 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.
+`vectara-agentic` can be easily hosted locally or on a remote machine behind an API endpoint, by following theses steps:
 
-## 📚 Examples
+### Step 1: Setup your API key
+Ensure that you have your API key set up as an environment variable:
 
-Check out our example AI assistants:
+```
+export VECTARA_AGENTIC_API_KEY=<YOUR-ENDPOINT-API-KEY>
+```
 
-- [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)
+### Step 2: Start the API Server
+Initialize the agent and start the FastAPI server by following this example:
+
+
+```
+from agent import Agent
+from agent_endpoint import start_app
+agent = Agent(...)            # Initialize your agent with appropriate parameters
+start_app(agent)
+```
+
+You can customize the host and port by passing them as arguments to `start_app()`:
+* Default: host="0.0.0.0" and port=8000.
+For example:
+```
+start_app(agent, host="0.0.0.0", port=8000)
+```
+
+### Step 3: Access the API Endpoint
+Once the server is running, you can interact with it using curl or any HTTP client. For example:
+
+```
+curl -G "http://<remote-server-ip>:8000/chat" \
+--data-urlencode "message=What is Vectara?" \
+-H "X-API-Key: <YOUR-API-KEY>"
+```
 
 ## 🤝 Contributing
 

vectara_agentic-0.1.16.dist-info/RECORD

@@ -0,0 +1,18 @@
+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=ZlASMUqOFi5HTDFaRUEB3Egf_nUuUtr1X-TjPkZceLc,508
+vectara_agentic/_callback.py,sha256=EexD7-Qx2lZuQk4kjzwvIJAyfIzroWKz2VaVPD4TTkM,4621
+vectara_agentic/_observability.py,sha256=v0xxTk8KI8nVK2rpyGqOVhyva9ymqOmZK5brKqFOwMM,3828
+vectara_agentic/_prompts.py,sha256=CxSKueS4lF130VMSovFKeapTM9DZ8Ja4akEFIw7q0Ks,5670
+vectara_agentic/agent.py,sha256=9nzPVb16wpeT5RiWQJiO5LuR9VTYp8yScKUqqgem7h8,19963
+vectara_agentic/agent_endpoint.py,sha256=I3zTEezbAiNeW5I41r0NjIaR8Ucn4oe1XVcALekakaA,1959
+vectara_agentic/tools.py,sha256=_rXEK9tuuDMM_Zf04AoehklydTMSb1esqEYkNjLvmyY,20103
+vectara_agentic/tools_catalog.py,sha256=CpFTTyocsTu-Sx8KjqSsZZhLditSrV-vRZd2YMFU0AY,4940
+vectara_agentic/types.py,sha256=FbZXc5oPje6kdimfrksDc8F-tYHSLK8ReAv7O291YkI,1131
+vectara_agentic/utils.py,sha256=7DgzU_hZIODrzuEfP8HP7l2dO9zEt8BObhO2tCTijow,3819
+vectara_agentic-0.1.16.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+vectara_agentic-0.1.16.dist-info/METADATA,sha256=QYMmXzZBZwLvgr9rcx4dt0aE-upuJ3mqlJi7v5vt0T0,13595
+vectara_agentic-0.1.16.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+vectara_agentic-0.1.16.dist-info/top_level.txt,sha256=Y7TQTFdOYGYodQRltUGRieZKIYuzeZj2kHqAUpfCUfg,22
+vectara_agentic-0.1.16.dist-info/RECORD,,

{vectara_agentic-0.1.14.dist-info → vectara_agentic-0.1.16.dist-info}/WHEEL

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

vectara_agentic-0.1.14.dist-info/RECORD

@@ -1,17 +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=Byj1d6B-DWzwa-vvRsbh4dcfHDgH5AnP-AUaBFLi7c0,449
-vectara_agentic/_callback.py,sha256=oRbGfSZtoG6UZA0LLbHtoUd1b3v7ACoc_CvIcHQOSqM,4670
-vectara_agentic/_observability.py,sha256=6QGcVGt5mf0IXTS5EMZ6jUGCqZwZ6DGeTtPFnOnGSKg,3694
-vectara_agentic/_prompts.py,sha256=BhvNiGcmkt7aIf888FtG4Pum-ZEh--pbqtTp70ZISoY,4729
-vectara_agentic/agent.py,sha256=DBTAVup0lZe-gG_nCXzxcdtX7XUDSeW7dAg7eNsAQac,18414
-vectara_agentic/tools.py,sha256=HMXvCcEqXszlidoFigEutuk-7WlJlkeG_fc6Jr_gG_A,19455
-vectara_agentic/tools_catalog.py,sha256=qojmqmA3DGYzA0mdeS0vycCh7w_R-3RMoV56lyYrbhw,5519
-vectara_agentic/types.py,sha256=SGkqKusZC6RpRnWdD2YSUq4uMQ3B4jP6qBWehPmeOdI,1132
-vectara_agentic/utils.py,sha256=TY0EHZ1vyc_xNKJoJYGdIce21_M3tQI50Hjumv-eOII,3797
-vectara_agentic-0.1.14.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-vectara_agentic-0.1.14.dist-info/METADATA,sha256=_OpYgV5AkGZerUdZ34YweTU9SW4uPsAp87AgNofq4RE,12014
-vectara_agentic-0.1.14.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-vectara_agentic-0.1.14.dist-info/top_level.txt,sha256=Y7TQTFdOYGYodQRltUGRieZKIYuzeZj2kHqAUpfCUfg,22
-vectara_agentic-0.1.14.dist-info/RECORD,,