uipath-langchain 0.0.108__tar.gz → 0.0.110__tar.gz

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/.github/workflows/cd.yml

@@ -2,7 +2,8 @@ name: CD
 
 on:
   workflow_run:
-    workflows: ["Core CI"]
+    workflows:
+      - CI
     types:
       - completed
 

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/.github/workflows/ci.yml

@@ -1,18 +1,20 @@
-name: Core CI
+name: CI
 
 on:
-  workflow_dispatch: {}
   push:
     branches:
       - main
-  pull_request:
+  pull_request_target:
+    types:
+      - opened
+      - synchronize
     branches:
       - main
 
 
 jobs:
   commit-lint:
-    if: ${{ github.event_name == 'pull_request' }}
+    if: ${{ github.event_name == 'pull_request_target' }}
     uses: ./.github/workflows/commitlint.yml
   lint:
     uses: ./.github/workflows/lint.yml

uipath_langchain-0.0.110/.github/workflows/commitlint.yml

@@ -0,0 +1,43 @@
+name: Commit Lint
+
+on:
+  workflow_call
+
+jobs:
+  commitlint:
+    name: Commit Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 22
+
+      - name: Install Git
+        run: |
+          if ! command -v git &> /dev/null; then
+              echo "Git is not installed. Installing..."
+              sudo apt-get update
+              sudo apt-get install -y git
+          else
+              echo "Git is already installed."
+          fi
+
+      - name: Install commitlint
+        run: |
+          npm install conventional-changelog-conventionalcommits
+          npm install commitlint@latest
+          npm install @commitlint/config-conventional
+
+      - name: Configure
+        run: |
+          echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
+
+      - name: Validate PR commits with commitlint
+        run: |
+          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr_branch
+          npx commitlint --from ${{ github.event.pull_request.base.sha }} --to pr_branch --verbose

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/.github/workflows/lint.yml

@@ -1,20 +1,12 @@
-name: Reusable Lint Workflow
+name: Lint
 
 on:
-  workflow_call:
-    inputs:
-      should_skip:
-        description: 'Whether to skip the linting step'
-        required: false
-        type: boolean
-        default: false
+  workflow_call
 
 jobs:
   lint:
     name: Lint
-    runs-on: "ubuntu-24.04"
-    if: inputs.should_skip == false
-
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
@@ -30,7 +22,7 @@ jobs:
           uv venv
           uv sync --all-extras
 
-      - name: "Check static types"
+      - name: Check static types
         run: |
           uv run mypy --config-file pyproject.toml .
 
@@ -38,7 +30,7 @@ jobs:
         run: |
           uv run ruff check .
 
-      - name: "Check formatting"
+      - name: Check formatting
         run: |
           uv run ruff format --check .
 

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/.github/workflows/slack.yml

@@ -1,7 +1,7 @@
 name: GitHub Reviewer Slack Agent
 
 on:
-  pull_request:
+  pull_request_target:
     types: [opened]
 
 jobs:

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Reusable Test Workflow
+name: Test
 
 on:
   workflow_call:
@@ -9,18 +9,11 @@ on:
         required: true
       UIPATH_CLIENT_SECRET:
         required: true
-    inputs:
-      should_skip:
-          description: 'Whether to skip the linting step'
-          required: false
-          type: boolean
-          default: false
 
 jobs:
   test:
     name: Test
-    runs-on: "ubuntu-24.04"
-    if: inputs.should_skip == false
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
@@ -31,16 +24,15 @@ jobs:
         with:
           python-version-file: ".python-version"
 
-      - name: "Setup venv"
+      - name: Setup venv
         run: |
           uv venv
           uv sync --all-extras
 
-      - name: "Run tests"
+      - name: Run tests
         run: |
           uv run pytest
         env:
           UIPATH_URL: ${{ secrets.UIPATH_URL }}
           UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
           UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
-

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath-langchain
-Version: 0.0.108
+Version: 0.0.110
 Summary: UiPath Langchain
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-langchain-python
@@ -24,7 +24,7 @@ Requires-Dist: langgraph>=0.2.70
 Requires-Dist: openai>=1.65.5
 Requires-Dist: pydantic-settings>=2.6.0
 Requires-Dist: python-dotenv>=1.0.1
