Merge pull request #63 from tjaffri/tjaffri/llamaindex-sample

Updates to llamaindex sample docs and deps

Author: cristipufu

samples/quickstart-llamacloud/README.md

@@ -42,7 +42,7 @@ source .venv/bin/activate  # On Windows: .venv\Scripts\activate
 
 ```bash
 # Install the project dependencies
-pip install -e .
+uv sync
 ```
 
 ### 3. Configure Environment Variables
@@ -56,14 +56,18 @@ cp .env.example .env
 
 Required environment variables:
 - `OPENAI_API_KEY`: Your OpenAI API key
-- `LLAMACLOUD_API_KEY`: Your LlamaCloud API key
-- `LLAMACLOUD_ORG_ID`: Your LlamaCloud organization ID
+- `LLAMACLOUD_API_KEY`: Your LlamaCloud API key (find it under API keys in your LlamaCloud account)
+- `LLAMACLOUD_ORG_ID`: Your LlamaCloud organization ID (find it under settings in your LlamaCloud account)
 - `LLAMACLOUD_PROJECT_NAME`: Your LlamaCloud project name
 - `LLAMACLOUD_INDEX_1_NAME`: First index name (e.g., "company-policy")
 - `LLAMACLOUD_INDEX_2_NAME`: Second index name (e.g., "personal-preferences")
 
 ## 4. Authenticate With UiPath
 
+Install the uipath cli, e.g. using `pipx install uipath`.
+
+Next, auth with uipath:
+
 ```shell
 > uipath auth
 ⠋ Authenticating with UiPath ...
@@ -86,10 +90,15 @@ Selected tenant: Tenant1
 ### 6. Run Locally
 
 ```bash
-# Run the agent with a query
+# Simply run the agent with a query
 uipath run agent '{"user_msg": "What are the travel rates for New York?"}'
 ```
 
+```bash
+# Run the agent in CLI dev mode (you can enter the input user message and look at traces)
+uipath dev
+```
+
 ### 7. Run as a UiPath Deployment
 
 1. **Package your project:**

samples/quickstart-llamacloud/agent.mermaid

@@ -0,0 +1,36 @@
+flowchart TD
+    step__done["_done"]:::stepStyle
+    step_aggregate_tool_results["aggregate_tool_results"]:::stepStyle
+    step_call_tool["call_tool"]:::stepStyle
+    step_init_run["init_run"]:::stepStyle
+    step_parse_agent_output["parse_agent_output"]:::stepStyle
+    step_run_agent_step["run_agent_step"]:::stepStyle
+    step_setup_agent["setup_agent"]:::stepStyle
+    event_StopEvent([<p>StopEvent</p>]):::stopEventStyle
+    event_ToolCallResult([<p>ToolCallResult</p>]):::defaultEventStyle
+    event_AgentInput([<p>AgentInput</p>]):::defaultEventStyle
+    event_ToolCall([<p>ToolCall</p>]):::defaultEventStyle
+    event_AgentWorkflowStartEvent([<p>AgentWorkflowStartEvent</p>]):::defaultEventStyle
+    event_AgentOutput([<p>AgentOutput</p>]):::defaultEventStyle
+    event_AgentSetup([<p>AgentSetup</p>]):::defaultEventStyle
+    event_StopEvent --> step__done
+    step_aggregate_tool_results --> event_AgentInput
+    step_aggregate_tool_results --> event_StopEvent
+    event_ToolCallResult --> step_aggregate_tool_results
+    step_call_tool --> event_ToolCallResult
+    event_ToolCall --> step_call_tool
+    step_init_run --> event_AgentInput
+    event_AgentWorkflowStartEvent --> step_init_run
+    step_parse_agent_output --> event_StopEvent
+    step_parse_agent_output --> event_AgentInput
+    step_parse_agent_output --> event_ToolCall
+    event_AgentOutput --> step_parse_agent_output
+    step_run_agent_step --> event_AgentOutput
+    event_AgentSetup --> step_run_agent_step
+    step_setup_agent --> event_AgentSetup
+    event_AgentInput --> step_setup_agent
+    classDef stepStyle fill:#f2f0ff,line-height:1.2
+    classDef externalStyle fill:#f2f0ff,line-height:1.2
+    classDef defaultEventStyle fill-opacity:0
+    classDef stopEventStyle fill:#bfb6fc
+    classDef inputRequiredStyle fill:#f2f0ff,line-height:1.2

samples/quickstart-llamacloud/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "quickstart-llamacloud"
-version = "0.0.2"
+version = "0.0.4"
 description = "UiPath LlamaIndex Quickstart with LlamaCloud Integration"
 authors = [{ name = "Tuana Celik", email = "tuana@runllama.ai" }]
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"
 dependencies = [
-    "uipath-llamaindex>=0.0.11",
+    "uipath-llamaindex>=0.0.33",
     "llama-index-llms-openai>=0.2.2",
     "llama-cloud-services"
 ] 

samples/quickstart-llamacloud/uipath.json

@@ -22,7 +22,7 @@
         "properties": {
           "response": {
             "title": "Agent Response",
-            "type": "string",
+            "type": "object",
             "description": "The agent's response using available tools to search company policies and personal preferences"
           }
         },