vectara-agentic 0.1.0__tar.gz

vectara_agentic-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

vectara_agentic-0.1.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include LICENSE
+include requirements.txt
+global-exclude *.pyc
+
+recursive-include vectara-agentic *.py
+recursive-include tests *.py

vectara_agentic-0.1.0/PKG-INFO

@@ -0,0 +1,190 @@
+Metadata-Version: 2.1
+Name: vectara_agentic
+Version: 0.1.0
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# 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)
+
+
+The idea of LLM-based agents it to use the LLM for building sophisticated AI assistants:
+- The LLM is used for reasoning and coming up with a game-plan for how to respond to the user query.
+- There are 1 or more "tools" provided to the agent. These tools can be used by the LLM to execute its plan.
+
+`vectara-agentic` is a Python library that let's you develop powerful AI assistants with Vectara, using Agentic-RAG:
+* Based on LlamaIndex Agent framework, customized for use with Vectara.
+* Supports the `ReAct` or `OpenAIAgent` agent types.
+* Includes many tools out of the box (e.g. for finance, legal and other verticals).
+
+## Getting Started
+
+### Prerequisites
+* A [Vectara account](https://console.vectara.com/signup)
+* A Vectara corpus with an [API key](https://docs.vectara.com/docs/api-keys)
+* [Python 3.10 (or higher)](https://www.python.org/downloads/)
+* An OpenAI API key specified in your environment as `OPENAI_API_KEY`
+
+### Install vectara-agentic
+
+- `python -m pip install vectara-agentic`
+
+### Create your AI assistant
+
+Creating an AI assistant with `vectara-agentic` involves the following:
+
+#### Step 1: Create Vectara RAG tool
+
+First, create an instance of the `VectaraToolFactory` class as follows:
+
+```python
+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'])
+```
+The tools factory has a useful helper function called `create_rag_tool` which automates the creation of a 
+tool to query Vectara RAG. 
+
+For example if my Vectara corpus includes financial information from company 
+10K annual reports for multiple companies and years, I can use the following:
+
+```python
+
+class QueryFinancialReportsArgs(BaseModel):
+    query: str = Field(..., description="The user query. Must be a question about the company's financials, and should not include the company name, ticker or year.")
+    year: int = Field(..., description=f"The year. an integer.")
+    ticker: str = Field(..., description=f"The company ticker. Must be a valid ticket symbol.")
+query_financial_reports = vec_factory.create_rag_tool(
+    tool_name = "query_financial_reports",
+    tool_description = """
+    Given a company name and year, 
+    returns a response (str) to a user query about the company's financials for that year.
+    When using this tool, make sure to provide a valid company ticker and year. 
+    Use this tool to get financial information one metric at a time.
+    """,
+    tool_args_schema = QueryFinancialReportsArgs,
+    tool_filter_template = "doc.year = {year} and doc.ticker = '{ticker}'"
+)
+```
+Note how `QueryFinancialReportsArgs` defines the arguments for my tool using pydantic's `Field` class. The `tool_description` 
+as well as the description of each argument are important as they provide the LLM with the ability to understand how to use 
+this tool in the most effective way.
+The `tool_filter_template` provides the template filtering expression the tool should use when calling Vectara.
+
+You can of course create more than one Vectara tool; tools may point at different corpora or may have different parameters for search
+or generation. Remember though to think about your tools wisely and from the agent point of view - at the end of the day they are just tools
+in the service of the agent, so should be differentiated.
+
+#### Step 2: Create Other Tools, as needed
+
+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, and much more.
+
+`vectara-agentic` provides a few tools out of the box:
+1. Standard tools: 
+- `get_current_date`: allows the agent to figure out which date it is.
+- `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. Financial tools: a set of tools for financial analysis of public company data:
+- `get_company_name`: get company name given its ticker (uses Yahoo Finance)
+- `calculate_return_on_equity`, `calculate_return_on_assets`, `calculate_debt_to_equity_ratio` and `calculate_ebitda`
+
+You can create your own tool directly from a Python function using the `create_tool()` method:
+
+```Python
+def mult_func(x, y):
+    return x*y
+
+mult_tool = ToolsFactory().create_tool(mult_func)
+```
+
+3. More tools to be coming soon
+ 
+#### Step 3: Create your agent
+
+```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
+- `update_func` is a callback function that will be called by the agent as it performs its task
+  The inputs to this function you provide are `status_type` of type AgentStatusType and 
+  `msg` which is a string.
+
+For example, for a financial agent we can use:
+
+```python
+topic = "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.
+    """
+```
+## Configuration
+
+`vectara-agentic` is using environment variables for a few global configuration 
+- `VECTARA_AGENTIC_AGENT_TYPE`: type of agent - `REACT` or `OPENAI` (default `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_LLM_PROVIDER`: agent LLM provider `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, or `FIREWORKS` (default `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_MODEL_NAME`: agent model name (default depends on provider)
+- `VECTARA_AGENTIC_TOOL_LLM_PROVIDER`: tool LLM provider `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, or `FIREWORKS` (default `OPENAI`)
+- `VECTARA_AGENTIC_TOOL_MODEL_NAME`: tool model name (default depends on provider)
+
+## Examples
+
+We have created a few example AI assistants that you can look at for inspiration and code examples:
+- [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).
+
+## Author
+
+👤 **Vectara**
+
+- Website: [vectara.com](https://vectara.com)
+- Twitter: [@vectara](https://twitter.com/vectara)
+- GitHub: [@vectara](https://github.com/vectara)
+- LinkedIn: [@vectara](https://www.linkedin.com/company/vectara/)
+- Discord: [@vectara](https://discord.gg/GFb8gMz6UH)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome and appreciated!<br />
+Feel free to check [issues page](https://github.com/vectara/py-vectara-agentic/issues). You can also take a look at the [contributing guide](https://github.com/vectara/py-vectara-agentic/blob/master/CONTRIBUTING.md).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2024 [Vectara](https://github.com/vectara).<br />
+This project is [Apache 2.0](https://github.com/vectara/py-vectara-agentic/blob/master/LICENSE) licensed.

vectara_agentic-0.1.0/README.md

@@ -0,0 +1,176 @@
+# 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)
+
+
+The idea of LLM-based agents it to use the LLM for building sophisticated AI assistants:
+- The LLM is used for reasoning and coming up with a game-plan for how to respond to the user query.
+- There are 1 or more "tools" provided to the agent. These tools can be used by the LLM to execute its plan.
+
+`vectara-agentic` is a Python library that let's you develop powerful AI assistants with Vectara, using Agentic-RAG:
+* Based on LlamaIndex Agent framework, customized for use with Vectara.
+* Supports the `ReAct` or `OpenAIAgent` agent types.
+* Includes many tools out of the box (e.g. for finance, legal and other verticals).
+
+## Getting Started
+
+### Prerequisites
+* A [Vectara account](https://console.vectara.com/signup)
+* A Vectara corpus with an [API key](https://docs.vectara.com/docs/api-keys)
+* [Python 3.10 (or higher)](https://www.python.org/downloads/)
+* An OpenAI API key specified in your environment as `OPENAI_API_KEY`
+
+### Install vectara-agentic
+
+- `python -m pip install vectara-agentic`
+
+### Create your AI assistant
+
+Creating an AI assistant with `vectara-agentic` involves the following:
+
+#### Step 1: Create Vectara RAG tool
+
+First, create an instance of the `VectaraToolFactory` class as follows:
+
+```python
+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'])
+```
+The tools factory has a useful helper function called `create_rag_tool` which automates the creation of a 
+tool to query Vectara RAG. 
+
+For example if my Vectara corpus includes financial information from company 
+10K annual reports for multiple companies and years, I can use the following:
+
+```python
+
+class QueryFinancialReportsArgs(BaseModel):
+    query: str = Field(..., description="The user query. Must be a question about the company's financials, and should not include the company name, ticker or year.")
+    year: int = Field(..., description=f"The year. an integer.")
+    ticker: str = Field(..., description=f"The company ticker. Must be a valid ticket symbol.")
+query_financial_reports = vec_factory.create_rag_tool(
+    tool_name = "query_financial_reports",
+    tool_description = """
+    Given a company name and year, 
+    returns a response (str) to a user query about the company's financials for that year.
+    When using this tool, make sure to provide a valid company ticker and year. 
+    Use this tool to get financial information one metric at a time.
+    """,
+    tool_args_schema = QueryFinancialReportsArgs,
+    tool_filter_template = "doc.year = {year} and doc.ticker = '{ticker}'"
+)
+```
+Note how `QueryFinancialReportsArgs` defines the arguments for my tool using pydantic's `Field` class. The `tool_description` 
+as well as the description of each argument are important as they provide the LLM with the ability to understand how to use 
+this tool in the most effective way.
+The `tool_filter_template` provides the template filtering expression the tool should use when calling Vectara.
+
+You can of course create more than one Vectara tool; tools may point at different corpora or may have different parameters for search
+or generation. Remember though to think about your tools wisely and from the agent point of view - at the end of the day they are just tools
+in the service of the agent, so should be differentiated.
+
+#### Step 2: Create Other Tools, as needed
+
+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, and much more.
+
+`vectara-agentic` provides a few tools out of the box:
+1. Standard tools: 
+- `get_current_date`: allows the agent to figure out which date it is.
+- `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. Financial tools: a set of tools for financial analysis of public company data:
+- `get_company_name`: get company name given its ticker (uses Yahoo Finance)
+- `calculate_return_on_equity`, `calculate_return_on_assets`, `calculate_debt_to_equity_ratio` and `calculate_ebitda`
+
+You can create your own tool directly from a Python function using the `create_tool()` method:
+
+```Python
+def mult_func(x, y):
+    return x*y
+
+mult_tool = ToolsFactory().create_tool(mult_func)
+```
+
+3. More tools to be coming soon
+ 
+#### Step 3: Create your agent
+
+```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
+- `update_func` is a callback function that will be called by the agent as it performs its task
+  The inputs to this function you provide are `status_type` of type AgentStatusType and 
+  `msg` which is a string.
+
+For example, for a financial agent we can use:
+
+```python
+topic = "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.
+    """
+```
+## Configuration
+
+`vectara-agentic` is using environment variables for a few global configuration 
+- `VECTARA_AGENTIC_AGENT_TYPE`: type of agent - `REACT` or `OPENAI` (default `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_LLM_PROVIDER`: agent LLM provider `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, or `FIREWORKS` (default `OPENAI`)
+- `VECTARA_AGENTIC_MAIN_MODEL_NAME`: agent model name (default depends on provider)
+- `VECTARA_AGENTIC_TOOL_LLM_PROVIDER`: tool LLM provider `OPENAI`, `ANTHROPIC`, `TOGETHER`, `GROQ`, or `FIREWORKS` (default `OPENAI`)
+- `VECTARA_AGENTIC_TOOL_MODEL_NAME`: tool model name (default depends on provider)
+
+## Examples
+
+We have created a few example AI assistants that you can look at for inspiration and code examples:
+- [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).
+
+## Author
+
+👤 **Vectara**
+
+- Website: [vectara.com](https://vectara.com)
+- Twitter: [@vectara](https://twitter.com/vectara)
+- GitHub: [@vectara](https://github.com/vectara)
+- LinkedIn: [@vectara](https://www.linkedin.com/company/vectara/)
+- Discord: [@vectara](https://discord.gg/GFb8gMz6UH)
+
+## 🤝 Contributing
+
+Contributions, issues and feature requests are welcome and appreciated!<br />
+Feel free to check [issues page](https://github.com/vectara/py-vectara-agentic/issues). You can also take a look at the [contributing guide](https://github.com/vectara/py-vectara-agentic/blob/master/CONTRIBUTING.md).
+
+## Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 📝 License
+
+Copyright © 2024 [Vectara](https://github.com/vectara).<br />
+This project is [Apache 2.0](https://github.com/vectara/py-vectara-agentic/blob/master/LICENSE) licensed.

vectara_agentic-0.1.0/requirements.txt

@@ -0,0 +1,20 @@
+llama-index==0.10.64
+llama-index-indices-managed-vectara==0.1.7
+llama-index-agent-llm-compiler==0.1.0
+llama-index-agent-openai==0.2.9
+llama-index-llms-openai==0.1.29
+llama-index-llms-anthropic==0.1.17
+llama-index-llms-together==0.1.3
+llama-index-llms-groq==0.1.4
+llama-index-tools-yahoo-finance==0.1.1
+llama-index-tools-arxiv==0.1.3
+llama-index-tools-database==0.1.3
+llama-index-tools-google==0.1.6
+llama-index-tools-tavily_research==0.1.3
+llama-index-llms-fireworks==0.1.8
+pydantic==1.10.17
+retrying==1.3.4
+mypy==1.11.0
+pylint==3.2.6
+flake8==7.1.0
+pymongo==4.6.1

vectara_agentic-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

vectara_agentic-0.1.0/setup.py

@@ -0,0 +1,26 @@
+from setuptools import setup, find_packages
+
+
+def read_requirements():
+    with open("requirements.txt") as req:
+        return req.read().splitlines()
+
+
+setup(
+    name="vectara_agentic",
+    version="0.1.0",
+    author="Ofer Mendelevitch",
+    author_email="ofer@vectara.com",
+    description="A Python package for creating AI Assistants and AI Agents with Vectara",
+    long_description=open("README.md").read(),
+    long_description_content_type="text/markdown",
+    url="https://github.com/vectara/py-vectara-agentic",
+    packages=find_packages(),
+    install_requires=read_requirements(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.10",
+)