azure-dynamic-sessions: add Python REPL tool (langchain-ai#21264)

Adds a Python REPL that executes code in a code interpreter session
using Azure Container Apps dynamic sessions.

---------

Co-authored-by: Erick Friis <[email protected]>

libs/partners/azure-dynamic-sessions/.gitignore

@@ -0,0 +1 @@
+__pycache__

libs/partners/azure-dynamic-sessions/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 LangChain, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

libs/partners/azure-dynamic-sessions/Makefile

@@ -0,0 +1,59 @@
+.PHONY: all format lint test tests integration_tests docker_tests help extended_tests
+
+# Default target executed when no arguments are given to make.
+all: help
+
+# Define a variable for the test file path.
+TEST_FILE ?= tests/unit_tests/
+
+test:
+ poetry run pytest $(TEST_FILE)
+
+tests:
+ poetry run pytest $(TEST_FILE)
+
+
+######################
+# LINTING AND FORMATTING
+######################
+
+# Define a variable for Python and notebook files.
+PYTHON_FILES=.
+MYPY_CACHE=.mypy_cache
+lint format: PYTHON_FILES=.
+lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=libs/partners/azure --name-only --diff-filter=d master | grep -E '\.py$$|\.ipynb$$')
+lint_package: PYTHON_FILES=langchain_azure_dynamic_sessions
+lint_tests: PYTHON_FILES=tests
+lint_tests: MYPY_CACHE=.mypy_cache_test
+
+lint lint_diff lint_package lint_tests:
+ poetry run ruff .
+ poetry run ruff format $(PYTHON_FILES) --diff
+ poetry run ruff --select I $(PYTHON_FILES)
+ mkdir $(MYPY_CACHE); poetry run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
+
+format format_diff:
+ poetry run ruff format $(PYTHON_FILES)
+ poetry run ruff --select I --fix $(PYTHON_FILES)
+
+spell_check:
+ poetry run codespell --toml pyproject.toml
+
+spell_fix:
+ poetry run codespell --toml pyproject.toml -w
+
+check_imports: $(shell find langchain_azure_dynamic_sessions -name '*.py')
+ poetry run python ./scripts/check_imports.py $^
+
+######################
+# HELP
+######################
+
+help:
+ @echo '----'
+ @echo 'check_imports - check imports'
+ @echo 'format - run code formatters'
+ @echo 'lint - run linters'
+ @echo 'test - run unit tests'
+ @echo 'tests - run unit tests'
+ @echo 'test TEST_FILE=<test_file> - run all tests in file'

libs/partners/azure-dynamic-sessions/README.md

@@ -0,0 +1,36 @@
+# langchain-azure-dynamic-sessions
+
+This package contains the LangChain integration for Azure Container Apps dynamic sessions. You can use it to add a secure and scalable code interpreter to your agents.
+
+## Installation
+
+```bash
+pip install -U langchain-azure-dynamic-sessions
+```
+
+## Usage
+
+You first need to create an Azure Container Apps session pool and obtain its management endpoint. Then you can use the `SessionsPythonREPLTool` tool to give your agent the ability to execute Python code.
+
+```python
+from langchain_azure_dynamic_sessions import SessionsPythonREPLTool
+
+
+# get the management endpoint from the session pool in the Azure portal
+tool = SessionsPythonREPLTool(pool_management_endpoint=POOL_MANAGEMENT_ENDPOINT)
+
+prompt = hub.pull("hwchase17/react")
+tools=[tool]
+react_agent = create_react_agent(
+ llm=llm,
+ tools=tools,
+ prompt=prompt,
+)
+
+react_agent_executor = AgentExecutor(agent=react_agent, tools=tools, verbose=True, handle_parsing_errors=True)
+
+react_agent_executor.invoke({"input": "What is the current time in Vancouver, Canada?"})
+```
+
+By default, the tool uses `DefaultAzureCredential` to authenticate with Azure. If you're using a user-assigned managed identity, you must set the `AZURE_CLIENT_ID` environment variable to the ID of the managed identity.
+

libs/partners/azure-dynamic-sessions/docs/provider.ipynb