-Requires-Dist: uipath<2.1.0,>=2.0.33
+Requires-Dist: uipath<2.1.0,>=2.0.55
 Provides-Extra: langchain
 Description-Content-Type: text/markdown
 

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/docs/chat_models.md

@@ -26,7 +26,7 @@ llm = ChatOpenAI(
 )
 ```
 
-You can simply change `ChatOpenAi` with `UiPathAzureChatOpenAI`, you don't have to provide an `OPEN_AI_TOKEN`
+You can simply change `ChatOpenAi` with `UiPathAzureChatOpenAI`, you don't have to provide an OpenAI token.
 
 ```python
 from uipath_langchain.chat.models import UiPathAzureChatOpenAI
@@ -41,7 +41,7 @@ llm = UiPathAzureChatOpenAI(
 )
 ```
 
-Currently the following models can be used with `UiPathAzureChatOpenAI` (this list can be updated in the future):
+Currently, the following models can be used with `UiPathAzureChatOpenAI` (this list can be updated in the future):
 
 -   `gpt-4`, `gpt-4-1106-Preview`, `gpt-4-32k`, `gpt-4-turbo-2024-04-09`, `gpt-4-vision-preview`, `gpt-4o-2024-05-13`, `gpt-4o-2024-08-06`, `gpt-4o-mini-2024-07-18`, `o3-mini-2025-01-31`
 
@@ -85,8 +85,9 @@ Currently the following models can be used with `UiPathChat` (this list can be u
 
 -   `anthropic.claude-3-5-sonnet-20240620-v1:0`, `anthropic.claude-3-5-sonnet-20241022-v2:0`, `anthropic.claude-3-7-sonnet-20250219-v1:0`, `anthropic.claude-3-haiku-20240307-v1:0`, `gemini-1.5-pro-001`, `gemini-2.0-flash-001`, `gpt-4o-2024-05-13`, `gpt-4o-2024-08-06`, `gpt-4o-2024-11-20`, `gpt-4o-mini-2024-07-18`, `o3-mini-2025-01-31`
 
-### Note
-
+/// warning
 Please note that that you may get errors related to data residency, as some models are not available on all regions.
 
 Example: `[Enforced Region] No model configuration found for product uipath-python-sdk in EU using model anthropic.claude-3-opus-20240229-v1:0`.
+
+///

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/docs/quick_start.md

@@ -10,8 +10,8 @@ Before proceeding, ensure you have the following installed:
 
 -   Python 3.10 or higher
 -   `pip` or `uv` package manager
--   A UiPath Cloud Platform account with appropriate permissions
--   Either Anthropic or OpenAI API key
+-   A UiPath Automation Cloud account with appropriate permissions
+-   An Anthropic or OpenAI API key
 
 /// info
 
@@ -20,7 +20,7 @@ Before proceeding, ensure you have the following installed:
 2. **OpenAI** - Generate an OpenAI API key [here](https://platform.openai.com).
    ///
 
-## Creating A New Project
+## Creating a New Project
 
 We recommend using `uv` for package management. To create a new project:
 
@@ -135,7 +135,7 @@ This command creates the following files:
 | `pyproject.toml` | Project metadata and dependencies as per [PEP 518](https://peps.python.org/pep-0518/).                                           |
 
 
-## Initialize project
+## Initialize Project
 
 <!-- termynal -->
 
@@ -228,18 +228,33 @@ uipath run agent '{\"topic\":\"uipath\"}'
 
 ///
 
-/// info
+/// attention
 
-Run command also accepts a _.json_ file as input:
->uipath run agent -f <path_to_input_json_file>
+For a shell agnostic option, please refer to the next section.
 
-   ///
+///
+
+### (Optional) Run The Agent with a json File as Input
+
+The `run` command can also take a .json file as an input. You can create a file named `input.json` having the following content:
+
+```json
+{
+  "topic": "UiPath"
+}
+```
+
+Use this file as agent input:
+
+```shell
+> uipath run agent --file input.json
+```
 
-## Deploy The Agent On UiPath Cloud Platform
+## Deploy the Agent to UiPath Automation Cloud
 
-Follow these steps to publish and run your agent on UiPath Cloud Platform:
+Follow these steps to publish and run your agent to UiPath Automation Cloud:
 
-### (Optional) Customize The Package
+### (Optional) Customize the Package
 
 Update author details in `pyproject.toml`:
 
@@ -274,7 +289,9 @@ Authors    : Your Name
 💡 Use the link above to configure any environment variables
 ```
 
