vectara-agentic

License Maintained Twitter Discord

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

  • Supports ReAct and OpenAIAgent agent types.
  • Includes pre-built tools for various domains (e.g., finance, legal).
  • Enables easy creation of custom AI assistants and agents.

Important Links

Prerequisites

Installation

pip install vectara-agentic

Quick Start

  1. Create a Vectara RAG tool
import os
from vectara_agentic import VectaraToolFactory

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']
)

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_financial_reports = vec_factory.create_rag_tool(
    tool_name="query_financial_reports",
    tool_description="Query financial reports for a company and year",
    tool_args_schema=QueryFinancialReportsArgs,
)
  1. 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 for more information.

  1. Create your agent
agent = Agent(
    tools = [query_financial_reports],
    topic = topic_of_expertise,
    custom_instructions = financial_bot_instructions,
)
  • 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:

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.
    """

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 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

vectara-agentic provides a few tools out of the box:

  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)
  1. 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
  1. 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.
  1. database_tools: providing a few 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.

You can create your own tool directly from a Python function using the create_tool() method of the ToolsFactor class:

def mult_func(x, y):
    return x*y

mult_tool = ToolsFactory().create_tool(mult_func)

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.

Examples

Check out our example AI assistants:

Contributing

We welcome contributions! Please see our contributing guide for more information.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for details.

Contact

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.4.10)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ofermend from gravatar.com ofermend

Credits

Author: Ofer Mendelevitch

License

Apache Software License

Requires

Python >=3.10

Tags

LLM NLP RAG Agentic-RAG

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vectara_agentic-0.1.8.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vectara_agentic-0.1.8-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file vectara_agentic-0.1.8.tar.gz.

File metadata

  • Download URL: vectara_agentic-0.1.8.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for vectara_agentic-0.1.8.tar.gz
Algorithm Hash digest
SHA256 1675c5276eb010d172c84ed120c246c69fa9af6e5ba9295e15c39d9214a377d3
MD5 1a4d8d7725b0f5b4fdfa4b787ca41ff3
BLAKE2b-256 d613a70e68e960a906b4010f553ac0c85ed84a40142d9f5e5accea76d690496c

See more details on using hashes here.

File details

Details for the file vectara_agentic-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for vectara_agentic-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9b2b206d177f36445b8ac61780c0b498ca99e1b7db587db33fb57e7f85b3ec9a
MD5 115fca7542ec3836c7b04ac686667730
BLAKE2b-256 d0a6a3361a503fe36cbad9d7b21811df721afac8f40c39386916cdc699b2b765

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.24

2 files

0.2.23

2 files

0.2.22

2 files

0.2.21

2 files

0.2.20

2 files

0.2.19

2 files

0.2.18

2 files

0.2.17

2 files

0.2.16

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.28

2 files

0.1.27

2 files

0.1.26

2 files

0.1.25

2 files

0.1.24

2 files

0.1.23

2 files

0.1.22

2 files

0.1.21

2 files

0.1.20

2 files

0.1.19

2 files

0.1.18

2 files

0.1.17

2 files

0.1.16

2 files

0.1.15

2 files

Yanked

0.1.14

2 files

Yanked reason: Issue with guardrail tools

0.1.13

2 files

Yanked

0.1.12

2 files

Yanked reason: Issue with requirements may cause installation to fail

Yanked

0.1.11

2 files

Yanked reason: Missing a requirements

0.1.10

2 files

0.1.9

2 files

This release

0.1.8 This release

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page