@@ -0,0 +1,169 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "# Azure Container Apps dynamic sessions\n",
+ "\n",
+ "Azure Container Apps dynamic sessions provides a secure and scalable way to run a Python code interpreter in Hyper-V isolated sandboxes. This allows your agents to run potentially untrusted code in a secure environment. The code interpreter environment includes many popular Python packages, such as NumPy, pandas, and scikit-learn.\n",
+ "\n",
+ "## Pre-requisites\n",
+ "\n",
+ "By default, the `SessionsPythonREPLTool` tool uses `DefaultAzureCredential` to authenticate with Azure. Locally, it'll use your credentials from the Azure CLI or VS Code. Install the Azure CLI and log in with `az login` to authenticate.\n",
+ "\n",
+ "## Using the tool\n",
+ "\n",
+ "Set variables:"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 1,
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "import os\n",
+ "import dotenv\n",
+ "dotenv.load_dotenv()\n",
+ "\n",
+ "POOL_MANAGEMENT_ENDPOINT = os.getenv(\"POOL_MANAGEMENT_ENDPOINT\")\n",
+ "AZURE_OPENAI_ENDPOINT = os.getenv(\"AZURE_OPENAI_ENDPOINT\")"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 4,
+ "metadata": {},
+ "outputs": [
+ {
+ "data": {
+ "text/plain": [
+ "'{\\n \"result\": 42,\\n \"stdout\": \"\",\\n \"stderr\": \"\"\\n}'"
+ ]
+ },
+ "execution_count": 4,
+ "metadata": {},
+ "output_type": "execute_result"
+ }
+ ],
+ "source": [
+ "from langchain_azure_dynamic_sessions import SessionsPythonREPLTool\n",
+ "\n",
+ "\n",
+ "tool = SessionsPythonREPLTool(pool_management_endpoint=POOL_MANAGEMENT_ENDPOINT)\n",
+ "tool.run(\"6 * 7\")\n"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "metadata": {},
+ "source": [
+ "## Full agent example"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": 3,
+ "metadata": {},
+ "outputs": [
+ {
+ "name": "stdout",
+ "output_type": "stream",
+ "text": [
+ "\n",
+ "\n",
+ "\u001b[1m> Entering new AgentExecutor chain...\u001b[0m\n",
+ "\u001b[32;1m\u001b[1;3mI need to calculate the compound interest on the initial amount over 6 years.\n",
+ "Action: Python_REPL\n",
+ "Action Input: \n",
+ "```python\n",
+ "initial_amount = 500\n",
+ "interest_rate = 0.05\n",
+ "time_period = 6\n",
+ "final_amount = initial_amount * (1 + interest_rate)**time_period\n",
+ "final_amount\n",
+ "```\u001b[0m\u001b[36;1m\u001b[1;3m{\n",
+ " \"result\": 670.0478203125002,\n",
+ " \"stdout\": \"\",\n",
+ " \"stderr\": \"\"\n",
+ "}\u001b[0m\u001b[32;1m\u001b[1;3mThe final amount after 6 years will be $670.05\n",
+ "Final Answer: $670.05\u001b[0m\n",
+ "\n",
+ "\u001b[1m> Finished chain.\u001b[0m\n"
+ ]
+ },
+ {
+ "data": {
+ "text/plain": [
+ "{'input': 'If I put $500 in a bank account with a 5% interest rate, how much money will I have in the account after 6 years?',\n",
+ " 'output': '$670.05'}"
+ ]
+ },
+ "execution_count": 3,
+ "metadata": {},
+ "output_type": "execute_result"
+ }
+ ],
+ "source": [
+ "import os\n",
+ "from azure.identity import DefaultAzureCredential\n",
+ "from langchain_azure_dynamic_sessions import SessionsPythonREPLTool\n",
+ "from langchain_openai import AzureChatOpenAI\n",
+ "from langchain import agents, hub\n",
+ "\n",
+ "\n",
+ "credential = DefaultAzureCredential()\n",
+ "os.environ[\"OPENAI_API_TYPE\"] = \"azure_ad\"\n",
+ "os.environ[\"OPENAI_API_KEY\"] = credential.get_token(\"https://cognitiveservices.azure.com/.default\").token\n",
+ "os.environ[\"AZURE_OPENAI_ENDPOINT\"] = AZURE_OPENAI_ENDPOINT\n",
+ "\n",
+ "llm = AzureChatOpenAI(\n",
+ " azure_deployment=\"gpt-35-turbo\",\n",
+ " openai_api_version=\"2023-09-15-preview\",\n",
+ " streaming=True,\n",
+ " temperature=0,\n",
+ ")\n",
+ "\n",
+ "repl = SessionsPythonREPLTool(\n",
+ " pool_management_endpoint=POOL_MANAGEMENT_ENDPOINT,\n",
+ ")\n",
+ "\n",
+ "tools = [repl]\n",
+ "react_agent = agents.create_react_agent(\n",
+ " llm=llm,\n",
+ " tools=tools,\n",
+ " prompt=hub.pull(\"hwchase17/react\"),\n",
+ ")\n",
+ "\n",
+ "react_agent_executor = agents.AgentExecutor(agent=react_agent, tools=tools, verbose=True, handle_parsing_errors=True)\n",
+ "\n",
+ "react_agent_executor.invoke({\"input\": \"If I put $500 in a bank account with a 5% interest rate, how much money will I have in the account after 6 years?\"})"
+ ]
+ }
+ ],
+ "metadata": {
+ "colab": {
+ "provenance": []
+ },
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.11.9"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 1
+}

libs/partners/azure-dynamic-sessions/langchain_azure_dynamic_sessions/__init__.py

@@ -0,0 +1,5 @@
+from langchain_azure_dynamic_sessions.tools.sessions import SessionsPythonREPLTool
+
+__all__ = [
+ "SessionsPythonREPLTool",
+]

libs/partners/azure-dynamic-sessions/langchain_azure_dynamic_sessions/tools/__init__.py

@@ -0,0 +1,5 @@
+from langchain_azure_dynamic_sessions.tools.sessions import SessionsPythonREPLTool
+
+__all__ = [
+ "SessionsPythonREPLTool",
+]