-> Please note that a process will be auto-created only upon publishing to **my-workspace** package feed.
+/// info
+Please note that a process will be auto-created only upon publishing to **my-workspace** package feed.
+   ///
 
 Set the environment variables using the provided link:
 
@@ -288,7 +305,7 @@ Set the environment variables using the provided link:
   />
 </picture>
 
-## Invoke The Agent On UiPath Cloud Platform
+## Invoke the Agent on UiPath Automation Cloud
 
 <!-- termynal -->
 
@@ -312,8 +329,18 @@ Use the provided link to monitor your job and view detailed traces.
   />
 </picture>
 
+### (Optional) Invoke The Agent with a json File as Input
+
+The `invoke` command operates similarly to the `run` command, allowing you to use the same .json file defined
+in the [(Optional) Run the agent with a .json file as input](#optional-run-the-agent-with-a-json-file-as-input)
+section, as agent input:
+
+```shell
+> uipath invoke agent --file input.json
+```
+
 ## Next Steps
 
 Congratulations! You have successfully set up, created, published, and run a UiPath LangChain Agent. 🚀
 
-For more advanced agents and examples, please refer to our [samples section](https://github.com/UiPath/uipath-langchain-python/tree/main/samples).
+For more advanced agents and agent samples, please refer to our [samples section](https://github.com/UiPath/uipath-langchain-python/tree/main/samples) in GitHub.

{uipath_langchain-0.0.108 → uipath_langchain-0.0.110}/pyproject.toml

@@ -1,11 +1,11 @@
 [project]
 name = "uipath-langchain"
-version = "0.0.108"
+version = "0.0.110"
 description = "UiPath Langchain"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"
 dependencies = [
-    "uipath>=2.0.33, <2.1.0",
+    "uipath>=2.0.55, <2.1.0",
     "langgraph>=0.2.70",
     "langchain-core>=0.3.34",
     "langgraph-checkpoint-sqlite>=2.0.3",

uipath_langchain-0.0.110/samples/RAG-quiz-generator/README.md

@@ -0,0 +1,244 @@
+# RAG Sample
+
+## Overview
+
+The RAG Sample project demonstrates the implementation of a Retrieval-Augmented Generation (RAG) system using [UiPath Context Grounding](https://docs.uipath.com/automation-cloud/automation-cloud/latest/admin-guide/about-context-grounding).
+The system comprises two langchain agents:
+1. **Quiz-Generator-RAG-Agent**: Attempts to generate a quiz using the given topic, leveraging only the information obtained through RAG.
+    In case it fails to gather sufficient relevant data, the system might opt to invoke the _Researcher-RAG-Agent_.
+2. **Researcher-RAG-Agent**: Retrieves pertinent information from the Internet based on the provided search instructions and uploads
+    it into a UiPath Context Grounding Index.
+
+## System Architecture
+
+The system utilizes LangGraph to create a directed graph of agents that can communicate and share state.
+
+### Quiz Generator Agent Graph
+
+```mermaid
+---
+---
+config:
+  flowchart:
+    curve: linear
+---
+graph TD;
+	__start__([<p>__start__</p>]):::first
+	invoke_researcher(invoke_researcher)
+	create_quiz(create_quiz)
+	return_quiz(return_quiz)
+	prepare_input(prepare_input)
+	__end__([<p>__end__</p>]):::last
+	__start__ --> prepare_input;
+	invoke_researcher --> create_quiz;
+	prepare_input --> create_quiz;
+	return_quiz --> __end__;
+	create_quiz -.-> invoke_researcher;
+	create_quiz -.-> return_quiz;
+	classDef default fill:#f2f0ff,line-height:1.2
+	classDef first fill-opacity:0
+	classDef last fill:#bfb6fc
+```
+
+### Researcher Agent Graph
+
+```mermaid
+---
+---
+config:
+  flowchart:
+    curve: linear
+---
+graph TD;
+	__start__([<p>__start__</p>]):::first
+	research(research)
+	add_data_to_context_grounding_index(add_data_to_context_grounding_index)
+	prepare_input(prepare_input)
+	create_file_name(create_file_name)
+	__end__([<p>__end__</p>]):::last
+	__start__ --> prepare_input;
+	add_data_to_context_grounding_index --> __end__;
+	create_file_name --> research;
+	prepare_input --> create_file_name;
+	research --> add_data_to_context_grounding_index;
+	classDef default fill:#f2f0ff,line-height:1.2
+	classDef first fill-opacity:0
+	classDef last fill:#bfb6fc
+
+```
+## Agent Responsibilities
+
+- **Quiz Generator Agent**:
+  - Receives user topics and executes searches using RAG.
+  - Decides if there is enough relevant information to generate a quiz.
+  - May ask _Researcher Agent_ for additional information.
+  - Returns final quiz to the user, complying to the requested output format _(question, difficulty, expected answer)_.
+
+- **Researcher Agent**:
+  - Retrieves information using a Tavily search tool.
+  - Uploads the data to a storage bucket (that the Context Grounding Index relies on).
+  - Triggers the  index ingestion.
+
+## Steps to Execute Project on UiPath Cloud Platform
+### Prerequisites
+1. **Create an Orchestrator Storage Bucket**
+
+For this demo we'll create it in the _Shared_ folder.
+
+![navigate to Storage Buckets page](../../docs/sample_images/RAG/create-storage-bucket-1.png)
+
+
+![create storage bucket](../../docs/sample_images/RAG/create-storage-bucket-2.png)
+2. **Create a Context Grounding Index**
+
+Next, we'll create a Context Grounding Index
+
+![navigate to Indexes page](../../docs/sample_images/RAG/create-index-1.png)
+
+When configuring _Index General Details_, we'll select the previously created storage bucket as data source.
+
+![create index](../../docs/sample_images/RAG/create-index-2.png)
+
+That's it! Next, we'll deploy the agents.
+
+### Deploy the agents
+1. **Clone the Repository**
+   ```bash
+   git clone https://github.com/UiPath/uipath-langchain-python.git
+   ```
+
+2. **Navigate to the Sample Directory**
+   - **Windows:**
+     ```bash
+     cd .\uipath-langchain-python\samples\RAG-quiz-generator
+     ```
+
+   - **Unix-like Systems (Linux, macOS):**
+     ```bash
+     cd ./uipath-langchain-python/samples/RAG-quiz-generator
+     ```
+
+3. **Create and Activate a Virtual Python Environment**
+   ```bash
+   pip install uv
+   uv venv -p 3.11 .venv
+   .venv\Scripts\activate  # Windows
+   source .venv/bin/activate  # Unix-like Systems
+   uv sync
+   ```
+
+4. **Authenticate with UiPath Cloud Platform**
+   ```bash
+   uipath auth
+   ```
+   > **Note:** After successful authentication in the browser, select the tenant for publishing the agent package.
+```
+👇 Select tenant:
+  0: DefaultTenant
+  1: Tenant2
+  2: Tenant3
+...
+Select tenant: 2
+```
+
+5. **Package and Publish Agents**
+   ```bash
+   uipath pack
+   uipath publish --my-workspace
+   ```
+```
+⠋ Publishing most recent package: RAG-agents.1.0.0.nupkg ...
+✓  Package published successfully!
+⠇ Getting process information ...
+🔗 Process configuration link: [LINK]
+💡 Use the link above to configure any environment variables
+```
+> Note: when publishing to _my-workspace_ a process will be auto-provisioned for you.
+> However, our package contains 2 agents (i.e. 2 entrypoints) thus we'll need to create an additional process.
+
+6. **Configure Agent Processes in Orchestrator**
+
+Follow the returned URL from the publish command:
+
+1. **Researcher Agent**
+
+Make sure _researcher-RAG-agent_ entrypoint is selected, set TAVILY and ANTHROPIC api keys and click on **Next**.
+
+![env-vars-researcher](../../docs/sample_images/RAG/researcher-1.png)
+
+> Note: We can leave everything empty in the _input_ section.
+
+On the _package requirements_ page click **Next**.
+
+![create-researcher](../../docs/sample_images/RAG/researcher-2.png)
+
+> Make sure the process name is _researcher-RAG-agent_.
+
+2. **Quiz Generator Agent**
+
+Lastly, we need to create the quiz generator agent.
+Create a new process in _my-workspace_.
+
+![process-page](../../docs/sample_images/RAG/process-page.png)
+
+![create-process](../../docs/sample_images/RAG/create-process.png)
+
+![create quiz generator agent](../../docs/sample_images/RAG/create-quiz-generator.png)
+
+7. **Run the agents on UiPath Cloud Platform**
+
+We can run the agent from _Processes_ page
+
+![run-process-button](../../docs/sample_images/RAG/run-process-1.png)
+
+![run-process](../../docs/sample_images/RAG/run-process-2.png)
+
+> ℹ️ Here is how we can easily copy any folder path.
+
+![folder-path](../../docs/sample_images/RAG/folder-path.png)
+
+8. **Conclusions**
+
+We can monitor our agent execution from the job info panel.
+
+![job-info](../../docs/sample_images/RAG/job-info.png)
+
+_Quiz-generator-RAG-agent_ may choose to invoke researcher agent
+multiple times before creating the quiz. The output should look like this:
+
+![agent-output](../../docs/sample_images/RAG/output.png)
+
+We can also check the storage bucket content.
+
+![click-storage-bucket](../../docs/sample_images/RAG/click-storage-bucket.png)
+
+This is the information fetched by our _researcher agent_ that the _quiz generator_ used to create the quiz using RAG.
+We can download this file/files to analyze them.
+
+![storage-bucket-content](../../docs/sample_images/RAG/storage-bucket-content.png)
+
+## Local Debugging
+You can locally debug individual agents by invoking them directly:
+
+#### Researcher Agent
+Run the researcher agent with:
+
+```bash
+uipath run researcher-RAG-agent '{"search_instructions":"Need data about spanish cuisine", "index_name":"sample-RAG-index", "index_folder_path":"<index_folder_path>"}'
+# or use .json file input
+uipath run researcher-RAG-agent -f input.example/researcher-debug-input.json
+```
+> **_NOTE:_**  This assumes that an index named _sample-RAG-index_ is created in the folder identified by the index_folder_path parameter.
+
+
+#### Quiz Generator Agent
+Run the quiz generator agent with:
+
+```bash
+uipath run quiz-generator-RAG-agent '{"quiz_topic":"spanish cuisine", "index_name":"sample-RAG-index", "index_folder_path":"<index_folder_path>"}'
+# or use .json file input
+uipath run quiz-generator-RAG-agent -f input.example/quiz-generator-debug-input.json
+```
+> **_NOTE:_**  This assumes that an agent named _researcher-RAG-agent_ is created in the folder identified by the folder_path parameter passed to _InvokeProcess_ method.
+> <br> ℹ️ check [researcher-RAG-agent.py](src/agents/quiz-generator-RAG-agent.py) file.
+

uipath_langchain-0.0.110/samples/RAG-quiz-generator/env.example

@@ -0,0 +1,2 @@
+TAVILY_API_KEY=xxx
+ANTHROPIC_API_KEY=xxx

uipath_langchain-0.0.110/samples/RAG-quiz-generator/input.example/quiz-generator-debug-input.json

@@ -0,0 +1,5 @@
+{
+  "quiz_topic":"spanish cuisine",
+  "index_name":"sample-RAG-index",
+  "index_folder_path":"<index_folder_path>"
+}

uipath_langchain-0.0.110/samples/RAG-quiz-generator/input.example/researcher-debug-input.json

@@ -0,0 +1,5 @@
+{
+  "search_instructions":"Need data about spanish cuisine",
+  "index_name":"sample-RAG-index",
+  "index_folder_path":"<index_folder_path>"
+}

uipath_langchain-0.0.110/samples/RAG-quiz-generator/langgraph.json

@@ -0,0 +1,8 @@
+{
+    "dependencies": ["."],
+    "graphs": {
+      "researcher-RAG-agent": "./src/agents/researcher-RAG-agent.py:graph",
+      "quiz-generator-RAG-agent": "./src/agents/quiz-generator-RAG-agent.py:graph"
+    },
+    "env": ".env"
+  }

uipath_langchain-0.0.110/samples/RAG-quiz-generator/pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "RAG-agents"
+version = "0.0.1"
+description = "Project containing two agents: quiz-generator-RAG-agent and researcher-RAG-agent."
+authors = [{ name = "John Doe", email = "john.doe@myemail.com" }]
+dependencies = [
+    "langgraph>=0.2.55",
+    "langchain-community>=0.3.9",
+    "langchain-anthropic>=0.3.8",
+    "langchain-experimental>=0.3.4",
+    "tavily-python>=0.5.0",
+    "uipath-langchain==0.0.105",
+]
+requires-python = ">=3.10"