Merge pull request #195 from UiPath/feature/add-llamaindex-chat-sample

feat: add llamaindex chat agent implementation

Author: GabrielVasilescu04

packages/uipath-llamaindex/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-llamaindex"
-version = "0.5.6"
+version = "0.5.7"
 description = "Python SDK that enables developers to build and deploy LlamaIndex agents to the UiPath Cloud Platform"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.11"

packages/uipath-llamaindex/samples/chat-agent/README.md

@@ -0,0 +1,30 @@
+# Literature Chat Agent
+
+An AI assistant using Llamaindex and Tavily search for literature research and recommendations.
+
+## Requirements
+
+- Python 3.11+
+- OpenAI API key
+- Tavily API key
+
+## Installation
+
+```bash
+uv venv -p 3.11 .venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv sync
+```
+
+Set your API keys as environment variables in .env
+
+```bash
+OPENAI_API_KEY=your_anthropic_api_key
+TAVILY_API_KEY=your_tavily_api_key
+```
+
+## Usage
+
+```bash
+uipath run agent '{"messages": [{"contentParts": [{"mimeType" :"text/plain", "data": {"inline": "Tell me about 1984 by George Orwell ?"}}], "role": "user"}]}'
+```

packages/uipath-llamaindex/samples/chat-agent/agent.mermaid

@@ -0,0 +1,19 @@
+flowchart TB
+  __start__(__start__)
+  aggregate_tool_results(aggregate_tool_results)
+  call_tool(call_tool)
+  init_run(init_run)
+  parse_agent_output(parse_agent_output)
+  run_agent_step(run_agent_step)
+  setup_agent(setup_agent)
+  __end__(__end__)
+  aggregate_tool_results --> |AgentInput|setup_agent
+  aggregate_tool_results --> |StopEvent|__end__
+  call_tool --> |ToolCallResult|aggregate_tool_results
+  __start__ --> |AgentWorkflowStartEvent|init_run
+  init_run --> |AgentInput|setup_agent
+  parse_agent_output --> |StopEvent|__end__
+  parse_agent_output --> |AgentInput|setup_agent
+  parse_agent_output --> |ToolCall|call_tool
+  run_agent_step --> |AgentOutput|parse_agent_output
+  setup_agent --> |AgentSetup|run_agent_step

packages/uipath-llamaindex/samples/chat-agent/llama_index.json

@@ -0,0 +1,5 @@
+{
+  "workflows": {
+    "agent": "main.py:agent"
+  }
+}

packages/uipath-llamaindex/samples/chat-agent/main.py

@@ -0,0 +1,29 @@
+import os
+
+from llama_index.core.agent.workflow import AgentWorkflow
+from llama_index.llms.openai import OpenAI
+from llama_index.tools.tavily_research import TavilyToolSpec
+
+llm = OpenAI(model="gpt-4o-mini")
+tavily_tool = TavilyToolSpec(api_key=os.environ["TAVILY_API_KEY"])
+
+SYSTEM_PROMPT = (
+    "You are an advanced AI assistant specializing in book research and literature analysis. "
+    "Your primary functions are:\n\n"
+    "1. Book Information Research: Gather comprehensive information about books, including plot summaries, "
+    "themes, publishing details, sales performance, critical reception, and awards.\n"
+    "2. Author Research: Provide detailed information about authors, translators, editors, and other "
+    "publishing industry professionals.\n"
+    "3. Book Recommendations: Suggest books based on user preferences, genres, themes, or similar books "
+    "they have enjoyed.\n"
+    "4. Publishing Industry Analysis: Analyze trends, bestseller data, genre popularity, and insights "
+    "from the literary world.\n"
+    "5. Book Trivia and Facts: Share interesting facts, behind-the-scenes stories, and trivia about "
+    "books, authors, and the publishing industry.\n\n"
+    "Use the search tool for recent or factual information. "
+    "Remember previous messages and maintain context across the discussion."
+)
+
+agent = AgentWorkflow.from_tools_or_functions(
+    tools_or_functions=tavily_tool.to_tool_list(), llm=llm, system_prompt=SYSTEM_PROMPT
+)

packages/uipath-llamaindex/samples/chat-agent/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "chat-agent"
+version = "0.0.1"
+description = "chat-agent"
+authors = [{ name = "John Doe", email = "john.doe@myemail.com" }]
+dependencies = [
+    "uipath-llamaindex>=0.5.7, <0.6.0",
+    "llama-index-llms-openai>=0.6.10",
+    "llama-index-tools-tavily-research>=0.4.2",
+    "llama-index-llms-openai>=0.6.18"
+]
+requires-python = ">=3.11"
+
+
+[dependency-groups]
+dev = [
+     "uipath-dev>=0.0.19",
+]
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true
+
+[tool.uv.sources]
+uipath-llamaindex = { index = "testpypi" }

packages/uipath-llamaindex/samples/chat-agent/uipath.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://cloud.uipath.com/draft/2024-12/uipath",
+  "runtimeOptions": {
+    "isConversational": true
+  },
+  "packOptions": {
+    "fileExtensionsIncluded": [],
+    "filesIncluded": [],
+    "filesExcluded": [],
+    "directoriesExcluded": [],
+    "includeUvLock": true
+  },
+  "functions": {}
+}

packages/uipath-llamaindex/src/uipath_llamaindex/runtime/chat/__init__.py

@@ -0,0 +1,3 @@
+from uipath_llamaindex.runtime.chat.messages import UiPathChatMessagesMapper
+
+__all__ = ["UiPathChatMessagesMapper"]