Merge branch 'main' into eyurtsev-patch-1

See release notes

.clabot

@@ -0,0 +1,4 @@
+{
+  "contributors": ["eyurtsev", "hwchase17", "nfcampos", "efriis", "jacoblee93", "dqbd", "kreneskyp", "adarsh-jha-dev", "harris", "baskaryan", "hinthornw", "bracesproul", "jakerachleff", "craigsdennis", "anhi", "169", "LarchLiu", "PaulLockett", "RCMatthias", "jwynia", "majiayu000", "mpskex", "shivachittamuru", "sinashaloudegi", "sowsan", "akira", "lucianotonet", "JGalego"],
+  "message": "Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the username {{usersWithoutCLA}} on file. In order for us to review and merge your code, please complete the Individual Contributor License Agreement here https://forms.gle/AQFbtkWRoHXUgipM6 .\n\nThis process is done manually on our side, so after signing the form one of the maintainers will add you to the contributors list.\n\nFor more details about why we have a CLA and other contribution guidelines please see: https://github.com/langchain-ai/langserve/blob/main/CONTRIBUTING.md."
+}

.github/workflows/_pydantic_compatibility.yml

@@ -13,6 +13,7 @@ env:
 
 jobs:
   build:
+    timeout-minutes: 10
     defaults:
       run:
         working-directory: ${{ inputs.working-directory }}

.github/workflows/langserve_ci.yml

@@ -11,8 +11,10 @@ on:
       - '.github/workflows/_test.yml'
       - '.github/workflows/langserve_ci.yml'
       - 'langserve/**'
+      - 'tests/**'
       - 'examples/**'
       - 'pyproject.toml'
+      - 'poetry.lock'
       - 'Makefile'
   workflow_dispatch:  # Allows to trigger the workflow manually in GitHub UI
 
@@ -38,7 +40,14 @@ jobs:
       working-directory: .
     secrets: inherit
 
+  pydantic-compatibility:
+    uses:
+      ./.github/workflows/_pydantic_compatibility.yml
+    with:
+      working-directory: .
+    secrets: inherit
   test:
+    timeout-minutes: 10
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -50,7 +59,7 @@ jobs:
           - "3.9"
           - "3.10"
           - "3.11"
-    name: Python ${{ matrix.python-version }} extended tests
+    name: Python ${{ matrix.python-version }} tests
     steps:
       - uses: actions/checkout@v3
 

Makefile

@@ -33,10 +33,10 @@ lint_diff format_diff: PYTHON_FILES=$(shell git diff --relative=. --name-only --
 
 lint lint_diff:
 	poetry run ruff .
-	poetry run black $(PYTHON_FILES) --check
+	poetry run ruff format $(PYTHON_FILES) --check
 
 format format_diff:
-	poetry run black $(PYTHON_FILES)
+	poetry run ruff format $(PYTHON_FILES)
 	poetry run ruff --select I --fix $(PYTHON_FILES)
 
 spell_check:

README.md

@@ -1,50 +1,124 @@
-# LangServe 🦜️🔗 
+# 🦜️🏓 LangServe
+
+[![Release Notes](https://img.shields.io/github/release/langchain-ai/langserve)](https://github.com/langchain-ai/langserve/releases)
+[![Downloads](https://static.pepy.tech/badge/langserve/month)](https://pepy.tech/project/langserve)
+[![Open Issues](https://img.shields.io/github/issues-raw/langchain-ai/langserve)](https://github.com/langchain-ai/langserve/issues)
+[![](https://dcbadge.vercel.app/api/server/6adMQxSpJS?compact=true&style=flat)](https://discord.com/channels/1038097195422978059/1170024642245832774)
+
+🚩 We will be releasing a hosted version of LangServe for one-click deployments of
+LangChain
+applications. [Sign up here](https://airtable.com/app0hN6sd93QcKubv/shrAjst60xXa6quV2)
+to get on the waitlist.
 
 ## Overview
 
-`LangServe` helps developers deploy `LangChain` [runnables and chains](https://python.langchain.com/docs/expression_language/) as a REST API.
+`LangServe` helps developers
+deploy `LangChain` [runnables and chains](https://python.langchain.com/docs/expression_language/)
+as a REST API.
 
-This library is integrated with [FastAPI](https://fastapi.tiangolo.com/) and uses [pydantic](https://docs.pydantic.dev/latest/) for data validation.
+This library is integrated with [FastAPI](https://fastapi.tiangolo.com/) and
+uses [pydantic](https://docs.pydantic.dev/latest/) for data validation.
 
-In addition, it provides a client that can be used to call into runnables deployed on a server.
-A javascript client is available in [LangChainJS](https://js.langchain.com/docs/api/runnables_remote/classes/RemoteRunnable).
+In addition, it provides a client that can be used to call into runnables deployed on a
+server.
+A javascript client is available
+in [LangChainJS](https://api.js.langchain.com/classes/langchain_runnables_remote.RemoteRunnable.html).
 
 ## Features
 
-- Input and Output schemas automatically inferred from your LangChain object, and enforced on every API call, with rich error messages
+- Input and Output schemas automatically inferred from your LangChain object, and
+  enforced on every API call, with rich error messages
 - API docs page with JSONSchema and Swagger (insert example link)
-- Efficient `/invoke`, `/batch` and `/stream` endpoints with support for many concurrent requests on a single server
-- `/stream_log` endpoint for streaming all (or some) intermediate steps from your chain/agent
-- Built-in (optional) tracing to [LangSmith](https://www.langchain.com/langsmith), just add your API key (see [Instructions](https://docs.smith.langchain.com/)])
-- All built with battle-tested open-source Python libraries like FastAPI, Pydantic, uvloop and asyncio.
-- Use the client SDK to call a LangServe server as if it was a Runnable running locally (or call the HTTP API directly)
+- Efficient `/invoke/`, `/batch/` and `/stream/` endpoints with support for many
+  concurrent requests on a single server
+- `/stream_log/` endpoint for streaming all (or some) intermediate steps from your
+  chain/agent
+- Playground page at `/playground/` with streaming output and intermediate steps
+- Built-in (optional) tracing to [LangSmith](https://www.langchain.com/langsmith), just
+  add your API key (see [Instructions](https://docs.smith.langchain.com/))
+- All built with battle-tested open-source Python libraries like FastAPI, Pydantic,
+  uvloop and asyncio.
+- Use the client SDK to call a LangServe server as if it was a Runnable running
+  locally (or call the HTTP API directly)
+- [LangServe Hub](https://github.com/langchain-ai/langchain/blob/master/templates/README.md)
 
-### Limitations
+## Limitations
 
 - Client callbacks are not yet supported for events that originate on the server
-- Does not work with [pydantic v2 yet](https://github.com/tiangolo/fastapi/issues/10360)
+- OpenAPI docs will not be generated when using Pydantic V2. Fast API does not
+  support [mixing pydantic v1 and v2 namespaces](https://github.com/tiangolo/fastapi/issues/10360).
+  See section below for more details.
 
-## LangChain CLI  🛠️
+## Hosted LangServe
+
+We will be releasing a hosted version of LangServe for one-click deployments of
+LangChain
+applications. [Sign up here](https://airtable.com/app0hN6sd93QcKubv/shrAjst60xXa6quV2)
+to get on the waitlist.
+
+## Security
+
+* Vulnerability in Versions 0.0.13 - 0.0.15 -- playground endpoint allows accessing
+  arbitrary files on
+  server. [Resolved in 0.0.16](https://github.com/langchain-ai/langserve/pull/98).
+
+## Installation
+
+For both client and server:
+
+```bash
+pip install "langserve[all]"
+```
+
+or `pip install "langserve[client]"` for client code,
+and `pip install "langserve[server]"` for server code.
+
+## LangChain CLI 🛠️
 
 Use the `LangChain` CLI to bootstrap a `LangServe` project quickly.
 
-To use the langchain CLI make sure that you have a recent version of `langchain` installed
-and also `typer`. (`pip install langchain typer` or `pip install "langchain[cli]"`)
+To use the langchain CLI make sure that you have a recent version of `langchain-cli`
+installed. You can install it with `pip install -U langchain-cli`.
 
 ```sh
-langchain ../path/to/directory
+langchain app new ../path/to/directory
 ```
 
-And follow the instructions...
-
 ## Examples
 
-For more examples, see the [examples](./examples) directory.
+Get your LangServe instance started quickly with
+[LangChain Templates](https://github.com/langchain-ai/langchain/blob/master/templates/README.md).
 
+For more examples, see the templates
+[index](https://github.com/langchain-ai/langchain/blob/master/templates/docs/INDEX.md)
+or the [examples](https://github.com/langchain-ai/langserve/tree/main/examples)
+directory.
+
+| Description                                                                                                                                                                                                                                                        | Links                                                                                                                                                                                                                               |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **LLMs** Minimal example that reserves OpenAI and Anthropic chat models. Uses async, supports batching and streaming.                                                                                                                                              | [server](https://github.com/langchain-ai/langserve/tree/main/examples/llm/server.py), [client](https://github.com/langchain-ai/langserve/blob/main/examples/llm/client.ipynb)                                                       | 
+| **Retriever** Simple server that exposes a retriever as a runnable.                                                                                                                                                                                                | [server](https://github.com/langchain-ai/langserve/tree/main/examples/retrieval/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/retrieval/client.ipynb)                                           | 
+| **Conversational Retriever** A [Conversational Retriever](https://python.langchain.com/docs/expression_language/cookbook/retrieval#conversational-retrieval-chain) exposed via LangServe                                                                           | [server](https://github.com/langchain-ai/langserve/tree/main/examples/conversational_retrieval_chain/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/conversational_retrieval_chain/client.ipynb) | 
+| **Agent** Implementation of an [Agent based on OpenAI tools](https://python.langchain.com/docs/modules/agents/agent_types/openai_functions_agent)                                                                                                                  | [server](https://github.com/langchain-ai/langserve/tree/main/examples/agent/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/agent/client.ipynb)                                                   | 
+| [RunnableWithMessageHistory](https://python.langchain.com/docs/expression_language/how_to/message_history) to implement chat persisted on backend, keyed off a `session_id` supplied by client.                                                                    | [server](https://github.com/langchain-ai/langserve/tree/main/examples/chat_with_persistence/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/chat_with_persistence/client.ipynb)                   |
+| [RunnableWithMessageHistory](https://python.langchain.com/docs/expression_language/how_to/message_history) to implement chat persisted on backend, keyed off a `conversation_id` supplied by client, and `user_id` (see Auth for implementing `user_id` properly). | [server](https://github.com/langchain-ai/langserve/tree/main/examples/chat_with_persistence_and_user/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/chat_with_persistence_and_user/client.ipynb) | 
+| [Configurable Runnable](https://python.langchain.com/docs/expression_language/how_to/configure) to create a retriever that supports run time configuration of the index name.                                                                                      | [server](https://github.com/langchain-ai/langserve/tree/main/examples/configurable_retrieval/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/configurable_retrieval/client.ipynb)                 | 
+| [Configurable Runnable](https://python.langchain.com/docs/expression_language/how_to/configure) that shows configurable fields and configurable alternatives.                                                                                                      | [server](https://github.com/langchain-ai/langserve/tree/main/examples/configurable_chain/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/configurable_chain/client.ipynb)                         | 
+| **APIHandler** Shows how to use `APIHandler` instead of `add_routes`. This provides more flexibility for developers to define endpoints. Works well with all FastAPI patterns, but takes a bit more effort.                                                        | [server](https://github.com/langchain-ai/langserve/tree/main/examples/api_handler_examples/server.py)                     |
+| **LCEL Example** Example that uses LCEL to manipulate a dictionary input.                                                                                                                                                                                          | [server](https://github.com/langchain-ai/langserve/tree/main/examples/passthrough_dict/client.ipynb), [client](https://github.com/langchain-ai/langserve/tree/main/examples/passthrough_dict/client.ipynb)                          | 
+| **Auth** with `add_routes`: Simple authentication that can be applied across all endpoints associated with app. (Not useful on its own for implementing per user logic.)                                                                                           | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/global_deps/server.py)                                                                                                                                   | 
+| **Auth** with `add_routes`: Simple authentication mechanism based on path dependencies. (No useful on its own for implementing per user logic.)                                                                                                                    | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/path_dependencies/server.py)                                                                                                                             | 
+| **Auth** with `add_routes`: Implement per user logic and auth for endpoints that use per request config modifier. (**Note**: At the moment, does not integrate with OpenAPI docs.)                                                                                 | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/per_req_config_modifier/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/auth/per_req_config_modifier/client.ipynb)     | 
+| **Auth** with `APIHandler`: Implement per user logic and auth that shows how to search only within user owned documents.                                                                                                                                           | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/api_handler/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/auth/api_handler/client.ipynb)                             | 
+| **Widgets** Different widgets that can be used with playground (file upload and chat)                                                                                                                                                                              | [server](https://github.com/langchain-ai/langserve/tree/main/examples/widgets/server.py)                                               | 
+| **Widgets** File upload widget used for LangServe playground.                                                                                                                                                                                                      | [server](https://github.com/langchain-ai/langserve/tree/main/examples/file_processing/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/file_processing/client.ipynb)                               | 
+
+## Sample Application
 
 ### Server
 
-Here's a server that deploys an OpenAI chat model, an Anthropic chat model, and a chain that uses
+Here's a server that deploys an OpenAI chat model, an Anthropic chat model, and a chain
+that uses
 the Anthropic model to tell a joke about a topic.
 
 ```python
@@ -54,11 +128,10 @@ from langchain.prompts import ChatPromptTemplate
 from langchain.chat_models import ChatAnthropic, ChatOpenAI
 from langserve import add_routes
 
-
 app = FastAPI(
-  title="LangChain Server",
-  version="1.0",
-  description="A simple api server using Langchain's Runnable interfaces",
+    title="LangChain Server",
+    version="1.0",
+    description="A simple api server using Langchain's Runnable interfaces",
 )
 
 add_routes(
@@ -78,7 +151,7 @@ prompt = ChatPromptTemplate.from_template("tell me a joke about {topic}")
 add_routes(
     app,
     prompt | model,
-    path="/chain",
+    path="/joke",
 )
 
 if __name__ == "__main__":
@@ -91,10 +164,19 @@ if __name__ == "__main__":
 
 If you've deployed the server above, you can view the generated OpenAPI docs using:
 
+> ⚠️ If using pydantic v2, docs will not be generated for *invoke*, *batch*, *stream*,
+*stream_log*. See [Pydantic](#pydantic) section below for more details.
+
 ```sh
 curl localhost:8000/docs
 ```
 
+make sure to **add** the `/docs` suffix.
+
+> ⚠️ Index page `/` is not defined by **design**, so `curl localhost:8000` or visiting
+> the URL
+> will return a 404. If you want content at `/` define an endpoint `@app.get("/")`.
+
 ### Client
 
 Python SDK
@@ -108,7 +190,7 @@ from langserve import RemoteRunnable
 
 openai = RemoteRunnable("http://localhost:8000/openai/")
 anthropic = RemoteRunnable("http://localhost:8000/anthropic/")
-joke_chain = RemoteRunnable("http://localhost:8000/chain/")
+joke_chain = RemoteRunnable("http://localhost:8000/joke/")
 
 joke_chain.invoke({"topic": "parrots"})
 
@@ -116,35 +198,37 @@ joke_chain.invoke({"topic": "parrots"})
 await joke_chain.ainvoke({"topic": "parrots"})
 
 prompt = [
-    SystemMessage(content='Act like either a cat or a parrot.'), 
+    SystemMessage(content='Act like either a cat or a parrot.'),
     HumanMessage(content='Hello!')
 ]
 
 # Supports astream
 async for msg in anthropic.astream(prompt):
     print(msg, end="", flush=True)
-    
+
 prompt = ChatPromptTemplate.from_messages(
     [("system", "Tell me a long story about {topic}")]
 )
-    
+
 # Can define custom chains
 chain = prompt | RunnableMap({
     "openai": openai,
     "anthropic": anthropic,
 })
 
-chain.batch([{ "topic": "parrots" }, { "topic": "cats" }])
+chain.batch([{"topic": "parrots"}, {"topic": "cats"}])
 ```
 
 In TypeScript (requires LangChain.js version 0.0.166 or later):
 
 ```typescript
-import { RemoteRunnable } from "langchain/runnables/remote";
+import {RemoteRunnable} from "langchain/runnables/remote";
 
-const chain = new RemoteRunnable({ url: `http://localhost:8000/chain/invoke/` });
+const chain = new RemoteRunnable({
+    url: `http://localhost:8000/joke/`,
+});
 const result = await chain.invoke({
-  "topic": "cats", 
+    topic: "cats",
 });
 ```
 
@@ -152,8 +236,9 @@ Python using `requests`:
 
 ```python
 import requests
+
 response = requests.post(
-    "http://localhost:8000/chain/invoke/",
+    "http://localhost:8000/joke/invoke",
     json={'input': {'topic': 'cats'}}
 )
 response.json()
@@ -162,7 +247,7 @@ response.json()
 You can also use `curl`:
 
 ```sh
-curl --location --request POST 'http://localhost:8000/chain/invoke/' \
+curl --location --request POST 'http://localhost:8000/joke/invoke' \
     --header 'Content-Type: application/json' \
     --data-raw '{
         "input": {
@@ -171,17 +256,16 @@ curl --location --request POST 'http://localhost:8000/chain/invoke/' \
     }'
 ```
 
-
-## Endpoints 
+## Endpoints
 
 The following code:
 
 ```python
 ...
 add_routes(
-  app,
-  runnable,
-  path="/my_runnable",
+    app,
+    runnable,
+    path="/my_runnable",
 )
 ```
 
@@ -190,37 +274,76 @@ adds of these endpoints to the server:
 - `POST /my_runnable/invoke` - invoke the runnable on a single input
 - `POST /my_runnable/batch` - invoke the runnable on a batch of inputs
 - `POST /my_runnable/stream` - invoke on a single input and stream the output
-- `POST /my_runnable/stream_log` - invoke on a single input and stream the output, including output of intermediate steps as it's generated
+- `POST /my_runnable/stream_log` - invoke on a single input and stream the output,
+  including output of intermediate steps as it's generated
 - `GET /my_runnable/input_schema` - json schema for input to the runnable
 - `GET /my_runnable/output_schema` - json schema for output of the runnable
 - `GET /my_runnable/config_schema` - json schema for config of the runnable
 
-## Installation
+These endpoints match
+the [LangChain Expression Language interface](https://python.langchain.com/docs/expression_language/interface) --
+please reference this documentation for more details.
 
-For both client and server:
+## Playground
 
-```bash
-pip install "langserve[all]"
-```
+You can find a playground page for your runnable at `/my_runnable/playground/`. This
+exposes a simple UI
+to [configure](https://python.langchain.com/docs/expression_language/how_to/configure)
+and invoke your runnable with streaming output and intermediate steps.
 
-or `pip install "langserve[client]"` for client code, and `pip install "langserve[server]"` for server code.
+<p align="center">
+<img src="https://github.com/langchain-ai/langserve/assets/3205522/5ca56e29-f1bb-40f4-84b5-15916384a276" width="50%"/>
+</p>
+
+### Widgets
+
+The playground supports [widgets](#playground-widgets) and can be used to test your
+runnable with different inputs. See the [widgets](#widgets) section below for more
+details.
+
+### Sharing
+
+In addition, for configurable runnables, the playground will allow you to configure the
+runnable and share a link with the configuration:
+
+<p align="center">
+<img src="https://github.com/langchain-ai/langserve/assets/3205522/86ce9c59-f8e4-4d08-9fa3-62030e0f521d" width="50%"/>
+</p>
 
 ## Legacy Chains
 
-LangServe works with both Runnables (constructed via [LangChain Expression Language](https://python.langchain.com/docs/expression_language/)) and legacy chains (inheriting from `Chain`).
-However, some of the input schemas for legacy chains may be incomplete/incorrect, leading to errors.
+LangServe works with both Runnables (constructed
+via [LangChain Expression Language](https://python.langchain.com/docs/expression_language/))
+and legacy chains (inheriting from `Chain`).
+However, some of the input schemas for legacy chains may be incomplete/incorrect,
+leading to errors.
 This can be fixed by updating the `input_schema` property of those chains in LangChain.
-If you encounter any errors, please open an issue on THIS repo, and we will work to address it.
-
-
-## Handling Authentication
-
-If you need to add authentication to your server, 
-please reference FastAPI's [security documentation](https://fastapi.tiangolo.com/tutorial/security/)
-and [middleware documentation](https://fastapi.tiangolo.com/tutorial/middleware/).
+If you encounter any errors, please open an issue on THIS repo, and we will work to
+address it.
 
 ## Deployment
 
+### Deploy to AWS
+
+You can deploy to AWS using the [AWS Copilot CLI](https://aws.github.io/copilot-cli/)
+
+```bash
+copilot init --app [application-name] --name [service-name] --type 'Load Balanced Web Service' --dockerfile './Dockerfile' --deploy
+```
+
+Click [here](https://aws.amazon.com/containers/copilot/) to learn more.
+
+### Deploy to Azure
+
+You can deploy to Azure using Azure Container Apps (Serverless):
+
+```
+az containerapp up --name [container-app-name] --source . --resource-group [resource-group-name] --environment  [environment-name] --ingress external --target-port 8001 --env-vars=OPENAI_API_KEY=your_key
+```
+
+You can find more
+info [here](https://learn.microsoft.com/en-us/azure/container-apps/containerapp-up)
+
 ### Deploy to GCP
 
 You can deploy to GCP Cloud Run using the following command:
@@ -228,3 +351,322 @@ You can deploy to GCP Cloud Run using the following command:
 ```
 gcloud run deploy [your-service-name] --source . --port 8001 --allow-unauthenticated --region us-central1 --set-env-vars=OPENAI_API_KEY=your_key
 ```
+
+### Community Contributed
+
+#### Deploy to Railway
+
+[Example Railway Repo](https://github.com/PaulLockett/LangServe-Railway/tree/main)
+
+[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/pW9tXP?referralCode=c-aq4K)
+
+## Pydantic
+
+LangServe provides support for Pydantic 2 with some limitations.
+
+1. OpenAPI docs will not be generated for invoke/batch/stream/stream_log when using
+   Pydantic V2. Fast API does not support [mixing pydantic v1 and v2 namespaces].
+2. LangChain uses the v1 namespace in Pydantic v2. Please read
+   the [following guidelines to ensure compatibility with LangChain](https://github.com/langchain-ai/langchain/discussions/9337)
+
+Except for these limitations, we expect the API endpoints, the playground and any other
+features to work as expected.
+
+## Advanced
+
+### Handling Authentication
+
+If you need to add authentication to your server, please read Fast API's documentation
+about [dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/)
+and [security](https://fastapi.tiangolo.com/tutorial/security/).
+
+The below examples show how to wire up authentication logic LangServe endpoints using FastAPI primitives.
+
+You are responsible for providing the actual authentication logic, the users table etc. 
+
+If you're not sure what you're doing, you could try using an existing solution [Auth0](https://auth0.com/).
+
+#### Using add_routes
+
+If you're using `add_routes`, see
+examples [here](https://github.com/langchain-ai/langserve/tree/main/examples/auth).
+
+| Description                                                                                                                                                                                                                                                        | Links                                                                                                                                                                                                                                |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Auth** with `add_routes`: Simple authentication that can be applied across all endpoints associated with app. (Not useful on its own for implementing per user logic.)                                                                                           | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/global_deps/server.py)                                                                                                                                    | 
+| **Auth** with `add_routes`: Simple authentication mechanism based on path dependencies. (No useful on its own for implementing per user logic.)                                                                                                                    | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/path_dependencies/server.py)                                                                                                                              | 
+| **Auth** with `add_routes`: Implement per user logic and auth for endpoints that use per request config modifier. (**Note**: At the moment, does not integrate with OpenAPI docs.)                                                                                 | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/per_req_config_modifier/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/auth/per_req_config_modifier/client.ipynb)     | 
+
+Alternatively, you can use FastAPI's [middleware](https://fastapi.tiangolo.com/tutorial/middleware/).
+
+Using global dependencies and path dependencies has the advantage that auth will be properly supported in the OpenAPI docs page, but
+these are not sufficient for implement per user logic (e.g., making an application that can search only within user owned documents).
+
+If you need to implement per user logic, you can use the `per_req_config_modifier` or `APIHandler` (below) to implement this logic.
+
+**Per User**
+
+If you need authorization or logic that is user dependent,
+specify `per_req_config_modifier` when using `add_routes`. Use a callable receives the
+raw `Request` object and can extract relevant information from it for authentication and
+authorization purposes.
+
+#### Using APIHandler
+
+If you feel comfortable with FastAPI and python, you can use LangServe's [APIHandler](https://github.com/langchain-ai/langserve/blob/main/examples/api_handler_examples/server.py).
+
+| Description                                                                                                                                                                                                                                                        | Links                                                                                                                                                                                                                                |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Auth** with `APIHandler`: Implement per user logic and auth that shows how to search only within user owned documents.                                                                                                                                           | [server](https://github.com/langchain-ai/langserve/tree/main/examples/auth/api_handler/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/auth/api_handler/client.ipynb)                             | 
+| **APIHandler** Shows how to use `APIHandler` instead of `add_routes`. This provides more flexibility for developers to define endpoints. Works well with all FastAPI patterns, but takes a bit more effort.                                                        | [server](https://github.com/langchain-ai/langserve/tree/main/examples/api_handler_examples/server.py) |
+
+It's a bit more work, but gives you complete control over the endpoint definitions, so
+you can do whatever custom logic you need for auth.
+
+### Files
+
+LLM applications often deal with files. There are different architectures
+that can be made to implement file processing; at a high level:
+
+1. The file may be uploaded to the server via a dedicated endpoint and processed using a
+   separate endpoint
+2. The file may be uploaded by either value (bytes of file) or reference (e.g., s3 url
+   to file content)
+3. The processing endpoint may be blocking or non-blocking
+4. If significant processing is required, the processing may be offloaded to a dedicated
+   process pool
+
+You should determine what is the appropriate architecture for your application.
+
+Currently, to upload files by value to a runnable, use base64 encoding for the
+file (`multipart/form-data` is not supported yet).
+
+Here's
+an [example](https://github.com/langchain-ai/langserve/tree/main/examples/file_processing)
+that shows
+how to use base64 encoding to send a file to a remote runnable.
+
+Remember, you can always upload files by reference (e.g., s3 url) or upload them as
+multipart/form-data to a dedicated endpoint.
+
+### Custom Input and Output Types
+
+Input and Output types are defined on all runnables.
+
+You can access them via the `input_schema` and `output_schema` properties.
+
+`LangServe` uses these types for validation and documentation.
+
+If you want to override the default inferred types, you can use the `with_types` method.
+
+Here's a toy example to illustrate the idea:
+
+```python
+from typing import Any
+
+from fastapi import FastAPI
+from langchain.schema.runnable import RunnableLambda
+
+app = FastAPI()
+
+
+def func(x: Any) -> int:
+    """Mistyped function that should accept an int but accepts anything."""
+    return x + 1
+
+
+runnable = RunnableLambda(func).with_types(
+    input_schema=int,
+)
+
+add_routes(app, runnable)
+```
+
+### Custom User Types
+
+Inherit from `CustomUserType` if you want the data to de-serialize into a
+pydantic model rather than the equivalent dict representation.
+
+At the moment, this type only works *server* side and is used
+to specify desired *decoding* behavior. If inheriting from this type
+the server will keep the decoded type as a pydantic model instead
+of converting it into a dict.
+
+```python
+from fastapi import FastAPI
+from langchain.schema.runnable import RunnableLambda
+
+from langserve import add_routes
+from langserve.schema import CustomUserType
+
+app = FastAPI()
+
+
+class Foo(CustomUserType):
+    bar: int
+
+
+def func(foo: Foo) -> int:
+    """Sample function that expects a Foo type which is a pydantic model"""
+    assert isinstance(foo, Foo)
+    return foo.bar
+
+
+# Note that the input and output type are automatically inferred!
+# You do not need to specify them.
+# runnable = RunnableLambda(func).with_types( # <-- Not needed in this case
+#     input_schema=Foo,
+#     output_schema=int,
+#
+add_routes(app, RunnableLambda(func), path="/foo")
+```
+
+### Playground Widgets
+
+The playground allows you to define custom widgets for your runnable from the backend.
+
+Here are a few examples:
+
+| Description                                                                                                                                                                                                                                                        | Links                                                                                                                                                                                                                                |
+|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Widgets** Different widgets that can be used with playground (file upload and chat)                                                                                                                                                                              | [server](https://github.com/langchain-ai/langserve/tree/main/examples/widgets/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/widgets/client.ipynb)                                               | 
+| **Widgets** File upload widget used for LangServe playground.                                                                                                                                                                                                      | [server](https://github.com/langchain-ai/langserve/tree/main/examples/file_processing/server.py), [client](https://github.com/langchain-ai/langserve/tree/main/examples/file_processing/client.ipynb)                               | 
+
+#### Schema
+
+- A widget is specified at the field level and shipped as part of the JSON schema of the
+  input type
+- A widget must contain a key called `type` with the value being one of a well known
+  list of widgets
+- Other widget keys will be associated with values that describe paths in a JSON object
+
+```typescript
+type JsonPath = number | string | (number | string)[];
+type NameSpacedPath = { title: string; path: JsonPath }; // Using title to mimick json schema, but can use namespace
+type OneOfPath = { oneOf: JsonPath[] };
+
+type Widget = {
+    type: string // Some well known type (e.g., base64file, chat etc.)
+    [key: string]: JsonPath | NameSpacedPath | OneOfPath;
+};
+```
+
+### Available Widgets
+
+There are only two widgets that the user can specify manually right now:
+
+1. File Upload Widget
+2. Chat History Widget
+
+See below more information about these widgets.
+
+All other widgets on the playground UI are created and managed automatically by the UI
+based on the config schema of the Runnable. When you create Configurable Runnables,
+the playground should create appropriate widgets for you to control the behavior.
+
+#### File Upload Widget
+
+Allows creation of a file upload input in the UI playground for files
+that are uploaded as base64 encoded strings. Here's the
+full [example](https://github.com/langchain-ai/langserve/tree/main/examples/file_processing).
+
+Snippet:
+
+```python
+try:
+    from pydantic.v1 import Field
+except ImportError:
+    from pydantic import Field
+
+from langserve import CustomUserType
+
+
+# ATTENTION: Inherit from CustomUserType instead of BaseModel otherwise
+#            the server will decode it into a dict instead of a pydantic model.
+class FileProcessingRequest(CustomUserType):
+    """Request including a base64 encoded file."""
+
+    # The extra field is used to specify a widget for the playground UI.
+    file: str = Field(..., extra={"widget": {"type": "base64file"}})
+    num_chars: int = 100
+
+```
+
+Example widget:
+
+<p align="center">
+<img src="https://github.com/langchain-ai/langserve/assets/3205522/52199e46-9464-4c2e-8be8-222250e08c3f" width="50%"/>
+</p>
+
+### Chat Widget
+
+Look
+at [widget example](https://github.com/langchain-ai/langserve/tree/main/examples/widgets/server.py).
+
+To define a chat widget, make sure that you pass "type": "chat".
+
+* "input" is JSONPath to the field in the *Request* that has the new input message.
+* "output" is JSONPath to the field in the *Response* that has new output message(s).
+* Don't specify these fields if the entire input or output should be used as they are (
+  e.g., if the output is a list of chat messages.)
+
+Here's a snippet:
+
+```python
+
+class ChatHistory(CustomUserType):
+    chat_history: List[Tuple[str, str]] = Field(
+        ...,
+        examples=[[("human input", "ai response")]],
+        extra={"widget": {"type": "chat", "input": "question", "output": "answer"}},
+    )
+    question: str
+
+
+def _format_to_messages(input: ChatHistory) -> List[BaseMessage]:
+    """Format the input to a list of messages."""
+    history = input.chat_history
+    user_input = input.question
+
+    messages = []
+
+    for human, ai in history:
+        messages.append(HumanMessage(content=human))
+        messages.append(AIMessage(content=ai))
+    messages.append(HumanMessage(content=user_input))
+    return messages
+
+
+model = ChatOpenAI()
+chat_model = RunnableParallel({"answer": (RunnableLambda(_format_to_messages) | model)})
+add_routes(
+    app,
+    chat_model.with_types(input_type=ChatHistory),
+    config_keys=["configurable"],
+    path="/chat",
+)
+```
+
+Example widget:
+<p align="center">
+<img src="https://github.com/langchain-ai/langserve/assets/3205522/a71ff37b-a6a9-4857-a376-cf27c41d3ca4" width="50%"/>
+</p>
+
+### Enabling / Disabling Endpoints (LangServe >=0.0.33)
+
+You can enable / disable which endpoints are exposed. Use `enabled_endpoints` if you
+want to make sure to never get a new endpoint when upgrading langserve to a newer
+verison.
+
+Enable: The code below will only enable `invoke`, `batch` and the
+corresponding `config_hash` endpoint variants.
+
+```python
+add_routes(app, chain, enabled_endpoints=["invoke", "batch", "config_hashes"])
+```
+
+Disable: The code below will disable the playground for the chain
+
+```python
+add_routes(app, chain, disabled_endpoints=["playground"])
+```

examples/agent/client.ipynb

@@ -18,16 +18,20 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
-   "metadata": {},
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'output': {'output': 'Eugene thinks that cats like fish.'}}"
+       "{'output': {'output': 'Eugene thinks that cats like fish.'},\n",
+       " 'callback_events': [],\n",
+       " 'metadata': {'run_id': 'e3d53871-4329-4f02-a17e-79d9b766f409'}}"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 1,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -50,7 +54,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 3,
+   "execution_count": 2,
    "metadata": {
     "tags": []
    },
@@ -70,7 +74,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 4,
+   "execution_count": 3,
    "metadata": {
     "tags": []
    },
@@ -81,7 +85,7 @@
        "{'output': 'Hello! How can I assist you today?'}"
       ]
      },
-     "execution_count": 4,
+     "execution_count": 3,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -92,7 +96,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 5,
+   "execution_count": 4,
    "metadata": {
     "tags": []
    },
@@ -103,7 +107,7 @@
        "{'output': 'Eugene thinks that cats like fish.'}"
       ]
      },
-     "execution_count": 5,
+     "execution_count": 4,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -113,11 +117,706 @@
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [
+    "## Stream\n",
+    "\n",
+    "Please note that streaming alternates between actions and observations. It does not stream individual tokens! If you need to stream individual tokens you will need to use astream_log!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "--\n",
+      "{'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])], 'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}\n",
+      "--\n",
+      "{'steps': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]), 'observation': [Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]}], 'messages': [FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')]}\n",
+      "--\n",
+      "{'output': \"Eugene thinks that cats like fish. Now let me tell you a story about that thought.\\n\\nOnce upon a time, in a small village, there lived a mischievous cat named Whiskers. Whiskers was known for his love for fish. Every day, he would venture out to the nearby river in search of his favorite food.\\n\\nOne sunny day, Whiskers set out on his usual fish-hunting expedition. As he approached the riverbank, he noticed a group of fishermen casting their nets into the water. Whiskers couldn't resist the temptation and decided to join in on the action.\\n\\nWith his agile paws, Whiskers skillfully maneuvered through the fishermen, strategically positioning himself to snatch the fish caught in their nets. The fishermen were amazed by Whiskers' quick reflexes and couldn't help but laugh at the sight of a cat fishing alongside them.\\n\\nWhiskers continued his fish-stealing escapades for several days, becoming somewhat of a local legend. People from neighboring villages would come to witness the incredible sight of a cat outsmarting seasoned fishermen.\\n\\nOne day, as Whiskers was enjoying his stolen fish by the river, he noticed a stray dog named Rover approaching him. Rover had heard about Whiskers' fishing talents and was intrigued by the cat's abilities.\\n\\nCurious, Whiskers decided to share his secret with Rover. He taught him the art of stealth and how to snatch fish from the nets without being noticed. Rover, being a quick learner, soon became Whiskers' partner in crime.\\n\\nTogether, Whiskers and Rover formed an unbeatable duo, leaving the fishermen puzzled and amazed at the disappearing fish. The villagers, entertained by their antics, started leaving fish out for Whiskers and Rover as a token of appreciation.\\n\\nAnd so, Whiskers and Rover continued their fish-stealing adventures, bringing joy and laughter to the village. Eugene's thought about cats and their love for fish certainly came to life in the mischievous and clever Whiskers, who proved that cats truly have a special affinity for fish.\", 'messages': [AIMessage(content=\"Eugene thinks that cats like fish. Now let me tell you a story about that thought.\\n\\nOnce upon a time, in a small village, there lived a mischievous cat named Whiskers. Whiskers was known for his love for fish. Every day, he would venture out to the nearby river in search of his favorite food.\\n\\nOne sunny day, Whiskers set out on his usual fish-hunting expedition. As he approached the riverbank, he noticed a group of fishermen casting their nets into the water. Whiskers couldn't resist the temptation and decided to join in on the action.\\n\\nWith his agile paws, Whiskers skillfully maneuvered through the fishermen, strategically positioning himself to snatch the fish caught in their nets. The fishermen were amazed by Whiskers' quick reflexes and couldn't help but laugh at the sight of a cat fishing alongside them.\\n\\nWhiskers continued his fish-stealing escapades for several days, becoming somewhat of a local legend. People from neighboring villages would come to witness the incredible sight of a cat outsmarting seasoned fishermen.\\n\\nOne day, as Whiskers was enjoying his stolen fish by the river, he noticed a stray dog named Rover approaching him. Rover had heard about Whiskers' fishing talents and was intrigued by the cat's abilities.\\n\\nCurious, Whiskers decided to share his secret with Rover. He taught him the art of stealth and how to snatch fish from the nets without being noticed. Rover, being a quick learner, soon became Whiskers' partner in crime.\\n\\nTogether, Whiskers and Rover formed an unbeatable duo, leaving the fishermen puzzled and amazed at the disappearing fish. The villagers, entertained by their antics, started leaving fish out for Whiskers and Rover as a token of appreciation.\\n\\nAnd so, Whiskers and Rover continued their fish-stealing adventures, bringing joy and laughter to the village. Eugene's thought about cats and their love for fish certainly came to life in the mischievous and clever Whiskers, who proved that cats truly have a special affinity for fish.\")]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream({\"input\": \"what does eugene think of cats? Then tell me a story about that thought.\"}):\n",
+    "    print('--')\n",
+    "    print(chunk)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Stream log\n",
+    "\n",
+    "If you need acccess the individual llm tokens from an agent use `astream_log`. Please make sure that you set **streaming=True** on your LLM (see server code). For this to work, the LLM must also support streaming!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "--\n",
+      "RunLogPatch({'op': 'replace',\n",
+      "  'path': '',\n",
+      "  'value': {'final_output': None,\n",
+      "            'id': '1213bf75-c5ff-401a-b3c5-b4663ec7dfca',\n",
+      "            'logs': {},\n",
+      "            'streamed_output': []}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '7629fc73-a2fd-48fa-b9a2-c336e270180d',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableSequence',\n",
+      "            'start_time': '2024-01-05T22:24:50.737+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': [],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '72d2e143-d977-4661-b901-430cae1ee739',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableParallel<input,agent_scratchpad>',\n",
+      "            'start_time': '2024-01-05T22:24:50.738+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '7ec78a86-596f-4904-9888-45ef67302cb8',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-05T22:24:50.739+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:input'],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '281ca194-3e0c-490c-b637-759f5d971769',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-05T22:24:50.739+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:agent_scratchpad'],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>/final_output',\n",
+      "  'value': {'output': 'what does eugene think of cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>/end_time',\n",
+      "  'value': '2024-01-05T22:24:50.740+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2/final_output',\n",
+      "  'value': {'output': []}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2/end_time',\n",
+      "  'value': '2024-01-05T22:24:50.740+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>/final_output',\n",
+      "  'value': {'agent_scratchpad': [],\n",
+      "            'input': 'what does eugene think of cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>/end_time',\n",
+      "  'value': '2024-01-05T22:24:50.740+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '68c6ad9d-b9f0-47e0-9ea7-d0f170a22732',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'ChatPromptTemplate',\n",
+      "            'start_time': '2024-01-05T22:24:50.741+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2'],\n",
+      "            'type': 'prompt'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate/final_output',\n",
+      "  'value': {'messages': [SystemMessage(content='You are a helpful assistant.'),\n",
+      "                         HumanMessage(content='what does eugene think of cats?')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate/end_time',\n",
+      "  'value': '2024-01-05T22:24:50.741+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '883e05a9-6b29-4494-92b3-51c72973cb54',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'ChatOpenAI',\n",
+      "            'start_time': '2024-01-05T22:24:50.743+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': ''}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '{\\n'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' '}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' \"'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': 'query'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '\":'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' \"'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': 'cats'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '\"\\n'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '}'}})})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGeneration(generation_info={'finish_reason': 'function_call'}, message=AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.497+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'f8052926-8eb1-4df1-a701-309ee48fd63c',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'OpenAIFunctionsAgentOutputParser',\n",
+      "            'start_time': '2024-01-05T22:24:51.498+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:4'],\n",
+      "            'type': 'parser'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser/final_output',\n",
+      "  'value': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.499+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence/final_output',\n",
+      "  'value': {'output': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.500+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])],\n",
+      "            'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}},\n",
+      " {'op': 'replace',\n",
+      "  'path': '/final_output',\n",
+      "  'value': {'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])],\n",
+      "            'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/get_eugene_thoughts',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'e745d7ec-5992-4ab8-a3ef-191342c6470c',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'get_eugene_thoughts',\n",
+      "            'start_time': '2024-01-05T22:24:51.501+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': [],\n",
+      "            'type': 'tool'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/get_eugene_thoughts/final_output',\n",
+      "  'value': {'output': \"[Document(page_content='cats like fish'), \"\n",
+      "                      \"Document(page_content='dogs like sticks')]\"}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/get_eugene_thoughts/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.737+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'messages': [FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')],\n",
+      "            'steps': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]),\n",
+      "                       'observation': [Document(page_content='cats like fish'),\n",
+      "                                       Document(page_content='dogs like sticks')]}]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/steps',\n",
+      "  'value': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]),\n",
+      "             'observation': [Document(page_content='cats like fish'),\n",
+      "                             Document(page_content='dogs like sticks')]}]},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/messages/1',\n",
+      "  'value': FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '15d4ae13-554b-4144-9aa8-05527a15c042',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableSequence',\n",
+      "            'start_time': '2024-01-05T22:24:51.739+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': [],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '207dab98-d50c-4f2c-934d-291ba3ffd953',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableParallel<input,agent_scratchpad>',\n",
+      "            'start_time': '2024-01-05T22:24:51.740+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:3',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '8795a642-3f8e-4e5c-aec6-825b7aac2148',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-05T22:24:51.741+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:input'],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:4',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '60be3aac-3718-4386-a941-1dd371b9a3ea',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-05T22:24:51.741+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:agent_scratchpad'],\n",
+      "            'type': 'chain'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:3/final_output',\n",
+      "  'value': {'output': 'what does eugene think of cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:3/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.742+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:4/final_output',\n",
+      "  'value': {'output': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}),\n",
+      "                       FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:4/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.742+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>:2/final_output',\n",
+      "  'value': {'agent_scratchpad': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}),\n",
+      "                                 FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')],\n",
+      "            'input': 'what does eugene think of cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>:2/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.742+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'f1ff89b0-ae9c-49d1-8a2e-73c7f001f1e7',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'ChatPromptTemplate',\n",
+      "            'start_time': '2024-01-05T22:24:51.743+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2'],\n",
+      "            'type': 'prompt'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate:2/final_output',\n",
+      "  'value': {'messages': [SystemMessage(content='You are a helpful assistant.'),\n",
+      "                         HumanMessage(content='what does eugene think of cats?'),\n",
+      "                         AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}),\n",
+      "                         FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate:2/end_time',\n",
+      "  'value': '2024-01-05T22:24:51.743+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'c4aeb3d0-33c3-4f46-80e9-d1ffb0f983f2',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'ChatOpenAI',\n",
+      "            'start_time': '2024-01-05T22:24:51.744+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI:2/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'E'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='E')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'ug'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ug')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'ene'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ene')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' has'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' has')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' two'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' two')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' thoughts'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' thoughts')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' on'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' on')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' cats'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' cats')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': '.'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='.')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' One'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' One')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' thought'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' thought')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' is'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' is')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' \"'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' \"')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'cats'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='cats')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' like'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' like')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' fish'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' fish')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': '\"'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='\"')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' and'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' and')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' the'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' the')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' other'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' other')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' thought'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' thought')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' is'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' is')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' \"'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' \"')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'dogs'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='dogs')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' like'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' like')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' sticks'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' sticks')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': '\".'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='\".')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI:2/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGeneration(text='Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".', generation_info={'finish_reason': 'stop'}, message=AIMessage(content='Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".'))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/end_time',\n",
+      "  'value': '2024-01-05T22:24:53.082+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '7074d8c2-df0b-4d18-9890-dd050c2f0ca9',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'OpenAIFunctionsAgentOutputParser',\n",
+      "            'start_time': '2024-01-05T22:24:53.083+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:4'],\n",
+      "            'type': 'parser'}})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser:2/final_output',\n",
+      "  'value': AgentFinish(return_values={'output': 'Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".'}, log='Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".')},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser:2/end_time',\n",
+      "  'value': '2024-01-05T22:24:53.084+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2/final_output',\n",
+      "  'value': {'output': AgentFinish(return_values={'output': 'Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".'}, log='Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".')}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2/end_time',\n",
+      "  'value': '2024-01-05T22:24:53.084+00:00'})\n",
+      "--\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'messages': [AIMessage(content='Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".')],\n",
+      "            'output': 'Eugene has two thoughts on cats. One thought is \"cats '\n",
+      "                      'like fish\" and the other thought is \"dogs like '\n",
+      "                      'sticks\".'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/output',\n",
+      "  'value': 'Eugene has two thoughts on cats. One thought is \"cats like fish\" '\n",
+      "           'and the other thought is \"dogs like sticks\".'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/messages/2',\n",
+      "  'value': AIMessage(content='Eugene has two thoughts on cats. One thought is \"cats like fish\" and the other thought is \"dogs like sticks\".')})\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream_log({\"input\": \"what does eugene think of cats?\"}):\n",
+    "    print('--')\n",
+    "    print(chunk)"
+   ]
   }
  ],
  "metadata": {
@@ -136,7 +835,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.1"
+   "version": "3.9.6"
   }
  },
  "nbformat": 4,

examples/agent/server.py

@@ -1,5 +1,16 @@
 #!/usr/bin/env python
-"""Example LangChain server exposes a conversational retrieval chain."""
+"""Example LangChain server exposes a conversational retrieval agent.
+
+Please see documentation for custom agent streaming here:
+
+https://python.langchain.com/docs/modules/agents/how_to/streaming#stream-tokens
+
+**ATTENTION**
+To support streaming individual tokens you will need to manually set the streaming=True
+on the LLM and use the stream_log endpoint rather than stream endpoint.
+"""
+from typing import Any
+
 from fastapi import FastAPI
 from langchain.agents import AgentExecutor, tool
 from langchain.agents.format_scratchpad import format_to_openai_functions
@@ -7,9 +18,9 @@ from langchain.agents.output_parsers import OpenAIFunctionsAgentOutputParser
 from langchain.chat_models import ChatOpenAI
 from langchain.embeddings import OpenAIEmbeddings
 from langchain.prompts import ChatPromptTemplate, MessagesPlaceholder
+from langchain.pydantic_v1 import BaseModel
 from langchain.tools.render import format_tool_to_openai_function
 from langchain.vectorstores import FAISS
-from pydantic import BaseModel
 
 from langserve import add_routes
 
@@ -35,7 +46,10 @@ prompt = ChatPromptTemplate.from_messages(
     ]
 )
 
-llm = ChatOpenAI()
+# We need to set streaming=True on the LLM to support streaming individual tokens.
+# when using the stream_log endpoint.
+# .stream for agents streams action observation pairs not individual tokens.
+llm = ChatOpenAI(streaming=True)
 
 llm_with_tools = llm.bind(functions=[format_tool_to_openai_function(t) for t in tools])
 
@@ -67,14 +81,14 @@ class Input(BaseModel):
 
 
 class Output(BaseModel):
-    output: str
+    output: Any
 
 
 # Adds routes to the app for using the chain under:
 # /invoke
 # /batch
 # /stream
-add_routes(app, agent_executor, input_type=Input, output_type=Output)
+add_routes(app, agent_executor.with_types(input_type=Input, output_type=Output))
 
 if __name__ == "__main__":
     import uvicorn

examples/api_handler_examples/server.py

@@ -0,0 +1,125 @@
+"""An example that shows how to use the API handler directly.
+
+For this to work with RemoteClient, the routes must match those expected
+by the client; i.e., /invoke, /batch, /stream, etc. No trailing slashes should be used.
+"""
+from importlib import metadata
+from typing import Annotated
+
+from fastapi import Depends, FastAPI, Request, Response
+from langchain_core.runnables import RunnableLambda
+from sse_starlette import EventSourceResponse
+
+from langserve import APIHandler
+
+PYDANTIC_VERSION = metadata.version("pydantic")
+_PYDANTIC_MAJOR_VERSION: int = int(PYDANTIC_VERSION.split(".")[0])
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+##
+# Example 1 -- invoke, batch together with doc-generation
+# This endpoint shows how to expose `invoke` and `batch` using the APIHandler.
+# It also shows how to generate documentation properly so it works correctly
+# depending on Fast API and pydantic versions.
+def add_one(x: int) -> int:
+    """Add one to the given number."""
+    return x + 1
+
+
+chain = RunnableLambda(add_one)
+
+api_handler = APIHandler(chain, path="/simple")
+
+
+# First register the endpoints without documentation
+@app.post("/simple/invoke", include_in_schema=False)
+async def simple_invoke(request: Request) -> Response:
+    """Handle a request."""
+    # The API Handler validates the parts of the request
+    # that are used by the runnnable (e.g., input, config fields)
+    return await api_handler.invoke(request)
+
+
+@app.post("/simple/batch", include_in_schema=False)
+async def simple_batch(request: Request) -> Response:
+    """Handle a request."""
+    # The API Handler validates the parts of the request
+    # that are used by the runnnable (e.g., input, config fields)
+    return await api_handler.batch(request)
+
+
+# Here, we show how to populate the documentation for the endpoint.
+# Please note that this is done separately from the actual endpoint.
+# This happens due to two reasons:
+# 1. FastAPI does not support using pydantic.v1 models in the docs endpoint.
+#    "https://github.com/tiangolo/fastapi/issues/10360"
+#    LangChain uses pydantic.v1 models!
+# 2. Configurable Runnables have a *dynamic* schema, which means that
+#    the shape of the input depends on the config.
+#    In this case, the openapi schema is a best effort showing the documentation
+#    that will work for the default config (and any non-conflicting configs).
+if _PYDANTIC_MAJOR_VERSION == 1:  # Do not use in your own
+    # Add documentation
+    @app.post("/simple/invoke")
+    async def simple_invoke_docs(
+        request: api_handler.InvokeRequest,
+    ) -> api_handler.InvokeResponse:
+        """API endpoint used only for documentation purposes. Populate /docs endpoint"""
+        raise NotImplementedError(
+            "This endpoint is only used for documentation purposes"
+        )
+
+    @app.post("/simple/batch")
+    async def simple_batch_docs(
+        request: api_handler.BatchRequest,
+    ) -> api_handler.BatchResponse:
+        """API endpoint used only for documentation purposes. Populate /docs endpoint"""
+        raise NotImplementedError(
+            "This endpoint is only used for documentation purposes"
+        )
+
+else:
+    print(
+        "Skipping documentation generation for pydantic v2: "
+        "https://github.com/tiangolo/fastapi/issues/10360"
+    )
+
+
+##
+# Example 2 -- Expose `invoke` and `stream` using the API Handler.
+# Uses FastAPI Depends get a ready API handler.
+async def _get_api_handler() -> APIHandler:
+    """Prepare a RunnableLambda."""
+    return APIHandler(RunnableLambda(add_one), path="/v2")
+
+
+@app.post("/v2/invoke")
+async def v2_invoke(
+    request: Request, runnable: Annotated[APIHandler, Depends(_get_api_handler)]
+) -> Response:
+    """Handle invoke request."""
+    # The API Handler validates the parts of the request
+    # that are used by the runnnable (e.g., input, config fields)
+    return await runnable.invoke(request)
+
+
+@app.post("/v2/stream")
+async def v2_stream(
+    request: Request, runnable: Annotated[APIHandler, Depends(_get_api_handler)]
+) -> EventSourceResponse:
+    """Handle stream request."""
+    # The API Handler validates the parts of the request
+    # that are used by the runnnable (e.g., input, config fields)
+    return await runnable.stream(request)
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/auth/api_handler/client.ipynb

@@ -0,0 +1,212 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Client\n",
+    "\n",
+    "This is an example client that interacts with the server that has \"auth\".\n",
+    "\n",
+    "Please reference appropriate documentation in the server code and in FastAPI to actually make this secure.\n",
+    "\n",
+    "\n",
+    "**ATTENTION** Only the invoke endpoint has been defined by the server! \n",
+    "So batch/stream won't work. If you want to add stream and batch, you can do so as well on the server side.\n",
+    "The server is implemented using the APIHandler, it's more flexible, but does require a bit more code. :)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Login as Alice"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "\n",
+    "response = requests.post(\"http://localhost:8000/token\", data={\"username\": \"alice\", \"password\": \"secret1\"})\n",
+    "result = response.json()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "token = result['access_token']"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "inputs = {\"input\": \"hello\"}\n",
+    "response = requests.post(\"http://localhost:8000/my_runnable/invoke\", \n",
+    "    json={\n",
+    "        'input': 'hello',\n",
+    "    },\n",
+    "    headers={\n",
+    "        'Authorization': f\"Bearer {token}\"\n",
+    "    }\n",
+    ")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output': [{'page_content': 'cats like mice',\n",
+       "   'metadata': {'owner_id': 'alice'},\n",
+       "   'type': 'Document'},\n",
+       "  {'page_content': 'cats like cheese',\n",
+       "   'metadata': {'owner_id': 'alice'},\n",
+       "   'type': 'Document'}],\n",
+       " 'callback_events': [],\n",
+       " 'metadata': {'run_id': '1732c9aa-c6d3-4736-b8ca-01265fa8ba06'}}"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "response.json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "You can also interact with this via the RemoteRunnable interface (to use in other chains)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/my_runnable\", headers={\"Authorization\": f\"Bearer {token}\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='cats like mice', metadata={'owner_id': 'alice'}),\n",
+       " Document(page_content='cats like cheese', metadata={'owner_id': 'alice'})]"
+      ]
+     },
+     "execution_count": 6,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"cat\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Login as John"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "\n",
+    "response = requests.post(\"http://localhost:8000/token\", data={\"username\": \"john\", \"password\": \"secret2\"})\n",
+    "token = response.json()['access_token']\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/my_runnable\", headers={\"Authorization\": f\"Bearer {token}\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='i like walks by the ocean', metadata={'owner_id': 'john'}),\n",
+       " Document(page_content='dogs like sticks', metadata={'owner_id': 'john'}),\n",
+       " Document(page_content='my favorite food is cheese', metadata={'owner_id': 'john'})]"
+      ]
+     },
+     "execution_count": 8,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"water\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/auth/api_handler/server.py

@@ -0,0 +1,285 @@
+#!/usr/bin/env python
+"""Example that shows how to use the underlying APIHandler class directly with Auth.
+
+This example shows how to apply logic based on the user's identity.
+
+You can build on these concepts to implement a more complex app:
+* Add endpoints that allow users to manage their documents.
+* Make a more complex runnable that does something with the retrieved documents; e.g.,
+  a conversational agent that responds to the user's input with the retrieved documents
+  (which are user specific documents).
+
+For authentication, we use a fake token that's the same as the username, adapting
+the following example from the FastAPI docs:
+
+https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/
+
+**ATTENTION**
+
+This example is not actually secure and should not be used in production.
+
+Once you understand how to use `per_req_config_modifier`, read through
+the FastAPI docs and implement proper auth:
+https://fastapi.tiangolo.com/tutorial/security/oauth2-jwt/
+
+
+**ATTENTION**
+
+This example does not integrate auth with OpenAPI, so the OpenAPI docs won't
+be able to help with authentication. This is currently a limitation
+if using `add_routes`. If you need this functionality, you can use
+the underlying `APIHandler` class directly, which affords maximal flexibility.
+"""
+from importlib import metadata
+from typing import Any, List, Optional, Union
+
+from fastapi import Depends, FastAPI, HTTPException, Request, Response, status
+from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
+from langchain_community.embeddings.openai import OpenAIEmbeddings
+from langchain_community.vectorstores.chroma import Chroma
+from langchain_core.documents import Document
+from langchain_core.runnables import (
+    ConfigurableField,
+    RunnableConfig,
+    RunnableSerializable,
+)
+from langchain_core.vectorstores import VectorStore
+from typing_extensions import Annotated
+
+from langserve import APIHandler
+from langserve.pydantic_v1 import BaseModel
+
+
+class User(BaseModel):
+    username: str
+    email: Union[str, None] = None
+    full_name: Union[str, None] = None
+    disabled: Union[bool, None] = None
+
+
+class UserInDB(User):
+    hashed_password: str
+
+
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
+
+app = FastAPI()
+
+FAKE_USERS_DB = {
+    "alice": {
+        "username": "alice",
+        "full_name": "Alice Wonderson",
+        "email": "alice@example.com",
+        "hashed_password": "fakehashedsecret1",
+        "disabled": False,
+    },
+    "john": {
+        "username": "john",
+        "full_name": "John Doe",
+        "email": "johndoe@example.com",
+        "hashed_password": "fakehashedsecret2",
+        "disabled": False,
+    },
+    "bob": {
+        "username": "john",
+        "full_name": "John Doe",
+        "email": "johndoe@example.com",
+        "hashed_password": "fakehashedsecret3",
+        "disabled": True,
+    },
+}
+
+
+def _fake_hash_password(password: str) -> str:
+    """Fake a hashed password."""
+    return "fakehashed" + password
+
+
+def _get_user(db: dict, username: str) -> Union[UserInDB, None]:
+    if username in db:
+        user_dict = db[username]
+        return UserInDB(**user_dict)
+
+
+def _fake_decode_token(token: str) -> Union[User, None]:
+    # This doesn't provide any security at all
+    # Check the next version
+    user = _get_user(FAKE_USERS_DB, token)
+    return user
+
+
+@app.post("/token")
+async def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]):
+    user_dict = FAKE_USERS_DB.get(form_data.username)
+    if not user_dict:
+        raise HTTPException(status_code=400, detail="Incorrect username or password")
+    user = UserInDB(**user_dict)
+    hashed_password = _fake_hash_password(form_data.password)
+    if not hashed_password == user.hashed_password:
+        raise HTTPException(status_code=400, detail="Incorrect username or password")
+
+    return {"access_token": user.username, "token_type": "bearer"}
+
+
+async def get_current_user(token: Annotated[str, Depends(oauth2_scheme)]):
+    user = _fake_decode_token(token)
+    if not user:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Invalid authentication credentials",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+    return user
+
+
+async def get_current_active_user(
+    current_user: Annotated[User, Depends(get_current_user)],
+):
+    if current_user.disabled:
+        raise HTTPException(status_code=400, detail="Inactive user")
+    return current_user
+
+
+class PerUserVectorstore(RunnableSerializable):
+    """A custom runnable that returns a list of documents for the given user.
+
+    The runnable is configurable by the user, and the search results are
+    filtered by the user ID.
+    """
+
+    user_id: Optional[str]
+    vectorstore: VectorStore
+
+    class Config:
+        # Allow arbitrary types since VectorStore is an abstract interface
+        # and not a pydantic model
+        arbitrary_types_allowed = True
+
+    def _invoke(
+        self, input: str, config: Optional[RunnableConfig] = None, **kwargs: Any
+    ) -> List[Document]:
+        """Invoke the retriever."""
+        # WARNING: Verify documentation of underlying vectorstore to make
+        # sure that it actually uses filters.
+        # Highly recommended to use unit-tests to verify this behavior, as
+        # implementations can be different depending on the underlying vectorstore.
+        retriever = self.vectorstore.as_retriever(
+            search_kwargs={"filter": {"owner_id": self.user_id}}
+        )
+        return retriever.invoke(input, config=config)
+
+    def invoke(
+        self, input: str, config: Optional[RunnableConfig] = None, **kwargs
+    ) -> List[Document]:
+        """Add one to an integer."""
+        return self._call_with_config(self._invoke, input, config, **kwargs)
+
+
+vectorstore = Chroma(
+    collection_name="some_collection",
+    embedding_function=OpenAIEmbeddings(),
+)
+
+vectorstore.add_documents(
+    [
+        Document(
+            page_content="cats like cheese",
+            metadata={"owner_id": "alice"},
+        ),
+        Document(
+            page_content="cats like mice",
+            metadata={"owner_id": "alice"},
+        ),
+        Document(
+            page_content="dogs like sticks",
+            metadata={"owner_id": "john"},
+        ),
+        Document(
+            page_content="my favorite food is cheese",
+            metadata={"owner_id": "john"},
+        ),
+        Document(
+            page_content="i like walks by the ocean",
+            metadata={"owner_id": "john"},
+        ),
+        Document(
+            page_content="dogs like grass",
+            metadata={"owner_id": "bob"},
+        ),
+    ]
+)
+
+per_user_retriever = PerUserVectorstore(
+    user_id=None,  # Placeholder ID that will be replaced by the per_req_config_modifier
+    vectorstore=vectorstore,
+).configurable_fields(
+    # Attention: Make sure to override the user ID for each request in the
+    # per_req_config_modifier. This should not be client configurable.
+    user_id=ConfigurableField(
+        id="user_id",
+        name="User ID",
+        description="The user ID to use for the retriever.",
+    )
+)
+
+
+# Let's define the API Handler
+api_handler = APIHandler(
+    per_user_retriever,
+    # Namespace for the runnable.
+    # Endpoints like batch / invoke should be under /my_runnable/invoke
+    # and /my_runnable/batch etc.
+    path="/my_runnable",
+)
+
+
+PYDANTIC_VERSION = metadata.version("pydantic")
+_PYDANTIC_MAJOR_VERSION: int = int(PYDANTIC_VERSION.split(".")[0])
+
+
+# **ATTENTION** Your code does not need to include both versions.
+# Use whichever version is appropriate given the pydantic version you are using.
+# Both versions are included here for demonstration purposes.
+#
+# If using pydantic <2, everything works as expected.
+# However, when using pydantic >=2 is installed, things are a bit
+# more complicated because LangChain uses the pydantic.v1 namespace
+# But the pydantic.v1 namespace is not supported by FastAPI.
+# See this issue: https://github.com/tiangolo/fastapi/issues/10360
+# So when using pydantic >=2, we need to use a vanilla starlette request
+# and response, and we will not have documentation.
+# Or we can create custom models for the request and response.
+# The underlying API Handler will still validate the request
+# correctly even if vanilla requests are used.
+if _PYDANTIC_MAJOR_VERSION == 1:
+
+    @app.post("/my_runnable/invoke")
+    async def invoke_with_auth(
+        # Included for documentation purposes
+        invoke_request: api_handler.InvokeRequest,
+        request: Request,
+        current_user: Annotated[User, Depends(get_current_active_user)],
+    ) -> Response:
+        """Handle a request."""
+        # The API Handler validates the parts of the request
+        # that are used by the runnnable (e.g., input, config fields)
+        config = {"configurable": {"user_id": current_user.username}}
+        return await api_handler.invoke(request, server_config=config)
+else:
+
+    @app.post("/my_runnable/invoke")
+    async def invoke_with_auth(
+        request: Request,
+        current_user: Annotated[User, Depends(get_current_active_user)],
+    ) -> Response:
+        """Handle a request."""
+        # The API Handler validates the parts of the request
+        # that are used by the runnnable (e.g., input, config fields)
+        config = {"configurable": {"user_id": current_user.username}}
+        return await api_handler.invoke(request, server_config=config)
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/auth/global_deps/server.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python
+"""An example that uses Fast API global dependencies.
+
+This approach can be used if the same authentication logic can be used
+for all endpoints in the application.
+
+This may be a reasonable approach for simple applications.
+
+See:
+
+* https://fastapi.tiangolo.com/tutorial/dependencies/global-dependencies/
+* https://fastapi.tiangolo.com/tutorial/dependencies/
+* https://fastapi.tiangolo.com/tutorial/security/
+"""
+
+from fastapi import Depends, FastAPI, Header, HTTPException
+from langchain_core.runnables import RunnableLambda
+from typing_extensions import Annotated
+
+from langserve import add_routes
+
+
+async def verify_token(x_token: Annotated[str, Header()]) -> None:
+    """Verify the token is valid."""
+    # Replace this with your actual authentication logic
+    if x_token != "secret-token":
+        raise HTTPException(status_code=400, detail="X-Token header invalid")
+
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    dependencies=[Depends(verify_token)],
+)
+
+
+def add_one(x: int) -> int:
+    """Add one to an integer."""
+    return x + 1
+
+
+chain = RunnableLambda(add_one)
+
+
+add_routes(
+    app,
+    chain,
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/auth/path_dependencies/server.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+"""An example that shows how to use path dependencies for authentication.
+
+The path dependencies are applied to all the routes added by the `add_routes`.
+
+To keep this example brief, we're providing a placeholder verify_token function
+that shows how to use path dependencies.
+
+To implement proper auth, please see the FastAPI docs:
+
+* https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/
+* https://fastapi.tiangolo.com/tutorial/dependencies/
+* https://fastapi.tiangolo.com/tutorial/security/
+"""  # noqa: E501
+
+from fastapi import Depends, FastAPI, Header, HTTPException
+from langchain_core.runnables import RunnableLambda
+from typing_extensions import Annotated
+
+from langserve import add_routes
+
+
+async def verify_token(x_token: Annotated[str, Header()]) -> None:
+    """Verify the token is valid."""
+    # Replace this with your actual authentication logic
+    if x_token != "secret-token":
+        raise HTTPException(status_code=400, detail="X-Token header invalid")
+
+
+app = FastAPI()
+
+
+def add_one(x: int) -> int:
+    """Add one to an integer."""
+    return x + 1
+
+
+chain = RunnableLambda(add_one)
+
+
+add_routes(
+    app,
+    chain,
+    dependencies=[Depends(verify_token)],
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/auth/per_req_config_modifier/client.ipynb

@@ -0,0 +1,207 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Client\n",
+    "\n",
+    "This is an example client that interacts with the server that has \"auth\".\n",
+    "\n",
+    "Please reference appropriate documentation in the server code and in FastAPI to actually make this secure."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Login as Alice"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "\n",
+    "response = requests.post(\"http://localhost:8000/token\", data={\"username\": \"alice\", \"password\": \"secret1\"})\n",
+    "result = response.json()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "token = result['access_token']"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "inputs = {\"input\": \"hello\"}\n",
+    "response = requests.post(\"http://localhost:8000/invoke\", \n",
+    "    json={\n",
+    "        'input': 'hello',\n",
+    "    },\n",
+    "    headers={\n",
+    "        'Authorization': f\"Bearer {token}\"\n",
+    "    }\n",
+    ")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output': [{'page_content': 'cats like mice',\n",
+       "   'metadata': {'owner_id': 'alice'},\n",
+       "   'type': 'Document'},\n",
+       "  {'page_content': 'cats like cheese',\n",
+       "   'metadata': {'owner_id': 'alice'},\n",
+       "   'type': 'Document'}],\n",
+       " 'callback_events': [],\n",
+       " 'metadata': {'run_id': '00000000-0000-0000-0000-000000000000'}}"
+      ]
+     },
+     "execution_count": 9,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "response.json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {
+    "tags": []
+   },
+   "source": [
+    "You can also interact with this via the RemoteRunnable interface (to use in other chains)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/\", headers={\"Authorization\": f\"Bearer {token}\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='cats like mice', metadata={'owner_id': 'alice'}),\n",
+       " Document(page_content='cats like cheese', metadata={'owner_id': 'alice'})]"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"cat\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Login as John"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 23,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "\n",
+    "response = requests.post(\"http://localhost:8000/token\", data={\"username\": \"john\", \"password\": \"secret2\"})\n",
+    "token = response.json()['access_token']\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/\", headers={\"Authorization\": f\"Bearer {token}\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 25,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='i like walks by the ocean', metadata={'owner_id': 'john'}),\n",
+       " Document(page_content='dogs like sticks', metadata={'owner_id': 'john'}),\n",
+       " Document(page_content='my favorite food is cheese', metadata={'owner_id': 'john'})]"
+      ]
+     },
+     "execution_count": 25,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"water\")"
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/auth/per_req_config_modifier/server.py

@@ -0,0 +1,243 @@
+#!/usr/bin/env python
+"""Example that shows how to use `per_req_config_modifier`.
+
+This is a simple example that shows how to use configurable runnables with
+per request configuration modification to achieve behavior that's different
+depending on the user.
+
+You can build on these concepts to implement a more complex app:
+* Add endpoints that allow users to manage their documents.
+* Make a more complex runnable that does something with the retrieved documents; e.g.,
+  a conversational agent that responds to the user's input with the retrieved documents
+  (which are user specific documents).
+
+For authentication, we use a fake token that's the same as the username, adapting
+the following example from the FastAPI docs:
+
+https://fastapi.tiangolo.com/tutorial/security/simple-oauth2/
+
+**ATTENTION**
+
+This example is not actually secure and should not be used in production.
+
+Once you understand how to use `per_req_config_modifier`, read through
+the FastAPI docs and implement proper auth:
+https://fastapi.tiangolo.com/tutorial/security/oauth2-jwt/
+
+
+**ATTENTION**
+
+This example does not integrate auth with OpenAPI, so the OpenAPI docs won't
+be able to help with authentication. This is currently a limitation
+if using `add_routes`. If you need this functionality, you can use
+the underlying `APIHandler` class directly, which affords maximal flexibility.
+"""
+from typing import Any, Dict, List, Optional, Union
+
+from fastapi import Depends, FastAPI, HTTPException, Request, status
+from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
+from langchain_community.embeddings.openai import OpenAIEmbeddings
+from langchain_community.vectorstores.chroma import Chroma
+from langchain_core.documents import Document
+from langchain_core.runnables import (
+    ConfigurableField,
+    RunnableConfig,
+    RunnableSerializable,
+)
+from langchain_core.vectorstores import VectorStore
+from typing_extensions import Annotated
+
+from langserve import add_routes
+from langserve.pydantic_v1 import BaseModel
+
+
+class User(BaseModel):
+    username: str
+    email: Union[str, None] = None
+    full_name: Union[str, None] = None
+    disabled: Union[bool, None] = None
+
+
+class UserInDB(User):
+    hashed_password: str
+
+
+oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")
+
+app = FastAPI()
+
+FAKE_USERS_DB = {
+    "alice": {
+        "username": "alice",
+        "full_name": "Alice Wonderson",
+        "email": "alice@example.com",
+        "hashed_password": "fakehashedsecret1",
+        "disabled": False,
+    },
+    "john": {
+        "username": "john",
+        "full_name": "John Doe",
+        "email": "johndoe@example.com",
+        "hashed_password": "fakehashedsecret2",
+        "disabled": False,
+    },
+    "bob": {
+        "username": "john",
+        "full_name": "John Doe",
+        "email": "johndoe@example.com",
+        "hashed_password": "fakehashedsecret3",
+        "disabled": True,
+    },
+}
+
+
+def _fake_hash_password(password: str) -> str:
+    """Fake a hashed password."""
+    return "fakehashed" + password
+
+
+def _get_user(db: dict, username: str) -> Union[UserInDB, None]:
+    if username in db:
+        user_dict = db[username]
+        return UserInDB(**user_dict)
+
+
+def _fake_decode_token(token: str) -> Union[User, None]:
+    # This doesn't provide any security at all
+    # Check the next version
+    user = _get_user(FAKE_USERS_DB, token)
+    return user
+
+
+@app.post("/token")
+async def login(form_data: Annotated[OAuth2PasswordRequestForm, Depends()]):
+    user_dict = FAKE_USERS_DB.get(form_data.username)
+    if not user_dict:
+        raise HTTPException(status_code=400, detail="Incorrect username or password")
+    user = UserInDB(**user_dict)
+    hashed_password = _fake_hash_password(form_data.password)
+    if not hashed_password == user.hashed_password:
+        raise HTTPException(status_code=400, detail="Incorrect username or password")
+
+    return {"access_token": user.username, "token_type": "bearer"}
+
+
+async def get_current_active_user_from_request(request: Request) -> User:
+    """Get the current active user from the request."""
+    token = await oauth2_scheme(request)
+    user = _fake_decode_token(token)
+    if not user:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Invalid authentication credentials",
+            headers={"WWW-Authenticate": "Bearer"},
+        )
+    if user.disabled:
+        raise HTTPException(status_code=400, detail="Inactive user")
+    return user
+
+
+class PerUserVectorstore(RunnableSerializable):
+    """A custom runnable that returns a list of documents for the given user.
+
+    The runnable is configurable by the user, and the search results are
+    filtered by the user ID.
+    """
+
+    user_id: Optional[str]
+    vectorstore: VectorStore
+
+    class Config:
+        # Allow arbitrary types since VectorStore is an abstract interface
+        # and not a pydantic model
+        arbitrary_types_allowed = True
+
+    def _invoke(
+        self, input: str, config: Optional[RunnableConfig] = None, **kwargs: Any
+    ) -> List[Document]:
+        """Invoke the retriever."""
+        # WARNING: Verify documentation of underlying vectorstore to make
+        # sure that it actually uses filters.
+        # Highly recommended to use unit-tests to verify this behavior, as
+        # implementations can be different depending on the underlying vectorstore.
+        retriever = self.vectorstore.as_retriever(
+            search_kwargs={"filter": {"owner_id": self.user_id}}
+        )
+        return retriever.invoke(input, config=config)
+
+    def invoke(
+        self, input: str, config: Optional[RunnableConfig] = None, **kwargs
+    ) -> List[Document]:
+        """Add one to an integer."""
+        return self._call_with_config(self._invoke, input, config, **kwargs)
+
+
+async def per_req_config_modifier(config: Dict, request: Request) -> Dict:
+    """Modify the config for each request."""
+    user = await get_current_active_user_from_request(request)
+    config["configurable"] = {}
+    # Attention: Make sure that the user ID is over-ridden for each request.
+    # We should not be accepting a user ID from the user in this case!
+    config["configurable"]["user_id"] = user.username
+    return config
+
+
+vectorstore = Chroma(
+    collection_name="some_collection",
+    embedding_function=OpenAIEmbeddings(),
+)
+
+vectorstore.add_documents(
+    [
+        Document(
+            page_content="cats like cheese",
+            metadata={"owner_id": "alice"},
+        ),
+        Document(
+            page_content="cats like mice",
+            metadata={"owner_id": "alice"},
+        ),
+        Document(
+            page_content="dogs like sticks",
+            metadata={"owner_id": "john"},
+        ),
+        Document(
+            page_content="my favorite food is cheese",
+            metadata={"owner_id": "john"},
+        ),
+        Document(
+            page_content="i like walks by the ocean",
+            metadata={"owner_id": "john"},
+        ),
+        Document(
+            page_content="dogs like grass",
+            metadata={"owner_id": "bob"},
+        ),
+    ]
+)
+
+per_user_retriever = PerUserVectorstore(
+    user_id=None,  # Placeholder ID that will be replaced by the per_req_config_modifier
+    vectorstore=vectorstore,
+).configurable_fields(
+    # Attention: Make sure to override the user ID for each request in the
+    # per_req_config_modifier. This should not be client configurable.
+    user_id=ConfigurableField(
+        id="user_id",
+        name="User ID",
+        description="The user ID to use for the retriever.",
+    )
+)
+
+add_routes(
+    app,
+    per_user_retriever,
+    per_req_config_modifier=per_req_config_modifier,
+    enabled_endpoints=["invoke"],
+)
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/chain/client.ipynb

@@ -1,191 +0,0 @@
-{
- "cells": [
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# Client\n",
-    "\n",
-    "Demo of client interacting with the simple chain server, which deploys a chain that tells jokes about a particular topic."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can interact with this via API directly"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "{'output': {'content': \"Why don't scientists trust atoms when playing sports? \\n\\nBecause they make up everything!\",\n",
-       "  'additional_kwargs': {},\n",
-       "  'type': 'ai',\n",
-       "  'example': False}}"
-      ]
-     },
-     "execution_count": 3,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "import requests\n",
-    "\n",
-    "inputs = {\"input\": {\"topic\": \"sports\"}}\n",
-    "response = requests.post(\"http://localhost:8000/invoke\", json=inputs)\n",
-    "\n",
-    "response.json()"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "You can also interact with this via the RemoteRunnable interface (to use in other chains)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "from langserve import RemoteRunnable\n",
-    "\n",
-    "remote_runnable = RemoteRunnable(\"http://localhost:8000/\")"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Remote runnable has the same interface as local runnables"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 3,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [],
-   "source": [
-    "response = await remote_runnable.ainvoke({\"topic\": \"sports\"})"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The client can also execute langchain code synchronously, and pass in configs"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 4,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "[AIMessage(content='Why did the football coach go to the bank?\\n\\nBecause he wanted to get his quarterback!', additional_kwargs={}, example=False),\n",
-       " AIMessage(content='Why did the car bring a sweater to the race?\\n\\nBecause it wanted to have a \"car-digan\" finish!', additional_kwargs={}, example=False)]"
-      ]
-     },
-     "execution_count": 4,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "from langchain.schema.runnable.config import RunnableConfig\n",
-    "\n",
-    "remote_runnable.batch([{\"topic\": \"sports\"}, {\"topic\": \"cars\"}])"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "The server supports streaming (using HTTP server-side events), which can help interact with long responses in real time"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 5,
-   "metadata": {
-    "tags": []
-   },
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Ah, indulge me in this lighthearted endeavor, dear interlocutor! Allow me to regale you with a rather verbose jest concerning our hirsute friends of the wilderness, the bears!\n",
-      "\n",
-      "Once upon a time, in the vast expanse of a verdant forest, there existed a most erudite and sagacious bear, renowned for his prodigious intellect and unabated curiosity. This bear, with his inquisitive disposition, embarked on a quest to uncover the secrets of humor, for he believed that laughter possessed the power to unite and uplift the spirits of all creatures, great and small.\n",
-      "\n",
-      "Upon his journey, our erudite bear encountered a group of mischievous woodland creatures, who, captivated by his exalted intelligence, dared to challenge him to create a jest that would truly encompass the majestic essence of the bear. Our sagacious bear, never one to back down from a challenge, took a moment to ponder, his profound thoughts swirling amidst the verdant canopy above.\n",
-      "\n",
-      "After much contemplation, the bear delivered his jest, thusly: \"Pray, dear friends, envision a most estimable gathering of bears, replete with their formidable bulk and majestic presence. In this symposium of ursine brilliance, one bear, with a prodigious appetite, sauntered forth to procure his daily sustenance. Alas, upon reaching his intended destination, he encountered a dapper gentleman, clad in a most resplendent suit, hitherto unseen in the realm of the forest.\n",
-      "\n",
-      "The gentleman, possessing an air of sophistication, addressed the bear with an air of candor, remarking, 'Good sir, I must confess that your corporeal form inspires awe and admiration in equal measure. However, I beseech you, kindly abstain from consuming the berries that grow in this territory, for they possess a most deleterious effect upon the digestive systems of bears.'\n",
-      "\n",
-      "In response, the bear, known for his indomitable spirit, replied in a most eloquent manner, 'Dearest sir, I appreciate your concern and your eloquent admonition, yet I must humbly convey that the allure of these succulent berries is simply irresistible. The culinary satisfaction they bring far outweighs the potential discomfort they may inflict upon my digestive faculties. Therefore, I am compelled to disregard your sage counsel and indulge in their delectable essence.'\n",
-      "\n",
-      "And so, dear listener, the bear, driven by his insatiable hunger, proceeded to relish the berries with unmitigated gusto, heedless of the gentleman's cautions. After partaking in his feast, the bear, much to his chagrin, soon discovered the veracity of the gentleman's warning, as his digestive faculties embarked upon an unrestrained journey of turmoil and trepidation.\n",
-      "\n",
-      "In the aftermath of his ill-fated indulgence, the bear, with a countenance of utmost regret, turned to the gentleman and uttered, 'Verily, good sir, your counsel was indeed sagacious and prescient. I find myself ensnared in a maelstrom of gastrointestinal distress, beseeching the heavens for respite from this discomfort.'\n",
-      "\n",
-      "And thus, dear interlocutor, we find ourselves at the crux of this jest, whereupon the bear, in his most vulnerable state, beseeches the heavens for relief from his gastrointestinal plight. In this moment of levity, we are reminded that even the most erudite and sagacious among us can succumb to the allure of temptation, and the consequences that follow serve as a timeless lesson for all creatures within the realm of nature.\"\n",
-      "\n",
-      "Oh, the whimsy of the bear's gastronomic misadventure! May it serve as a reminder that, even amidst the grandeur of the natural world, we must exercise prudence and contemplate the ramifications of our actions."
-     ]
-    }
-   ],
-   "source": [
-    "async for chunk in remote_runnable.astream({\"topic\": \"bears, but super verbose\"}):\n",
-    "    print(chunk.content, end=\"\", flush=True)"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
-  }
- ],
- "metadata": {
-  "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.10.1"
-  }
- },
- "nbformat": 4,
- "nbformat_minor": 4
-}

examples/chain/server.py

@@ -1,67 +0,0 @@
-#!/usr/bin/env python
-"""Example LangChain server exposes a chain composed of a prompt and an LLM."""
-from fastapi import FastAPI
-from fastapi.middleware.cors import CORSMiddleware
-from langchain.chat_models import ChatOpenAI
-from langchain.prompts import PromptTemplate
-
-# from typing_extensions import TypedDict
-from langchain.pydantic_v1 import BaseModel
-from langchain.schema.output_parser import StrOutputParser
-from langchain.schema.runnable import ConfigurableField
-
-from langserve import add_routes
-
-model = ChatOpenAI(temperature=0.5).configurable_alternatives(
-    ConfigurableField(id="llm", name="LLM"),
-    high_temp=ChatOpenAI(temperature=0.9),
-    low_temp=ChatOpenAI(temperature=0.1, max_tokens=1),
-    default_key="medium_temp",
-)
-prompt = PromptTemplate.from_template(
-    "tell me a joke about {topic}."
-).configurable_fields(
-    template=ConfigurableField(
-        id="prompt",
-        name="Prompt",
-        description="The prompt to use. Must contain {topic}",
-    )
-)
-chain = prompt | model | StrOutputParser()
-
-app = FastAPI(
-    title="LangChain Server",
-    version="1.0",
-    description="Spin up a simple api server using Langchain's Runnable interfaces",
-)
-
-# Set all CORS enabled origins
-app.add_middleware(
-    CORSMiddleware,
-    allow_origins=["*"],
-    allow_credentials=True,
-    allow_methods=["*"],
-    allow_headers=["*"],
-    expose_headers=["*"],
-)
-
-
-# The input type is automatically inferred from the runnable
-# interface; however, if you want to override it, you can do so
-# by passing in the input_type argument to add_routes.
-class ChainInput(BaseModel):
-    """The input to the chain."""
-
-    topic: str
-
-
-add_routes(app, chain, input_type=ChainInput, config_keys=["configurable"])
-
-# Alternatively, you can rely on langchain's type inference
-# to infer the input type from the runnable interface.
-# add_routes(app, chain)
-
-if __name__ == "__main__":
-    import uvicorn
-
-    uvicorn.run(app, host="localhost", port=8000)

examples/chat_with_persistence/client.ipynb

@@ -0,0 +1,277 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Chat History\n",
+    "\n",
+    "An example of a client interacting with a chatbot where message history is persisted on the backend."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import uuid\n",
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "chat = RemoteRunnable(\"http://localhost:8000/\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Let's create a prompt composed of a system message and a human message."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "session_id = str(uuid.uuid4())"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "AIMessage(content=\" Hello Eugene! My name is Claude. It's nice to meet another cat lover.\")"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat.invoke({\"human_input\": \"my name is eugene. i like cats. what is your name?\"}, {'configurable': { 'session_id': session_id } })"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "AIMessage(content=' You told me your name is Eugene.')"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat.invoke({\"human_input\": \"what was my name?\"}, {'configurable': { 'session_id': session_id } })"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "AIMessage(content=' You said you like cats.')"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat.invoke({\"human_input\": \"What animal do i like?\"}, {'configurable': { 'session_id': session_id } })"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      " Sure\n",
+      ",\n",
+      " I\n",
+      "'d\n",
+      " be\n",
+      " happy\n",
+      " to\n",
+      " count\n",
+      " to\n",
+      " 10\n",
+      ":\n",
+      "\n",
+      "\n",
+      "1\n",
+      ",\n",
+      " 2\n",
+      ",\n",
+      " 3\n",
+      ",\n",
+      " 4\n",
+      ",\n",
+      " 5\n",
+      ",\n",
+      " 6\n",
+      ",\n",
+      " 7\n",
+      ",\n",
+      " 8\n",
+      ",\n",
+      " 9\n",
+      ",\n",
+      " 10\n"
+     ]
+    }
+   ],
+   "source": [
+    "for chunk in chat.stream({'human_input': \"Can you count till 10?\"},  {'configurable': { 'session_id': session_id } }):\n",
+    "    print()\n",
+    "    print(chunk.content, end='', flush=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1;39m[\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"my name is eugene. i like cats. what is your name?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\" Hello Eugene! My name is Claude. It's nice to meet another cat lover.\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"what was my name?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\" You told me your name is Eugene.\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"What animal do i like?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\" You said you like cats.\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"Can you count till 10?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"AIMessageChunk\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\" Sure, I'd be happy to count to 10:\\n\\n1, 2, 3, 4, 5, 6, 7, 8, 9, 10\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"AIMessageChunk\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "\u001b[1;39m]\u001b[0m\n"
+     ]
+    }
+   ],
+   "source": [
+    "!cat chat_histories/c7a327f3-5578-4fb7-a8f2-3082d7cb58cc.json | jq ."
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/chat_with_persistence/server.py

@@ -0,0 +1,105 @@
+#!/usr/bin/env python
+"""Example of a chat server with persistence handled on the backend.
+
+For simplicity, we're using file storage here -- to avoid the need to set up
+a database. This is obviously not a good idea for a production environment,
+but will help us to demonstrate the RunnableWithMessageHistory interface.
+
+We'll use cookies to identify the user and/or session. This will help illustrate how to
+fetch configuration from the request.
+"""
+import re
+from pathlib import Path
+from typing import Callable, Union
+
+from fastapi import FastAPI, HTTPException
+from langchain.chat_models import ChatAnthropic
+from langchain.memory import FileChatMessageHistory
+from langchain_core.chat_history import BaseChatMessageHistory
+from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
+from langchain_core.runnables.history import RunnableWithMessageHistory
+from typing_extensions import TypedDict
+
+from langserve import add_routes
+
+
+def _is_valid_identifier(value: str) -> bool:
+    """Check if the session ID is in a valid format."""
+    # Use a regular expression to match the allowed characters
+    valid_characters = re.compile(r"^[a-zA-Z0-9-_]+$")
+    return bool(valid_characters.match(value))
+
+
+def create_session_factory(
+    base_dir: Union[str, Path],
+) -> Callable[[str], BaseChatMessageHistory]:
+    """Create a session ID factory that creates session IDs from a base dir.
+
+    Args:
+        base_dir: Base directory to use for storing the chat histories.
+
+    Returns:
+        A session ID factory that creates session IDs from a base path.
+    """
+    base_dir_ = Path(base_dir) if isinstance(base_dir, str) else base_dir
+    if not base_dir_.exists():
+        base_dir_.mkdir(parents=True)
+
+    def get_chat_history(session_id: str) -> FileChatMessageHistory:
+        """Get a chat history from a session ID."""
+        if not _is_valid_identifier(session_id):
+            raise HTTPException(
+                status_code=400,
+                detail=f"Session ID `{session_id}` is not in a valid format. "
+                "Session ID must only contain alphanumeric characters, "
+                "hyphens, and underscores.",
+            )
+        file_path = base_dir_ / f"{session_id}.json"
+        return FileChatMessageHistory(str(file_path))
+
+    return get_chat_history
+
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+# Declare a chain
+prompt = ChatPromptTemplate.from_messages(
+    [
+        ("system", "You're an assistant by the name of Bob."),
+        MessagesPlaceholder(variable_name="history"),
+        ("human", "{human_input}"),
+    ]
+)
+
+chain = prompt | ChatAnthropic(model="claude-2")
+
+
+class InputChat(TypedDict):
+    """Input for the chat endpoint."""
+
+    human_input: str
+    """Human input"""
+
+
+chain_with_history = RunnableWithMessageHistory(
+    chain,
+    create_session_factory("chat_histories"),
+    input_messages_key="human_input",
+    history_messages_key="history",
+).with_types(input_type=InputChat)
+
+
+add_routes(
+    app,
+    chain_with_history,
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/chat_with_persistence_and_user/client.ipynb

@@ -0,0 +1,359 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Chat History\n",
+    "\n",
+    "Here we'll be interacting with a server that's exposing a chat bot with message history being persisted on the backend."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import uuid\n",
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "conversation_id = str(uuid.uuid4())\n",
+    "chat = RemoteRunnable(\"http://localhost:8000/\", cookies={\"user_id\": \"eugene\"})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Let's create a prompt composed of a system message and a human message."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "AIMessage(content=\"Hello Eugene! I'm Bob, your virtual assistant. How can I assist you today?\")"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat.invoke({\"human_input\": \"my name is eugene. what is your name?\"}, {'configurable': { 'conversation_id': conversation_id } })"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "AIMessage(content='Your name is Eugene. Is there something specific you would like assistance with, Eugene?')"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat.invoke({\"human_input\": \"what was my name?\"}, {'configurable': { 'conversation_id': conversation_id } })"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Use different user but same conversation id"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "chat = RemoteRunnable(\"http://localhost:8000/\", cookies={\"user_id\": \"nuno\"})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "AIMessage(content=\"I apologize, but I don't have access to personal information about users. As an AI assistant, I prioritize user privacy and data protection.\")"
+      ]
+     },
+     "execution_count": 7,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chat.invoke({\"human_input\": \"what was my name?\"}, {'configurable': { 'conversation_id': conversation_id }})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "\n",
+      "Of\n",
+      " course\n",
+      "!\n",
+      " Here\n",
+      " you\n",
+      " go\n",
+      ":\n",
+      "\n",
+      "\n",
+      "1\n",
+      ",\n",
+      " \n",
+      "2\n",
+      ",\n",
+      " \n",
+      "3\n",
+      ",\n",
+      " \n",
+      "4\n",
+      ",\n",
+      " \n",
+      "5\n",
+      ",\n",
+      " \n",
+      "6\n",
+      ",\n",
+      " \n",
+      "7\n",
+      ",\n",
+      " \n",
+      "8\n",
+      ",\n",
+      " \n",
+      "9\n",
+      ",\n",
+      " \n",
+      "10\n",
+      ".\n"
+     ]
+    }
+   ],
+   "source": [
+    "for chunk in chat.stream({'human_input': \"Can you count till 10?\"},  {'configurable': { 'conversation_id': conversation_id } }):\n",
+    "    print()\n",
+    "    print(chunk.content, end='', flush=True)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'cd8e5a55-0295-41cd-a885-775e0403fd25'"
+      ]
+     },
+     "execution_count": 11,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "conversation_id"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[01;34mchat_histories/\u001b[0m\n",
+      "├── \u001b[01;34meugene\u001b[0m\n",
+      "│   └── cd8e5a55-0295-41cd-a885-775e0403fd25.json\n",
+      "└── \u001b[01;34mnuno\u001b[0m\n",
+      "    └── cd8e5a55-0295-41cd-a885-775e0403fd25.json\n",
+      "\n",
+      "2 directories, 2 files\n"
+     ]
+    }
+   ],
+   "source": [
+    "!tree chat_histories/"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 17,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1;39m[\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"my name is eugene. what is your name?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"Hello Eugene! I'm Bob, your virtual assistant. How can I assist you today?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"what was my name?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"Your name is Eugene. Is there something specific you would like assistance with, Eugene?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "\u001b[1;39m]\u001b[0m\n"
+     ]
+    }
+   ],
+   "source": [
+    "!cat chat_histories/eugene/cd8e5a55-0295-41cd-a885-775e0403fd25.json | jq ."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\u001b[1;39m[\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"what was my name?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"I apologize, but I don't have access to personal information about users. As an AI assistant, I prioritize user privacy and data protection.\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"ai\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"Can you count till 10?\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"human\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m,\n",
+      "  \u001b[1;39m{\n",
+      "    \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"AIMessageChunk\"\u001b[0m\u001b[1;39m,\n",
+      "    \u001b[0m\u001b[34;1m\"data\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{\n",
+      "      \u001b[0m\u001b[34;1m\"content\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"Of course! Here you go:\\n\\n1, 2, 3, 4, 5, 6, 7, 8, 9, 10.\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"additional_kwargs\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[1;39m{}\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"type\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;32m\"AIMessageChunk\"\u001b[0m\u001b[1;39m,\n",
+      "      \u001b[0m\u001b[34;1m\"example\"\u001b[0m\u001b[1;39m: \u001b[0m\u001b[0;39mfalse\u001b[0m\u001b[1;39m\n",
+      "    \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "  \u001b[1;39m}\u001b[0m\u001b[1;39m\n",
+      "\u001b[1;39m]\u001b[0m\n"
+     ]
+    }
+   ],
+   "source": [
+    "!cat chat_histories/nuno/cd8e5a55-0295-41cd-a885-775e0403fd25.json | jq ."
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/chat_with_persistence_and_user/server.py

@@ -0,0 +1,182 @@
+#!/usr/bin/env python
+"""Example of a chat server with persistence handled on the backend.
+
+For simplicity, we're using file storage here -- to avoid the need to set up
+a database. This is obviously not a good idea for a production environment,
+but will help us to demonstrate the RunnableWithMessageHistory interface.
+
+We'll use cookies to identify the user. This will help illustrate how to
+fetch configuration from the request.
+"""
+import re
+from pathlib import Path
+from typing import Any, Callable, Dict, Union
+
+from fastapi import FastAPI, HTTPException, Request
+from langchain.chat_models import ChatOpenAI
+from langchain.memory import FileChatMessageHistory
+from langchain.schema.runnable.utils import ConfigurableFieldSpec
+from langchain_core import __version__
+from langchain_core.chat_history import BaseChatMessageHistory
+from langchain_core.prompts import ChatPromptTemplate, MessagesPlaceholder
+from langchain_core.runnables.history import RunnableWithMessageHistory
+from typing_extensions import TypedDict
+
+from langserve import add_routes
+
+# Define the minimum required version as (0, 1, 0)
+# Earlier versions did not allow specifying custom config fields in
+# RunnableWithMessageHistory.
+MIN_VERSION_LANGCHAIN_CORE = (0, 1, 0)
+
+# Split the version string by "." and convert to integers
+LANGCHAIN_CORE_VERSION = tuple(map(int, __version__.split(".")))
+
+if LANGCHAIN_CORE_VERSION < MIN_VERSION_LANGCHAIN_CORE:
+    raise RuntimeError(
+        f"Minimum required version of langchain-core is {MIN_VERSION_LANGCHAIN_CORE}, "
+        f"but found {LANGCHAIN_CORE_VERSION}"
+    )
+
+
+def _is_valid_identifier(value: str) -> bool:
+    """Check if the value is a valid identifier."""
+    # Use a regular expression to match the allowed characters
+    valid_characters = re.compile(r"^[a-zA-Z0-9-_]+$")
+    return bool(valid_characters.match(value))
+
+
+def create_session_factory(
+    base_dir: Union[str, Path],
+) -> Callable[[str], BaseChatMessageHistory]:
+    """Create a factory that can retrieve chat histories.
+
+    The chat histories are keyed by user ID and conversation ID.
+
+    Args:
+        base_dir: Base directory to use for storing the chat histories.
+
+    Returns:
+        A factory that can retrieve chat histories keyed by user ID and conversation ID.
+    """
+    base_dir_ = Path(base_dir) if isinstance(base_dir, str) else base_dir
+    if not base_dir_.exists():
+        base_dir_.mkdir(parents=True)
+
+    def get_chat_history(user_id: str, conversation_id: str) -> FileChatMessageHistory:
+        """Get a chat history from a user id and conversation id."""
+        if not _is_valid_identifier(user_id):
+            raise ValueError(
+                f"User ID {user_id} is not in a valid format. "
+                "User ID must only contain alphanumeric characters, "
+                "hyphens, and underscores."
+                "Please include a valid cookie in the request headers called 'user-id'."
+            )
+        if not _is_valid_identifier(conversation_id):
+            raise ValueError(
+                f"Conversation ID {conversation_id} is not in a valid format. "
+                "Conversation ID must only contain alphanumeric characters, "
+                "hyphens, and underscores. Please provide a valid conversation id "
+                "via config. For example, "
+                "chain.invoke(.., {'configurable': {'conversation_id': '123'}})"
+            )
+
+        user_dir = base_dir_ / user_id
+        if not user_dir.exists():
+            user_dir.mkdir(parents=True)
+        file_path = user_dir / f"{conversation_id}.json"
+        return FileChatMessageHistory(str(file_path))
+
+    return get_chat_history
+
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+def _per_request_config_modifier(
+    config: Dict[str, Any], request: Request
+) -> Dict[str, Any]:
+    """Update the config"""
+    config = config.copy()
+    configurable = config.get("configurable", {})
+    # Look for a cookie named "user_id"
+    user_id = request.cookies.get("user_id", None)
+
+    if user_id is None:
+        raise HTTPException(
+            status_code=400,
+            detail="No user id found. Please set a cookie named 'user_id'.",
+        )
+
+    configurable["user_id"] = user_id
+    config["configurable"] = configurable
+    return config
+
+
+# Declare a chain
+prompt = ChatPromptTemplate.from_messages(
+    [
+        ("system", "You're an assistant by the name of Bob."),
+        MessagesPlaceholder(variable_name="history"),
+        ("human", "{human_input}"),
+    ]
+)
+
+chain = prompt | ChatOpenAI()
+
+
+class InputChat(TypedDict):
+    """Input for the chat endpoint."""
+
+    human_input: str
+    """Human input"""
+
+
+chain_with_history = RunnableWithMessageHistory(
+    chain,
+    create_session_factory("chat_histories"),
+    input_messages_key="human_input",
+    history_messages_key="history",
+    history_factory_config=[
+        ConfigurableFieldSpec(
+            id="user_id",
+            annotation=str,
+            name="User ID",
+            description="Unique identifier for the user.",
+            default="",
+            is_shared=True,
+        ),
+        ConfigurableFieldSpec(
+            id="conversation_id",
+            annotation=str,
+            name="Conversation ID",
+            description="Unique identifier for the conversation.",
+            default="",
+            is_shared=True,
+        ),
+    ],
+).with_types(input_type=InputChat)
+
+
+add_routes(
+    app,
+    chain_with_history,
+    per_req_config_modifier=_per_request_config_modifier,
+    # Disable playground and batch
+    # 1) Playground we're passing information via headers, which is not supported via
+    #    the playground right now.
+    # 2) Disable batch to avoid users being confused. Batch will work fine
+    #    as long as users invoke it with multiple configs appropriately, but
+    #    without validation users are likely going to forget to do that.
+    #    In addition, there's likely little sense in support batch for a chatbot.
+    disabled_endpoints=["playground", "batch"],
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/configurable_agent_executor/client.ipynb

@@ -0,0 +1,770 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Client\n",
+    "\n",
+    "Demo of a client interacting with a custom runnable executor that supports configuration.\n",
+    "\n",
+    "This server does not support invoke or batch! only stream and astream log! (see backend code.)\n",
+    "\n",
+    "The underlying backend code is just a demo in this case -- it's working around an existing bug, but uses \n",
+    "the opportunity to show how to create custom runnables."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can interact with this via API directly"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "event: metadata\n",
+      "data: {\"run_id\": \"5e6ce60a-95c4-4fe5-8c4a-ec1d347afd83\"}\n",
+      "\n",
+      "event: data\n",
+      "data: {\"actions\":[{\"tool\":\"get_eugene_thoughts\",\"tool_input\":{\"query\":\"cats\"},\"log\":\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\",\"type\":\"AgentActionMessageLog\",\"message_log\":[{\"content\":\"\",\"additional_kwargs\":{\"function_call\":{\"name\":\"get_eugene_thoughts\",\"arguments\":\"{\\n  \\\"query\\\": \\\"cats\\\"\\n}\"}},\"type\":\"ai\",\"example\":false}]}],\"messages\":[{\"content\":\"\",\"additional_kwargs\":{\"function_call\":{\"name\":\"get_eugene_thoughts\",\"arguments\":\"{\\n  \\\"query\\\": \\\"cats\\\"\\n}\"}},\"type\":\"ai\",\"example\":false}]}\n",
+      "\n",
+      "event: data\n",
+      "data: {\"steps\":[{\"action\":{\"tool\":\"get_eugene_thoughts\",\"tool_input\":{\"query\":\"cats\"},\"log\":\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\",\"type\":\"AgentActionMessageLog\",\"message_log\":[{\"content\":\"\",\"additional_kwargs\":{\"function_call\":{\"name\":\"get_eugene_thoughts\",\"arguments\":\"{\\n  \\\"query\\\": \\\"cats\\\"\\n}\"}},\"type\":\"ai\",\"example\":false}]},\"observation\":[{\"page_content\":\"cats like fish\",\"metadata\":{},\"type\":\"Document\"},{\"page_content\":\"dogs like sticks\",\"metadata\":{},\"type\":\"Document\"}]}],\"messages\":[{\"content\":\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\",\"additional_kwargs\":{},\"type\":\"function\",\"name\":\"get_eugene_thoughts\"}]}\n",
+      "\n",
+      "event: data\n",
+      "data: {\"output\":\"Eugene thinks that cats like fish.\",\"messages\":[{\"content\":\"Eugene thinks that cats like fish.\",\"additional_kwargs\":{},\"type\":\"ai\",\"example\":false}]}\n",
+      "\n",
+      "event: end\n",
+      "\n",
+      "\n"
+     ]
+    }
+   ],
+   "source": [
+    "import requests\n",
+    "\n",
+    "inputs = {\"input\": {\"input\": \"what does eugene think of cats?\"}}\n",
+    "response = requests.post(\"http://localhost:8000/stream\", json=inputs)\n",
+    "\n",
+    "print(response.text)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can also interact with this via the RemoteRunnable interface (to use in other chains)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Remote runnable has the same interface as local runnables"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'output': 'Hello! How can I assist you today?', 'messages': [AIMessage(content='Hello! How can I assist you today?')]}\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream({\"input\": \"hi!\"}):\n",
+    "    print(chunk)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "RunLogPatch({'op': 'replace',\n",
+      "  'path': '',\n",
+      "  'value': {'final_output': None,\n",
+      "            'id': '9f415b49-ba69-4fdf-9b9c-5ccc1805487f',\n",
+      "            'logs': {},\n",
+      "            'streamed_output': []}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '95a0ba72-9511-4fff-8b8c-410e7108ee60',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableSequence',\n",
+      "            'start_time': '2024-01-06T03:12:42.213+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': [],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'a0afa5a6-a408-4a2d-83f8-8e4c8193f963',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableParallel<input,agent_scratchpad>',\n",
+      "            'start_time': '2024-01-06T03:12:42.214+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '2aed7d13-2d0b-4c37-a4b3-d3f266bbf7e6',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-06T03:12:42.215+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:input'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '9328b5cf-fd7b-48fe-affb-2973643189e9',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-06T03:12:42.215+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:agent_scratchpad'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>/final_output',\n",
+      "  'value': {'output': 'what does eugene think about cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.217+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2/final_output',\n",
+      "  'value': {'output': []}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.217+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>/final_output',\n",
+      "  'value': {'agent_scratchpad': [],\n",
+      "            'input': 'what does eugene think about cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.218+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'a08bec71-bf7f-46c5-b082-14f7bff421cd',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'ChatPromptTemplate',\n",
+      "            'start_time': '2024-01-06T03:12:42.219+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2'],\n",
+      "            'type': 'prompt'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate/final_output',\n",
+      "  'value': {'messages': [SystemMessage(content='You are a helpful assistant.'),\n",
+      "                         HumanMessage(content='what does eugene think about cats?')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.219+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'bf859261-467b-44b3-84fb-80d8c9e9dff2',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'LLM',\n",
+      "            'start_time': '2024-01-06T03:12:42.221+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': ''}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '{\\n'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' '}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' \"'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': 'query'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '\":'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' \"'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': 'cats'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '\"\\n'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '}'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGeneration(generation_info={'finish_reason': 'function_call'}, message=AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.806+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'd635ccbb-1db3-4515-b1ca-0c14752d361a',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'OpenAIFunctionsAgentOutputParser',\n",
+      "            'start_time': '2024-01-06T03:12:42.807+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:4'],\n",
+      "            'type': 'parser'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser/final_output',\n",
+      "  'value': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.809+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence/final_output',\n",
+      "  'value': {'output': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence/end_time',\n",
+      "  'value': '2024-01-06T03:12:42.809+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])],\n",
+      "            'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}},\n",
+      " {'op': 'replace',\n",
+      "  'path': '/final_output',\n",
+      "  'value': {'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])],\n",
+      "            'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/get_eugene_thoughts',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '5eecdbe8-3374-4f0e-8ae8-d8a7e2394ae1',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'get_eugene_thoughts',\n",
+      "            'start_time': '2024-01-06T03:12:42.810+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': [],\n",
+      "            'type': 'tool'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/get_eugene_thoughts/final_output',\n",
+      "  'value': {'output': \"[Document(page_content='cats like fish'), \"\n",
+      "                      \"Document(page_content='dogs like sticks')]\"}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/get_eugene_thoughts/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.095+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'messages': [FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')],\n",
+      "            'steps': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]),\n",
+      "                       'observation': [Document(page_content='cats like fish'),\n",
+      "                                       Document(page_content='dogs like sticks')]}]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/steps',\n",
+      "  'value': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]),\n",
+      "             'observation': [Document(page_content='cats like fish'),\n",
+      "                             Document(page_content='dogs like sticks')]}]},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/messages/1',\n",
+      "  'value': FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '89bf8195-df48-4fde-81b0-9e1982051caa',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableSequence',\n",
+      "            'start_time': '2024-01-06T03:12:43.097+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': [],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '567c178a-4897-4865-af27-7122432df7bd',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'RunnableParallel<input,agent_scratchpad>',\n",
+      "            'start_time': '2024-01-06T03:12:43.098+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:3',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '03530072-e5b2-4d7e-b875-f77e3d47481b',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-06T03:12:43.099+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:input'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:4',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'c554e615-1b70-4dc1-a4aa-aa09ccdacb09',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2024-01-06T03:12:43.099+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:agent_scratchpad'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:3/final_output',\n",
+      "  'value': {'output': 'what does eugene think about cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:3/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.100+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:4/final_output',\n",
+      "  'value': {'output': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}),\n",
+      "                       FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:4/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.100+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>:2/final_output',\n",
+      "  'value': {'agent_scratchpad': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}),\n",
+      "                                 FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')],\n",
+      "            'input': 'what does eugene think about cats?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel<input,agent_scratchpad>:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.101+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '724c5bf8-d475-45ec-a69a-a4f188dc405f',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'ChatPromptTemplate',\n",
+      "            'start_time': '2024-01-06T03:12:43.101+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2'],\n",
+      "            'type': 'prompt'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate:2/final_output',\n",
+      "  'value': {'messages': [SystemMessage(content='You are a helpful assistant.'),\n",
+      "                         HumanMessage(content='what does eugene think about cats?'),\n",
+      "                         AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}),\n",
+      "                         FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.102+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '4542ae99-f854-41be-9669-41d8cd7dfb24',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'LLM',\n",
+      "            'start_time': '2024-01-06T03:12:43.103+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': 'E'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='E')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': 'ug'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ug')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': 'ene'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ene')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' thinks'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' thinks')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' that'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' that')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' cats'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' cats')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' like'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' like')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' fish'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' fish')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': '.'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='.')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM:2/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGeneration(text='Eugene thinks that cats like fish.', generation_info={'finish_reason': 'stop'}, message=AIMessage(content='Eugene thinks that cats like fish.'))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.776+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '281c8ae8-dbc6-433f-86c8-20b86b3c8eee',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'OpenAIFunctionsAgentOutputParser',\n",
+      "            'start_time': '2024-01-06T03:12:43.776+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:4'],\n",
+      "            'type': 'parser'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser:2/final_output',\n",
+      "  'value': AgentFinish(return_values={'output': 'Eugene thinks that cats like fish.'}, log='Eugene thinks that cats like fish.')},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/OpenAIFunctionsAgentOutputParser:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.777+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2/final_output',\n",
+      "  'value': {'output': AgentFinish(return_values={'output': 'Eugene thinks that cats like fish.'}, log='Eugene thinks that cats like fish.')}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:43.778+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'messages': [AIMessage(content='Eugene thinks that cats like fish.')],\n",
+      "            'output': 'Eugene thinks that cats like fish.'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/output',\n",
+      "  'value': 'Eugene thinks that cats like fish.'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/messages/2',\n",
+      "  'value': AIMessage(content='Eugene thinks that cats like fish.')})\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream_log({\"input\": \"what does eugene think about cats?\"}):\n",
+    "    print(chunk)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "RunLogPatch({'op': 'replace',\n",
+      "  'path': '',\n",
+      "  'value': {'final_output': None,\n",
+      "            'id': '51c65021-1b40-4a45-81b3-95fc5c5b545a',\n",
+      "            'logs': {},\n",
+      "            'streamed_output': []}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '7a34b2a3-d6c0-4a0b-9939-2bde70a98958',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'LLM',\n",
+      "            'start_time': '2024-01-06T03:12:43.812+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': ''}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '{\\n'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' '}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' \"'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': 'query'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '\":'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': ' \"'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': 'cats'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '\"\\n'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='', additional_kwargs={'function_call': {'arguments': '}'}})})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGeneration(generation_info={'finish_reason': 'function_call'}, message=AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}}))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM/end_time',\n",
+      "  'value': '2024-01-06T03:12:44.588+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])],\n",
+      "            'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}},\n",
+      " {'op': 'replace',\n",
+      "  'path': '/final_output',\n",
+      "  'value': {'actions': [AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})])],\n",
+      "            'messages': [AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'messages': [FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')],\n",
+      "            'steps': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]),\n",
+      "                       'observation': [Document(page_content='cats like fish'),\n",
+      "                                       Document(page_content='dogs like sticks')]}]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/steps',\n",
+      "  'value': [{'action': AgentActionMessageLog(tool='get_eugene_thoughts', tool_input={'query': 'cats'}, log=\"\\nInvoking: `get_eugene_thoughts` with `{'query': 'cats'}`\\n\\n\\n\", message_log=[AIMessage(content='', additional_kwargs={'function_call': {'name': 'get_eugene_thoughts', 'arguments': '{\\n  \"query\": \"cats\"\\n}'}})]),\n",
+      "             'observation': [Document(page_content='cats like fish'),\n",
+      "                             Document(page_content='dogs like sticks')]}]},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/messages/1',\n",
+      "  'value': FunctionMessage(content=\"[Document(page_content='cats like fish'), Document(page_content='dogs like sticks')]\", name='get_eugene_thoughts')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '8ff3b248-fb7e-4305-bd57-54e21a85bacb',\n",
+      "            'metadata': {'__langserve_endpoint': 'stream_log',\n",
+      "                         '__langserve_version': '0.0.37',\n",
+      "                         '__useragent': 'python-httpx/0.25.2'},\n",
+      "            'name': 'LLM',\n",
+      "            'start_time': '2024-01-06T03:12:44.756+00:00',\n",
+      "            'streamed_output': [],\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': 'E'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='E')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': 'ug'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ug')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': 'ene'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ene')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' thinks'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' thinks')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' that'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' that')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' cats'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' cats')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' like'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' like')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ' fish'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' fish')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': '.'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='.')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/LLM:2/streamed_output_str/-', 'value': ''},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/LLM:2/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGeneration(text='Eugene thinks that cats like fish.', generation_info={'finish_reason': 'stop'}, message=AIMessage(content='Eugene thinks that cats like fish.'))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/LLM:2/end_time',\n",
+      "  'value': '2024-01-06T03:12:45.171+00:00'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': {'messages': [AIMessage(content='Eugene thinks that cats like fish.')],\n",
+      "            'output': 'Eugene thinks that cats like fish.'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/output',\n",
+      "  'value': 'Eugene thinks that cats like fish.'},\n",
+      " {'op': 'add',\n",
+      "  'path': '/final_output/messages/2',\n",
+      "  'value': AIMessage(content='Eugene thinks that cats like fish.')})\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream_log({\"input\": \"what does eugene think about cats?\"}, include_names=[\"LLM\"]):\n",
+    "    print(chunk)"
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/configurable_agent_executor/server.py

@@ -0,0 +1,155 @@
+#!/usr/bin/env python
+"""An example that shows how to create a custom agent executor like Runnable.
+
+At the time of writing, there is a bug in the current AgentExecutor that
+prevents it from correctly propagating configuration of the underlying
+runnable. While that bug should be fixed, this is an example shows
+how to create a more complex custom runnable.
+
+Please see documentation for custom agent streaming here:
+
+https://python.langchain.com/docs/modules/agents/how_to/streaming#stream-tokens
+
+**ATTENTION**
+To support streaming individual tokens you will need to manually set the streaming=True
+on the LLM and use the stream_log endpoint rather than stream endpoint.
+"""
+from typing import Any, AsyncIterator, Dict, List, Optional, cast
+
+from fastapi import FastAPI
+from langchain.agents import AgentExecutor, tool
+from langchain.agents.format_scratchpad import format_to_openai_functions
+from langchain.agents.output_parsers import OpenAIFunctionsAgentOutputParser
+from langchain.chat_models import ChatOpenAI
+from langchain.embeddings import OpenAIEmbeddings
+from langchain.prompts import ChatPromptTemplate, MessagesPlaceholder
+from langchain.pydantic_v1 import BaseModel
+from langchain.tools.render import format_tool_to_openai_function
+from langchain.vectorstores import FAISS
+from langchain_core.runnables import (
+    ConfigurableField,
+    ConfigurableFieldSpec,
+    Runnable,
+    RunnableConfig,
+)
+from langchain_core.runnables.utils import Input, Output
+
+from langserve import add_routes
+
+vectorstore = FAISS.from_texts(
+    ["cats like fish", "dogs like sticks"], embedding=OpenAIEmbeddings()
+)
+retriever = vectorstore.as_retriever()
+
+
+@tool
+def get_eugene_thoughts(query: str) -> list:
+    """Returns Eugene's thoughts on a topic."""
+    return retriever.get_relevant_documents(query)
+
+
+tools = [get_eugene_thoughts]
+
+prompt = ChatPromptTemplate.from_messages(
+    [
+        ("system", "You are a helpful assistant."),
+        ("user", "{input}"),
+        MessagesPlaceholder(variable_name="agent_scratchpad"),
+    ]
+)
+
+# We need to set streaming=True on the LLM to support streaming individual tokens.
+# when using the stream_log endpoint.
+# .stream for agents streams action observation pairs not individual tokens.
+llm = ChatOpenAI(temperature=0, streaming=True).configurable_fields(
+    temperature=ConfigurableField(
+        id="llm_temperature",
+        name="LLM Temperature",
+        description="The temperature of the LLM",
+    )
+)
+
+llm_with_tools = llm.bind(
+    functions=[format_tool_to_openai_function(t) for t in tools]
+).with_config({"run_name": "LLM"})
+
+
+class CustomAgentExecutor(Runnable):
+    """A custom runnable that will be used by the agent executor."""
+
+    def __init__(self, **kwargs):
+        """Initialize the runnable."""
+        super().__init__(**kwargs)
+        self.agent = (
+            {
+                "input": lambda x: x["input"],
+                "agent_scratchpad": lambda x: format_to_openai_functions(
+                    x["intermediate_steps"]
+                ),
+            }
+            | prompt
+            | llm_with_tools
+            | OpenAIFunctionsAgentOutputParser()
+        )
+
+    def invoke(self, input: Input, config: Optional[RunnableConfig] = None) -> Output:
+        """Will not be used."""
+        raise NotImplementedError()
+
+    @property
+    def config_specs(self) -> List[ConfigurableFieldSpec]:
+        return self.agent.config_specs
+
+    async def astream(
+        self,
+        input: Input,
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Optional[Any],
+    ) -> AsyncIterator[Output]:
+        """Stream the agent's output."""
+        configurable = cast(Dict[str, Any], config.pop("configurable", {}))
+
+        if configurable:
+            configured_agent = self.agent.with_config(
+                {
+                    "configurable": configurable,
+                }
+            )
+        else:
+            configured_agent = self.agent
+
+        executor = AgentExecutor(
+            agent=configured_agent,
+            tools=tools,
+        ).with_config({"run_name": "executor"})
+
+        async for output in executor.astream(input, config=config, **kwargs):
+            yield output
+
+
+app = FastAPI()
+
+
+# We need to add these input/output schemas because the current AgentExecutor
+# is lacking in schemas.
+class Input(BaseModel):
+    input: str
+
+
+class Output(BaseModel):
+    output: Any
+
+
+runnable = CustomAgentExecutor()
+
+# Add routes to the app for using the custom agent executor.
+add_routes(
+    app,
+    runnable.with_types(input_type=Input, output_type=Output),
+    disabled_endpoints=["invoke", "batch"],  # not implemented
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/configurable_chain/client.ipynb

@@ -0,0 +1,289 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Client\n",
+    "\n",
+    "Demo of client interacting with the simple chain server, which deploys a chain that tells jokes about a particular topic."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can interact with this via API directly"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import requests\n",
+    "\n",
+    "inputs = {\"input\": {\"topic\": \"sports\"}}\n",
+    "response = requests.post(\"http://localhost:8000/configurable_temp/invoke\", json=inputs)\n",
+    "\n",
+    "response.json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can also interact with this via the RemoteRunnable interface (to use in other chains)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/configurable_temp\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Remote runnable has the same interface as local runnables"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "response = await remote_runnable.ainvoke({\"topic\": \"sports\"})"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The client can also execute langchain code synchronously, and pass in configs"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.schema.runnable.config import RunnableConfig\n",
+    "\n",
+    "remote_runnable.batch([{\"topic\": \"sports\"}, {\"topic\": \"cars\"}])"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The server supports streaming (using HTTP server-side events), which can help interact with long responses in real time"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "async for chunk in remote_runnable.astream({\"topic\": \"bears, but a bit verbose\"}):\n",
+    "    print(chunk, end=\"\", flush=True)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configurability\n",
+    "\n",
+    "The server chains have been exposed as configurable chains!\n",
+    "\n",
+    "```python \n",
+    "\n",
+    "model = ChatOpenAI(temperature=0.5).configurable_alternatives(\n",
+    "    ConfigurableField(\n",
+    "        id=\"llm\",\n",
+    "        name=\"LLM\",\n",
+    "        description=(\n",
+    "            \"Decide whether to use a high or a low temperature parameter for the LLM.\"\n",
+    "        ),\n",
+    "    ),\n",
+    "    high_temp=ChatOpenAI(temperature=0.9),\n",
+    "    low_temp=ChatOpenAI(temperature=0.1),\n",
+    "    default_key=\"medium_temp\",\n",
+    ")\n",
+    "prompt = PromptTemplate.from_template(\n",
+    "    \"tell me a joke about {topic}.\"\n",
+    ").configurable_fields(  # Example of a configurable field\n",
+    "    template=ConfigurableField(\n",
+    "        id=\"prompt\",\n",
+    "        name=\"Prompt\",\n",
+    "        description=(\"The prompt to use. Must contain {topic}.\"),\n",
+    "    )\n",
+    ")\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "We can now use the configurability of the runnable in the API!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "await remote_runnable.ainvoke(\n",
+    "    {\"topic\": \"sports\"},\n",
+    "    config={\n",
+    "        \"configurable\": {\"prompt\": \"how to say {topic} in french\", \"llm\": \"low_temp\"}\n",
+    "    },\n",
+    ")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configurability Based on Request Properties\n",
+    "\n",
+    "If you want to change your chain invocation based on your request's properties,\n",
+    "you can do so with `add_routes`'s `per_req_config_modifier` method as follows:\n",
+    "\n",
+    "```python \n",
+    "\n",
+    "# Add another example route where you can configure the model based\n",
+    "# on properties of the request. This is useful for passing in API\n",
+    "# keys from request headers (WITH CAUTION) or using other properties\n",
+    "# of the request to configure the model.\n",
+    "def fetch_api_key_from_header(config: Dict[str, Any], req: Request) -> Dict[str, Any]:\n",
+    "    if \"x-api-key\" in req.headers:\n",
+    "        config[\"configurable\"][\"openai_api_key\"] = req.headers[\"x-api-key\"]\n",
+    "    return config\n",
+    "\n",
+    "dynamic_auth_model = ChatOpenAI(openai_api_key='placeholder').configurable_fields(\n",
+    "    openai_api_key=ConfigurableField(\n",
+    "        id=\"openai_api_key\",\n",
+    "        name=\"OpenAI API Key\",\n",
+    "        description=(\n",
+    "            \"API Key for OpenAI interactions\"\n",
+    "        ),\n",
+    "    ),\n",
+    ")\n",
+    "\n",
+    "dynamic_auth_chain = dynamic_auth_model | StrOutputParser()\n",
+    "\n",
+    "add_routes(\n",
+    "    app, \n",
+    "    dynamic_auth_chain, \n",
+    "    path=\"/auth_from_header\",\n",
+    "    config_keys=[\"configurable\"], \n",
+    "    per_req_config_modifier=fetch_api_key_from_header\n",
+    ")\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now, we can see that our request to the model will only work if we have a specific request\n",
+    "header set:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# The model will fail with an auth error\n",
+    "unauthenticated_response = requests.post(\n",
+    "    \"http://localhost:8000/auth_from_header/invoke\", json={\"input\": \"hello\"}\n",
+    ")\n",
+    "unauthenticated_response.json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Now, ensure that you have run the following locally on your shell\n",
+    "```bash\n",
+    "export TEST_API_KEY=<INSERT MY KEY HERE>\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# The model will succeed as long as the above shell script is run previously\n",
+    "import os\n",
+    "\n",
+    "test_key = os.environ[\"TEST_API_KEY\"]\n",
+    "authenticated_response = requests.post(\n",
+    "    \"http://localhost:8000/auth_from_header/invoke\",\n",
+    "    json={\"input\": \"hello\"},\n",
+    "    headers={\"x-api-key\": test_key},\n",
+    ")\n",
+    "authenticated_response.json()"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "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.9.18"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/configurable_chain/server.py

@@ -0,0 +1,124 @@
+#!/usr/bin/env python
+"""Example of configurable runnables.
+
+This example shows how to use two options for configuration of runnables:
+
+1) Configurable Fields: Use this to specify values for a given initialization parameter
+2) Configurable Alternatives: Use this to specify complete alternative runnables
+"""
+from typing import Any, Dict
+
+from fastapi import FastAPI, HTTPException, Request
+from fastapi.middleware.cors import CORSMiddleware
+from langchain.chat_models import ChatOpenAI
+from langchain.prompts import PromptTemplate
+from langchain.schema.output_parser import StrOutputParser
+from langchain.schema.runnable import ConfigurableField
+
+from langserve import add_routes
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+# Set all CORS enabled origins
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+    expose_headers=["*"],
+)
+
+###############################################################################
+#                EXAMPLE 1: Configure fields based on RunnableConfig          #
+###############################################################################
+model = ChatOpenAI(temperature=0.5).configurable_alternatives(
+    ConfigurableField(
+        id="llm",
+        name="LLM",
+        description=(
+            "Decide whether to use a high or a low temperature parameter for the LLM."
+        ),
+    ),
+    high_temp=ChatOpenAI(temperature=0.9),
+    low_temp=ChatOpenAI(temperature=0.1),
+    default_key="medium_temp",
+)
+prompt = PromptTemplate.from_template(
+    "tell me a joke about {topic}."
+).configurable_fields(  # Example of a configurable field
+    template=ConfigurableField(
+        id="prompt",
+        name="Prompt",
+        description="The prompt to use. Must contain {topic}.",
+    )
+)
+chain = prompt | model | StrOutputParser()
+
+add_routes(app, chain, path="/configurable_temp")
+
+
+###############################################################################
+#                EXAMPLE 2: Configure prompt based on RunnableConfig          #
+###############################################################################
+configurable_prompt = PromptTemplate.from_template(
+    "tell me a joke about {topic}."
+).configurable_alternatives(
+    ConfigurableField(
+        id="prompt",
+        name="Prompt",
+        description="The prompt to use. Must contain {topic}.",
+    ),
+    default_key="joke",
+    fact=PromptTemplate.from_template(
+        "tell me a fact about {topic} in {language} language."
+    ),
+)
+prompt_chain = configurable_prompt | model | StrOutputParser()
+
+add_routes(app, prompt_chain, path="/configurable_prompt")
+
+
+###############################################################################
+#             EXAMPLE 3: Configure fields based on Request metadata           #
+###############################################################################
+
+
+# Add another example route where you can configure the model based
+# on properties of the request. This is useful for passing in API
+# keys from request headers (WITH CAUTION) or using other properties
+# of the request to configure the model.
+def fetch_api_key_from_header(config: Dict[str, Any], req: Request) -> Dict[str, Any]:
+    if "x-api-key" in req.headers:
+        config["configurable"]["openai_api_key"] = req.headers["x-api-key"]
+    else:
+        raise HTTPException(401, "No API key provided")
+
+    return config
+
+
+dynamic_auth_model = ChatOpenAI(openai_api_key="placeholder").configurable_fields(
+    openai_api_key=ConfigurableField(
+        id="openai_api_key",
+        name="OpenAI API Key",
+        description=("API Key for OpenAI interactions"),
+    ),
+)
+
+dynamic_auth_chain = dynamic_auth_model | StrOutputParser()
+
+add_routes(
+    app,
+    dynamic_auth_chain,
+    path="/auth_from_header",
+    per_req_config_modifier=fetch_api_key_from_header,
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/configurable_retrieval/client.ipynb

@@ -0,0 +1,168 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Client\n",
+    "\n",
+    "Demo of a client interacting with a configurable retriever (see server code)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can interact with this via API directly"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 1,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output': [{'page_content': 'cats like fish',\n",
+       "   'metadata': {},\n",
+       "   'type': 'Document'},\n",
+       "  {'page_content': 'dogs like sticks', 'metadata': {}, 'type': 'Document'}],\n",
+       " 'callback_events': [],\n",
+       " 'metadata': {'run_id': 'f375cdf6-2848-4976-9565-f69e175c24ce'}}"
+      ]
+     },
+     "execution_count": 1,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import requests\n",
+    "\n",
+    "inputs = {\"input\": \"cat\"}\n",
+    "response = requests.post(\"http://localhost:8000/invoke\", json=inputs)\n",
+    "\n",
+    "response.json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can also interact with this via the RemoteRunnable interface (to use in other chains)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "remote_runnable = RemoteRunnable(\"http://localhost:8000/\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Remote runnable has the same interface as local runnables"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 3,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='cats like fish'),\n",
+       " Document(page_content='dogs like sticks')]"
+      ]
+     },
+     "execution_count": 3,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"cat\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 4,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='cats like fish'),\n",
+       " Document(page_content='dogs like sticks')]"
+      ]
+     },
+     "execution_count": 4,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"cat\", {\"configurable\": {\"collection_name\": \"Index 1\"}})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "[Document(page_content='x_n+1=a * xn * (1-xn)')]"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "await remote_runnable.ainvoke(\"cat\", {\"configurable\": {\"collection_name\": \"Index 2\"}})"
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/configurable_retrieval/server.py

@@ -0,0 +1,126 @@
+#!/usr/bin/env python
+"""A more complex example that shows how to configure index name at run time."""
+from typing import Any, Iterable, List, Optional, Type
+
+from fastapi import FastAPI
+from langchain.embeddings import OpenAIEmbeddings
+from langchain.schema import Document
+from langchain.schema.embeddings import Embeddings
+from langchain.schema.retriever import BaseRetriever
+from langchain.schema.runnable import (
+    ConfigurableFieldSingleOption,
+    RunnableConfig,
+    RunnableSerializable,
+)
+from langchain.schema.vectorstore import VST
+from langchain.vectorstores import FAISS, VectorStore
+
+from langserve import add_routes
+from langserve.pydantic_v1 import BaseModel, Field
+
+vectorstore1 = FAISS.from_texts(
+    ["cats like fish", "dogs like sticks"], embedding=OpenAIEmbeddings()
+)
+
+vectorstore2 = FAISS.from_texts(["x_n+1=a * xn * (1-xn)"], embedding=OpenAIEmbeddings())
+
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+class UnderlyingVectorStore(VectorStore):
+    """This is a fake vectorstore for demo purposes."""
+
+    def __init__(self, collection_name: str) -> None:
+        """Fake vectorstore that has a collection name."""
+        self.collection_name = collection_name
+
+    def as_retriever(self) -> BaseRetriever:
+        if self.collection_name == "index1":
+            return vectorstore1.as_retriever()
+        elif self.collection_name == "index2":
+            return vectorstore2.as_retriever()
+        else:
+            raise NotImplementedError(
+                f"No retriever for collection {self.collection_name}"
+            )
+
+    def add_texts(
+        self,
+        texts: Iterable[str],
+        metadatas: Optional[List[dict]] = None,
+        **kwargs: Any,
+    ) -> List[str]:
+        raise NotImplementedError()
+
+    @classmethod
+    def from_texts(
+        cls: Type[VST],
+        texts: List[str],
+        embedding: Embeddings,
+        metadatas: Optional[List[dict]] = None,
+        **kwargs: Any,
+    ) -> VST:
+        raise NotImplementedError()
+
+    def similarity_search(
+        self, embedding: List[float], k: int = 4, **kwargs: Any
+    ) -> List[Document]:
+        raise NotImplementedError()
+
+
+class ConfigurableRetriever(RunnableSerializable[str, List[Document]]):
+    """Create a custom retriever that can be configured by the user.
+
+    This is an example of how to create a custom runnable that can be configured
+    to use a different collection name at run time.
+
+    Configuration involves instantiating a VectorStore with a collection name.
+    at run time, so the underlying vectorstore should be *cheap* to instantiate.
+
+    For example, it should not be making any network requests at instantiation time.
+
+    Make sure that the vectorstore you use meets this criteria.
+    """
+
+    collection_name: str
+
+    def invoke(
+        self, input: str, config: Optional[RunnableConfig] = None
+    ) -> List[Document]:
+        """Invoke the retriever."""
+        vectorstore = UnderlyingVectorStore(self.collection_name)
+        retriever = vectorstore.as_retriever()
+        return retriever.invoke(input, config=config)
+
+
+configurable_collection_name = ConfigurableRetriever(
+    collection_name="index1"
+).configurable_fields(
+    collection_name=ConfigurableFieldSingleOption(
+        id="collection_name",
+        name="Collection Name",
+        description="The name of the collection to use for the retriever.",
+        options={
+            "Index 1": "index1",
+            "Index 2": "index2",
+        },
+        default="Index 1",
+    )
+)
+
+
+class Request(BaseModel):
+    __root__: str = Field(default="cat", description="Search query")
+
+
+add_routes(app, configurable_collection_name.with_types(input_type=Request))
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/conversational_retrieval_chain/client.ipynb

@@ -18,16 +18,23 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 2,
-   "metadata": {},
+   "execution_count": 11,
+   "metadata": {
+    "tags": []
+   },
    "outputs": [
     {
      "data": {
       "text/plain": [
-       "{'output': {'answer': 'Cats like fish.'}}"
+       "{'output': {'content': 'Based on the given context, the information we have about Harrison is that he worked at Kensho.',\n",
+       "  'additional_kwargs': {},\n",
+       "  'type': 'ai',\n",
+       "  'example': False},\n",
+       " 'callback_events': [],\n",
+       " 'metadata': {'run_id': '3455df2b-93f8-4e67-b1a3-27f90670cf7b'}}"
       ]
      },
-     "execution_count": 2,
+     "execution_count": 11,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -35,7 +42,7 @@
    "source": [
     "import requests\n",
     "\n",
-    "inputs = {\"input\": {\"question\": \"what do cats like?\", \"chat_history\": \"\"}}\n",
+    "inputs = {\"input\": {\"question\": \"what do you know about harrison\", \"chat_history\": []}}\n",
     "response = requests.post(\"http://localhost:8000/invoke\", json=inputs)\n",
     "\n",
     "response.json()"
@@ -50,7 +57,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 6,
+   "execution_count": 12,
    "metadata": {
     "tags": []
    },
@@ -70,7 +77,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 13,
    "metadata": {
     "tags": []
    },
@@ -78,21 +85,21 @@
     {
      "data": {
       "text/plain": [
-       "{'answer': 'Cats like fish.'}"
+       "AIMessage(content='Based on the given context, the only information we have about Harrison is that he worked at Kensho.')"
       ]
      },
-     "execution_count": 7,
+     "execution_count": 13,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
-    "await remote_runnable.ainvoke({\"question\": \"what do cats like?\", \"chat_history\": \"\"})"
+    "await remote_runnable.ainvoke({\"question\": \"what do you know about harrison\", \"chat_history\": []})"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 14,
    "metadata": {
     "tags": []
    },
@@ -100,26 +107,501 @@
     {
      "data": {
       "text/plain": [
-       "{'answer': 'Cats like fish.'}"
+       "AIMessage(content='Harrison worked at Kensho.')"
       ]
      },
-     "execution_count": 10,
+     "execution_count": 14,
      "metadata": {},
      "output_type": "execute_result"
     }
    ],
    "source": [
     "await remote_runnable.ainvoke(\n",
-    "    {\"question\": \"what do cats like?\", \"chat_history\": [(\"hi\", \"hi\")]}\n",
+    "    {\"question\": \"what do you know about harrison\", \"chat_history\": [(\"hi\", \"hi\")]}\n",
     ")"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 16,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "content=''\n",
+      "content='H'\n",
+      "content='arrison'\n",
+      "content=' worked'\n",
+      "content=' at'\n",
+      "content=' Kens'\n",
+      "content='ho'\n",
+      "content='.'\n",
+      "content=''\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream(\n",
+    "    {\"question\": \"what do you know about harrison\", \"chat_history\": [(\"hi\", \"hi\")]}\n",
+    "):\n",
+    "    print(chunk)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [
+    "stream log shows all intermediate steps as well!"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "RunLogPatch({'op': 'replace',\n",
+      "  'path': '',\n",
+      "  'value': {'final_output': None,\n",
+      "            'id': '2ff5a98d-49f0-40ae-92fe-489c3047d1c3',\n",
+      "            'logs': {},\n",
+      "            'streamed_output': []}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'ffdda3c9-a0ba-49a6-af18-c01748c31801',\n",
+      "            'metadata': {},\n",
+      "            'name': 'RunnableParallel',\n",
+      "            'start_time': '2023-11-16T15:59:23.348',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'a9da3f2c-f3ae-44c1-a2f4-1035faa0d1c2',\n",
+      "            'metadata': {},\n",
+      "            'name': 'RunnableSequence',\n",
+      "            'start_time': '2023-11-16T15:59:23.349',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:standalone_question'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '4d32b08f-a989-4c01-8068-479bed506d99',\n",
+      "            'metadata': {},\n",
+      "            'name': 'RunnableParallel',\n",
+      "            'start_time': '2023-11-16T15:59:23.349',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'c7b9bd78-cbb4-41f9-b31a-50a5f8940a8d',\n",
+      "            'metadata': {},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2023-11-16T15:59:23.350',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:chat_history'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>/final_output',\n",
+      "  'value': {'output': '\\nHuman: hi\\nAssistant: hi'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>/end_time',\n",
+      "  'value': '2023-11-16T15:59:23.350'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel:2/final_output',\n",
+      "  'value': {'chat_history': '\\nHuman: hi\\nAssistant: hi'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel:2/end_time',\n",
+      "  'value': '2023-11-16T15:59:23.351'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/PromptTemplate',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'ef9f8729-2d4a-4887-86a8-a284d64f5882',\n",
+      "            'metadata': {},\n",
+      "            'name': 'PromptTemplate',\n",
+      "            'start_time': '2023-11-16T15:59:23.351',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2'],\n",
+      "            'type': 'prompt'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/PromptTemplate/final_output',\n",
+      "  'value': StringPromptValue(text='Given the following conversation and a follow up question, rephrase the \\nfollow up question to be a standalone question, in its original language.\\n\\nChat History:\\n\\nHuman: hi\\nAssistant: hi\\nFollow Up Input: what do you know about harrison\\nStandalone question:')},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/PromptTemplate/end_time',\n",
+      "  'value': '2023-11-16T15:59:23.351'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '7cda5923-ed2a-42ea-aee7-a2391371ff2f',\n",
+      "            'metadata': {},\n",
+      "            'name': 'ChatOpenAI',\n",
+      "            'start_time': '2023-11-16T15:59:23.352',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'llm'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/StrOutputParser',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '6a0e199d-51fa-4306-8a7d-054444c6855f',\n",
+      "            'metadata': {},\n",
+      "            'name': 'StrOutputParser',\n",
+      "            'start_time': '2023-11-16T15:59:24.613',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:4'],\n",
+      "            'type': 'parser'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel:3',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '74a13de1-c2d1-43c0-813a-7ce0246118b3',\n",
+      "            'metadata': {},\n",
+      "            'name': 'RunnableParallel',\n",
+      "            'start_time': '2023-11-16T15:59:24.616',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '625e2183-7ee5-4f1f-8f47-56541afc96ee',\n",
+      "            'metadata': {},\n",
+      "            'name': 'RunnableSequence',\n",
+      "            'start_time': '2023-11-16T15:59:24.619',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:context'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': 'What'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': ' information'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': ' do'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': ' you'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': ' have'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': ' about'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/streamed_output_str/-',\n",
+      "  'value': ' Harrison'})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': '?'})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI/streamed_output_str/-', 'value': ''})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGenerationChunk(text='What information do you have about Harrison?', generation_info={'finish_reason': 'stop'}, message=AIMessageChunk(content='What information do you have about Harrison?'))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI/end_time',\n",
+      "  'value': '2023-11-16T15:59:24.832'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/StrOutputParser/final_output',\n",
+      "  'value': {'output': 'What information do you have about Harrison?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/StrOutputParser/end_time',\n",
+      "  'value': '2023-11-16T15:59:24.833'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence/final_output',\n",
+      "  'value': {'output': 'What information do you have about Harrison?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence/end_time',\n",
+      "  'value': '2023-11-16T15:59:24.834'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel/final_output',\n",
+      "  'value': {'standalone_question': 'What information do you have about '\n",
+      "                                   'Harrison?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel/end_time',\n",
+      "  'value': '2023-11-16T15:59:24.835'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableLambda',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '71b2e8dc-753f-4bf2-83de-b87b26828370',\n",
+      "            'metadata': {},\n",
+      "            'name': 'RunnableLambda',\n",
+      "            'start_time': '2023-11-16T15:59:24.837',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:1'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableLambda/final_output',\n",
+      "  'value': {'output': 'What information do you have about Harrison?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableLambda/end_time',\n",
+      "  'value': '2023-11-16T15:59:24.837'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/Retriever',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'd3d6254d-d073-478f-b00b-bc27eafa24fd',\n",
+      "            'metadata': {},\n",
+      "            'name': 'Retriever',\n",
+      "            'start_time': '2023-11-16T15:59:24.839',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:2', 'FAISS', 'OpenAIEmbeddings'],\n",
+      "            'type': 'retriever'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '77f7132a-d98f-4121-89cf-10e462c26496',\n",
+      "            'metadata': {},\n",
+      "            'name': '<lambda>',\n",
+      "            'start_time': '2023-11-16T15:59:24.839',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['map:key:question'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2/final_output',\n",
+      "  'value': {'output': 'What information do you have about Harrison?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/<lambda>:2/end_time',\n",
+      "  'value': '2023-11-16T15:59:24.840'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/Retriever/final_output',\n",
+      "  'value': {'documents': [Document(page_content='harrison worked at kensho')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/Retriever/end_time',\n",
+      "  'value': '2023-11-16T15:59:25.074'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/_combine_documents',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': '82aecf3e-ca9d-4b48-a281-03f8e834ea62',\n",
+      "            'metadata': {},\n",
+      "            'name': '_combine_documents',\n",
+      "            'start_time': '2023-11-16T15:59:25.075',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'chain'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/_combine_documents/final_output',\n",
+      "  'value': {'output': 'harrison worked at kensho'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/_combine_documents/end_time',\n",
+      "  'value': '2023-11-16T15:59:25.075'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2/final_output',\n",
+      "  'value': {'output': 'harrison worked at kensho'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableSequence:2/end_time',\n",
+      "  'value': '2023-11-16T15:59:25.075'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel:3/final_output',\n",
+      "  'value': {'context': 'harrison worked at kensho',\n",
+      "            'question': 'What information do you have about Harrison?'}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/RunnableParallel:3/end_time',\n",
+      "  'value': '2023-11-16T15:59:25.076'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'b37f36ce-3a27-4402-81c4-6893f03ec179',\n",
+      "            'metadata': {},\n",
+      "            'name': 'ChatPromptTemplate',\n",
+      "            'start_time': '2023-11-16T15:59:25.076',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:3'],\n",
+      "            'type': 'prompt'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate/final_output',\n",
+      "  'value': {'messages': [HumanMessage(content='Answer the question based only on the following context:\\nharrison worked at kensho\\n\\nQuestion: What information do you have about Harrison?\\n')]}},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatPromptTemplate/end_time',\n",
+      "  'value': '2023-11-16T15:59:25.077'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2',\n",
+      "  'value': {'end_time': None,\n",
+      "            'final_output': None,\n",
+      "            'id': 'b1179088-eb7c-49c5-af1e-bd09c48408bf',\n",
+      "            'metadata': {},\n",
+      "            'name': 'ChatOpenAI',\n",
+      "            'start_time': '2023-11-16T15:59:25.078',\n",
+      "            'streamed_output_str': [],\n",
+      "            'tags': ['seq:step:4'],\n",
+      "            'type': 'llm'}})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI:2/streamed_output_str/-', 'value': ''})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='Based')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'Based'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' on')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' on'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' the')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' the'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' given')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' given'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' context')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' context'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=',')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ','})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' the')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' the'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' only')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' only'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' information')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' information'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' we')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' we'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' have')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' have'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' about')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' about'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' Harrison')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' Harrison'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' is')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' is'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' that')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' that'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' he')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' he'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' worked')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' worked'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' at')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' at'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content=' Kens')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': ' Kens'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='ho')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': 'ho'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='.')})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/streamed_output_str/-',\n",
+      "  'value': '.'})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/streamed_output/-',\n",
+      "  'value': AIMessageChunk(content='')})\n",
+      "RunLogPatch({'op': 'add', 'path': '/logs/ChatOpenAI:2/streamed_output_str/-', 'value': ''})\n",
+      "RunLogPatch({'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/final_output',\n",
+      "  'value': LLMResult(generations=[[ChatGenerationChunk(text='Based on the given context, the only information we have about Harrison is that he worked at Kensho.', generation_info={'finish_reason': 'stop'}, message=AIMessageChunk(content='Based on the given context, the only information we have about Harrison is that he worked at Kensho.'))]], llm_output=None, run=None)},\n",
+      " {'op': 'add',\n",
+      "  'path': '/logs/ChatOpenAI:2/end_time',\n",
+      "  'value': '2023-11-16T15:59:26.547'})\n",
+      "RunLogPatch({'op': 'replace',\n",
+      "  'path': '/final_output',\n",
+      "  'value': {'output': AIMessageChunk(content='Based on the given context, the only information we have about Harrison is that he worked at Kensho.')}})\n"
+     ]
+    }
+   ],
+   "source": [
+    "async for chunk in remote_runnable.astream_log(\n",
+    "    {\"question\": \"what do you know about harrison\", \"chat_history\": [(\"hi\", \"hi\")]}\n",
+    "):\n",
+    "    print(chunk)"
+   ]
   }
  ],
  "metadata": {
@@ -138,7 +620,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.1"
+   "version": "3.9.6"
   }
  },
  "nbformat": 4,

examples/conversational_retrieval_chain/server.py

@@ -1,21 +1,101 @@
 #!/usr/bin/env python
-"""Example LangChain server exposes a conversational retrieval chain."""
+"""Example LangChain server exposes a conversational retrieval chain.
+
+Follow the reference here:
+
+https://python.langchain.com/docs/expression_language/cookbook/retrieval#conversational-retrieval-chain
+
+To run this example, you will need to install the following packages:
+pip install langchain openai faiss-cpu tiktoken
+"""  # noqa: F401
+
+from operator import itemgetter
+from typing import List, Tuple
+
 from fastapi import FastAPI
-from langchain.chains import ConversationalRetrievalChain
 from langchain.chat_models import ChatOpenAI
 from langchain.embeddings import OpenAIEmbeddings
+from langchain.prompts import ChatPromptTemplate
+from langchain.prompts.prompt import PromptTemplate
+from langchain.schema import format_document
+from langchain.schema.output_parser import StrOutputParser
+from langchain.schema.runnable import RunnableMap, RunnablePassthrough
 from langchain.vectorstores import FAISS
 
 from langserve import add_routes
+from langserve.pydantic_v1 import BaseModel, Field
+
+_TEMPLATE = """Given the following conversation and a follow up question, rephrase the 
+follow up question to be a standalone question, in its original language.
+
+Chat History:
+{chat_history}
+Follow Up Input: {question}
+Standalone question:"""
+CONDENSE_QUESTION_PROMPT = PromptTemplate.from_template(_TEMPLATE)
+
+ANSWER_TEMPLATE = """Answer the question based only on the following context:
+{context}
+
+Question: {question}
+"""
+ANSWER_PROMPT = ChatPromptTemplate.from_template(ANSWER_TEMPLATE)
+
+DEFAULT_DOCUMENT_PROMPT = PromptTemplate.from_template(template="{page_content}")
+
+
+def _combine_documents(
+    docs, document_prompt=DEFAULT_DOCUMENT_PROMPT, document_separator="\n\n"
+):
+    """Combine documents into a single string."""
+    doc_strings = [format_document(doc, document_prompt) for doc in docs]
+    return document_separator.join(doc_strings)
+
+
+def _format_chat_history(chat_history: List[Tuple]) -> str:
+    """Format chat history into a string."""
+    buffer = ""
+    for dialogue_turn in chat_history:
+        human = "Human: " + dialogue_turn[0]
+        ai = "Assistant: " + dialogue_turn[1]
+        buffer += "\n" + "\n".join([human, ai])
+    return buffer
+
 
 vectorstore = FAISS.from_texts(
-    ["cats like fish", "dogs like sticks"], embedding=OpenAIEmbeddings()
+    ["harrison worked at kensho"], embedding=OpenAIEmbeddings()
 )
 retriever = vectorstore.as_retriever()
 
-model = ChatOpenAI()
+_inputs = RunnableMap(
+    standalone_question=RunnablePassthrough.assign(
+        chat_history=lambda x: _format_chat_history(x["chat_history"])
+    )
+    | CONDENSE_QUESTION_PROMPT
+    | ChatOpenAI(temperature=0)
+    | StrOutputParser(),
+)
+_context = {
+    "context": itemgetter("standalone_question") | retriever | _combine_documents,
+    "question": lambda x: x["standalone_question"],
+}
 
-chain = ConversationalRetrievalChain.from_llm(model, retriever)
+
+# User input
+class ChatHistory(BaseModel):
+    """Chat history with the bot."""
+
+    chat_history: List[Tuple[str, str]] = Field(
+        ...,
+        extra={"widget": {"type": "chat", "input": "question"}},
+    )
+    question: str
+
+
+conversational_qa_chain = (
+    _inputs | _context | ANSWER_PROMPT | ChatOpenAI() | StrOutputParser()
+)
+chain = conversational_qa_chain.with_types(input_type=ChatHistory)
 
 app = FastAPI(
     title="LangChain Server",
@@ -26,7 +106,7 @@ app = FastAPI(
 # /invoke
 # /batch
 # /stream
-add_routes(app, chain)
+add_routes(app, chain, enable_feedback_endpoint=True)
 
 if __name__ == "__main__":
     import uvicorn

examples/file_processing/client.ipynb

@@ -0,0 +1,156 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# File processing\n",
+    "\n",
+    "This client will be uploading a PDF file to the langserve server which will read the PDF and extract content from the first page."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Let's load the file in base64 encoding:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 18,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "import base64\n",
+    "\n",
+    "with open(\"sample.pdf\", \"rb\") as f:\n",
+    "    data = f.read()\n",
+    "\n",
+    "encoded_data = base64.b64encode(data).decode(\"utf-8\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Using raw requests"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 19,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output': 'If you’re reading this you might be using LangServe 🦜🏓!\\n\\nThis is a sample PDF!\\n\\n\\x0c',\n",
+       " 'callback_events': []}"
+      ]
+     },
+     "execution_count": 19,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import requests\n",
+    "\n",
+    "requests.post(\n",
+    "    \"http://localhost:8000/pdf/invoke/\", json={\"input\": {\"file\": encoded_data}}\n",
+    ").json()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Using the SDK"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 20,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "runnable = RemoteRunnable(\"http://localhost:8000/pdf/\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 21,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "'If you’re reading this you might be using LangServe 🦜🏓!\\n\\nThis is a sample PDF!\\n\\n\\x0c'"
+      ]
+     },
+     "execution_count": 21,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "runnable.invoke({\"file\": encoded_data})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 22,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "['If you’re reading this you might be using LangServe 🦜🏓!\\n\\nThis is a sample PDF!\\n\\n\\x0c',\n",
+       " 'If you’re ']"
+      ]
+     },
+     "execution_count": 22,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "runnable.batch([{\"file\": encoded_data}, {\"file\": encoded_data, \"num_chars\": 10}])"
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/file_processing/server.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python
+"""Example that shows how to upload files and process files in the server.
+
+This example uses a very simple architecture for dealing with file uploads
+and processing.
+
+The main issue with this approach is that processing is done in
+the same process rather than offloaded to a process pool. A smaller
+issue is that the base64 encoding incurs an additional encoding/decoding
+overhead.
+
+This example also specifies a "base64file" widget, which will create a widget
+allowing one to upload a binary file using the langserve playground UI.
+"""
+import base64
+
+from fastapi import FastAPI
+from langchain.document_loaders.blob_loaders import Blob
+from langchain.document_loaders.parsers.pdf import PDFMinerParser
+from langchain.pydantic_v1 import Field
+from langchain.schema.runnable import RunnableLambda
+
+from langserve import CustomUserType, add_routes
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+# ATTENTION: Inherit from CustomUserType instead of BaseModel otherwise
+#            the server will decode it into a dict instead of a pydantic model.
+class FileProcessingRequest(CustomUserType):
+    """Request including a base64 encoded file."""
+
+    # The extra field is used to specify a widget for the playground UI.
+    file: str = Field(..., extra={"widget": {"type": "base64file"}})
+    num_chars: int = 100
+
+
+def _process_file(request: FileProcessingRequest) -> str:
+    """Extract the text from the first page of the PDF."""
+    content = base64.b64decode(request.file.encode("utf-8"))
+    blob = Blob(data=content)
+    documents = list(PDFMinerParser().lazy_parse(blob))
+    content = documents[0].page_content
+    return content[: request.num_chars]
+
+
+add_routes(
+    app,
+    RunnableLambda(_process_file).with_types(input_type=FileProcessingRequest),
+    config_keys=["configurable"],
+    path="/pdf",
+)
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/llm/client.ipynb

@@ -229,7 +229,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from langchain.schema.runnable import PutLocalVar, GetLocalVar"
+    "from langchain.schema.runnable import RunnablePassthrough"
    ]
   },
   {
@@ -266,13 +266,8 @@
     ")\n",
     "\n",
     "\n",
-    "chain = (\n",
-    "    comedian_chain\n",
-    "    | PutLocalVar(\"joke\")\n",
-    "    | {\"joke\": GetLocalVar(\"joke\")}\n",
-    "    | joke_classifier_chain\n",
-    "    | PutLocalVar(\"classification\")\n",
-    "    | {\"joke\": GetLocalVar(\"joke\"), \"classification\": GetLocalVar(\"classification\")}\n",
+    "chain = {\"joke\": comedian_chain} | RunnablePassthrough.assign(\n",
+    "    classification=joke_classifier_chain\n",
     ")"
    ]
   },

examples/passthrough_dict/client.ipynb

@@ -0,0 +1,148 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Passthrough information\n",
+    "\n",
+    "An example that shows how to pass through additional info with the request, and get it back with the response."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 8,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langchain.prompts.chat import ChatPromptTemplate"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 9,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "chain = RemoteRunnable(\"http://localhost:8000/v1/\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Let's create a prompt composed of a system message and a human message."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 10,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output': AIMessage(content='`apple` translates to `mela` in Italian.'),\n",
+       " 'info': {'info': {'user_id': 42, 'user_info': {'address': 42}}}}"
+      ]
+     },
+     "execution_count": 10,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain.invoke({'thing': 'apple', 'language': 'italian', 'info': {\"user_id\": 42, \"user_info\": {\"address\": 42}}})"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 11,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "{'info': {'info': {'user_id': 42, 'user_info': {'address': 42}}}}\n",
+      "{'output': AIMessageChunk(content='')}\n",
+      "{'output': AIMessageChunk(content='m')}\n",
+      "{'output': AIMessageChunk(content='ela')}\n",
+      "{'output': AIMessageChunk(content='')}\n"
+     ]
+    }
+   ],
+   "source": [
+    "for chunk in chain.stream({'thing': 'apple', 'language': 'italian', 'info': {\"user_id\": 42, \"user_info\": {\"address\": 42}}}):\n",
+    "    print(chunk)"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 12,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [],
+   "source": [
+    "from langserve import RemoteRunnable\n",
+    "\n",
+    "chain = RemoteRunnable(\"http://localhost:8000/v2/\")"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
+   "metadata": {
+    "tags": []
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "{'output': AIMessage(content='`apple` translates to `mela` in Italian.'),\n",
+       " 'info': {'user_id': 42, 'user_info': {'address': 42}}}"
+      ]
+     },
+     "execution_count": 13,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "chain.invoke({'thing': 'apple', 'language': 'italian', 'info': {\"user_id\": 42, \"user_info\": {\"address\": 42}}})"
+   ]
+  }
+ ],
+ "metadata": {
+  "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.9.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 4
+}

examples/passthrough_dict/server.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+"""Example LangChain server passes through some of the inputs in the response."""
+
+from typing import Any, Callable, Dict, List, Optional, TypedDict
+
+from fastapi import FastAPI
+from langchain.chat_models import ChatOpenAI
+from langchain.prompts import ChatPromptTemplate
+from langchain.schema.runnable import RunnableMap, RunnablePassthrough
+
+from langserve import add_routes
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+def _create_projection(
+    *, include_keys: Optional[List] = None, exclude_keys: Optional[List[str]] = None
+) -> Callable[[dict], dict]:
+    """Create a projection function."""
+
+    def _project_dict(
+        d: dict,
+    ) -> dict:
+        """Project dictionary."""
+        keys = d.keys()
+        if include_keys is not None:
+            keys = set(keys) & set(include_keys)
+        if exclude_keys is not None:
+            keys = set(keys) - set(exclude_keys)
+        return {k: d[k] for k in keys}
+
+    return _project_dict
+
+
+prompt = ChatPromptTemplate.from_messages(
+    [("human", "translate `{thing}` to {language}")]
+)
+model = ChatOpenAI()
+
+underlying_chain = prompt | model
+
+wrapped_chain = RunnableMap(
+    {
+        "output": _create_projection(exclude_keys=["info"]) | underlying_chain,
+        "info": _create_projection(include_keys=["info"]),
+    }
+)
+
+
+class Input(TypedDict):
+    thing: str
+    language: str
+    info: Dict[str, Any]
+
+
+class Output(TypedDict):
+    output: underlying_chain.output_schema
+    info: Dict[str, Any]
+
+
+add_routes(
+    app, wrapped_chain.with_types(input_type=Input, output_type=Output), path="/v1"
+)
+
+
+# Version 2
+# Uses RunnablePassthrough.assign
+wrapped_chain_2 = RunnablePassthrough.assign(output=underlying_chain) | {
+    "output": lambda x: x["output"],
+    "info": lambda x: x["info"],
+}
+
+add_routes(
+    app,
+    wrapped_chain_2.with_types(input_type=Input, output_type=Output),
+    path="/v2",
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

examples/widgets/server.py

@@ -0,0 +1,143 @@
+#!/usr/bin/env python
+"""Endpoint shows off available playground widgets."""
+import base64
+from json import dumps
+from typing import Any, Dict, List, Tuple
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+from langchain.chat_models.openai import ChatOpenAI
+from langchain.document_loaders.blob_loaders import Blob
+from langchain.document_loaders.parsers.pdf import PDFMinerParser
+from langchain.pydantic_v1 import BaseModel, Field
+from langchain.schema.messages import (
+    AIMessage,
+    BaseMessage,
+    FunctionMessage,
+    HumanMessage,
+)
+from langchain.schema.runnable import RunnableLambda
+from langchain_core.runnables import RunnableParallel
+
+from langserve import CustomUserType
+from langserve.server import add_routes
+
+app = FastAPI(
+    title="LangChain Server",
+    version="1.0",
+    description="Spin up a simple api server using Langchain's Runnable interfaces",
+)
+
+
+# Set all CORS enabled origins
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=["*"],
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+    expose_headers=["*"],
+)
+
+# Example 1: Chat Widget
+# This shows how to create a chat widget.
+
+
+class ChatHistory(CustomUserType):
+    chat_history: List[Tuple[str, str]] = Field(
+        ...,
+        examples=[[("a", "aa")]],
+        extra={"widget": {"type": "chat", "input": "question", "output": "answer"}},
+    )
+    question: str
+
+
+def _format_to_messages(input: ChatHistory) -> List[BaseMessage]:
+    """Format the input to a list of messages."""
+    history = input.chat_history
+    user_input = input.question
+
+    messages = []
+
+    for human, ai in history:
+        messages.append(HumanMessage(content=human))
+        messages.append(AIMessage(content=ai))
+    messages.append(HumanMessage(content=user_input))
+    return messages
+
+
+model = ChatOpenAI()
+chat_model = RunnableParallel({"answer": (RunnableLambda(_format_to_messages) | model)})
+add_routes(
+    app,
+    chat_model.with_types(input_type=ChatHistory),
+    config_keys=["configurable"],
+    path="/chat",
+)
+
+
+# Example 2: Chat Widget with History
+# This one isn't hooked up toa model. It just shows that FunctionMessages can be used
+# surfaced as well in the playground.
+
+
+class ChatHistoryMessage(BaseModel):
+    chat_history: List[BaseMessage] = Field(
+        ...,
+        extra={"widget": {"type": "chat", "input": "location"}},
+    )
+    location: str
+
+
+def chat_message_bot(input: Dict[str, Any]) -> List[BaseMessage]:
+    """Bot that repeats the question twice."""
+    return [
+        AIMessage(
+            content="",
+            additional_kwargs={
+                "function_call": {
+                    "name": "get_weather",
+                    "arguments": dumps({"location": input["location"]}),
+                }
+            },
+        ),
+        FunctionMessage(name="get_weather", content='{"value": 32}'),
+        AIMessage(content=f"Weather in {input['location']}: 32"),
+    ]
+
+
+add_routes(
+    app,
+    RunnableLambda(chat_message_bot).with_types(input_type=ChatHistoryMessage),
+    config_keys=["configurable"],
+    path="/chat_message",
+)
+
+# Example 3: File Processing Widget
+
+
+class FileProcessingRequest(BaseModel):
+    file: bytes = Field(..., extra={"widget": {"type": "base64file"}})
+    num_chars: int = 100
+
+
+def process_file(input: Dict[str, Any]) -> str:
+    """Extract the text from the first page of the PDF."""
+    content = base64.decodebytes(input["file"])
+    blob = Blob(data=content)
+    documents = list(PDFMinerParser().lazy_parse(blob))
+    content = documents[0].page_content
+    return content[: input["num_chars"]]
+
+
+add_routes(
+    app,
+    RunnableLambda(process_file).with_types(input_type=FileProcessingRequest),
+    config_keys=["configurable"],
+    path="/pdf",
+)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(app, host="localhost", port=8000)

langserve/__init__.py

@@ -1,7 +1,19 @@
-"""Main entrypoint into package."""
+"""Main entrypoint into package.
 
+This is the ONLY public interface into the package. All other modules are
+to be considered private and subject to change without notice.
+"""
+
+from langserve.api_handler import APIHandler
 from langserve.client import RemoteRunnable
+from langserve.schema import CustomUserType
 from langserve.server import add_routes
 from langserve.version import __version__
 
-__all__ = ["RemoteRunnable", "add_routes", "__version__"]
+__all__ = [
+    "RemoteRunnable",
+    "APIHandler",
+    "add_routes",
+    "__version__",
+    "CustomUserType",
+]

langserve/callbacks.py

@@ -0,0 +1,475 @@
+from __future__ import annotations
+
+import uuid
+from typing import Any, Dict, List, Optional, Sequence
+from uuid import UUID
+
+from langchain.callbacks.base import AsyncCallbackHandler
+from langchain.callbacks.manager import (
+    BaseRunManager,
+    ahandle_event,
+    handle_event,
+)
+from langchain.schema import AgentAction, AgentFinish, BaseMessage, Document, LLMResult
+from typing_extensions import TypedDict
+
+
+class CallbackEventDict(TypedDict, total=False):
+    """A dictionary representation of a callback event."""
+
+    type: str
+    parent_run_id: Optional[UUID]
+    run_id: UUID
+
+
+class AsyncEventAggregatorCallback(AsyncCallbackHandler):
+    """A callback handler that aggregates all the events that have been called.
+
+    This callback handler aggregates all the events that have been called placing
+    them in a single mutable list.
+
+    This callback handler is not threading safe, and is meant to be used in an async
+    context only.
+    """
+
+    def __init__(self) -> None:
+        """Get a list of all the callback events that have been called."""
+        super().__init__()
+        # Callback events is a mutable state that is used only in an async context,
+        # so it should be safe to mutate without the usage of a lock.
+        self.callback_events: List[CallbackEventDict] = []
+
+    def log_callback(self, event: CallbackEventDict) -> None:
+        """Log the callback event."""
+        self.callback_events.append(event)
+
+    async def on_chat_model_start(
+        self,
+        serialized: Dict[str, Any],
+        messages: List[List[BaseMessage]],
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        **kwargs: Any,
+    ) -> Any:
+        """Attempt to serialize the callback event."""
+        self.log_callback(
+            {
+                "type": "on_chat_model_start",
+                "serialized": serialized,
+                "messages": messages,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "metadata": metadata,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_chain_start(
+        self,
+        serialized: Dict[str, Any],
+        inputs: Dict[str, Any],
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        **kwargs: Any,
+    ) -> None:
+        """Attempt to serialize the callback event."""
+        self.log_callback(
+            {
+                "type": "on_chain_start",
+                "serialized": serialized,
+                "inputs": inputs,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "metadata": metadata,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_chain_end(
+        self,
+        outputs: Any,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_chain_end",
+                "outputs": outputs,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_chain_error(
+        self,
+        error: BaseException,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_chain_error",
+                "error": error,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_retriever_start(
+        self,
+        serialized: Dict[str, Any],
+        query: str,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_retriever_start",
+                "serialized": serialized,
+                "query": query,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "metadata": metadata,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_retriever_end(
+        self,
+        documents: Sequence[Document],
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_retriever_end",
+                "documents": documents,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_retriever_error(
+        self,
+        error: BaseException,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_retriever_error",
+                "error": error,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_tool_start(
+        self,
+        serialized: Dict[str, Any],
+        input_str: str,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_tool_start",
+                "serialized": serialized,
+                "input_str": input_str,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "metadata": metadata,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_tool_end(
+        self,
+        output: str,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_tool_end",
+                "output": output,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_tool_error(
+        self,
+        error: BaseException,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_tool_error",
+                "error": error,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_agent_action(
+        self,
+        action: AgentAction,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_agent_action",
+                "action": action,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_agent_finish(
+        self,
+        finish: AgentFinish,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_agent_finish",
+                "finish": finish,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_llm_start(
+        self,
+        serialized: Dict[str, Any],
+        prompts: List[str],
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_llm_start",
+                "serialized": serialized,
+                "prompts": prompts,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "metadata": metadata,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_llm_end(
+        self,
+        response: LLMResult,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_llm_end",
+                "response": response,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+    async def on_llm_error(
+        self,
+        error: BaseException,
+        *,
+        run_id: UUID,
+        parent_run_id: Optional[UUID] = None,
+        tags: Optional[List[str]] = None,
+        **kwargs: Any,
+    ) -> None:
+        self.log_callback(
+            {
+                "type": "on_llm_error",
+                "error": error,
+                "run_id": run_id,
+                "parent_run_id": parent_run_id,
+                "tags": tags,
+                "kwargs": kwargs,
+            }
+        )
+
+
+def replace_uuids(
+    callback_events: Sequence[CallbackEventDict],
+) -> List[CallbackEventDict]:
+    """Replace uids in the event callbacks with new uids.
+
+    This function mutates the event callback events in place.
+
+    Args:
+        callback_events: A list of event callbacks.
+    """
+    # Create a dictionary to store mappings from old UID to new UID
+    uid_mapping: dict = {}
+
+    updated_events = []
+
+    # Iterate through the list of event callbacks
+    for event in callback_events:
+        updated_event = event.copy()
+        # Replace UIDs in the 'run_id' field
+        if "run_id" in updated_event and updated_event["run_id"] is not None:
+            if updated_event["run_id"] not in uid_mapping:
+                # Generate a new UUID
+                new_uid = uuid.uuid4()
+                uid_mapping[updated_event["run_id"]] = new_uid
+            # Replace the old UID with the new one
+            updated_event["run_id"] = uid_mapping[updated_event["run_id"]]
+
+        # Replace UIDs in the 'parent_run_id' field if it's not None
+        if (
+            "parent_run_id" in updated_event
+            and updated_event["parent_run_id"] is not None
+        ):
+            if updated_event["parent_run_id"] not in uid_mapping:
+                # Generate a new UUID
+                new_uid = uuid.uuid4()
+                uid_mapping[updated_event["parent_run_id"]] = new_uid
+            # Replace the old UID with the new one
+            updated_event["parent_run_id"] = uid_mapping[updated_event["parent_run_id"]]
+        updated_events.append(updated_event)
+    return updated_events
+
+
+# Mapping from event name to ignore condition name
+NAME_TO_IGNORE_CONDITION = {
+    "on_retry": "ignore_retry",
+    "on_text": None,
+    "on_agent_action": "ignore_agent",
+    "on_agent_finish": "ignore_agent",
+    "on_llm_start": "ignore_llm",
+    "on_llm_end": "ignore_llm",
+    "on_llm_error": "ignore_llm",
+    "on_chain_start": "ignore_chain",
+    "on_chain_end": "ignore_chain",
+    "on_chain_error": "ignore_chain",
+    "on_chat_model_start": "ignore_chat_model",
+    "on_tool_start": "ignore_agent",
+    "on_tool_end": "ignore_agent",
+    "on_tool_error": "ignore_agent",
+    "on_retriever_start": "ignore_retriever",
+    "on_retriever_end": "ignore_retriever",
+    "on_retriever_error": "ignore_retriever",
+}
+
+
+async def ahandle_callbacks(
+    callback_manager: BaseRunManager,
+    callback_events: Sequence[CallbackEventDict],
+) -> None:
+    """Invoke all the callback handlers with the given callback events."""
+    callback_events = replace_uuids(callback_events)
+
+    # 1. Do I need inheritable handlers
+    for event in callback_events:
+        if event["parent_run_id"] is None:  # How do we make sure it's None!?
+            event["parent_run_id"] = callback_manager.run_id
+
+        event_data = {key: value for key, value in event.items() if key != "type"}
+
+        await ahandle_event(
+            # Unpacking like this may not work
+            callback_manager.handlers,
+            event["type"],
+            ignore_condition_name=NAME_TO_IGNORE_CONDITION.get(event["type"], None),
+            **event_data,
+        )
+
+
+def handle_callbacks(
+    callback_manager: BaseRunManager,
+    callback_events: Sequence[CallbackEventDict],
+) -> None:
+    """Invoke all the callback handlers with the given callback events."""
+    callback_events = replace_uuids(callback_events)
+
+    for event in callback_events:
+        if event["parent_run_id"] is None:  # How do we make sure it's None!?
+            event["parent_run_id"] = callback_manager.run_id
+
+        event_data = {key: value for key, value in event.items() if key != "type"}
+
+        handle_event(
+            # Unpacking like this may not work
+            callback_manager.handlers,
+            event["type"],
+            ignore_condition_name=NAME_TO_IGNORE_CONDITION.get(event["type"], None),
+            **event_data,
+        )

langserve/client.py

@@ -1,8 +1,12 @@
 from __future__ import annotations
 
 import asyncio
+import copy
+import json
+import logging
 import weakref
 from concurrent.futures import ThreadPoolExecutor
+from functools import lru_cache
 from typing import (
     Any,
     AsyncIterator,
@@ -11,12 +15,17 @@ from typing import (
     List,
     Optional,
     Sequence,
+    Tuple,
     Union,
 )
 from urllib.parse import urljoin
 
 import httpx
 from httpx._types import AuthTypes, CertTypes, CookieTypes, HeaderTypes, VerifyTypes
+from langchain.callbacks.manager import (
+    AsyncCallbackManagerForChainRun,
+    CallbackManagerForChainRun,
+)
 from langchain.callbacks.tracers.log_stream import RunLogPatch
 from langchain.load.dump import dumpd
 from langchain.schema.runnable import Runnable
@@ -26,9 +35,16 @@ from langchain.schema.runnable.config import (
     get_async_callback_manager_for_config,
     get_callback_manager_for_config,
 )
-from langchain.schema.runnable.utils import Input, Output
+from langchain.schema.runnable.utils import AddableDict, Input, Output
 
-from langserve.serialization import simple_dumpd, simple_loads
+from langserve.callbacks import CallbackEventDict, ahandle_callbacks, handle_callbacks
+from langserve.serialization import (
+    Serializer,
+    WellKnownLCSerializer,
+    load_events,
+)
+
+logger = logging.getLogger(__name__)
 
 
 def _without_callbacks(config: Optional[RunnableConfig]) -> RunnableConfig:
@@ -37,6 +53,35 @@ def _without_callbacks(config: Optional[RunnableConfig]) -> RunnableConfig:
     return {k: v for k, v in _config.items() if k != "callbacks"}
 
 
+@lru_cache(maxsize=1_000)  # Will accommodate up to 1_000 different error messages
+def _log_error_message_once(error_message: str) -> None:
+    """Log an error message once."""
+    logger.error(error_message)
+
+
+def _sanitize_request(request: httpx.Request) -> httpx.Request:
+    """Remove sensitive headers from the request."""
+    accept_headers = {
+        "accept",
+        "content-type",
+        "user-agent",
+        "connection",
+        "content-length",
+        "accept-encoding",
+        "host",
+    }
+    new_headers = request.headers.copy()
+    for key, value in new_headers.items():
+        if key.lower() not in accept_headers:
+            new_headers[key] = "<redacted>"
+        else:
+            new_headers[key] = value
+
+    new_request = copy.copy(request)
+    new_request.headers = new_headers
+    return new_request
+
+
 def _raise_for_status(response: httpx.Response) -> None:
     """Re-raise with a more informative message.
 
@@ -58,7 +103,7 @@ def _raise_for_status(response: httpx.Response) -> None:
 
         raise httpx.HTTPStatusError(
             message=message,
-            request=e.request,
+            request=_sanitize_request(e.request),
             response=e.response,
         )
 
@@ -94,6 +139,62 @@ def _close_clients(sync_client: httpx.Client, async_client: httpx.AsyncClient) -
         asyncio.run(async_client.aclose())
 
 
+def _raise_exception_from_data(data: str, request: httpx.Request) -> None:
+    """Raise an httpx exception from the given error event data."""
+    try:
+        decoded_data = json.loads(data)
+    except json.JSONDecodeError:
+        raise httpx.HTTPStatusError(
+            message="invalid json in error event sent from server",
+            request=_sanitize_request(request),
+            response=httpx.Response(status_code=500, text=data),
+        )
+    raise httpx.HTTPStatusError(
+        message=decoded_data["message"],
+        request=_sanitize_request(request),
+        response=httpx.Response(
+            status_code=decoded_data["status_code"],
+            text=decoded_data["message"],
+        ),
+    )
+
+
+def _decode_response(
+    serializer: Serializer,
+    response: httpx.Response,
+    *,
+    is_batch: bool = False,
+) -> Tuple[Any, Union[List[CallbackEventDict], List[List[CallbackEventDict]]]]:
+    """Decode the response."""
+    _raise_for_status(response)
+    obj = response.json()
+    if not isinstance(obj, dict):
+        raise ValueError(f"Expected a dictionary, got {obj}")
+
+    if "output" not in obj:
+        raise ValueError("Key `output` not found in")
+
+    output = serializer.loadd(obj["output"])
+
+    if "callback_events" in obj:
+        if is_batch:
+            if not isinstance(obj["callback_events"], list):
+                raise ValueError(
+                    f"Expected a list of callback events, got {obj['callback_events']}"
+                )
+            else:
+                callback_events = [
+                    load_events(callback_events)
+                    for callback_events in obj["callback_events"]
+                ]
+        else:
+            callback_events = load_events(obj["callback_events"])
+    else:
+        callback_events = []
+
+    return output, callback_events
+
+
 class RemoteRunnable(Runnable[Input, Output]):
     """A RemoteRunnable is a runnable that is executed on a remote server.
 
@@ -103,8 +204,6 @@ class RemoteRunnable(Runnable[Input, Output]):
 
     - `batch` with `return_exceptions=True` since we do not support exception
       translation from the server.
-    - Callbacks via the `config` argument as serialization of callbacks is not
-      supported.
     """
 
     def __init__(
@@ -118,6 +217,7 @@ class RemoteRunnable(Runnable[Input, Output]):
         verify: VerifyTypes = True,
         cert: Optional[CertTypes] = None,
         client_kwargs: Optional[Dict[str, Any]] = None,
+        use_server_callback_events: bool = True,
     ) -> None:
         """Initialize the client.
 
@@ -130,10 +230,13 @@ class RemoteRunnable(Runnable[Input, Output]):
             verify: Whether to verify SSL certificates
             cert: SSL certificate to use for requests
             client_kwargs: If provided will be unpacked as kwargs to both the sync
-                           and async httpx clients
+                and async httpx clients
+            use_server_callback_events: Whether to invoke callbacks on any
+                callback events returned by the server.
         """
         _client_kwargs = client_kwargs or {}
-        self.url = url
+        # Enforce trailing slash
+        self.url = url if url.endswith("/") else url + "/"
         self.sync_client = httpx.Client(
             base_url=url,
             timeout=timeout,
@@ -157,21 +260,32 @@ class RemoteRunnable(Runnable[Input, Output]):
 
         # Register cleanup handler once RemoteRunnable is garbage collected
         weakref.finalize(self, _close_clients, self.sync_client, self.async_client)
+        self._lc_serializer = WellKnownLCSerializer()
+        self._use_server_callback_events = use_server_callback_events
 
     def _invoke(
-        self, input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any
+        self,
+        input: Input,
+        run_manager: CallbackManagerForChainRun,
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Any,
     ) -> Output:
         """Invoke the runnable with the given input and config."""
         response = self.sync_client.post(
             "/invoke",
             json={
-                "input": simple_dumpd(input),
+                "input": self._lc_serializer.dumpd(input),
                 "config": _without_callbacks(config),
                 "kwargs": kwargs,
             },
         )
-        _raise_for_status(response)
-        return simple_loads(response.text)["output"]
+        output, callback_events = _decode_response(
+            self._lc_serializer, response, is_batch=False
+        )
+
+        if self._use_server_callback_events and callback_events:
+            handle_callbacks(run_manager, callback_events)
+        return output
 
     def invoke(
         self, input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any
@@ -181,18 +295,27 @@ class RemoteRunnable(Runnable[Input, Output]):
         return self._call_with_config(self._invoke, input, config=config)
 
     async def _ainvoke(
-        self, input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any
+        self,
+        input: Input,
+        run_manager: AsyncCallbackManagerForChainRun,
+        config: Optional[RunnableConfig] = None,
+        **kwargs: Any,
     ) -> Output:
+        """Invoke the runnable with the given input and config."""
         response = await self.async_client.post(
             "/invoke",
             json={
-                "input": simple_dumpd(input),
+                "input": self._lc_serializer.dumpd(input),
                 "config": _without_callbacks(config),
                 "kwargs": kwargs,
             },
         )
-        _raise_for_status(response)
-        return simple_loads(response.text)["output"]
+        output, callback_events = _decode_response(
+            self._lc_serializer, response, is_batch=False
+        )
+        if self._use_server_callback_events and callback_events:
+            handle_callbacks(run_manager, callback_events)
+        return output
 
     async def ainvoke(
         self, input: Input, config: Optional[RunnableConfig] = None, **kwargs: Any
@@ -204,6 +327,7 @@ class RemoteRunnable(Runnable[Input, Output]):
     def _batch(
         self,
         inputs: List[Input],
+        run_manager: List[CallbackManagerForChainRun],
         config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None,
         *,
         return_exceptions: bool = False,
@@ -224,13 +348,23 @@ class RemoteRunnable(Runnable[Input, Output]):
         response = self.sync_client.post(
             "/batch",
             json={
-                "inputs": simple_dumpd(inputs),
+                "inputs": self._lc_serializer.dumpd(inputs),
                 "config": _config,
                 "kwargs": kwargs,
             },
         )
-        _raise_for_status(response)
-        return simple_loads(response.text)["output"]
+        outputs, corresponding_callback_events = _decode_response(
+            self._lc_serializer, response, is_batch=True
+        )
+
+        # Now handle callbacks if any were returned
+        if self._use_server_callback_events and corresponding_callback_events:
+            for run_manager_, callback_events in zip(
+                run_manager, corresponding_callback_events
+            ):
+                handle_callbacks(run_manager_, callback_events)
+
+        return outputs
 
     def batch(
         self,
@@ -245,6 +379,7 @@ class RemoteRunnable(Runnable[Input, Output]):
     async def _abatch(
         self,
         inputs: List[Input],
+        run_manager: List[AsyncCallbackManagerForChainRun],
         config: Optional[Union[RunnableConfig, List[RunnableConfig]]] = None,
         *,
         return_exceptions: bool = False,
@@ -266,13 +401,27 @@ class RemoteRunnable(Runnable[Input, Output]):
         response = await self.async_client.post(
             "/batch",
             json={
-                "inputs": simple_dumpd(inputs),
+                "inputs": self._lc_serializer.dumpd(inputs),
                 "config": _config,
                 "kwargs": kwargs,
             },
         )
-        _raise_for_status(response)
-        return simple_loads(response.text)["output"]
+        outputs, corresponding_callback_events = _decode_response(
+            self._lc_serializer, response, is_batch=True
+        )
+
+        # Now handle callbacks
+
+        if self._use_server_callback_events and corresponding_callback_events:
+            tasks = []
+            for run_manager_, callback_events in zip(
+                run_manager, corresponding_callback_events
+            ):
+                tasks.append(ahandle_callbacks(run_manager_, callback_events))
+
+            # Execute coroutines concurrently
+            await asyncio.gather(*tasks)
+        return outputs
 
     async def abatch(
         self,
@@ -300,14 +449,15 @@ class RemoteRunnable(Runnable[Input, Output]):
         callback_manager = get_callback_manager_for_config(config)
 
         final_output: Optional[Output] = None
+        final_output_supported = True
 
         run_manager = callback_manager.on_chain_start(
             dumpd(self),
-            simple_dumpd(input),
+            self._lc_serializer.dumpd(input),
             name=config.get("run_name"),
         )
         data = {
-            "input": simple_dumpd(input),
+            "input": self._lc_serializer.dumpd(input),
             "config": _without_callbacks(config),
             "kwargs": kwargs,
         }
@@ -327,17 +477,48 @@ class RemoteRunnable(Runnable[Input, Output]):
             ) as event_source:
                 for sse in event_source.iter_sse():
                     if sse.event == "data":
-                        chunk = simple_loads(sse.data)
+                        chunk = self._lc_serializer.loads(sse.data)
+                        if isinstance(chunk, dict):
+                            # Any dict returned from streaming end point
+                            # is assumed to follow additive semantics
+                            # and will be converted to an AddableDict
+                            # automatically
+                            chunk = AddableDict(chunk)
                         yield chunk
 
-                        if final_output:
-                            final_output += chunk
-                        else:
-                            final_output = chunk
+                        if final_output_supported:
+                            # here we attempt to aggregate the final output
+                            # from the stream.
+                            # the final output is used for the final callback
+                            # event (`on_chain_end`)
+                            # Aggregating the final output is only supported
+                            # if the output is additive (e.g., string or
+                            # AddableDict, etc.)
+                            # We attempt to aggregate it on best effort basis.
+                            if final_output is None:
+                                final_output = chunk
+                            else:
+                                try:
+                                    final_output = final_output + chunk
+                                except TypeError:
+                                    final_output = None
+                                    final_output_supported = False
+                    elif sse.event == "error":
+                        # This can only be a server side error
+                        _raise_exception_from_data(
+                            sse.data, httpx.Request(method="POST", url=endpoint)
+                        )
+                    elif sse.event == "metadata":
+                        # Nothing to do for metadata for the regular remote client.
+                        continue
                     elif sse.event == "end":
                         break
                     else:
-                        raise NotImplementedError(f"Unknown event {sse.event}")
+                        _log_error_message_once(
+                            f"Encountered an unsupported event type: `{sse.event}`. "
+                            f"Try upgrading the remote client to the latest version."
+                            f"Ignoring events of type `{sse.event}`."
+                        )
         except BaseException as e:
             run_manager.on_chain_error(e)
             raise
@@ -354,14 +535,15 @@ class RemoteRunnable(Runnable[Input, Output]):
         callback_manager = get_async_callback_manager_for_config(config)
 
         final_output: Optional[Output] = None
+        final_output_supported = True
 
         run_manager = await callback_manager.on_chain_start(
             dumpd(self),
-            simple_dumpd(input),
+            self._lc_serializer.dumpd(input),
             name=config.get("run_name"),
         )
         data = {
-            "input": simple_dumpd(input),
+            "input": self._lc_serializer.dumpd(input),
             "config": _without_callbacks(config),
             "kwargs": kwargs,
         }
@@ -378,18 +560,49 @@ class RemoteRunnable(Runnable[Input, Output]):
             ) as event_source:
                 async for sse in event_source.aiter_sse():
                     if sse.event == "data":
-                        chunk = simple_loads(sse.data)
+                        chunk = self._lc_serializer.loads(sse.data)
+                        if isinstance(chunk, dict):
+                            # Any dict returned from streaming end point
+                            # is assumed to follow additive semantics
+                            # and will be converted to an AddableDict
+                            # automatically
+                            chunk = AddableDict(chunk)
                         yield chunk
 
-                        if final_output:
-                            final_output += chunk
-                        else:
-                            final_output = chunk
+                        if final_output_supported:
+                            # here we attempt to aggregate the final output
+                            # from the stream.
+                            # the final output is used for the final callback
+                            # event (`on_chain_end`)
+                            # Aggregating the final output is only supported
+                            # if the output is additive (e.g., string or
+                            # AddableDict, etc.)
+                            # We attempt to aggregate it on best effort basis.
+                            if final_output is None:
+                                final_output = chunk
+                            else:
+                                try:
+                                    final_output = final_output + chunk
+                                except TypeError:
+                                    final_output = None
+                                    final_output_supported = False
+
+                    elif sse.event == "error":
+                        # This can only be a server side error
+                        _raise_exception_from_data(
+                            sse.data, httpx.Request(method="POST", url=endpoint)
+                        )
+                    elif sse.event == "metadata":
+                        # Nothing to do for metadata for the regular remote client.
+                        continue
                     elif sse.event == "end":
                         break
-
                     else:
-                        raise NotImplementedError(f"Unknown event {sse.event}")
+                        _log_error_message_once(
+                            f"Encountered an unsupported event type: `{sse.event}`. "
+                            f"Try upgrading the remote client to the latest version."
+                            f"Ignoring events of type `{sse.event}`."
+                        )
         except BaseException as e:
             await run_manager.on_chain_error(e)
             raise
@@ -428,11 +641,11 @@ class RemoteRunnable(Runnable[Input, Output]):
 
         run_manager = await callback_manager.on_chain_start(
             dumpd(self),
-            simple_dumpd(input),
+            self._lc_serializer.dumpd(input),
             name=config.get("run_name"),
         )
         data = {
-            "input": simple_dumpd(input),
+            "input": self._lc_serializer.dumpd(input),
             "config": _without_callbacks(config),
             "kwargs": kwargs,
             "diff": True,
@@ -456,19 +669,31 @@ class RemoteRunnable(Runnable[Input, Output]):
             ) as event_source:
                 async for sse in event_source.aiter_sse():
                     if sse.event == "data":
-                        data = simple_loads(sse.data)
+                        data = self._lc_serializer.loads(sse.data)
+                        # Create a copy of the data to yield since underlying
+                        # code is using jsonpatch which does some stuff in-place
+                        # that can cause unexpected consequences.
+                        chunk_to_yield = RunLogPatch(*copy.deepcopy(data["ops"]))
                         chunk = RunLogPatch(*data["ops"])
 
-                        yield chunk
-
+                        yield chunk_to_yield
                         if final_output:
                             final_output += chunk
                         else:
                             final_output = chunk
+                    elif sse.event == "error":
+                        # This can only be a server side error
+                        _raise_exception_from_data(
+                            sse.data, httpx.Request(method="POST", url=endpoint)
+                        )
                     elif sse.event == "end":
                         break
                     else:
-                        raise NotImplementedError(f"Unknown event {sse.event}")
+                        _log_error_message_once(
+                            f"Encountered an unsupported event type: `{sse.event}`. "
+                            f"Try upgrading the remote client to the latest version."
+                            f"Ignoring events of type `{sse.event}`."
+                        )
         except BaseException as e:
             await run_manager.on_chain_error(e)
             raise

langserve/playground.py

@@ -2,46 +2,94 @@ import json
 import mimetypes
 import os
 from string import Template
-from typing import List, Type
+from typing import Sequence, Type
 
 from fastapi.responses import Response
 from langchain.schema.runnable import Runnable
 
-try:
-    from pydantic.v1 import BaseModel
-except ImportError:
-    from pydantic import BaseModel
+from langserve.pydantic_v1 import BaseModel
 
 
 class PlaygroundTemplate(Template):
     delimiter = "____"
 
 
+def _get_mimetype(path: str) -> str:
+    """Get mimetype for file.
+
+    Custom implementation of mimetypes.guess_type that
+    uses the file extension to determine the mimetype for some files.
+
+    This is necessary due to: https://bugs.python.org/issue43975
+    Resolves issue: https://github.com/langchain-ai/langserve/issues/245
+
+    Args:
+        path (str): Path to file
+
+    Returns:
+        str: Mimetype of file
+    """
+    try:
+        file_extension = path.lower().split(".")[-1]
+    except IndexError:
+        return mimetypes.guess_type(path)[0]
+
+    if file_extension == "js":
+        return "application/javascript"
+    elif file_extension == "css":
+        return "text/css"
+    elif file_extension in ["htm", "html"]:
+        return "text/html"
+
+    # If the file extension is not one of the specified ones,
+    # use the default guess method
+    mime_type = mimetypes.guess_type(path)[0]
+    return mime_type
+
+
 async def serve_playground(
     runnable: Runnable,
     input_schema: Type[BaseModel],
-    config_keys: List[str],
+    config_keys: Sequence[str],
     base_url: str,
     file_path: str,
+    feedback_enabled: bool,
 ) -> Response:
-    local_file_path = os.path.join(
-        os.path.dirname(__file__),
-        "./playground/dist",
-        file_path or "index.html",
+    """Serve the playground."""
+    local_file_path = os.path.abspath(
+        os.path.join(
+            os.path.dirname(__file__),
+            "./playground/dist",
+            file_path or "index.html",
+        )
     )
-    with open(local_file_path) as f:
-        mime_type = mimetypes.guess_type(local_file_path)[0]
-        if mime_type in ("text/html", "text/css", "application/javascript"):
-            res = PlaygroundTemplate(f.read()).substitute(
-                LANGSERVE_BASE_URL=base_url[1:]
-                if base_url.startswith("/")
-                else base_url,
-                LANGSERVE_CONFIG_SCHEMA=json.dumps(
-                    runnable.config_schema(include=config_keys).schema()
-                ),
-                LANGSERVE_INPUT_SCHEMA=json.dumps(input_schema.schema()),
-            )
-        else:
-            res = f.buffer.read()
 
-    return Response(res, media_type=mime_type)
+    base_dir = os.path.abspath(
+        os.path.join(os.path.dirname(__file__), "./playground/dist")
+    )
+
+    if base_dir != os.path.commonpath((base_dir, local_file_path)):
+        return Response("Not Found", status_code=404)
+
+    try:
+        with open(local_file_path, encoding="utf-8") as f:
+            mime_type = _get_mimetype(local_file_path)
+            if mime_type in ("text/html", "text/css", "application/javascript"):
+                response = PlaygroundTemplate(f.read()).substitute(
+                    LANGSERVE_BASE_URL=base_url[1:]
+                    if base_url.startswith("/")
+                    else base_url,
+                    LANGSERVE_CONFIG_SCHEMA=json.dumps(
+                        runnable.config_schema(include=config_keys).schema()
+                    ),
+                    LANGSERVE_INPUT_SCHEMA=json.dumps(input_schema.schema()),
+                    LANGSERVE_FEEDBACK_ENABLED=json.dumps(
+                        "true" if feedback_enabled else "false"
+                    ),
+                )
+            else:
+                response = f.buffer.read()
+    except FileNotFoundError:
+        return Response("Not Found", status_code=404)
+
+    return Response(response, media_type=mime_type)

langserve/playground/.gitignore

@@ -23,4 +23,6 @@ dist-ssr
 *.sln
 *.sw?
 
-.yarn
+.yarn
+
+!dist

langserve/playground/dist/index.html

@@ -5,8 +5,8 @@
     <link rel="icon" href="/____LANGSERVE_BASE_URL/favicon.ico" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Playground</title>
-    <script type="module" crossorigin src="/____LANGSERVE_BASE_URL/assets/index-6c8f83bb.js"></script>
-    <link rel="stylesheet" href="/____LANGSERVE_BASE_URL/assets/index-5008c8a8.css">
+    <script type="module" crossorigin src="/____LANGSERVE_BASE_URL/assets/index-fbe3df33.js"></script>
+    <link rel="stylesheet" href="/____LANGSERVE_BASE_URL/assets/index-52e8ab2f.css">
   </head>
   <body>
     <div id="root"></div>
@@ -14,6 +14,7 @@
       try {
         window.CONFIG_SCHEMA = ____LANGSERVE_CONFIG_SCHEMA;
         window.INPUT_SCHEMA = ____LANGSERVE_INPUT_SCHEMA;
+        window.FEEDBACK_ENABLED = ____LANGSERVE_FEEDBACK_ENABLED;
       } catch (error) {
         // pass
       }

langserve/playground/index.html

@@ -12,6 +12,7 @@
       try {
         window.CONFIG_SCHEMA = ____LANGSERVE_CONFIG_SCHEMA;
         window.INPUT_SCHEMA = ____LANGSERVE_INPUT_SCHEMA;
+        window.FEEDBACK_ENABLED = ____LANGSERVE_FEEDBACK_ENABLED;
       } catch (error) {
         // pass
       }

langserve/playground/package.json

@@ -20,15 +20,17 @@
     "@mui/icons-material": "^5.14.11",
     "@mui/material": "^5.14.11",
     "@mui/x-date-pickers": "^6.16.0",
+    "@radix-ui/react-toggle-group": "^1.0.4",
     "clsx": "^2.0.0",
     "dayjs": "^1.11.10",
     "fast-json-patch": "^3.1.1",
-    "json-schema-defaults": "^0.4.0",
     "lodash": "^4.17.21",
     "lz-string": "^1.5.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
+    "swr": "^2.2.4",
     "tailwind-merge": "^1.14.0",
+    "use-debounce": "^9.0.4",
     "vaul": "^0.7.3"
   },
   "devDependencies": {

langserve/playground/src/App.tsx

@@ -1,368 +1,222 @@
 import "./App.css";
 
-import React, { useEffect, useRef, useState } from "react";
-import defaults from "json-schema-defaults";
-import { JsonForms } from "@jsonforms/react";
-import {
-  materialAllOfControlTester,
-  MaterialAllOfRenderer,
-  materialAnyOfControlTester,
-  MaterialAnyOfRenderer,
-  MaterialObjectRenderer,
-  materialOneOfControlTester,
-  MaterialOneOfRenderer,
-} from "@jsonforms/material-renderers";
-import dayjs from "dayjs";
-import utc from "dayjs/plugin/utc";
-import relativeDate from "dayjs/plugin/relativeTime";
-import SendIcon from "./assets/SendIcon.svg?react";
+import { useEffect, useRef, useState } from "react";
+
 import ShareIcon from "./assets/ShareIcon.svg?react";
-import ChevronRight from "./assets/ChevronRight.svg?react";
-import { compressToEncodedURIComponent } from "lz-string";
 
-import {
-  BooleanCell,
-  DateCell,
-  DateTimeCell,
-  EnumCell,
-  IntegerCell,
-  NumberCell,
-  SliderCell,
-  TimeCell,
-  booleanCellTester,
-  dateCellTester,
-  dateTimeCellTester,
-  enumCellTester,
-  integerCellTester,
-  numberCellTester,
-  sliderCellTester,
-  textAreaCellTester,
-  textCellTester,
-  timeCellTester,
-  vanillaRenderers,
-  InputControl,
-} from "@jsonforms/vanilla-renderers";
-
-import { useSchemas } from "./useSchemas";
-import { RunState, useStreamLog } from "./useStreamLog";
-import {
-  JsonFormsCore,
-  RankedTester,
-  rankWith,
-  and,
-  uiTypeIs,
-  schemaMatches,
-  schemaTypeIs,
-} from "@jsonforms/core";
-import CustomArrayControlRenderer, {
-  materialArrayControlTester,
-} from "./components/CustomArrayControlRenderer";
-import CustomTextAreaCell from "./components/CustomTextAreaCell";
-import JsonTextAreaCell from "./components/JsonTextAreaCell";
+import { useConfigSchema, useFeedback, useInputSchema } from "./useSchemas";
+import { useStreamLog } from "./useStreamLog";
+import { AppCallbackContext, useAppStreamCallbacks } from "./useStreamCallback";
+import { JsonSchema } from "@jsonforms/core";
+import { ShareDialog } from "./components/ShareDialog";
+import { IntermediateSteps } from "./components/IntermediateSteps";
+import { StreamOutput } from "./components/StreamOutput";
+import { ConfigValue, SectionConfigure } from "./sections/SectionConfigure";
+import { InputValue, SectionInputs } from "./sections/SectionInputs";
+import { SubmitButton } from "./components/SubmitButton";
+import { useDebounce } from "use-debounce";
 import { cn } from "./utils/cn";
-import { getStateFromUrl, ShareDialog } from "./components/ShareDialog";
+import { CorrectnessFeedback } from "./components/feedback/CorrectnessFeedback";
+import { getStateFromUrl } from "./utils/url";
 
-dayjs.extend(relativeDate);
-dayjs.extend(utc);
+function InputPlayground(props: {
+  configSchema: { schema: JsonSchema; defaults: unknown };
+  inputSchema: { schema: JsonSchema; defaults: unknown };
 
-function str(o: unknown): React.ReactNode {
-  return typeof o === "object"
-    ? JSON.stringify(o, null, 2)
-    : (o as React.ReactNode);
-}
+  configData: ConfigValue;
 
-const isObjectWithPropertiesControl = rankWith(
-  2,
-  and(
-    uiTypeIs("Control"),
-    schemaTypeIs("object"),
-    schemaMatches((schema) =>
-      Object.prototype.hasOwnProperty.call(schema, "properties")
-    )
-  )
-);
+  startStream: (input: unknown, config: unknown) => void;
+  stopStream: (() => void) | undefined;
 
-const isObject = rankWith(1, and(uiTypeIs("Control"), schemaTypeIs("object")));
-const isElse = rankWith(1, and(uiTypeIs("Control")));
+  children?: React.ReactNode;
+}) {
+  const [inputData, setInputData] = useState<InputValue>({
+    data: props.inputSchema.defaults,
+    errors: [],
+  });
 
-const renderers = [
-  ...vanillaRenderers,
+  const submitRef = useRef<(() => void) | null>(null);
+  submitRef.current = () => {
+    if (
+      !props.stopStream &&
+      (!!inputData.errors?.length || !!props.configData.errors?.length)
+    ) {
+      return;
+    }
 
-  // use material renderers to handle objects and json schema references
-  // they should yield the rendering to simpler cells
-  { tester: isObjectWithPropertiesControl, renderer: MaterialObjectRenderer },
-  { tester: materialAllOfControlTester, renderer: MaterialAllOfRenderer },
-  { tester: materialAnyOfControlTester, renderer: MaterialAnyOfRenderer },
-  { tester: materialOneOfControlTester, renderer: MaterialOneOfRenderer },
+    if (props.stopStream) {
+      props.stopStream();
+    } else {
+      props.startStream(inputData.data, props.configData.data);
+    }
+  };
 
-  // custom renderers
-  { tester: materialArrayControlTester, renderer: CustomArrayControlRenderer },
-  { tester: isObject, renderer: InputControl },
-];
+  useEffect(() => {
+    window.addEventListener("keydown", (e) => {
+      if (e.key === "Enter" && (e.metaKey || e.ctrlKey)) {
+        e.preventDefault();
+        submitRef.current?.();
+      }
+    });
+  }, []);
 
-const nestedArrayControlTester: RankedTester = rankWith(1, (_, jsonSchema) => {
-  return jsonSchema.type === "array";
-});
+  const isSendDisabled =
+    !props.stopStream &&
+    (!!inputData.errors?.length || !!props.configData.errors?.length);
 
-const cells = [
-  { tester: booleanCellTester, cell: BooleanCell },
-  { tester: dateCellTester, cell: DateCell },
-  { tester: dateTimeCellTester, cell: DateTimeCell },
-  { tester: enumCellTester, cell: EnumCell },
-  { tester: integerCellTester, cell: IntegerCell },
-  { tester: numberCellTester, cell: NumberCell },
-  { tester: sliderCellTester, cell: SliderCell },
-  { tester: textAreaCellTester, cell: CustomTextAreaCell },
-  { tester: textCellTester, cell: CustomTextAreaCell },
-  { tester: timeCellTester, cell: TimeCell },
-  { tester: nestedArrayControlTester, cell: CustomArrayControlRenderer },
-  { tester: isElse, cell: JsonTextAreaCell },
-];
-
-function IntermediateSteps(props: { latest: RunState }) {
-  const [expanded, setExpanded] = useState(false);
   return (
-    <div className="flex flex-col border border-divider-700 rounded-2xl bg-background">
-      <button
-        className="font-medium text-left p-4 flex items-center justify-between"
-        onClick={() => setExpanded((open) => !open)}
-      >
-        <span>Intermediate steps</span>
-        <ChevronRight
-          className={cn("transition-all", expanded && "rotate-90")}
+    <>
+      <SectionInputs
+        input={props.inputSchema.schema}
+        value={inputData}
+        onChange={(input) => setInputData(input)}
+      />
+
+      {props.children}
+
+      <div className="flex-grow md:hidden" />
+
+      <div className="gap-4 grid grid-cols-2 sticky -mx-4 px-4 py-4 bottom-0 bg-background md:static md:bg-transparent">
+        <div className="md:hidden absolute inset-x-0 bottom-full h-5 bg-gradient-to-t from-black/5 to-black/0" />
+
+        <ShareDialog config={props.configData.data}>
+          <button
+            type="button"
+            className="px-4 py-3 gap-3 font-medium border border-divider-700 rounded-full flex items-center justify-center hover:bg-divider-500/50 active:bg-divider-500 transition-colors"
+          >
+            <ShareIcon className="flex-shrink-0" /> <span>Share</span>
+          </button>
+        </ShareDialog>
+
+        <SubmitButton
+          disabled={isSendDisabled}
+          onSubmit={submitRef.current}
+          isLoading={!!props.stopStream}
         />
-      </button>
-      {expanded && (
-        <div className="flex flex-col gap-5 p-4 pt-0 divide-solid divide-y divide-divider-700 rounded-b-xl">
-          {Object.values(props.latest.logs).map((log) => (
-            <div
-              className="gap-3 flex-col min-w-0 flex bg-background pt-3 first-of-type:pt-0"
-              key={log.id}
-            >
-              <div className="flex items-center justify-between">
-                <strong className="text-sm font-medium">{log.name}</strong>
-                <p className="text-sm">{dayjs.utc(log.start_time).fromNow()}</p>
-              </div>
-              <pre className="break-words whitespace-pre-wrap min-w-0 text-sm bg-ls-gray-400 rounded-lg p-3">
-                {str(log.final_output) ?? "..."}
-              </pre>
-            </div>
-          ))}
-        </div>
-      )}
-    </div>
+      </div>
+    </>
   );
 }
 
-function App() {
-  const [isIframe] = useState(() => window.self !== window.top);
+function ConfigPlayground(props: {
+  configSchema: {
+    schema: JsonSchema;
+    defaults: unknown;
+  };
+}) {
+  const urlState = getStateFromUrl(window.location.href);
+  const [configData, setConfigData] = useState<ConfigValue>({
+    data: urlState.configFromUrl ?? props.configSchema.defaults,
+    errors: [],
+    defaults: true,
+  });
 
-  // it is possible that defaults are being applied _after_
-  // the initial update message has been sent from the parent window
-  // so we store the initial config data in a ref
-  const initConfigData = useRef<JsonFormsCore["data"]>(null);
+  const feedback = useFeedback();
 
-  // store form state
-  const [configData, setConfigData] = useState<
-    Pick<JsonFormsCore, "data" | "errors">
-  >({ data: {}, errors: [] });
+  // input schema is derived from config data
+  const [debouncedConfigData, debounceState] = useDebounce(
+    configData.data,
+    500
+  );
 
-  const [inputData, setInputData] = useState<
-    Pick<JsonFormsCore, "data" | "errors">
-  >({ data: null, errors: [] });
-  // fetch input and config schemas from the server
-  const schemas = useSchemas();
-  // apply defaults defined in each schema
-  useEffect(() => {
-    if (schemas.config) {
-      const state = getStateFromUrl(window.location.href);
-      setConfigData({
-        data:
-          state.configFromUrl ??
-          initConfigData.current ??
-          defaults(schemas.config),
-        errors: [],
-      });
-      setInputData({ data: null, errors: [] });
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [schemas.config]);
-  // the runner
-  const { startStream, stopStream, latest } = useStreamLog();
+  const inputSchema = useInputSchema(
+    debouncedConfigData !== props.configSchema.defaults
+      ? debouncedConfigData
+      : undefined
+  );
 
-  useEffect(() => {
-    window.parent?.postMessage({ type: "init" }, "*");
-  }, []);
+  const { context, callbacks } = useAppStreamCallbacks();
+  const { startStream, stopStream, latest } = useStreamLog(callbacks);
 
-  useEffect(() => {
-    function listener(event: MessageEvent) {
-      if (event.source === window.parent) {
-        const message = event.data;
-        if (typeof message === "object" && message != null) {
-          switch (message.type) {
-            case "update": {
-              const value: { config: JsonFormsCore["data"] } = message.value;
-              if (Object.keys(value.config).length > 0) {
-                initConfigData.current = value.config;
-                setConfigData({ data: value.config, errors: [] });
-                break;
-              }
-            }
-          }
-        }
-      }
-    }
+  return (
+    <AppCallbackContext.Provider value={context}>
+      <SectionConfigure
+        config={props.configSchema.schema}
+        value={configData}
+        onChange={setConfigData}
+      />
 
-    window.addEventListener("message", listener);
-    return () => window.removeEventListener("message", listener);
-  }, []);
+      <div
+        className={cn(
+          "flex flex-col flex-grow gap-4 w-full transition-opacity",
+          (inputSchema.isLoading || debounceState.isPending()) &&
+            "opacity-50 pointer-events-none"
+        )}
+      >
+        {inputSchema.error != null ? (
+          <div className="bg-background rounded-xl">
+            <div className="bg-red-500/10 text-red-700 dark:text-red-300 rounded-xl p-3">
+              {inputSchema.error.toString()}
+            </div>
+          </div>
+        ) : (
+          <>
+            {inputSchema.data != null ? (
+              <InputPlayground
+                configSchema={props.configSchema}
+                inputSchema={inputSchema.data}
+                configData={configData}
+                startStream={startStream}
+                stopStream={stopStream}
+              >
+                {latest && (
+                  <div className="flex flex-col gap-3">
+                    <h2 className="text-xl font-semibold">Output</h2>
+                    <div className="p-4 border border-divider-700 flex flex-col gap-3 rounded-2xl bg-background text-lg whitespace-pre-wrap break-words relative group">
+                      <StreamOutput streamed={latest.streamed_output} />
 
-  return schemas.config && schemas.input ? (
+                      {feedback.data && latest.id ? (
+                        <div className="absolute right-4 top-4 flex items-center gap-2 transition-opacity opacity-0 focus-within:opacity-100 group-hover:opacity-100">
+                          <CorrectnessFeedback
+                            key={latest.id}
+                            runId={latest.id}
+                          />
+                        </div>
+                      ) : null}
+                    </div>
+                    <IntermediateSteps
+                      latest={latest}
+                      feedbackEnabled={!!feedback.data}
+                    />
+                  </div>
+                )}
+              </InputPlayground>
+            ) : null}
+          </>
+        )}
+      </div>
+    </AppCallbackContext.Provider>
+  );
+}
+
+function Playground() {
+  const configSchema = useConfigSchema();
+  if (configSchema.isLoading) return null;
+
+  if (configSchema.error != null) {
+    return (
+      <div className="bg-background rounded-xl">
+        <div className="bg-red-500/10 text-red-700 dark:text-red-300 rounded-xl p-3">
+          {configSchema.error.toString()}
+        </div>
+      </div>
+    );
+  }
+  if (configSchema.data == null) return "No config schema found";
+  return <ConfigPlayground configSchema={configSchema.data} />;
+}
+
+export function App() {
+  return (
     <div className="flex items-center flex-col text-ls-black bg-gradient-to-b from-[#F9FAFB] to-[#EFF8FF] min-h-[100dvh] dark:from-[#0C111C] dark:to-[#0C111C]">
       <div className="flex flex-col flex-grow gap-4 px-4 pt-6 max-w-[800px] w-full">
         <h1 className="text-2xl text-left">
           <strong>🦜 LangServe</strong> Playground
         </h1>
-        <div className="flex flex-col gap-3">
-          {!isIframe && <h2 className="text-xl font-semibold">Configure</h2>}
-
-          <JsonForms
-            schema={schemas.config}
-            data={configData.data}
-            renderers={renderers}
-            cells={cells}
-            onChange={({ data, errors }) =>
-              data ? setConfigData({ data, errors }) : undefined
-            }
-          />
-          {!!configData.errors?.length && configData.data && (
-            <div className="bg-background rounded-xl">
-              <div className="bg-red-500/10 text-red-700 dark:text-red-300 rounded-xl p-3">
-                <strong className="font-bold">Validation Errors</strong>
-                <ul className="list-disc pl-5">
-                  {configData.errors?.map((e, i) => (
-                    <li key={i}>{e.message}</li>
-                  ))}
-                </ul>
-              </div>
-            </div>
-          )}
-        </div>
-
-        {!isIframe && (
-          <div className="flex flex-col gap-3">
-            <h2 className="text-xl font-semibold">Try it</h2>
-
-            <div className="p-4 border border-divider-700 flex flex-col gap-3 rounded-2xl bg-background">
-              <h3 className="font-medium">Inputs</h3>
-
-              <JsonForms
-                schema={schemas.input}
-                data={inputData.data}
-                renderers={renderers}
-                cells={cells}
-                onChange={({ data, errors }) => setInputData({ data, errors })}
-              />
-              {!!inputData.errors?.length && inputData.data && (
-                <div className="bg-red-500/10 text-red-700 dark:text-red-300 rounded-xl p-3">
-                  <strong className="font-bold">Validation Errors</strong>
-                  <ul className="list-disc pl-5">
-                    {inputData.errors?.map((e, i) => (
-                      <li key={i}>{e.message}</li>
-                    ))}
-                  </ul>
-                </div>
-              )}
-            </div>
-
-            {latest && (
-              <div className="flex flex-col gap-3">
-                <h2 className="text-xl font-semibold">Output</h2>
-                <div className="p-4 border border-divider-700 flex flex-col gap-3 rounded-2xl bg-background text-lg">
-                  {latest.streamed_output.map(str).join("") || "..."}
-                </div>
-                <IntermediateSteps latest={latest} />
-              </div>
-            )}
-          </div>
-        )}
-
-        <div className="flex-grow md:hidden" />
-
-        <div className="gap-4 grid grid-cols-2 sticky -mx-4 px-4 py-4 bottom-0 bg-background md:static md:bg-transparent">
-          <div className="md:hidden absolute inset-x-0 bottom-full h-5 bg-gradient-to-t from-black/5 to-black/0" />
-
-          {isIframe ? (
-            <>
-              <button
-                type="button"
-                className="px-4 py-3 gap-3 font-medium border border-divider-700 rounded-full flex items-center justify-center hover:bg-divider-500/50 active:bg-divider-500 transition-colors"
-                onClick={() =>
-                  window.parent?.postMessage({ type: "close" }, "*")
-                }
-              >
-                Cancel
-              </button>
-              <button
-                type="button"
-                className="px-4 py-3 gap-3 font-medium border border-transparent rounded-full flex items-center justify-center bg-blue-500 hover:bg-blue-600 active:bg-blue-700 disabled:opacity-50 transition-colors"
-                onClick={() => {
-                  const hash = compressToEncodedURIComponent(
-                    JSON.stringify(configData.data)
-                  );
-
-                  const state = getStateFromUrl(window.location.href);
-                  const targetUrl = `${state.basePath}/c/${hash}`;
-                  window.parent?.postMessage(
-                    {
-                      type: "apply",
-                      value: { targetUrl, config: configData.data },
-                    },
-                    "*"
-                  );
-                }}
-              >
-                <span className="text-white">Apply</span>
-              </button>
-            </>
-          ) : (
-            <>
-              <ShareDialog config={configData.data}>
-                <button
-                  type="button"
-                  className="px-4 py-3 gap-3 font-medium border border-divider-700 rounded-full flex items-center justify-center hover:bg-divider-500/50 active:bg-divider-500 transition-colors"
-                >
-                  <ShareIcon className="flex-shrink-0" /> <span>Share</span>
-                </button>
-              </ShareDialog>
-              <button
-                type="button"
-                className="px-4 py-3 gap-3 font-medium border border-transparent rounded-full flex items-center justify-center bg-blue-500 hover:bg-blue-600 active:bg-blue-700 disabled:opacity-50 transition-colors"
-                onClick={() => {
-                  stopStream
-                    ? stopStream()
-                    : startStream(inputData.data, configData.data);
-                }}
-                disabled={
-                  !stopStream &&
-                  (!!inputData.errors?.length || !!configData.errors?.length)
-                }
-              >
-                {stopStream ? (
-                  <span className="text-white">Stop</span>
-                ) : (
-                  <>
-                    <SendIcon className="flex-shrink-0" />
-                    <span className="text-white">Start</span>
-                  </>
-                )}
-              </button>
-            </>
-          )}
-        </div>
+        <Playground />
       </div>
     </div>
-  ) : null;
+  );
 }
 
 export default App;

langserve/playground/src/assets/ChatIcon.svg

@@ -0,0 +1,6 @@
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <path fill-rule="evenodd" clip-rule="evenodd"
+    d="M7.7588 2H16.2414C17.0464 1.99999 17.7107 1.99998 18.2519 2.04419C18.814 2.09012 19.3307 2.18868 19.8161 2.43597C20.5687 2.81947 21.1806 3.43139 21.5641 4.18404C21.8114 4.66937 21.91 5.18608 21.9559 5.74817C22.0001 6.28936 22.0001 6.95372 22.0001 7.75868V13.2413C22.0001 14.0463 22.0001 14.7106 21.9559 15.2518C21.91 15.8139 21.8114 16.3306 21.5641 16.816C21.1806 17.5686 20.5687 18.1805 19.8161 18.564C19.3307 18.8113 18.814 18.9099 18.2519 18.9558C17.7107 19 17.0464 19 16.2414 19H13.6838C13.0197 19 12.8263 19.0047 12.6504 19.0408C12.4738 19.0771 12.303 19.137 12.1425 19.219C11.9826 19.3007 11.8286 19.4178 11.31 19.8327L8.89688 21.7632C8.7132 21.9102 8.52597 22.06 8.36137 22.1689C8.20394 22.273 7.8987 22.4593 7.50172 22.4597C7.0449 22.4602 6.61276 22.2525 6.32778 21.8955C6.08012 21.5852 6.03492 21.2305 6.01785 21.0425C6 20.846 6.00005 20.6062 6.00009 20.371L6.0001 18.9918C5.60829 18.9789 5.27229 18.9461 4.96482 18.8637C3.58445 18.4938 2.50626 17.4156 2.13639 16.0353C1.9993 15.5236 1.99962 14.933 2.00005 14.1376C2.00007 14.0924 2.0001 14.0465 2.0001 14L2.0001 7.7587C2.00008 6.95373 2.00007 6.28937 2.04429 5.74817C2.09022 5.18608 2.18878 4.66937 2.43607 4.18404C2.81956 3.43139 3.43149 2.81947 4.18413 2.43597C4.66947 2.18868 5.18617 2.09012 5.74827 2.04419C6.28947 1.99998 6.95383 1.99999 7.7588 2ZM5.91113 4.03755C5.47272 4.07337 5.24852 4.1383 5.09212 4.21799C4.71579 4.40973 4.40983 4.7157 4.21808 5.09202C4.13839 5.24842 4.07347 5.47262 4.03765 5.91104C4.00087 6.36113 4.0001 6.94342 4.0001 7.8V14C4.0001 14.9944 4.00869 15.2954 4.06824 15.5176C4.25318 16.2078 4.79227 16.7469 5.48246 16.9319C5.70474 16.9914 6.00574 17 7.0001 17C7.55238 17 8.0001 17.4477 8.0001 18V19.9194L10.0606 18.271C10.0834 18.2528 10.1058 18.2348 10.1279 18.2171C10.55 17.8791 10.8691 17.6237 11.2326 17.4379C11.5536 17.274 11.8952 17.1541 12.2483 17.0817C12.6482 16.9996 13.0569 16.9998 13.5976 17C13.626 17 13.6547 17 13.6838 17H16.2001C17.0567 17 17.639 16.9992 18.0891 16.9624C18.5275 16.9266 18.7517 16.8617 18.9081 16.782C19.2844 16.5903 19.5904 16.2843 19.7821 15.908C19.8618 15.7516 19.9267 15.5274 19.9625 15.089C19.9993 14.6389 20.0001 14.0566 20.0001 13.2V7.8C20.0001 6.94342 19.9993 6.36113 19.9625 5.91104C19.9267 5.47262 19.8618 5.24842 19.7821 5.09202C19.5904 4.7157 19.2844 4.40973 18.9081 4.21799C18.7517 4.1383 18.5275 4.07337 18.0891 4.03755C17.639 4.00078 17.0567 4 16.2001 4H7.8001C6.94352 4 6.36122 4.00078 5.91113 4.03755Z"
+    fill="currentColor" />
+</svg>
+  

langserve/playground/src/assets/CircleSpinIcon.svg

@@ -0,0 +1,15 @@
+<svg
+  aria-hidden="true"
+  viewBox="0 0 100 101"
+  fill="none"
+  xmlns="http://www.w3.org/2000/svg"
+>
+  <path
+    d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
+    fill="currentColor"
+  />
+  <path
+    d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
+    fill="currentFill"
+  />
+</svg>

langserve/playground/src/assets/CodeIcon.svg

@@ -1,6 +1,6 @@
-<svg width="19" height="13" viewBox="0 0 19 13" fill="none" xmlns="http://www.w3.org/2000/svg">
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
   <path fill-rule="evenodd" clip-rule="evenodd"
-    d="M6.75657 0.91107C7.08201 1.23651 7.08201 1.76414 6.75657 2.08958L2.34583 6.50033L6.75657 10.9111C7.08201 11.2365 7.08201 11.7641 6.75657 12.0896C6.43114 12.415 5.9035 12.415 5.57806 12.0896L0.578062 7.08958C0.252625 6.76414 0.252625 6.23651 0.578062 5.91107L5.57806 0.91107C5.9035 0.585633 6.43114 0.585633 6.75657 0.91107ZM12.2447 0.91107C12.5702 0.585633 13.0978 0.585633 13.4232 0.91107L18.4232 5.91107C18.7487 6.23651 18.7487 6.76414 18.4232 7.08958L13.4232 12.0896C13.0978 12.415 12.5702 12.415 12.2447 12.0896C11.9193 11.7641 11.9193 11.2365 12.2447 10.9111L16.6555 6.50033L12.2447 2.08958C11.9193 1.76414 11.9193 1.23651 12.2447 0.91107Z"
-    fill="currentColor" fill-opacity="0.9" />
+    d="M8.70711 5.29289C9.09763 5.68342 9.09763 6.31658 8.70711 6.70711L3.41421 12L8.70711 17.2929C9.09763 17.6834 9.09763 18.3166 8.70711 18.7071C8.31658 19.0976 7.68342 19.0976 7.29289 18.7071L1.29289 12.7071C0.902369 12.3166 0.902369 11.6834 1.29289 11.2929L7.29289 5.29289C7.68342 4.90237 8.31658 4.90237 8.70711 5.29289ZM15.2929 5.29289C15.6834 4.90237 16.3166 4.90237 16.7071 5.29289L22.7071 11.2929C23.0976 11.6834 23.0976 12.3166 22.7071 12.7071L16.7071 18.7071C16.3166 19.0976 15.6834 19.0976 15.2929 18.7071C14.9024 18.3166 14.9024 17.6834 15.2929 17.2929L20.5858 12L15.2929 6.70711C14.9024 6.31658 14.9024 5.68342 15.2929 5.29289Z"
+    fill="currentColor" />
 </svg>
   

langserve/playground/src/assets/ThumbsDownIcon.svg

@@ -0,0 +1,6 @@
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <path
+    d="M17 2V13M22 9.8V5.2C22 4.07989 22 3.51984 21.782 3.09202C21.5903 2.71569 21.2843 2.40973 20.908 2.21799C20.4802 2 19.9201 2 18.8 2H8.11802C6.65654 2 5.92579 2 5.33559 2.26743C4.81541 2.50314 4.37331 2.88242 4.06125 3.36072C3.70718 3.90339 3.59606 4.62564 3.37383 6.07012L2.85076 9.47012C2.55765 11.3753 2.4111 12.3279 2.69381 13.0691C2.94195 13.7197 3.40866 14.2637 4.01393 14.6079C4.70354 15 5.66734 15 7.59494 15H8.40001C8.96006 15 9.24009 15 9.454 15.109C9.64216 15.2049 9.79514 15.3578 9.89101 15.546C10 15.7599 10 16.0399 10 16.6V19.5342C10 20.896 11.104 22 12.4658 22C12.7907 22 13.085 21.8087 13.217 21.5119L16.5777 13.9502C16.7306 13.6062 16.807 13.4343 16.9278 13.3082C17.0346 13.1967 17.1657 13.1115 17.311 13.0592C17.4753 13 17.6634 13 18.0398 13H18.8C19.9201 13 20.4802 13 20.908 12.782C21.2843 12.5903 21.5903 12.2843 21.782 11.908C22 11.4802 22 10.9201 22 9.8Z"
+    stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
+</svg>
+  

langserve/playground/src/assets/ThumbsUpIcon.svg

@@ -0,0 +1,6 @@
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+  <path
+    d="M7 22V11M2 13V20C2 21.1046 2.89543 22 4 22H17.4262C18.907 22 20.1662 20.9197 20.3914 19.4562L21.4683 12.4562C21.7479 10.6389 20.3418 9 18.5032 9H15C14.4477 9 14 8.55228 14 8V4.46584C14 3.10399 12.896 2 11.5342 2C11.2093 2 10.915 2.1913 10.7831 2.48812L7.26394 10.4061C7.10344 10.7673 6.74532 11 6.35013 11H4C2.89543 11 2 11.8954 2 13Z"
+    stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" />
+</svg>
+  

langserve/playground/src/components/ChatMessageTuplesControlRenderer.tsx

@@ -0,0 +1,146 @@
+import { withJsonFormsControlProps } from "@jsonforms/react";
+import PlusIcon from "../assets/PlusIcon.svg?react";
+import TrashIcon from "../assets/TrashIcon.svg?react";
+import {
+  rankWith,
+  and,
+  schemaMatches,
+  Paths,
+  isControl,
+} from "@jsonforms/core";
+import { AutosizeTextarea } from "./AutosizeTextarea";
+import { isJsonSchemaExtra } from "../utils/schema";
+import { useStreamCallback } from "../useStreamCallback";
+import { getNormalizedJsonPath, traverseNaiveJsonPath } from "../utils/path";
+import { getMessageContent } from "../utils/messages";
+
+type MessageTuple = [string, string];
+
+export const chatMessagesTupleTester = rankWith(
+  12,
+  and(
+    isControl,
+    schemaMatches((schema) => {
+      if (schema.type !== "array") return false;
+      if (typeof schema.items !== "object" || schema.items == null)
+        return false;
+
+      if (!isJsonSchemaExtra(schema) || schema.extra.widget.type !== "chat") {
+        return false;
+      }
+
+      if ("type" in schema.items) {
+        return (
+          schema.items.type === "array" &&
+          schema.items.minItems === 2 &&
+          schema.items.maxItems === 2 &&
+          Array.isArray(schema.items.items) &&
+          schema.items.items.length === 2 &&
+          schema.items.items.every((schema) => schema.type === "string")
+        );
+      }
+
+      return false;
+    })
+  )
+);
+
+export const ChatMessageTuplesControlRenderer = withJsonFormsControlProps(
+  (props) => {
+    const data: Array<MessageTuple> = props.data ?? [];
+
+    useStreamCallback("onSuccess", (ctx) => {
+      if (!isJsonSchemaExtra(props.schema)) return;
+      const widget = props.schema.extra.widget;
+      if (!("input" in widget) && !("output" in widget)) return;
+
+      const inputPath = getNormalizedJsonPath(widget.input ?? "");
+      const outputPath = getNormalizedJsonPath(widget.output ?? "");
+
+      const isSingleOutputKey =
+        ctx.output != null &&
+        Object.keys(ctx.output).length === 1 &&
+        Object.keys(ctx.output)[0] === "output";
+
+      const human = traverseNaiveJsonPath(ctx.input, inputPath);
+      let ai = traverseNaiveJsonPath(ctx.output, outputPath);
+
+      if (isSingleOutputKey) {
+        ai = traverseNaiveJsonPath(ai, ["output", ...outputPath]) ?? ai;
+      }
+
+      ai = getMessageContent(ai);
+      if (typeof human === "string" && typeof ai === "string") {
+        props.handleChange(props.path, [...data, [human, ai]]);
+      }
+    });
+
+    return (
+      <div className="control">
+        <div className="flex items-center justify-between">
+          <label className="text-xs uppercase font-semibold text-ls-gray-100">
+            {props.label || "Messages"}
+          </label>
+          <button
+            className="p-1 rounded-full"
+            onClick={() => props.handleChange(props.path, [...data, ["", ""]])}
+          >
+            <PlusIcon className="w-5 h-5" />
+          </button>
+        </div>
+
+        <div className="flex flex-col gap-3 mt-1 empty:hidden">
+          {data.map(([human, ai], index) => {
+            const msgPath = Paths.compose(props.path, `${index}`);
+            return (
+              <div className="control group relative" key={index}>
+                <div className="grid gap-3">
+                  <div className="flex-grow">
+                    <div className="flex items-start justify-between gap-2">
+                      <div className="text-xs uppercase font-semibold text-ls-gray-100 mb-1 ">
+                        Human
+                      </div>
+                    </div>
+                    <AutosizeTextarea
+                      value={human}
+                      onChange={(human) => {
+                        props.handleChange(Paths.compose(msgPath, "0"), human);
+                      }}
+                    />
+                  </div>
+                  <div className="flex-shrink-0 h-px bg-divider-700" />
+                  <div className="flex-grow">
+                    <div className="flex items-start justify-between gap-2">
+                      <div className="text-xs uppercase font-semibold text-ls-gray-100 mb-1 ">
+                        AI
+                      </div>
+                    </div>
+
+                    <AutosizeTextarea
+                      value={ai}
+                      onChange={(ai) => {
+                        props.handleChange(Paths.compose(msgPath, "1"), ai);
+                      }}
+                    />
+                  </div>
+                </div>
+
+                <button
+                  className="absolute right-3 top-3 p-1 border rounded opacity-0 transition-opacity border-divider-700 group-focus-within:opacity-100 group-hover:opacity-100"
+                  onClick={() => {
+                    props.handleChange(
+                      props.path,
+                      data.filter((_, i) => i !== index)
+                    );
+                  }}
+                >
+                  <TrashIcon className="w-4 h-4" />
+                </button>
+              </div>
+            );
+          })}
+        </div>
+      </div>
+    );
+  }
+);

langserve/playground/src/components/ChatMessagesControlRenderer.tsx

@@ -0,0 +1,355 @@
+import { withJsonFormsControlProps } from "@jsonforms/react";
+import PlusIcon from "../assets/PlusIcon.svg?react";
+import TrashIcon from "../assets/TrashIcon.svg?react";
+import CodeIcon from "../assets/CodeIcon.svg?react";
+import ChatIcon from "../assets/ChatIcon.svg?react";
+import {
+  rankWith,
+  and,
+  schemaMatches,
+  Paths,
+  isControl,
+} from "@jsonforms/core";
+import { AutosizeTextarea } from "./AutosizeTextarea";
+import { useStreamCallback } from "../useStreamCallback";
+import { getNormalizedJsonPath, traverseNaiveJsonPath } from "../utils/path";
+import { isJsonSchemaExtra } from "../utils/schema";
+import * as ToggleGroup from "@radix-ui/react-toggle-group";
+
+export const chatMessagesTester = rankWith(
+  12,
+  and(
+    isControl,
+    schemaMatches((schema) => {
+      if (schema.type !== "array") return false;
+      if (typeof schema.items !== "object" || schema.items == null)
+        return false;
+
+      if (
+        "type" in schema.items &&
+        schema.items.type != null &&
+        schema.items.title != null
+      ) {
+        return (
+          schema.items.type === "object" &&
+          (schema.items.title?.endsWith("Message") ||
+            schema.items.title?.endsWith("MessageChunk"))
+        );
+      }
+
+      if ("anyOf" in schema.items && schema.items.anyOf != null) {
+        return schema.items.anyOf.every((schema) => {
+          const isObjectMessage =
+            schema.type === "object" &&
+            (schema.title?.endsWith("Message") ||
+              schema.title?.endsWith("MessageChunk"));
+
+          const isTupleMessage =
+            schema.type === "array" &&
+            schema.minItems === 2 &&
+            schema.maxItems === 2 &&
+            Array.isArray(schema.items) &&
+            schema.items.length === 2 &&
+            schema.items.every((schema) => schema.type === "string");
+
+          return isObjectMessage || isTupleMessage;
+        });
+      }
+
+      return false;
+    })
+  )
+);
+
+interface MessageFields {
+  content: string;
+  additional_kwargs?: { [key: string]: unknown };
+  name?: string;
+  type?: string;
+
+  role?: string;
+}
+
+function isMessageFields(x: unknown): x is MessageFields {
+  if (typeof x !== "object" || x == null) return false;
+  if (!("content" in x) || typeof x.content !== "string") return false;
+  if (
+    "additional_kwargs" in x &&
+    typeof x.additional_kwargs !== "object" &&
+    x.additional_kwargs != null
+  )
+    return false;
+  if ("name" in x && typeof x.name !== "string" && x.name != null) return false;
+  if ("type" in x && typeof x.type !== "string" && x.type != null) return false;
+  if ("role" in x && typeof x.role !== "string" && x.role != null) return false;
+  return true;
+}
+
+function constructMessage(
+  x: unknown,
+  assumedRole: string
+): Array<MessageFields> | null {
+  if (typeof x === "string") {
+    return [{ content: x, type: assumedRole }];
+  }
+
+  if (isMessageFields(x)) {
+    return [x];
+  }
+
+  if (Array.isArray(x) && x.every(isMessageFields)) {
+    return x;
+  }
+
+  return null;
+}
+
+function isOpenAiFunctionCall(
+  x: unknown
+): x is { name: string; arguments: string } {
+  if (typeof x !== "object" || x == null) return false;
+  if (!("name" in x) || typeof x.name !== "string") return false;
+  if (!("arguments" in x) || typeof x.arguments !== "string") return false;
+  return true;
+}
+
+export const ChatMessagesControlRenderer = withJsonFormsControlProps(
+  (props) => {
+    const data: Array<MessageFields> = props.data ?? [];
+
+    useStreamCallback("onSuccess", (ctx) => {
+      if (!isJsonSchemaExtra(props.schema)) return;
+      const widget = props.schema.extra.widget;
+      if (!("input" in widget) && !("output" in widget)) return;
+
+      const inputPath = getNormalizedJsonPath(widget.input ?? "");
+      const outputPath = getNormalizedJsonPath(widget.output ?? "");
+
+      const human = traverseNaiveJsonPath(ctx.input, inputPath);
+      let ai = traverseNaiveJsonPath(ctx.output, outputPath);
+
+      const isSingleOutputKey =
+        ctx.output != null &&
+        Object.keys(ctx.output).length === 1 &&
+        Object.keys(ctx.output)[0] === "output";
+
+      if (isSingleOutputKey) {
+        ai = traverseNaiveJsonPath(ai, ["output", ...outputPath]) ?? ai;
+      }
+
+      const humanMsg = constructMessage(human, "human");
+      const aiMsg = constructMessage(ai, "ai");
+
+      let newMessages = undefined;
+      if (humanMsg != null) {
+        newMessages ??= [...data];
+        newMessages.push(...humanMsg);
+      }
+      if (aiMsg != null) {
+        newMessages ??= [...data];
+        newMessages.push(...aiMsg);
+      }
+
+      if (newMessages != null) {
+        props.handleChange(props.path, newMessages);
+      }
+    });
+
+    return (
+      <div className="control">
+        <div className="flex items-center justify-between">
+          <label className="text-xs uppercase font-semibold text-ls-gray-100">
+            {props.label || "Messages"}
+          </label>
+          <button
+            className="p-1 rounded-full"
+            onClick={() => {
+              const lastRole = data.length ? data[data.length - 1].type : "ai";
+              props.handleChange(props.path, [
+                ...data,
+                { content: "", type: lastRole === "human" ? "ai" : "human" },
+              ]);
+            }}
+          >
+            <PlusIcon className="w-5 h-5" />
+          </button>
+        </div>
+
+        <div className="flex flex-col gap-3 mt-1 empty:hidden">
+          {data.map((message, index) => {
+            const msgPath = Paths.compose(props.path, `${index}`);
+            const type = message.type ?? "chat";
+
+            const isAiFunctionCall = isOpenAiFunctionCall(
+              message.additional_kwargs?.function_call
+            );
+
+            return (
+              <div className="control group" key={index}>
+                <div className="flex items-start justify-between gap-2">
+                  <select
+                    className="-ml-1 min-w-[100px]"
+                    value={type}
+                    onChange={(e) => {
+                      props.handleChange(
+                        Paths.compose(msgPath, "type"),
+                        e.target.value
+                      );
+                    }}
+                  >
+                    <option value="human">Human</option>
+                    <option value="ai">AI</option>
+                    <option value="system">System</option>
+                    <option value="function">Function</option>
+
+                    <option value="chat">Chat</option>
+                  </select>
+                  <div className="flex items-center gap-2">
+                    {message.type === "ai" && (
+                      <ToggleGroup.Root
+                        type="single"
+                        aria-label="Message Type"
+                        className="opacity-0 transition-opacity group-focus-within:opacity-100 group-hover:opacity-100"
+                        value={isAiFunctionCall ? "function" : "text"}
+                        onValueChange={(value) => {
+                          switch (value) {
+                            case "function": {
+                              props.handleChange(
+                                Paths.compose(msgPath, "additional_kwargs"),
+                                {
+                                  function_call: {
+                                    name: "",
+                                    arguments: "{}",
+                                  },
+                                }
+                              );
+
+                              break;
+                            }
+                            case "text": {
+                              props.handleChange(
+                                Paths.compose(msgPath, "additional_kwargs"),
+                                {}
+                              );
+
+                              break;
+                            }
+                          }
+                        }}
+                      >
+                        <ToggleGroup.Item
+                          className="rounded-s border border-divider-700 px-2.5 py-1 data-[state=on]:bg-divider-500/50"
+                          value="text"
+                          aria-label="Text message"
+                        >
+                          <ChatIcon className="w-4 h-4" />
+                        </ToggleGroup.Item>
+                        <ToggleGroup.Item
+                          className="rounded-e border border-l-0 border-divider-700 px-2.5 py-1 data-[state=on]:bg-divider-500/50"
+                          value="function"
+                          aria-label="Function call"
+                        >
+                          <CodeIcon className="w-4 h-4" />
+                        </ToggleGroup.Item>
+                      </ToggleGroup.Root>
+                    )}
+
+                    <button
+                      className="p-1 border rounded opacity-0 transition-opacity border-divider-700 group-focus-within:opacity-100 group-hover:opacity-100"
+                      onClick={() => {
+                        props.handleChange(
+                          props.path,
+                          data.filter((_, i) => i !== index)
+                        );
+                      }}
+                    >
+                      <TrashIcon className="w-4 h-4" />
+                    </button>
+                  </div>
+                </div>
+
+                {type === "chat" && (
+                  <input
+                    className="mb-1"
+                    placeholder="Role"
+                    value={message.role ?? ""}
+                    onChange={(e) => {
+                      props.handleChange(
+                        Paths.compose(msgPath, "role"),
+                        e.target.value
+                      );
+                    }}
+                  />
+                )}
+
+                {type === "function" && (
+                  <input
+                    className="mb-1"
+                    placeholder="Function Name"
+                    value={message.name ?? ""}
+                    onChange={(e) => {
+                      props.handleChange(
+                        Paths.compose(msgPath, "name"),
+                        e.target.value
+                      );
+                    }}
+                  />
+                )}
+
+                {type === "ai" &&
+                isOpenAiFunctionCall(
+                  message.additional_kwargs?.function_call
+                ) ? (
+                  <>
+                    <input
+                      className="mb-1"
+                      placeholder="Function Name"
+                      value={
+                        message.additional_kwargs?.function_call.name ?? ""
+                      }
+                      onChange={(e) => {
+                        props.handleChange(
+                          Paths.compose(
+                            msgPath,
+                            "additional_kwargs.function_call.name"
+                          ),
+                          e.target.value
+                        );
+                      }}
+                    />
+
+                    <AutosizeTextarea
+                      value={
+                        message.additional_kwargs?.function_call?.arguments ??
+                        ""
+                      }
+                      onChange={(content) => {
+                        props.handleChange(
+                          Paths.compose(
+                            msgPath,
+                            "additional_kwargs.function_call.arguments"
+                          ),
+                          content
+                        );
+                      }}
+                    />
+                  </>
+                ) : (
+                  <AutosizeTextarea
+                    value={message.content}
+                    onChange={(content) => {
+                      props.handleChange(
+                        Paths.compose(msgPath, "content"),
+                        content
+                      );
+                    }}
+                  />
+                )}
+              </div>
+            );
+          })}
+        </div>
+      </div>
+    );
+  }
+);

langserve/playground/src/components/CustomAnyOfRenderer.tsx

@@ -0,0 +1,37 @@
+import { JsonFormsDispatch, withJsonFormsAnyOfProps } from "@jsonforms/react";
+import {
+  rankWith,
+  createCombinatorRenderInfos,
+  JsonSchema,
+  isAnyOfControl,
+} from "@jsonforms/core";
+import { renderers, cells } from "../renderers";
+
+export const CustomAnyOfRenderer = withJsonFormsAnyOfProps((props) => {
+  const anyOfRenderInfos = createCombinatorRenderInfos(
+    (props.schema as JsonSchema).anyOf!,
+    props.rootSchema,
+    "anyOf",
+    props.uischema,
+    props.path,
+    props.uischemas
+  );
+
+  // just assume the last type is the selected one
+  // for `anyOf` caused by passing inputs from LLMs/Chat Models
+  // this will result in showing the Message renderer
+  const selectedIndex = anyOfRenderInfos.length - 1;
+  const selectedAnyOfRenderInfo = anyOfRenderInfos[selectedIndex];
+
+  return (
+    <JsonFormsDispatch
+      schema={selectedAnyOfRenderInfo.schema}
+      uischema={selectedAnyOfRenderInfo.uischema}
+      path={props.path}
+      renderers={renderers}
+      cells={cells}
+    />
+  );
+});
+
+export const customAnyOfTester = rankWith(3, isAnyOfControl);

langserve/playground/src/components/CustomArrayControlRenderer.tsx

@@ -84,7 +84,7 @@ export const MaterialArrayControlRenderer = (props: ArrayLayoutProps) => {
 
 // eslint-disable-next-line react-refresh/only-export-components
 export const materialArrayControlTester: RankedTester = rankWith(
-  999,
+  11,
   or(isObjectArrayControl, isPrimitiveArrayControl, isObjectArrayWithNesting)
 );
 

langserve/playground/src/components/CustomArrayControlRenderer/MaterialTableControl.tsx

@@ -92,7 +92,7 @@ const generateCells = (
   enabled: boolean,
   cells?: JsonFormsCellRendererRegistryEntry[]
 ) => {
-  if (schema.type === "object") {
+  if (schema?.type === "object") {
     return getValidColumnProps(schema).map((prop) => {
       const cellPath = Paths.compose(rowPath, prop);
       const props = {
@@ -381,7 +381,7 @@ interface TableRowsProp {
 const TableRows = ({
   data,
   path,
-  schema,
+  schema = {},
   openDeleteDialog,
   moveUp,
   moveDown,
@@ -444,7 +444,7 @@ export class MaterialTableControl extends React.Component<
     const {
       label,
       path,
-      schema,
+      schema = {},
       rootSchema,
       uischema,
       errors,
@@ -456,7 +456,7 @@ export class MaterialTableControl extends React.Component<
     } = this.props;
 
     const controlElement = uischema as ControlElement;
-    const isObjectSchema = schema.type === "object";
+    const isObjectSchema = schema?.type === "object";
     const headerCells: any = isObjectSchema
       ? generateCells(TableHeaderCell as any, schema, path, enabled, cells)
       : undefined;

langserve/playground/src/components/FileBase64Tester.tsx

@@ -0,0 +1,44 @@
+import { ChangeEvent } from "react";
+import { withJsonFormsControlProps } from "@jsonforms/react";
+import { rankWith, and, schemaMatches, isControl } from "@jsonforms/core";
+import { isJsonSchemaExtra } from "../utils/schema";
+
+export const fileBase64Tester = rankWith(
+  12,
+  and(
+    isControl,
+    schemaMatches((schema) => {
+      if (!isJsonSchemaExtra(schema)) return false;
+      return schema.extra.widget.type === "base64file";
+    })
+  )
+);
+
+export const FileBase64ControlRenderer = withJsonFormsControlProps((props) => {
+  const handleFileUpload = (event: ChangeEvent<HTMLInputElement>) => {
+    const file = event.target.files?.[0];
+    if (!file) return;
+
+    const reader = new FileReader();
+
+    reader.onload = () => {
+      const base64String = reader.result as string | null;
+      if (base64String != null) {
+        const prefix = base64String.indexOf("base64,") + "base64,".length;
+        props.handleChange(props.path, base64String.slice(prefix));
+      }
+    };
+
+    reader.readAsDataURL(file);
+  };
+
+  return (
+    <div className="control">
+      <label className="text-xs uppercase font-semibold text-ls-gray-100">
+        {props.label}
+      </label>
+
+      <input type="file" onChange={handleFileUpload} />
+    </div>
+  );
+});

langserve/playground/src/components/IntermediateSteps.tsx

@@ -0,0 +1,64 @@
+import { useState } from "react";
+import dayjs from "dayjs";
+import ChevronRight from "../assets/ChevronRight.svg?react";
+import { RunState } from "../useStreamLog";
+import { cn } from "../utils/cn";
+import { str } from "../utils/str";
+import { CorrectnessFeedback } from "./feedback/CorrectnessFeedback";
+
+export function IntermediateSteps(props: {
+  latest: RunState;
+  feedbackEnabled: boolean;
+}) {
+  const [expanded, setExpanded] = useState(false);
+  const length = Object.values(props.latest.logs).length;
+  const disabled = length === 0;
+  return (
+    <div className="flex flex-col border border-divider-700 rounded-2xl bg-background">
+      <button
+        className="font-medium text-left p-4 flex items-center justify-between"
+        disabled={disabled}
+        onClick={() => setExpanded((open) => !open)}
+      >
+        <span>
+          Intermediate steps{" "}
+          <span className="bg-ls-gray-400 text-ls-gray-100 text-sm px-1 py-0.5 rounded-md ml-1">
+            {length}
+          </span>
+        </span>
+        <ChevronRight
+          className={cn(
+            "transition-all",
+            expanded && "rotate-90",
+            disabled && "opacity-20"
+          )}
+        />
+      </button>
+      {expanded && (
+        <div className="flex flex-col gap-5 p-4 pt-0 divide-solid divide-y divide-divider-700 rounded-b-xl">
+          {Object.values(props.latest.logs).map((log) => (
+            <div
+              className="gap-3 flex-col min-w-0 flex bg-background pt-3 first-of-type:pt-0"
+              key={log.id}
+            >
+              <div className="flex items-center justify-between">
+                <strong className="text-sm font-medium">{log.name}</strong>
+                <p className="text-sm">{dayjs.utc(log.start_time).fromNow()}</p>
+              </div>
+              <div className="bg-ls-gray-400 rounded-lg p-3 relative group">
+                <pre className="break-words whitespace-pre-wrap min-w-0 text-sm">
+                  {str(log.final_output) ?? "..."}
+                </pre>
+                {props.feedbackEnabled && log.id ? (
+                  <div className="absolute right-3 top-3 flex items-center gap-2 transition-opacity opacity-0 focus-within:opacity-100 group-hover:opacity-100">
+                    <CorrectnessFeedback key={log.id} runId={log.id} />
+                  </div>
+                ) : null}
+              </div>
+            </div>
+          ))}
+        </div>
+      )}
+    </div>
+  );
+}

langserve/playground/src/components/ShareDialog.tsx

@@ -4,37 +4,11 @@ import CodeIcon from "../assets/CodeIcon.svg?react";
 import PadlockIcon from "../assets/PadlockIcon.svg?react";
 import CopyIcon from "../assets/CopyIcon.svg?react";
 import CheckCircleIcon from "../assets/CheckCircleIcon.svg?react";
-import {
-  compressToEncodedURIComponent,
-  decompressFromEncodedURIComponent,
-} from "lz-string";
+import { compressToEncodedURIComponent } from "lz-string";
+import { getStateFromUrl } from "../utils/url";
 
 const URL_LENGTH_LIMIT = 2000;
 
-export function getStateFromUrl(path: string) {
-  let configFromUrl = null;
-  let basePath = path;
-  if (basePath.endsWith("/")) {
-    basePath = basePath.slice(0, -1);
-  }
-
-  if (basePath.endsWith("/playground")) {
-    basePath = basePath.slice(0, -"/playground".length);
-  }
-
-  // check if we can omit the last segment
-  const [configHash, c, ...rest] = basePath.split("/").reverse();
-  if (c === "c") {
-    basePath = rest.reverse().join("/");
-    try {
-      configFromUrl = JSON.parse(decompressFromEncodedURIComponent(configHash));
-    } catch (error) {
-      console.error(error);
-    }
-  }
-  return { basePath, configFromUrl };
-}
-
 function CopyButton(props: { value: string }) {
   const [copied, setCopied] = useState(false);
   const cbRef = useRef<number | null>(null);
@@ -121,7 +95,6 @@ const result = await chain.invoke({ ... });
                     <PadlockIcon className="mx-3" />
                     <div className="overflow-auto whitespace-nowrap py-3 no-scrollbar text-ls-gray-100">
                       {playgroundUrl.split("://")[1]}
-                      PadlockIcon
                     </div>
                     <CopyButton value={playgroundUrl} />
                   </div>
@@ -131,7 +104,7 @@ const result = await chain.invoke({ ... });
               <div className="flex flex-col gap-2 p-3 rounded-2xl dark:bg-[#2C2C2E] bg-gray-100">
                 <div className="flex items-center gap-3">
                   <div className="w-10 h-10 flex items-center justify-center text-center text-sm bg-background rounded-xl">
-                    <CodeIcon />
+                    <CodeIcon className="w-4 h-4" />
                   </div>
                   <span className="font-semibold">Get the code</span>
                 </div>

langserve/playground/src/components/StreamOutput.tsx

@@ -0,0 +1,108 @@
+import { str } from "../utils/str";
+
+// inlined from langchain/schema
+interface BaseMessageFields {
+  content: string;
+  name?: string;
+  additional_kwargs?: {
+    [key: string]: unknown;
+  };
+}
+
+class AIMessageChunk {
+  /** The text of the message. */
+  content: string;
+
+  /** The name of the message sender in a multi-user chat. */
+  name?: string;
+
+  /** Additional keyword arguments */
+  additional_kwargs: NonNullable<BaseMessageFields["additional_kwargs"]>;
+
+  constructor(fields: BaseMessageFields) {
+    // Make sure the default value for additional_kwargs is passed into super() for serialization
+    if (!fields.additional_kwargs) {
+      // eslint-disable-next-line no-param-reassign
+      fields.additional_kwargs = {};
+    }
+
+    this.name = fields.name;
+    this.content = fields.content;
+    this.additional_kwargs = fields.additional_kwargs;
+  }
+
+  static _mergeAdditionalKwargs(
+    left: NonNullable<BaseMessageFields["additional_kwargs"]>,
+    right: NonNullable<BaseMessageFields["additional_kwargs"]>
+  ): NonNullable<BaseMessageFields["additional_kwargs"]> {
+    const merged = { ...left };
+    for (const [key, value] of Object.entries(right)) {
+      if (merged[key] === undefined) {
+        merged[key] = value;
+      } else if (typeof merged[key] !== typeof value) {
+        throw new Error(
+          `additional_kwargs[${key}] already exists in the message chunk, but with a different type.`
+        );
+      } else if (typeof merged[key] === "string") {
+        merged[key] = (merged[key] as string) + value;
+      } else if (
+        !Array.isArray(merged[key]) &&
+        typeof merged[key] === "object"
+      ) {
+        merged[key] = this._mergeAdditionalKwargs(
+          merged[key] as NonNullable<BaseMessageFields["additional_kwargs"]>,
+          value as NonNullable<BaseMessageFields["additional_kwargs"]>
+        );
+      } else {
+        throw new Error(
+          `additional_kwargs[${key}] already exists in this message chunk.`
+        );
+      }
+    }
+    return merged;
+  }
+
+  concat(chunk: AIMessageChunk) {
+    return new AIMessageChunk({
+      content: this.content + chunk.content,
+      additional_kwargs: AIMessageChunk._mergeAdditionalKwargs(
+        this.additional_kwargs,
+        chunk.additional_kwargs
+      ),
+    });
+  }
+}
+
+function isAiMessageChunkFields(value: unknown): value is BaseMessageFields {
+  if (typeof value !== "object" || value == null) return false;
+  return "content" in value && typeof value["content"] === "string";
+}
+
+function isAiMessageChunkFieldsList(
+  value: unknown[]
+): value is BaseMessageFields[] {
+  return value.length > 0 && value.every((x) => isAiMessageChunkFields(x));
+}
+
+export function StreamOutput(props: { streamed: unknown[] }) {
+  // check if we're streaming AIMessageChunk
+  if (isAiMessageChunkFieldsList(props.streamed)) {
+    const concat = props.streamed.reduce<AIMessageChunk | null>(
+      (memo, field) => {
+        const chunk = new AIMessageChunk(field);
+        if (memo == null) return chunk;
+        return memo.concat(chunk);
+      },
+      null
+    );
+
+    const functionCall = concat?.additional_kwargs?.function_call;
+    return (
+      concat?.content ||
+      (!!functionCall && JSON.stringify(functionCall, null, 2)) ||
+      "..."
+    );
+  }
+
+  return props.streamed.map(str).join("") || "...";
+}

langserve/playground/src/components/SubmitButton.tsx

@@ -0,0 +1,50 @@
+import SendIcon from "../assets/SendIcon.svg?react";
+import { cn } from "../utils/cn";
+
+export function SubmitButton(props: {
+  disabled: boolean;
+  isLoading?: boolean;
+  onSubmit: () => void;
+}) {
+  return (
+    <button
+      type="button"
+      className={cn(
+        "px-4 py-3 gap-3 font-medium border border-transparent rounded-full flex items-center justify-center bg-blue-500 disabled:opacity-50 transition-colors",
+        !props.disabled ? "hover:bg-blue-600 active:bg-blue-700" : ""
+      )}
+      onClick={props.onSubmit}
+      disabled={props.disabled}
+    >
+      {props.isLoading ? (
+        <>
+          <div role="status">
+            <svg
+              aria-hidden="true"
+              className="w-5 h-5 animate-spin text-white fill-ls-blue"
+              viewBox="0 0 100 101"
+              fill="none"
+              xmlns="http://www.w3.org/2000/svg"
+            >
+              <path
+                d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
+                fill="currentColor"
+              />
+              <path
+                d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
+                fill="currentFill"
+              />
+            </svg>
+            <span className="sr-only">Loading...</span>
+          </div>
+          <span className="text-white">Stop</span>
+        </>
+      ) : (
+        <>
+          <SendIcon className="flex-shrink-0" />
+          <span className="text-white">Start</span>
+        </>
+      )}
+    </button>
+  );
+}

langserve/playground/src/components/feedback/CorrectnessFeedback.tsx

@@ -0,0 +1,89 @@
+import ThumbsUpIcon from "../../assets/ThumbsUpIcon.svg?react";
+import ThumbsDownIcon from "../../assets/ThumbsDownIcon.svg?react";
+import CircleSpinIcon from "../../assets/CircleSpinIcon.svg?react";
+import { resolveApiUrl } from "../../utils/url";
+import { useState } from "react";
+import { cn } from "../../utils/cn";
+import useSWRMutation from "swr/mutation";
+
+const useFeedbackMutation = (runId: string) => {
+  interface FeedbackArguments {
+    key: string;
+    score: number;
+  }
+
+  const [lastArg, setLastArg] = useState<FeedbackArguments | null>(null);
+
+  const mutation = useSWRMutation(
+    ["feedback", runId],
+    async ([, runId], { arg }: { arg: FeedbackArguments }) => {
+      const payload = { run_id: runId, key: arg.key, score: arg.score };
+      setLastArg(arg);
+
+      const request = await fetch(resolveApiUrl("/feedback"), {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify(payload),
+      });
+
+      if (!request.ok) throw new Error(`Failed request ${request.status}`);
+      const json: {
+        id: string;
+        score: number;
+      } = await request.json();
+
+      return json;
+    }
+  );
+
+  return { lastArg: mutation.isMutating ? lastArg : null, mutation };
+};
+
+export function CorrectnessFeedback(props: { runId: string }) {
+  const score = useFeedbackMutation(props.runId);
+
+  if (props.runId == null) return null;
+  return (
+    <>
+      <button
+        type="button"
+        className={cn(
+          "border focus-within:border-ls-blue focus-within:outline-none bg-background rounded p-1 border-divider-700 hover:bg-divider-500/50 active:bg-divider-500",
+          score.mutation.data?.score === 1 && "text-teal-500"
+        )}
+        disabled={score.mutation.isMutating}
+        onClick={() => {
+          if (score.mutation.data?.score !== 1) {
+            score.mutation.trigger({ key: "correctness", score: 1 });
+          }
+        }}
+      >
+        {score.lastArg?.score === 1 ? (
+          <CircleSpinIcon className="animate-spin w-4 h-4 text-white/50 fill-white" />
+        ) : (
+          <ThumbsUpIcon className="w-4 h-4" />
+        )}
+      </button>
+
+      <button
+        type="button"
+        className={cn(
+          "border focus-within:border-ls-blue focus-within:outline-none bg-background rounded p-1 border-divider-700 hover:bg-divider-500/50 active:bg-divider-500",
+          score.mutation.data?.score === 0 && "text-red-500"
+        )}
+        disabled={score.mutation.isMutating}
+        onClick={() => {
+          if (score.mutation.data?.score !== 0) {
+            score.mutation.trigger({ key: "correctness", score: 0 });
+          }
+        }}
+      >
+        {score.lastArg?.score === 0 ? (
+          <CircleSpinIcon className="animate-spin w-4 h-4 text-white/50 fill-white" />
+        ) : (
+          <ThumbsDownIcon className="w-4 h-4" />
+        )}
+      </button>
+    </>
+  );
+}

langserve/playground/src/main.tsx

@@ -1,4 +1,11 @@
 import ReactDOM from "react-dom/client";
 import App from "./App.tsx";
 
+import dayjs from "dayjs";
+import utc from "dayjs/plugin/utc";
+import relativeDate from "dayjs/plugin/relativeTime";
+
+dayjs.extend(relativeDate);
+dayjs.extend(utc);
+
 ReactDOM.createRoot(document.getElementById("root")!).render(<App />);

langserve/playground/src/renderers.tsx

@@ -0,0 +1,111 @@
+import {
+  materialAllOfControlTester,
+  MaterialAllOfRenderer,
+  MaterialObjectRenderer,
+  materialOneOfControlTester,
+  MaterialOneOfRenderer,
+} from "@jsonforms/material-renderers";
+import {
+  BooleanCell,
+  DateCell,
+  DateTimeCell,
+  EnumCell,
+  IntegerCell,
+  NumberCell,
+  SliderCell,
+  TimeCell,
+  booleanCellTester,
+  dateCellTester,
+  dateTimeCellTester,
+  enumCellTester,
+  integerCellTester,
+  numberCellTester,
+  sliderCellTester,
+  textAreaCellTester,
+  textCellTester,
+  timeCellTester,
+  vanillaRenderers,
+  InputControl,
+} from "@jsonforms/vanilla-renderers";
+import {
+  RankedTester,
+  rankWith,
+  and,
+  uiTypeIs,
+  schemaMatches,
+  schemaTypeIs,
+} from "@jsonforms/core";
+import CustomArrayControlRenderer, {
+  materialArrayControlTester,
+} from "./components/CustomArrayControlRenderer";
+import CustomTextAreaCell from "./components/CustomTextAreaCell";
+import JsonTextAreaCell from "./components/JsonTextAreaCell";
+import {
+  chatMessagesTester,
+  ChatMessagesControlRenderer,
+} from "./components/ChatMessagesControlRenderer";
+import {
+  ChatMessageTuplesControlRenderer,
+  chatMessagesTupleTester,
+} from "./components/ChatMessageTuplesControlRenderer";
+import {
+  fileBase64Tester,
+  FileBase64ControlRenderer,
+} from "./components/FileBase64Tester";
+import {
+  customAnyOfTester,
+  CustomAnyOfRenderer,
+} from "./components/CustomAnyOfRenderer";
+
+const isObjectWithPropertiesControl = rankWith(
+  2,
+  and(
+    uiTypeIs("Control"),
+    schemaTypeIs("object"),
+    schemaMatches((schema) =>
+      Object.prototype.hasOwnProperty.call(schema, "properties")
+    )
+  )
+);
+const isObject = rankWith(1, and(uiTypeIs("Control"), schemaTypeIs("object")));
+const isElse = rankWith(1, and(uiTypeIs("Control")));
+
+export const renderers = [
+  ...vanillaRenderers,
+
+  // use material renderers to handle objects and json schema references
+  // they should yield the rendering to simpler cells
+  { tester: isObjectWithPropertiesControl, renderer: MaterialObjectRenderer },
+  { tester: materialAllOfControlTester, renderer: MaterialAllOfRenderer },
+  { tester: materialOneOfControlTester, renderer: MaterialOneOfRenderer },
+
+  { tester: customAnyOfTester, renderer: CustomAnyOfRenderer },
+
+  // custom renderers
+  { tester: materialArrayControlTester, renderer: CustomArrayControlRenderer },
+  { tester: isObject, renderer: InputControl },
+  { tester: chatMessagesTester, renderer: ChatMessagesControlRenderer },
+  {
+    tester: chatMessagesTupleTester,
+    renderer: ChatMessageTuplesControlRenderer,
+  },
+  { tester: fileBase64Tester, renderer: FileBase64ControlRenderer },
+];
+const nestedArrayControlTester: RankedTester = rankWith(1, (_, jsonSchema) => {
+  return jsonSchema.type === "array";
+});
+
+export const cells = [
+  { tester: booleanCellTester, cell: BooleanCell },
+  { tester: dateCellTester, cell: DateCell },
+  { tester: dateTimeCellTester, cell: DateTimeCell },
+  { tester: enumCellTester, cell: EnumCell },
+  { tester: integerCellTester, cell: IntegerCell },
+  { tester: numberCellTester, cell: NumberCell },
+  { tester: sliderCellTester, cell: SliderCell },
+  { tester: textAreaCellTester, cell: CustomTextAreaCell },
+  { tester: textCellTester, cell: CustomTextAreaCell },
+  { tester: timeCellTester, cell: TimeCell },
+  { tester: nestedArrayControlTester, cell: CustomArrayControlRenderer },
+  { tester: isElse, cell: JsonTextAreaCell },
+];

langserve/playground/src/sections/SectionConfigure.tsx

@@ -0,0 +1,50 @@
+import { JsonForms } from "@jsonforms/react";
+import { JsonFormsCore, JsonSchema } from "@jsonforms/core";
+import { renderers, cells } from "../renderers";
+
+export type ConfigValue = Pick<JsonFormsCore, "data" | "errors"> & {
+  defaults: boolean;
+};
+
+export function SectionConfigure(props: {
+  config: JsonSchema | undefined;
+  value: ConfigValue;
+  onChange: (value: ConfigValue) => void;
+}) {
+  if (props.config == null || Object.keys(props.config).length === 0) {
+    return null;
+  }
+
+  return (
+    <div className="flex flex-col gap-3 [&:has(.content>.vertical-layout:first-child:last-child:empty)]:hidden">
+      <h2 className="text-xl font-semibold">Configure</h2>
+
+      <div className="content flex flex-col gap-3">
+        <JsonForms
+          schema={props.config}
+          data={props.value.data}
+          renderers={renderers}
+          cells={cells}
+          onChange={({ data, errors }) => {
+            if (data) {
+              props.onChange({ data, errors, defaults: false });
+            }
+          }}
+        />
+
+        {!!props.value.errors?.length && props.value.data && (
+          <div className="bg-background rounded-xl">
+            <div className="bg-red-500/10 text-red-700 dark:text-red-300 rounded-xl p-3">
+              <strong className="font-bold">Validation Errors</strong>
+              <ul className="list-disc pl-5">
+                {props.value.errors?.map((e, i) => (
+                  <li key={i}>{e.message}</li>
+                ))}
+              </ul>
+            </div>
+          </div>
+        )}
+      </div>
+    </div>
+  );
+}

langserve/playground/src/sections/SectionInputs.tsx

@@ -0,0 +1,64 @@
+import { useMemo } from "react";
+import defaults from "../utils/defaults";
+import { JsonForms } from "@jsonforms/react";
+import { JsonFormsCore, JsonSchema } from "@jsonforms/core";
+import { renderers, cells } from "../renderers";
+
+export type InputValue = Pick<JsonFormsCore, "data" | "errors">;
+
+export function SectionInputs(props: {
+  input: JsonSchema | undefined;
+  value: InputValue;
+  onChange: (value: InputValue) => void;
+}) {
+  const isInputResetable = useMemo(() => {
+    if (!props.input) return false;
+    return (
+      JSON.stringify(defaults(props.input)) !== JSON.stringify(props.value.data)
+    );
+  }, [props.input, props.value.data]);
+
+  return (
+    <div className="flex flex-col gap-3">
+      <h2 className="text-xl font-semibold">Try it</h2>
+
+      <div className="p-4 border border-divider-700 flex flex-col gap-3 rounded-2xl bg-background">
+        <div className="flex items-center justify-between">
+          <h3 className="font-medium">Inputs</h3>
+          {isInputResetable && (
+            <button
+              type="button"
+              className="text-sm px-1 -mr-1 py-0.5 rounded-md hover:bg-divider-500/50 active:bg-divider-500 text-ls-gray-100"
+              onClick={() =>
+                props.onChange({
+                  data: defaults(props.input),
+                  errors: [],
+                })
+              }
+            >
+              Reset
+            </button>
+          )}
+        </div>
+
+        <JsonForms
+          schema={props.input}
+          data={props.value.data}
+          renderers={renderers}
+          cells={cells}
+          onChange={({ data, errors }) => props.onChange({ data, errors })}
+        />
+        {!!props.value.errors?.length && props.value.data && (
+          <div className="bg-red-500/10 text-red-700 dark:text-red-300 rounded-xl p-3">
+            <strong className="font-bold">Validation Errors</strong>
+            <ul className="list-disc pl-5">
+              {props.value.errors?.map((e, i) => (
+                <li key={i}>{e.message}</li>
+              ))}
+            </ul>
+          </div>
+        )}
+      </div>
+    </div>
+  );
+}

langserve/playground/src/types.tsx

@@ -0,0 +1,5 @@
+export interface StreamCallback {
+  onSuccess?: (ctx: { input: unknown; output: unknown }) => void;
+  onError?: () => void;
+  onStart?: (ctx: { input: unknown }) => void;
+}

langserve/playground/src/types/json-schema-defaults.d.ts

@@ -1,5 +0,0 @@
-declare module "json-schema-defaults" {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  function defaults(schema: any): any;
-  export = defaults;
-}

langserve/playground/src/useSchemas.tsx

@@ -1,6 +1,10 @@
-import { useEffect, useState } from "react";
 import { resolveApiUrl } from "./utils/url";
 import { simplifySchema } from "./utils/simplifySchema";
+import { JsonSchema } from "@jsonforms/core";
+import { compressToEncodedURIComponent } from "lz-string";
+
+import useSWR from "swr";
+import defaults from "./utils/defaults";
 
 declare global {
   interface Window {
@@ -8,41 +12,72 @@ declare global {
     CONFIG_SCHEMA?: any;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     INPUT_SCHEMA?: any;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    FEEDBACK_ENABLED?: any;
   }
 }
 
-export function useSchemas() {
-  const [schemas, setSchemas] = useState({
-    config: null,
-    input: null,
-  });
-
-  useEffect(() => {
-    async function save() {
-      if (import.meta.env.DEV) {
-        const [config, input] = await Promise.all([
-          fetch(resolveApiUrl("/config_schema"))
-            .then((r) => r.json())
-            .then(simplifySchema),
-          fetch(resolveApiUrl("/input_schema"))
-            .then((r) => r.json())
-            .then(simplifySchema),
-        ]);
-        setSchemas({ config, input });
-      } else {
-        setSchemas({
-          config: window.CONFIG_SCHEMA
-            ? await simplifySchema(window.CONFIG_SCHEMA)
-            : null,
-          input: window.INPUT_SCHEMA
-            ? await simplifySchema(window.INPUT_SCHEMA)
-            : null,
-        });
-      }
+export function useFeedback() {
+  return useSWR(["/feedback"], async () => {
+    if (!import.meta.env.DEV && window.FEEDBACK_ENABLED) {
+      return window.FEEDBACK_ENABLED === "true";
     }
 
-    save();
-  }, []);
-
-  return schemas;
+    const response = await fetch(resolveApiUrl("/feedback"), {
+      method: "HEAD",
+    });
+    return response.ok;
+  });
+}
+
+export function useConfigSchema() {
+  return useSWR(["/config_schema"], async () => {
+    let schema: JsonSchema | null = null;
+    if (!import.meta.env.DEV && window.CONFIG_SCHEMA) {
+      schema = await simplifySchema(window.CONFIG_SCHEMA);
+    } else {
+      const response = await fetch(resolveApiUrl(`/config_schema`));
+      if (!response.ok) throw new Error(await response.text());
+
+      const json = await response.json();
+      schema = await simplifySchema(json);
+    }
+
+    if (schema == null) return null;
+    return {
+      schema,
+      defaults: defaults(schema),
+    };
+  });
+}
+
+export function useInputSchema(configData?: unknown) {
+  return useSWR(
+    ["/input_schema", configData],
+    async ([, configData]) => {
+      // TODO: this won't work if we're already seeing a prefixed URL
+      const prefix = configData
+        ? `/c/${compressToEncodedURIComponent(JSON.stringify(configData))}`
+        : "";
+
+      let schema: JsonSchema | null = null;
+
+      if (!prefix && !import.meta.env.DEV && window.INPUT_SCHEMA) {
+        schema = await simplifySchema(window.INPUT_SCHEMA);
+      } else {
+        const response = await fetch(resolveApiUrl(`${prefix}/input_schema`));
+        if (!response.ok) throw new Error(await response.text());
+
+        const json = await response.json();
+        schema = await simplifySchema(json);
+      }
+
+      if (schema == null) return null;
+      return {
+        schema,
+        defaults: defaults(schema),
+      };
+    },
+    { keepPreviousData: true }
+  );
 }

langserve/playground/src/useStreamCallback.tsx

@@ -0,0 +1,71 @@
+import {
+  MutableRefObject,
+  createContext,
+  useContext,
+  useEffect,
+  useRef,
+} from "react";
+
+import { StreamCallback } from "./types";
+
+export const AppCallbackContext = createContext<MutableRefObject<{
+  onStart: Exclude<StreamCallback["onStart"], undefined>[];
+  onSuccess: Exclude<StreamCallback["onSuccess"], undefined>[];
+  onError: Exclude<StreamCallback["onError"], undefined>[];
+}> | null>(null);
+
+export function useAppStreamCallbacks() {
+  // callbacks handling
+  const context = useRef<{
+    onStart: Exclude<StreamCallback["onStart"], undefined>[];
+    onSuccess: Exclude<StreamCallback["onSuccess"], undefined>[];
+    onError: Exclude<StreamCallback["onError"], undefined>[];
+  }>({ onStart: [], onSuccess: [], onError: [] });
+
+  const callbacks: StreamCallback = {
+    onStart(...args) {
+      for (const callback of context.current.onStart) {
+        callback(...args);
+      }
+    },
+    onSuccess(...args) {
+      for (const callback of context.current.onSuccess) {
+        callback(...args);
+      }
+    },
+    onError(...args) {
+      for (const callback of context.current.onError) {
+        callback(...args);
+      }
+    },
+  };
+
+  return { context, callbacks };
+}
+
+export function useStreamCallback<
+  Type extends "onStart" | "onSuccess" | "onError"
+>(type: Type, callback: Exclude<StreamCallback[Type], undefined>) {
+  type CallbackType = Exclude<StreamCallback[Type], undefined>;
+
+  const appCbRef = useContext(AppCallbackContext);
+
+  const callbackRef = useRef<CallbackType>(callback);
+  callbackRef.current = callback;
+
+  useEffect(() => {
+    // @ts-expect-error Not sure why I can't expand the tuple
+    const current = (...args) => callbackRef.current?.(...args);
+    appCbRef?.current[type].push(current);
+
+    return () => {
+      if (!appCbRef) return;
+
+      // @ts-expect-error Assingability issues due to the tuple object
+      // eslint-disable-next-line react-hooks/exhaustive-deps
+      appCbRef.current[type] = appCbRef.current[type].filter(
+        (callbacks) => callbacks !== current
+      );
+    };
+  }, [type, appCbRef]);
+}

langserve/playground/src/useStreamLog.tsx

@@ -1,7 +1,8 @@
-import { useCallback, useReducer, useState } from "react";
+import { useCallback, useRef, useState } from "react";
 import { applyPatch, Operation } from "fast-json-patch";
 import { fetchEventSource } from "@microsoft/fetch-event-source";
 import { resolveApiUrl } from "./utils/url";
+import { StreamCallback } from "./types";
 
 export interface LogEntry {
   // ID of the sub-run.
@@ -44,13 +45,26 @@ function reducer(state: RunState | null, action: Operation[]) {
   return applyPatch(state, action, true, false).newDocument;
 }
 
-export function useStreamLog() {
-  const [latest, updateLatest] = useReducer(reducer, null);
+export function useStreamLog(callbacks: StreamCallback = {}) {
+  const [latest, setLatest] = useState<RunState | null>(null);
   const [controller, setController] = useState<AbortController | null>(null);
 
+  const startRef = useRef(callbacks.onStart);
+  startRef.current = callbacks.onStart;
+
+  const successRef = useRef(callbacks.onSuccess);
+  successRef.current = callbacks.onSuccess;
+
+  const errorRef = useRef(callbacks.onError);
+  errorRef.current = callbacks.onError;
+
   const startStream = useCallback(async (input: unknown, config: unknown) => {
     const controller = new AbortController();
     setController(controller);
+    startRef.current?.({ input });
+
+    let innerLatest: RunState | null = null;
+
     await fetchEventSource(resolveApiUrl("/stream_log").toString(), {
       signal: controller.signal,
       method: "POST",
@@ -58,14 +72,18 @@ export function useStreamLog() {
       body: JSON.stringify({ input, config }),
       onmessage(msg) {
         if (msg.event === "data") {
-          updateLatest(JSON.parse(msg.data)?.ops);
+          innerLatest = reducer(innerLatest, JSON.parse(msg.data)?.ops);
+          setLatest(innerLatest);
         }
       },
+      openWhenHidden: true,
       onclose() {
         setController(null);
+        successRef.current?.({ input, output: innerLatest?.final_output });
       },
       onerror(error) {
         setController(null);
+        errorRef.current?.();
         throw error;
       },
     });

langserve/playground/src/utils/defaults.ts

@@ -0,0 +1,220 @@
+// (c) 2015 Chute Corporation. Released under the terms of the MIT License.
+// Modified to use TypeScript and handle edge cases with tuples
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable no-prototype-builtins */
+
+"use strict";
+
+/**
+ * check whether item is plain object
+ * @param {*} item
+ * @return {Boolean}
+ */
+const isObject = (item: unknown): item is Record<string, unknown> => {
+  return (
+    typeof item === "object" &&
+    item !== null &&
+    item.toString() === {}.toString()
+  );
+};
+
+/**
+ * deep JSON object clone
+ *
+ * @param {Object} source
+ * @return {Object}
+ */
+const cloneJSON = (source: any): any => {
+  return JSON.parse(JSON.stringify(source));
+};
+
+/**
+ * returns a result of deep merge of two objects
+ *
+ * @param {Object} target
+ * @param {Object} source
+ * @return {Object}
+ */
+const merge = (
+  target: Record<string, unknown>,
+  source: Record<string, unknown>
+) => {
+  target = cloneJSON(target);
+
+  for (const key in source) {
+    if (source.hasOwnProperty(key)) {
+      const sourceKeyValue = source[key];
+      const targetKeyValue = target[key];
+
+      if (isObject(sourceKeyValue) && isObject(targetKeyValue)) {
+        target[key] = merge(targetKeyValue, sourceKeyValue);
+      } else {
+        target[key] = sourceKeyValue;
+      }
+    }
+  }
+  return target;
+};
+
+/**
+ * get object by reference. works only with local references that points on
+ * definitions object
+ *
+ * @param {String} path
+ * @param {Object} definitions
+ * @return {Object}
+ */
+const getLocalRef = function (
+  inputPath: string,
+  definitions: Record<string, unknown>
+) {
+  const path = inputPath.replace(/^#\/definitions\//, "").split("/");
+
+  const find = function (path: string[], root: any): any {
+    const key = path.shift();
+    if (!key) return {};
+
+    if (!root[key]) {
+      return {};
+    } else if (!path.length) {
+      return root[key];
+    } else {
+      return find(path, root[key]);
+    }
+  };
+
+  const result = find(path, definitions);
+
+  if (!isObject(result)) {
+    return result;
+  }
+  return cloneJSON(result);
+};
+
+/**
+ * merge list of objects from allOf properties
+ * if some of objects contains $ref field extracts this reference and merge it
+ *
+ * @param {Array} allOfList
+ * @param {Object} definitions
+ * @return {Object}
+ */
+const mergeAllOf = function (allOfList: any[], definitions: any) {
+  const length = allOfList.length;
+  let index = -1,
+    result = {};
+
+  while (++index < length) {
+    let item = allOfList[index];
+
+    item =
+      typeof item.$ref !== "undefined"
+        ? getLocalRef(item.$ref, definitions)
+        : item;
+
+    result = merge(result, item);
+  }
+
+  return result;
+};
+
+/**
+ * returns a object that built with default values from json schema
+ *
+ * @param {Object} schema
+ * @param {Object} definitions
+ * @return {Object}
+ */
+const defaults = (schema: any, definitions: Record<string, any>): unknown => {
+  if (typeof schema["default"] !== "undefined") {
+    return schema["default"];
+  } else if (typeof schema.allOf !== "undefined") {
+    const mergedItem = mergeAllOf(schema.allOf, definitions);
+    return defaults(mergedItem, definitions);
+  } else if (typeof schema.$ref !== "undefined") {
+    const reference = getLocalRef(schema.$ref, definitions);
+    return defaults(reference, definitions);
+  } else if (schema.type === "object") {
+    if (!schema.properties) {
+      return {};
+    }
+
+    for (const key in schema.properties) {
+      if (schema.properties.hasOwnProperty(key)) {
+        schema.properties[key] = defaults(schema.properties[key], definitions);
+
+        if (typeof schema.properties[key] === "undefined") {
+          delete schema.properties[key];
+        }
+      }
+    }
+
+    return schema.properties;
+  } else if (schema.type === "array") {
+    if (!schema.items) {
+      return [];
+    }
+
+    // minimum item count
+    const ct = schema.minItems || 0;
+
+    // tuple-typed arrays
+    if (schema.items.constructor === Array) {
+      const values = schema.items.map((item: unknown) =>
+        defaults(item, definitions)
+      );
+
+      // remove undefined items at the end (unless required by minItems)
+      for (let i = values.length - 1; i >= 0; i--) {
+        if (typeof values[i] !== "undefined") {
+          break;
+        }
+        if (i + 1 > ct) {
+          values.pop();
+        }
+      }
+
+      // if all values are undefined -> return undefined even
+      // if minItems is set
+      if (values.every((item: unknown) => typeof item === "undefined")) {
+        return undefined;
+      }
+
+      return values;
+    }
+
+    // object-typed arrays
+    const value = defaults(schema.items, definitions);
+
+    if (typeof value === "undefined") {
+      return [];
+    } else {
+      const values = [];
+      for (let i = 0; i < Math.max(0, ct); i++) {
+        values.push(cloneJSON(value));
+      }
+      return values;
+    }
+  }
+};
+
+/**
+ * main function
+ *
+ * @param {Object} schema
+ * @param {Object|undefined} definitions
+ * @return {Object}
+ */
+export default function (
+  schema: any,
+  definitions?: Record<string, unknown> | undefined
+) {
+  if (typeof definitions === "undefined") {
+    definitions = (schema.definitions as Record<string, unknown>) || {};
+  } else if (isObject(schema.definitions)) {
+    definitions = merge(definitions, schema.definitions);
+  }
+
+  return defaults(cloneJSON(schema), definitions);
+}

langserve/playground/src/utils/messages.ts

@@ -0,0 +1,7 @@
+export function getMessageContent(x: unknown) {
+  if (typeof x === "string") return x;
+  if (typeof x === "object" && x != null) {
+    if ("content" in x && typeof x.content === "string") return x.content;
+  }
+  return null;
+}

langserve/playground/src/utils/path.ts

@@ -0,0 +1,31 @@
+function isAccessibleObject(x: unknown): x is Record<string | number, unknown> {
+  return typeof x === "object" && x != null;
+}
+
+export function getNormalizedJsonPath(
+  path: string | number | Array<string | number>
+) {
+  return Array.isArray(path) ? path : [path];
+}
+
+export function traverseNaiveJsonPath(
+  x: unknown,
+  path: string | number | Array<string | number>
+) {
+  const queue = getNormalizedJsonPath(path);
+
+  let tmp: unknown = x;
+  while (queue.length > 0) {
+    const first = queue.shift()!;
+    if (first === "") continue;
+    if (Array.isArray(tmp)) {
+      tmp = tmp[+first];
+    } else if (isAccessibleObject(tmp)) {
+      tmp = tmp[first];
+    } else {
+      return undefined;
+    }
+  }
+
+  return tmp;
+}

langserve/playground/src/utils/schema.ts

@@ -0,0 +1,28 @@
+import { JsonSchema } from "@jsonforms/core";
+
+type JsonSchemaExtra = JsonSchema & {
+  extra: {
+    widget: {
+      type: string;
+      [key: string]: string | number | Array<string | number>;
+    };
+  };
+};
+
+export function isJsonSchemaExtra(x: JsonSchema): x is JsonSchemaExtra {
+  if (!("extra" in x && typeof x.extra === "object" && x.extra != null)) {
+    return false;
+  }
+
+  if (
+    !(
+      "widget" in x.extra &&
+      typeof x.extra.widget === "object" &&
+      x.extra.widget != null
+    )
+  ) {
+    return false;
+  }
+
+  return true;
+}

langserve/playground/src/utils/str.ts

@@ -0,0 +1,5 @@
+export function str(o: unknown): React.ReactNode {
+  return typeof o === "object"
+    ? JSON.stringify(o, null, 2)
+    : (o as React.ReactNode);
+}

langserve/playground/src/utils/url.ts

@@ -1,8 +1,33 @@
-export function resolveApiUrl(path: string) {
-  if (import.meta.env.DEV) {
-    return new URL(path, "http://127.0.0.1:8000");
+import { decompressFromEncodedURIComponent } from "lz-string";
+
+export function getStateFromUrl(path: string) {
+  let configFromUrl = null;
+  let basePath = path;
+  if (basePath.endsWith("/")) {
+    basePath = basePath.slice(0, -1);
   }
 
-  const prefix = window.location.pathname.split("/playground")[0];
-  return new URL(prefix + path, window.location.origin);
+  if (basePath.endsWith("/playground")) {
+    basePath = basePath.slice(0, -"/playground".length);
+  }
+
+  // check if we can omit the last segment
+  const [configHash, c, ...rest] = basePath.split("/").reverse();
+  if (c === "c") {
+    basePath = rest.reverse().join("/");
+    try {
+      configFromUrl = JSON.parse(decompressFromEncodedURIComponent(configHash));
+    } catch (error) {
+      console.error(error);
+    }
+  }
+  return { basePath, configFromUrl };
+}
+
+export function resolveApiUrl(path: string) {
+  const { basePath } = getStateFromUrl(window.location.href);
+  let prefix = new URL(basePath).pathname;
+  if (prefix.endsWith("/")) prefix = prefix.slice(0, -1);
+
+  return new URL(prefix + path, basePath);
 }

langserve/playground/vite.config.ts

@@ -6,4 +6,13 @@ import svgr from "vite-plugin-svgr";
 export default defineConfig({
   base: "/____LANGSERVE_BASE_URL/",
   plugins: [svgr(), react()],
+  server: {
+    proxy: {
+      "^/____LANGSERVE_BASE_URL.*/(config_schema|input_schema|stream_log|feedback)(/[a-zA-Z0-9-]*)?$": {
+        target: "http://127.0.0.1:8000",
+        changeOrigin: true,
+        rewrite: (path) => path.replace("/____LANGSERVE_BASE_URL", ""),
+      },
+    },
+  },
 });

langserve/playground/yarn.lock

@@ -736,6 +736,17 @@
   dependencies:
     "@babel/runtime" "^7.13.10"
 
+"@radix-ui/react-collection@1.0.3":
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/@radix-ui/react-collection/-/react-collection-1.0.3.tgz#9595a66e09026187524a36c6e7e9c7d286469159"
+  integrity sha512-3SzW+0PW7yBBoQlT8wNcGtaxaD0XSu0uLUFgrtHY08Acx05TaHaOmVLR73c0j/cqpDy53KBMO7s0dx2wmOIDIA==
+  dependencies:
+    "@babel/runtime" "^7.13.10"
+    "@radix-ui/react-compose-refs" "1.0.1"
+    "@radix-ui/react-context" "1.0.1"
+    "@radix-ui/react-primitive" "1.0.3"
+    "@radix-ui/react-slot" "1.0.2"
+
 "@radix-ui/react-compose-refs@1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@radix-ui/react-compose-refs/-/react-compose-refs-1.0.1.tgz#7ed868b66946aa6030e580b1ffca386dd4d21989"
@@ -771,6 +782,13 @@
     aria-hidden "^1.1.1"
     react-remove-scroll "2.5.5"
 
+"@radix-ui/react-direction@1.0.1":
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/@radix-ui/react-direction/-/react-direction-1.0.1.tgz#9cb61bf2ccf568f3421422d182637b7f47596c9b"
+  integrity sha512-RXcvnXgyvYvBEOhCBuddKecVkoMiI10Jcm5cTI7abJRAHYfFxeu+FBQs/DvdxSYucxR5mna0dNsL6QFlds5TMA==
+  dependencies:
+    "@babel/runtime" "^7.13.10"
+
 "@radix-ui/react-dismissable-layer@1.0.5":
   version "1.0.5"
   resolved "https://registry.yarnpkg.com/@radix-ui/react-dismissable-layer/-/react-dismissable-layer-1.0.5.tgz#3f98425b82b9068dfbab5db5fff3df6ebf48b9d4"
@@ -833,6 +851,22 @@
     "@babel/runtime" "^7.13.10"
     "@radix-ui/react-slot" "1.0.2"
 
+"@radix-ui/react-roving-focus@1.0.4":
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/@radix-ui/react-roving-focus/-/react-roving-focus-1.0.4.tgz#e90c4a6a5f6ac09d3b8c1f5b5e81aab2f0db1974"
+  integrity sha512-2mUg5Mgcu001VkGy+FfzZyzbmuUWzgWkj3rvv4yu+mLw03+mTzbxZHvfcGyFp2b8EkQeMkpRQ5FiA2Vr2O6TeQ==
+  dependencies:
+    "@babel/runtime" "^7.13.10"
+    "@radix-ui/primitive" "1.0.1"
+    "@radix-ui/react-collection" "1.0.3"
+    "@radix-ui/react-compose-refs" "1.0.1"
+    "@radix-ui/react-context" "1.0.1"
+    "@radix-ui/react-direction" "1.0.1"
+    "@radix-ui/react-id" "1.0.1"
+    "@radix-ui/react-primitive" "1.0.3"
+    "@radix-ui/react-use-callback-ref" "1.0.1"
+    "@radix-ui/react-use-controllable-state" "1.0.1"
+
 "@radix-ui/react-slot@1.0.2":
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/@radix-ui/react-slot/-/react-slot-1.0.2.tgz#a9ff4423eade67f501ffb32ec22064bc9d3099ab"
@@ -841,6 +875,30 @@
     "@babel/runtime" "^7.13.10"
     "@radix-ui/react-compose-refs" "1.0.1"
 
+"@radix-ui/react-toggle-group@^1.0.4":
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/@radix-ui/react-toggle-group/-/react-toggle-group-1.0.4.tgz#f5b5c8c477831b013bec3580c55e20a68179d6ec"
+  integrity sha512-Uaj/M/cMyiyT9Bx6fOZO0SAG4Cls0GptBWiBmBxofmDbNVnYYoyRWj/2M/6VCi/7qcXFWnHhRUfdfZFvvkuu8A==
+  dependencies:
+    "@babel/runtime" "^7.13.10"
+    "@radix-ui/primitive" "1.0.1"
+    "@radix-ui/react-context" "1.0.1"
+    "@radix-ui/react-direction" "1.0.1"
+    "@radix-ui/react-primitive" "1.0.3"
+    "@radix-ui/react-roving-focus" "1.0.4"
+    "@radix-ui/react-toggle" "1.0.3"
+    "@radix-ui/react-use-controllable-state" "1.0.1"
+
+"@radix-ui/react-toggle@1.0.3":
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/@radix-ui/react-toggle/-/react-toggle-1.0.3.tgz#aecb2945630d1dc5c512997556c57aba894e539e"
+  integrity sha512-Pkqg3+Bc98ftZGsl60CLANXQBBQ4W3mTFS9EJvNxKMZ7magklKV69/id1mlAlOFDDfHvlCms0fx8fA4CMKDJHg==
+  dependencies:
+    "@babel/runtime" "^7.13.10"
+    "@radix-ui/primitive" "1.0.1"
+    "@radix-ui/react-primitive" "1.0.3"
+    "@radix-ui/react-use-controllable-state" "1.0.1"
+
 "@radix-ui/react-use-callback-ref@1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@radix-ui/react-use-callback-ref/-/react-use-callback-ref-1.0.1.tgz#f4bb1f27f2023c984e6534317ebc411fc181107a"
@@ -1224,13 +1282,6 @@ arg@^5.0.2:
   resolved "https://registry.yarnpkg.com/arg/-/arg-5.0.2.tgz#c81433cc427c92c4dcf4865142dbca6f15acd59c"
   integrity sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==
 
-argparse@^1.0.9:
-  version "1.0.10"
-  resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911"
-  integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==
-  dependencies:
-    sprintf-js "~1.0.2"
-
 argparse@^2.0.1:
   version "2.0.1"
   resolved "https://registry.yarnpkg.com/argparse/-/argparse-2.0.1.tgz#246f50f3ca78a3240f6c997e8a9bd1eac49e4b38"
@@ -1356,6 +1407,11 @@ chokidar@^3.5.3:
   optionalDependencies:
     fsevents "~2.3.2"
 
+client-only@^0.0.1:
+  version "0.0.1"
+  resolved "https://registry.yarnpkg.com/client-only/-/client-only-0.0.1.tgz#38bba5d403c41ab150bff64a95c85013cf73bca1"
+  integrity sha512-IV3Ou0jSMzZrd3pZ48nLkT9DA7Ag1pnPzaiQhpW7c3RbcqqzvzzVu+L8gfqMp/8IM2MQtSiqaCxrrcfu8I8rMA==
+
 clsx@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/clsx/-/clsx-2.0.0.tgz#12658f3fd98fafe62075595a5c30e43d18f3d00b"
@@ -1985,13 +2041,6 @@ json-parse-even-better-errors@^2.3.0:
   resolved "https://registry.yarnpkg.com/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz#7c47805a94319928e05777405dc12e1f7a4ee02d"
   integrity sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==
 
-json-schema-defaults@^0.4.0:
-  version "0.4.0"
-  resolved "https://registry.yarnpkg.com/json-schema-defaults/-/json-schema-defaults-0.4.0.tgz#b63ee7e7aa83f29b54cb31d31ecddeb056c3306c"
-  integrity sha512-UsUrkDVNvHTneyeQOYHH9ZHb3+6OjwYfJ831SdO0yjtXtYZ7Jh8BKWsuJYUQW7qckP5JhHawsg4GI6A5fMaR/Q==
-  dependencies:
-    argparse "^1.0.9"
-
 json-schema-traverse@^0.4.1:
   version "0.4.1"
   resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660"
@@ -2522,11 +2571,6 @@ source-map@^0.5.7:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.7.tgz#8a039d2d1021d22d1ea14c80d8ea468ba2ef3fcc"
   integrity sha512-LbrmJOMUSdEVxIKvdcJzQC+nQhe8FUZQTXQy6+I75skNgn3OoQ0DZA8YnFa7gp8tqtL3KPf1kmo0R5DoApeSGQ==
 
-sprintf-js@~1.0.2:
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"
-  integrity sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==
-
 strip-ansi@^6.0.1:
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9"
@@ -2581,6 +2625,14 @@ svg-parser@^2.0.4:
   resolved "https://registry.yarnpkg.com/svg-parser/-/svg-parser-2.0.4.tgz#fdc2e29e13951736140b76cb122c8ee6630eb6b5"
   integrity sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==
 
+swr@^2.2.4:
+  version "2.2.4"
+  resolved "https://registry.yarnpkg.com/swr/-/swr-2.2.4.tgz#03ec4c56019902fbdc904d78544bd7a9a6fa3f07"
+  integrity sha512-njiZ/4RiIhoOlAaLYDqwz5qH/KZXVilRLvomrx83HjzCWTfa+InyfAjv05PSFxnmLzZkNO9ZfvgoqzAaEI4sGQ==
+  dependencies:
+    client-only "^0.0.1"
+    use-sync-external-store "^1.2.0"
+
 tailwind-merge@^1.14.0:
   version "1.14.0"
   resolved "https://registry.yarnpkg.com/tailwind-merge/-/tailwind-merge-1.14.0.tgz#e677f55d864edc6794562c63f5001f45093cdb8b"
@@ -2699,6 +2751,11 @@ use-callback-ref@^1.3.0:
   dependencies:
     tslib "^2.0.0"
 
+use-debounce@^9.0.4:
+  version "9.0.4"
+  resolved "https://registry.yarnpkg.com/use-debounce/-/use-debounce-9.0.4.tgz#51d25d856fbdfeb537553972ce3943b897f1ac85"
+  integrity sha512-6X8H/mikbrt0XE8e+JXRtZ8yYVvKkdYRfmIhWZYsP8rcNs9hk3APV8Ua2mFkKRLcJKVdnX2/Vwrmg2GWKUQEaQ==
+
 use-sidecar@^1.1.2:
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/use-sidecar/-/use-sidecar-1.1.2.tgz#2f43126ba2d7d7e117aa5855e5d8f0276dfe73c2"
@@ -2707,6 +2764,11 @@ use-sidecar@^1.1.2:
     detect-node-es "^1.1.0"
     tslib "^2.0.0"
 
+use-sync-external-store@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/use-sync-external-store/-/use-sync-external-store-1.2.0.tgz#7dbefd6ef3fe4e767a0cf5d7287aacfb5846928a"
+  integrity sha512-eEgnFxGQ1Ife9bzYs6VLi8/4X6CObHMw9Qr9tPY43iKwsPw8xE8+EFsf/2cFZ5S3esXgpWgtSCtLNS41F+sKPA==
+
 util-deprecate@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/util-deprecate/-/util-deprecate-1.0.2.tgz#450d4dc9fa70de732762fbd2d4a28981419a0ccf"

langserve/pydantic_v1.py

@@ -0,0 +1,33 @@
+from importlib import metadata
+
+## Create namespaces for pydantic v1 and v2.
+# This code must stay at the top of the file before other modules may
+# attempt to import pydantic since it adds pydantic_v1 and pydantic_v2 to sys.modules.
+#
+# This hack is done for the following reasons:
+# * Langchain will attempt to remain compatible with both pydantic v1 and v2 since
+#   both dependencies and dependents may be stuck on either version of v1 or v2.
+# * Creating namespaces for pydantic v1 and v2 should allow us to write code that
+#   unambiguously uses either v1 or v2 API.
+# * This change is easier to roll out and roll back.
+
+try:
+    # F401: imported but unused
+    from pydantic.v1 import (  # noqa: F401
+        BaseModel,
+        Field,
+        ValidationError,
+        create_model,
+    )
+except ImportError:
+    from pydantic import BaseModel, Field, ValidationError, create_model  # noqa: F401
+
+
+# This is not a pydantic v1 thing, but it feels too small to create a new module for.
+
+PYDANTIC_VERSION = metadata.version("pydantic")
+
+try:
+    _PYDANTIC_MAJOR_VERSION: int = int(PYDANTIC_VERSION.split(".")[0])
+except metadata.PackageNotFoundError:
+    _PYDANTIC_MAJOR_VERSION = -1

langserve/schema.py

@@ -0,0 +1,109 @@
+from datetime import datetime
+from typing import Dict, List, Optional, Union
+from uuid import UUID
+
+from pydantic import BaseModel  # Floats between v1 and v2
+
+from langserve.pydantic_v1 import BaseModel as BaseModelV1
+
+
+class CustomUserType(BaseModelV1):
+    """Inherit from this class to create a custom user type.
+
+    Use a custom user type if you want the data to de-serialize
+    into a pydantic model rather than the equivalent dict representation.
+
+    In general, make sure to add a `type` attribute to your class
+    to help pydantic to discriminate unions.
+
+    https://docs.pydantic.dev/1.10/usage/types/#discriminated-unions-aka-tagged-unions
+
+    Limitations:
+        At the moment, this type only works SERVER side and is used
+        to specify desired DECODING behavior. If inheriting from this type
+        the server will keep the decoded type as a pydantic model instead
+        of converting it into a dict.
+    """
+
+
+class SharedResponseMetadata(BaseModelV1):
+    """
+    Any response metadata should inherit from this class. Response metadata
+    represents non-output data that may be useful to some clients, but
+    ignorable to most. For example, the run_ids associated with each run
+    kicked off by the associated request.
+
+    SharedResponseMetadata is an abstraction to represent any metadata
+    representing a LangServe response shared across all outputs in said
+    response.
+    """
+
+    pass
+
+
+class SingletonResponseMetadata(SharedResponseMetadata):
+    """
+    Represents response metadata used for just single input/output LangServe
+    responses.
+    """
+
+    # Represents the parent run id for a given request
+    run_id: UUID
+
+
+class BatchResponseMetadata(SharedResponseMetadata):
+    """
+    Represents response metadata used for batches of input/output LangServe
+    responses.
+    """
+
+    # Represents each parent run id for a given request, in
+    # the same order in which they were received
+    run_ids: List[UUID]
+
+
+class BaseFeedback(BaseModel):
+    """
+    Shared information between create requests of feedback and feedback objects
+    """
+
+    run_id: UUID
+    """The associated run ID this feedback is logged for."""
+
+    key: str
+    """The metric name, tag, or aspect to provide feedback on."""
+
+    score: Optional[Union[float, int, bool]] = None
+    """Value or score to assign the run."""
+
+    value: Optional[Union[float, int, bool, str, Dict]] = None
+    """The display value for the feedback if not a metric."""
+
+    comment: Optional[str] = None
+    """Comment or explanation for the feedback."""
+
+
+class FeedbackCreateRequest(BaseFeedback):
+    """
+    Represents a request that creates feedback for an individual run
+    """
+
+    pass
+
+
+class Feedback(BaseFeedback):
+    """
+    Represents feedback given on an individual run
+    """
+
+    id: UUID
+    """The unique ID of the feedback that was created."""
+
+    created_at: datetime
+    """The time the feedback was created."""
+
+    modified_at: datetime
+    """The time the feedback was last modified."""
+
+    correction: Optional[Dict] = None
+    """Correction for the run."""

langserve/serialization.py

@@ -1,11 +1,21 @@
-"""Serialization module for Well Known LangChain objects.
+"""Serialization for well known objects and callback events.
 
 Specialized JSON serialization for well known LangChain objects that
 can be expected to be frequently transmitted between chains.
-"""
-import json
-from typing import Any, Union
 
+Callback events handle well known objects together with a few other
+common types like UUIDs and Exceptions that might appear in the callback.
+
+By default, exceptions are serialized as a generic exception without
+any information about the exception. This is done to prevent leaking
+sensitive information from the server to the client.
+"""
+import abc
+import logging
+from functools import lru_cache
+from typing import Any, Dict, List, Union
+
+import orjson
 from langchain.prompts.base import StringPromptValue
 from langchain.prompts.chat import ChatPromptValueConcrete
 from langchain.schema.agent import AgentAction, AgentActionMessageLog, AgentFinish
@@ -22,11 +32,23 @@ from langchain.schema.messages import (
     SystemMessage,
     SystemMessageChunk,
 )
+from langchain.schema.output import (
+    ChatGeneration,
+    ChatGenerationChunk,
+    Generation,
+    LLMResult,
+)
 
-try:
-    from pydantic.v1 import BaseModel, ValidationError
-except ImportError:
-    from pydantic import BaseModel, ValidationError
+from langserve.pydantic_v1 import BaseModel, ValidationError
+from langserve.validation import CallbackEvent
+
+logger = logging.getLogger(__name__)
+
+
+@lru_cache(maxsize=1_000)  # Will accommodate up to 1_000 different error messages
+def _log_error_message_once(error_message: str) -> None:
+    """Log an error message once."""
+    logger.error(error_message)
 
 
 class WellKnownLCObject(BaseModel):
@@ -54,54 +76,156 @@ class WellKnownLCObject(BaseModel):
         AgentAction,
         AgentFinish,
         AgentActionMessageLog,
+        LLMResult,
+        ChatGeneration,
+        Generation,
+        ChatGenerationChunk,
     ]
 
 
-# Custom JSON Encoder
-class _LangChainEncoder(json.JSONEncoder):
-    """Custom JSON Encoder that can encode pydantic objects as well."""
-
-    def default(self, obj) -> Any:
-        if isinstance(obj, BaseModel):
-            return obj.dict()
-        return super().default(obj)
+def default(obj) -> Any:
+    """Default serialization for well known objects."""
+    if isinstance(obj, BaseModel):
+        return obj.dict()
+    return super().default(obj)
 
 
-# Custom JSON Decoder
-class _LangChainDecoder(json.JSONDecoder):
-    """Custom JSON Decoder that handles well known LangChain objects."""
+def _decode_lc_objects(value: Any) -> Any:
+    """Decode the value."""
+    if isinstance(value, dict):
+        v = {key: _decode_lc_objects(v) for key, v in value.items()}
 
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        """Initialize the LangChainDecoder."""
-        super().__init__(object_hook=self.decoder, *args, **kwargs)
+        try:
+            obj = WellKnownLCObject.parse_obj(v)
+            parsed = obj.__root__
+            if set(parsed.dict()) != set(value):
+                raise ValueError("Invalid object")
+            return parsed
+        except (ValidationError, ValueError):
+            return v
+    elif isinstance(value, list):
+        return [_decode_lc_objects(item) for item in value]
+    else:
+        return value
 
-    def decoder(self, value) -> Any:
-        """Decode the value."""
-        if isinstance(value, dict):
+
+class ServerSideException(Exception):
+    """Exception raised when a server side exception occurs.
+
+    The goal of this exception is to provide a way to communicate
+    to the client that a server side exception occurred without
+    revealing too much information about the exception as it may contain
+    sensitive information.
+    """
+
+
+def _decode_event_data(value: Any) -> Any:
+    """Decode the event data from a JSON object representation."""
+    if isinstance(value, dict):
+        try:
+            obj = CallbackEvent.parse_obj(value)
+            return obj.__root__
+        except ValidationError:
             try:
                 obj = WellKnownLCObject.parse_obj(value)
                 return obj.__root__
             except ValidationError:
-                return {key: self.decoder(v) for key, v in value.items()}
-        elif isinstance(value, list):
-            return [self.decoder(item) for item in value]
-        else:
-            return value
+                return {key: _decode_event_data(v) for key, v in value.items()}
+    elif isinstance(value, list):
+        return [_decode_event_data(item) for item in value]
+    else:
+        return value
 
 
 # PUBLIC API
 
 
-def simple_dumpd(obj: Any) -> Any:
-    """Convert the given object to a JSON serializable object."""
-    return json.loads(json.dumps(obj, cls=_LangChainEncoder))
+class Serializer(abc.ABC):
+    @abc.abstractmethod
+    def dumpd(self, obj: Any) -> Any:
+        """Convert the given object to a JSON serializable object."""
+
+    @abc.abstractmethod
+    def dumps(self, obj: Any) -> bytes:
+        """Dump the given object as a JSON string."""
+
+    @abc.abstractmethod
+    def loads(self, s: bytes) -> Any:
+        """Load the given JSON string."""
+
+    @abc.abstractmethod
+    def loadd(self, obj: Any) -> Any:
+        """Load the given object."""
 
 
-def simple_dumps(obj: Any) -> str:
-    """Dump the given object as a JSON string."""
-    return json.dumps(obj, cls=_LangChainEncoder)
+class WellKnownLCSerializer(Serializer):
+    def dumpd(self, obj: Any) -> Any:
+        """Convert the given object to a JSON serializable object."""
+        return orjson.loads(orjson.dumps(obj, default=default))
+
+    def dumps(self, obj: Any) -> bytes:
+        """Dump the given object as a JSON string."""
+        return orjson.dumps(obj, default=default)
+
+    def loadd(self, obj: Any) -> Any:
+        """Load the given object."""
+        return _decode_lc_objects(obj)
+
+    def loads(self, s: bytes) -> Any:
+        """Load the given JSON string."""
+        return self.loadd(orjson.loads(s))
 
 
-def simple_loads(s: str) -> Any:
-    """Load the given JSON string."""
-    return json.loads(s, cls=_LangChainDecoder)
+def _project_top_level(model: BaseModel) -> Dict[str, Any]:
+    """Project the top level of the model as dict."""
+    return {key: getattr(model, key) for key in model.__fields__}
+
+
+def load_events(events: Any) -> List[Dict[str, Any]]:
+    """Load and validate the event.
+
+    Args:
+        events: The events to load and validate.
+
+    Returns:
+        The loaded and validated events.
+    """
+    if not isinstance(events, list):
+        _log_error_message_once(f"Expected a list got {type(events)}")
+        return []
+
+    decoded_events = []
+
+    for event in events:
+        if not isinstance(event, dict):
+            _log_error_message_once(f"Expected a dict got {type(event)}")
+            # Discard the event / potentially error
+            continue
+
+        # First load all inner objects
+        decoded_event_data = {
+            key: _decode_lc_objects(value) for key, value in event.items()
+        }
+
+        # Then validate the event
+        try:
+            full_event = CallbackEvent.parse_obj(decoded_event_data)
+        except ValidationError as e:
+            msg = f"Encountered an invalid event: {e}"
+            if "type" in decoded_event_data:
+                msg += f' of type {repr(decoded_event_data["type"])}'
+            _log_error_message_once(msg)
+            continue
+
+        decoded_event_data = _project_top_level(full_event.__root__)
+
+        if decoded_event_data["type"].endswith("_error"):
+            # Data is validated by this point, so we can assume that the shape
+            # of the data is correct
+            error = decoded_event_data["error"]
+            msg = f"{error['status_code']}: {error['message']}"
+            decoded_event_data["error"] = ServerSideException(msg)
+
+        decoded_events.append(decoded_event_data)
+
+    return decoded_events

langserve/validation.py

@@ -16,14 +16,25 @@ Models are created with a namespace to avoid name collisions when hosting
 multiple runnables. When present the name collisions prevent fastapi from
 generating OpenAPI specs.
 """
-from typing import List, Optional, Sequence, Union
+from typing import Any, Dict, List, Literal, Optional, Sequence, Union
+from uuid import UUID
+
+from langchain.schema import (
+    BaseMessage,
+    ChatGeneration,
+    Document,
+    Generation,
+    RunInfo,
+)
+from typing_extensions import Type
+
+from langserve.schema import BatchResponseMetadata, SingletonResponseMetadata
 
 try:
     from pydantic.v1 import BaseModel, Field, create_model
 except ImportError:
     from pydantic import BaseModel, Field, create_model
 
-from typing_extensions import Type, TypedDict
 
 # Type that is either a python annotation or a pydantic model that can be
 # used to validate the input or output of a runnable.
@@ -35,7 +46,7 @@ Validator = Union[Type[BaseModel], type]
 def create_invoke_request_model(
     namespace: str,
     input_type: Validator,
-    config: TypedDict,
+    config: Type[BaseModel],
 ) -> Type[BaseModel]:
     """Create a pydantic model for the invoke request."""
     invoke_request_type = create_model(
@@ -66,7 +77,7 @@ def create_invoke_request_model(
 def create_stream_request_model(
     namespace: str,
     input_type: Validator,
-    config: TypedDict,
+    config: Type[BaseModel],
 ) -> Type[BaseModel]:
     """Create a pydantic model for the stream request."""
     stream_request_model = create_model(
@@ -97,7 +108,7 @@ def create_stream_request_model(
 def create_batch_request_model(
     namespace: str,
     input_type: Validator,
-    config: TypedDict,
+    config: Type[BaseModel],
 ) -> Type[BaseModel]:
     """Create a pydantic model for the batch request."""
     batch_request_type = create_model(
@@ -129,7 +140,7 @@ def create_batch_request_model(
 def create_stream_log_request_model(
     namespace: str,
     input_type: Validator,
-    config: TypedDict,
+    config: Type[BaseModel],
 ) -> Type[BaseModel]:
     """Create a pydantic model for the invoke request."""
     stream_log_request = create_model(
@@ -184,6 +195,14 @@ def create_stream_log_request_model(
     return stream_log_request
 
 
+class InvokeBaseResponse(BaseModel):
+    """Base class for invoke request."""
+
+
+class BatchBaseResponse(BaseModel):
+    """Base class for batch response."""
+
+
 def create_invoke_response_model(
     namespace: str,
     output_type: Validator,
@@ -194,6 +213,21 @@ def create_invoke_response_model(
     invoke_response_type = create_model(
         f"{namespace}InvokeResponse",
         output=(output_type, Field(..., description="The output of the invocation.")),
+        callback_events=(
+            List[CallbackEvent],
+            Field(..., description="Callback events generated by the server side."),
+        ),
+        metadata=(
+            SingletonResponseMetadata,
+            Field(
+                ...,
+                description=(
+                    "Metadata about the response that may be useful to "
+                    "specific clients"
+                ),
+            ),
+        ),
+        __base__=InvokeBaseResponse,
     )
     invoke_response_type.update_forward_refs()
     return invoke_response_type
@@ -217,6 +251,248 @@ def create_batch_response_model(
                 ),
             ),
         ),
+        callback_events=(
+            List[List[CallbackEvent]],
+            Field(
+                ...,
+                description=(
+                    "Callback events generated by the server side."
+                    "The outer list corresponds to the inputs and the inner "
+                    "list corresponds to the callbacks generated for that input."
+                ),
+            ),
+        ),
+        metadata=(
+            BatchResponseMetadata,
+            Field(
+                ...,
+                description=(
+                    "Metadata about the response that may be useful to specific clients"
+                ),
+            ),
+        ),
+        __base__=BatchBaseResponse,
     )
     batch_response_type.update_forward_refs()
     return batch_response_type
+
+
+class InvokeRequestShallowValidator(BaseModel):
+    """Shallow validator for Invoke Request.
+
+    Validate basic shape of invoke request, downstream code
+    is expected to do further validation.
+    """
+
+    input: Any = Field(..., description="The input to the runnable.")
+    config: Optional[Dict[str, Any]] = Field(default_factory=dict)
+
+
+class BatchRequestShallowValidator(BaseModel):
+    """Shallow validator for Batch Request."""
+
+    inputs: Any = Field(..., description="The inputs to the runnable.")
+    config: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = Field(
+        default_factory=dict
+    )
+
+
+class StreamLogParameters(BaseModel):
+    """Shallow validator for Stream Log Request"""
+
+    include_names: Optional[Sequence[str]] = None
+    include_types: Optional[Sequence[str]] = None
+    include_tags: Optional[Sequence[str]] = None
+    exclude_names: Optional[Sequence[str]] = None
+    exclude_types: Optional[Sequence[str]] = None
+    exclude_tags: Optional[Sequence[str]] = None
+
+
+# Pydantic validators for callback events
+# These objects may have a slightly different shape than the callback events
+# used internally in langchain because they represent a serialized version
+# of the callback event.
+# For example, exceptions are replaced by error objects consisting of a
+# status code and a message.
+
+
+class OnChainStart(BaseModel):
+    """On Chain Start Callback Event."""
+
+    serialized: Dict[str, Any]
+    inputs: Any
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    kwargs: Any = None
+    type: Literal["on_chain_start"] = "on_chain_start"
+
+
+class OnChainEnd(BaseModel):
+    """On Chain End Callback Event."""
+
+    outputs: Any
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_chain_end"] = "on_chain_end"
+
+
+class Error(BaseModel):
+    """Error object that is modeled after an HTTP error format."""
+
+    status_code: int
+    message: str
+    type: Literal["error"] = "error"
+
+
+class OnChainError(BaseModel):
+    """On Chain Error Callback Event."""
+
+    error: Error
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_chain_error"] = "on_chain_error"
+
+
+class OnToolStart(BaseModel):
+    """On Tool Start Callback Event."""
+
+    serialized: Dict[str, Any]
+    input_str: str
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    kwargs: Any = None
+    type: Literal["on_tool_start"] = "on_tool_start"
+
+
+class OnToolEnd(BaseModel):
+    """On Tool End Callback Event."""
+
+    output: str
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_tool_end"] = "on_tool_end"
+
+
+class OnToolError(BaseModel):
+    """On Tool Error Callback Event."""
+
+    error: Error
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_tool_error"] = "on_tool_error"
+
+
+class OnChatModelStart(BaseModel):
+    """On Chat Model Start Callback Event."""
+
+    serialized: Dict[str, Any]
+    messages: List[List[BaseMessage]]
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    kwargs: Any = None
+    type: Literal["on_chat_model_start"] = "on_chat_model_start"
+
+
+class OnLLMStart(BaseModel):
+    """On LLM Start Callback Event."""
+
+    serialized: Dict[str, Any]
+    prompts: List[str]
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    kwargs: Any = None
+    type: Literal["on_llm_start"] = "on_llm_start"
+
+
+class LLMResult(BaseModel):
+    """Concrete instance of LLMResult for validation only.
+
+    Must be kept in sync with langchain.schema.llm.LLMResult.
+    """
+
+    generations: List[List[Union[Generation, ChatGeneration]]]
+    """List of generated outputs. This is a List[List[]] because
+    each input could have multiple candidate generations."""
+    llm_output: Optional[dict] = None
+    """Arbitrary LLM provider-specific output."""
+    run: Optional[List[RunInfo]] = None
+    """List of metadata info for model call for each input."""
+
+
+class OnLLMEnd(BaseModel):
+    """On LLM End Callback Event."""
+
+    response: LLMResult
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_llm_end"] = "on_llm_end"
+
+
+class OnRetrieverStart(BaseModel):
+    """On Retriever Start Callback Event."""
+
+    serialized: Dict[str, Any]
+    query: str
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    metadata: Optional[Dict[str, Any]] = None
+    kwargs: Any = None
+    type: Literal["on_retriever_start"] = "on_retriever_start"
+
+
+class OnRetrieverError(BaseModel):
+    """On Retriever Error Callback Event."""
+
+    error: Error
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_retriever_error"] = "on_retriever_error"
+
+
+class OnRetrieverEnd(BaseModel):
+    """On Retriever End Callback Event."""
+
+    documents: Sequence[Document]
+    run_id: UUID
+    parent_run_id: Optional[UUID] = None
+    tags: Optional[List[str]] = None
+    kwargs: Any = None
+    type: Literal["on_retriever_end"] = "on_retriever_end"
+
+
+class CallbackEvent(BaseModel):
+    __root__: Union[
+        OnChainStart,
+        OnChainEnd,
+        OnChainError,
+        OnChatModelStart,
+        OnLLMStart,
+        OnLLMEnd,
+        OnToolStart,
+        OnToolEnd,
+        OnToolError,
+        OnRetrieverStart,
+        OnRetrieverEnd,
+        OnRetrieverError,
+    ]

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "langserve"
-version = "0.0.13"
+version = "0.0.39"
 description = ""
 readme = "README.md"
 authors = ["LangChain"]
@@ -12,11 +12,12 @@ include = ["langserve/playground/dist/**/*"]
 [tool.poetry.dependencies]
 python = "^3.8.1"
 httpx = ">=0.23.0" # May be able to decrease this version
-fastapi = {version = ">=0.90.1", optional = true}
+fastapi = {version = ">=0.90.1,<1", optional = true}
 sse-starlette = {version = "^1.3.0", optional = true}
 httpx-sse = {version = ">=0.3.1", optional = true}
-pydantic = "^1"
-langchain = ">=0.0.316"
+pydantic = ">=1"
+langchain = ">=0.0.333"
+orjson = ">=2"
 
 [tool.poetry.group.dev.dependencies]
 jupyterlab = "^3.6.1"
@@ -27,8 +28,7 @@ httpx-sse = ">=0.3.1"
 [tool.poetry.group.typing.dependencies]
 
 [tool.poetry.group.lint.dependencies]
-black = { version="^23.1.0", extras=["jupyter"] }
-ruff = "^0.0.255"
+ruff = "^0.1.4"
 codespell = "^2.2.0"
 
 [tool.poetry.group.test.dependencies]
@@ -38,6 +38,7 @@ pytest-asyncio = "^0.21.1"
 pytest-mock = "^3.11.1"
 pytest-socket = "^0.6.0"
 pytest-watch = "^4.2.0"
+pytest-timeout = "^2.2.0"
 
 [tool.poetry.group.examples.dependencies]
 openai = "^0.28.0"
@@ -84,3 +85,15 @@ omit = [
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.pytest.ini_options]
+# --strict-markers will raise errors on unknown marks.
+# https://docs.pytest.org/en/7.1.x/how-to/mark.html#raising-errors-on-unknown-marks
+#
+# https://docs.pytest.org/en/7.1.x/reference/reference.html
+# --strict-config       any warnings encountered while parsing the `pytest`
+#                       section of the configuration file raise errors.
+addopts = "--strict-markers --strict-config --durations=5 -vv"
+# Global timeout for all tests. There shuold be a good reason for a test to
+# take more than 5 seconds
+timeout = 5
+asyncio_mode = "auto"

tests/unit_tests/test_callbacks.py

@@ -0,0 +1,59 @@
+import uuid
+
+from langserve.callbacks import AsyncEventAggregatorCallback, replace_uuids
+
+
+async def test_event_aggregator() -> None:
+    """Test that the event aggregator is aggregating events."""
+
+    from langchain.llms import FakeListLLM
+    from langchain.prompts import ChatPromptTemplate
+
+    prompt = ChatPromptTemplate.from_template("{question}")
+    llm = FakeListLLM(responses=["hello", "world"])
+
+    chain = prompt | llm
+    callback = AsyncEventAggregatorCallback()
+    assert callback.callback_events == []
+    assert chain.invoke({"question": "hello"}, {"callbacks": [callback]}) == "hello"
+    callback_events = callback.callback_events
+    assert isinstance(callback_events, list)
+    assert len(callback_events) == 6
+    assert [event["type"] for event in callback_events] == [
+        "on_chain_start",
+        "on_chain_start",
+        "on_chain_end",
+        "on_llm_start",
+        "on_llm_end",
+        "on_chain_end",
+    ]
+
+
+def test_replace_uuids() -> None:
+    """Test replace uuids in place."""
+    uuid1 = uuid.UUID(int=1)
+    uuid2 = uuid.UUID(int=2)
+
+    events = [
+        {
+            "type": "on_llm_start",
+            "run_id": uuid1,
+            "parent_run_id": None,
+        },
+        {
+            "type": "on_llm_start",
+            "run_id": uuid1,
+            "parent_run_id": uuid2,
+        },
+    ]
+    new_events = replace_uuids(events)
+    # Assert original event is unchanged
+    assert events[0]["run_id"] == uuid1
+    assert isinstance(new_events, list)
+    assert len(new_events) == 2
+
+    assert new_events[0]["run_id"] != uuid1
+    assert new_events[1]["run_id"] != uuid2
+    assert new_events[0]["run_id"] == new_events[1]["run_id"]
+    assert new_events[0]["run_id"] != new_events[1]["parent_run_id"]
+    assert new_events[0]["parent_run_id"] is None

tests/unit_tests/test_playground.py

@@ -0,0 +1,24 @@
+import pytest
+
+from langserve.playground import _get_mimetype
+
+
+@pytest.mark.parametrize(
+    "file_extension, expected_mimetype",
+    [
+        ("js", "application/javascript"),
+        ("css", "text/css"),
+        ("htm", "text/html"),
+        ("html", "text/html"),
+        ("txt", "text/plain"),  # An example of an unknown extension using guess_type
+    ],
+)
+def test_get_mimetype(file_extension: str, expected_mimetype: str) -> None:
+    # Create a filename with the given extension
+    filename = f"test_file.{file_extension}"
+
+    # Call the _get_mimetype function with the test filename
+    mimetype = _get_mimetype(filename)
+
+    # Check if the returned mimetype matches the expected one
+    assert mimetype == expected_mimetype

tests/unit_tests/test_serialization.py

@@ -1,3 +1,6 @@
+import datetime
+import uuid
+from enum import Enum
 from typing import Any
 
 import pytest
@@ -6,13 +9,14 @@ from langchain.schema.messages import (
     HumanMessageChunk,
     SystemMessage,
 )
+from langchain.schema.output import ChatGeneration
 
 try:
     from pydantic.v1 import BaseModel
 except ImportError:
     from pydantic import BaseModel
 
-from langserve.serialization import simple_dumps, simple_loads
+from langserve.serialization import WellKnownLCSerializer, load_events
 
 
 @pytest.mark.parametrize(
@@ -39,17 +43,22 @@ from langserve.serialization import simple_dumps, simple_loads
             "numbers": [1, 2, 3],
             "boom": "Hello, world!",
         },
+        [ChatGeneration(message=HumanMessage(content="Hello"))],
     ],
 )
 def test_serialization(data: Any) -> None:
     """There and back again! :)"""
     # Test encoding
-    assert isinstance(simple_dumps(data), str)
+    lc_serializer = WellKnownLCSerializer()
+
+    assert isinstance(lc_serializer.dumps(data), bytes)
+    # Translate to python primitives and load back into object
+    assert lc_serializer.loadd(lc_serializer.dumpd(data)) == data
     # Test simple equality (does not include pydantic class names)
-    assert simple_loads(simple_dumps(data)) == data
+    assert lc_serializer.loads(lc_serializer.dumps(data)) == data
     # Test full representation equality (includes pydantic class names)
     assert _get_full_representation(
-        simple_loads(simple_dumps(data))
+        lc_serializer.loads(lc_serializer.dumps(data))
     ) == _get_full_representation(data)
 
 
@@ -75,3 +84,102 @@ def _get_full_representation(data: Any) -> Any:
         return data.schema()
     else:
         return data
+
+
+@pytest.mark.parametrize(
+    "data,expected",
+    [
+        ([], []),
+        (
+            [
+                {
+                    "type": "on_llm_start",
+                    "serialized": {},
+                    "prompts": [],
+                    "run_id": str(uuid.UUID(int=2)),
+                    "parent_run_id": str(uuid.UUID(int=1)),
+                    "tags": ["h"],
+                    "metadata": {},
+                    "kwargs": {},
+                }
+            ],
+            [
+                {
+                    "type": "on_llm_start",
+                    "serialized": {},
+                    "prompts": [],
+                    "run_id": uuid.UUID(int=2),
+                    "parent_run_id": uuid.UUID(int=1),
+                    "tags": ["h"],
+                    "metadata": {},
+                    "kwargs": {},
+                }
+            ],
+        ),
+    ],
+)
+def test_decode_events(data: Any, expected: Any) -> None:
+    """Test decoding events."""
+    assert load_events(data) == expected
+
+
+class SimpleEnum(Enum):
+    a = "a"
+    b = "b"
+
+
+class SimpleModel(BaseModel):
+    x: int
+    y: SimpleEnum
+    z: uuid.UUID
+    dt: datetime.datetime
+    d: datetime.date
+    t: datetime.time
+
+
+@pytest.mark.parametrize(
+    "obj, expected",
+    [
+        ({"key": "value"}, {"key": "value"}),
+        ([1, 2, 3], [1, 2, 3]),
+        (123, 123),
+        (uuid.UUID(int=1), "00000000-0000-0000-0000-000000000001"),
+        (datetime.datetime(2020, 1, 1), "2020-01-01T00:00:00"),
+        (datetime.date(2020, 1, 1), "2020-01-01"),
+        (datetime.time(0, 0, 0), "00:00:00"),
+        (datetime.time(0, 0, 0, 1), "00:00:00.000001"),
+        (SimpleEnum.a, "a"),
+        (
+            SimpleModel(
+                x=1,
+                y=SimpleEnum.a,
+                z=uuid.UUID(int=1),
+                dt=datetime.datetime(2020, 1, 1),
+                d=datetime.date(2020, 1, 1),
+                t=datetime.time(0, 0, 0),
+            ),
+            {
+                "x": 1,
+                "y": "a",
+                "z": "00000000-0000-0000-0000-000000000001",
+                "dt": "2020-01-01T00:00:00",
+                "d": "2020-01-01",
+                "t": "00:00:00",
+            },
+        ),
+        ("string", "string"),
+        (True, True),
+        (None, None),
+    ],
+)
+def test_encoding_of_well_known_types(obj: Any, expected: str) -> None:
+    """Test encoding of well known types.
+
+    This tests verifies that our custom serializer is able to encode some well
+    known types; e.g., uuid, datetime, date, time
+
+    It doesn't handle types like Decimal or frozenset etc just yet while we determine
+    how to roll out a more complete solution.
+    """
+    lc_serializer = WellKnownLCSerializer()
+    assert lc_serializer.dumpd(obj) == expected

tests/unit_tests/test_validation.py

@@ -1,10 +1,12 @@
 from typing import List, Optional
+from unittest.mock import MagicMock
 
 import pytest
+from fastapi import Request
 from langchain.prompts import PromptTemplate
 from langchain.schema.runnable.utils import ConfigurableField
 
-from langserve.server import _unpack_config
+from langserve.api_handler import _unpack_request_config
 
 try:
     from pydantic.v1 import BaseModel, ValidationError
@@ -138,7 +140,7 @@ def test_validation(test_case) -> None:
             model(**test_case)
 
 
-def test_invoke_request_with_runnables() -> None:
+async def test_invoke_request_with_runnables() -> None:
     """Test that the invoke request model is created correctly."""
     runnable = PromptTemplate.from_template("say hello to {name}").configurable_fields(
         template=ConfigurableField(
@@ -151,12 +153,15 @@ def test_invoke_request_with_runnables() -> None:
     Model = create_invoke_request_model("", runnable.input_schema, config)
 
     assert (
-        _unpack_config(
+        await _unpack_request_config(
             Model(
                 input={"name": "bob"},
             ).config,
-            keys=[],
+            config_keys=[],
             model=config,
+            request=MagicMock(Request),
+            per_req_config_modifier=lambda x, y: x,
+            server_config=None,
         )
         == {}
     )
@@ -178,6 +183,13 @@ def test_invoke_request_with_runnables() -> None:
         "template": "goodbye {name}",
     }
 
-    assert _unpack_config(request.config, keys=["configurable"], model=config) == {
+    assert await _unpack_request_config(
+        request.config,
+        config_keys=["configurable"],
+        model=config,
+        request=MagicMock(Request),
+        per_req_config_modifier=lambda x, y: x,
+        server_config=None,
+    ) == {
         "configurable": {"template": "goodbye {name}"},
     }

tests/unit_tests/utils.py

@@ -1,10 +1,13 @@
-from typing import Any, List, Mapping, Optional
+from typing import Any, Dict, List, Mapping, Optional
+from uuid import UUID
 
 from langchain.callbacks.manager import (
     AsyncCallbackManagerForLLMRun,
     CallbackManagerForLLMRun,
 )
+from langchain.callbacks.tracers.base import BaseTracer
 from langchain.llms.base import LLM
+from langsmith.schemas import Run
 
 
 class FakeListLLM(LLM):
@@ -52,3 +55,42 @@ class FakeListLLM(LLM):
     @property
     def _identifying_params(self) -> Mapping[str, Any]:
         return {"responses": self.responses}
+
+
+class FakeTracer(BaseTracer):
+    """Fake tracer that records LangChain execution.
+
+    It replaces run ids with deterministic UUIDs."""
+
+    def __init__(self) -> None:
+        """Initialize the tracer."""
+        super().__init__()
+        self.runs: List[Run] = []
+        self.uuids_map: Dict[UUID, UUID] = {}
+        self.uuids_generator = (
+            UUID(f"00000000-0000-4000-8000-{i:012}", version=4) for i in range(10_000)
+        )
+
+    def _replace_uuid(self, uuid: UUID) -> UUID:
+        """Replace a UUID with a deterministic one."""
+        if uuid not in self.uuids_map:
+            self.uuids_map[uuid] = next(self.uuids_generator)
+        return self.uuids_map[uuid]
+
+    def _copy_run(self, run: Run) -> Run:
+        """Copy a run, replacing UUIDs."""
+        return run.copy(
+            update={
+                "id": self._replace_uuid(run.id),
+                "parent_run_id": self.uuids_map[run.parent_run_id]
+                if run.parent_run_id
+                else None,
+                "child_runs": [self._copy_run(child) for child in run.child_runs],
+                "execution_order": None,
+                "child_execution_order": None,
+            }
+        )
+
+    def _persist_run(self, run: Run) -> None:
+        """Persist a run."""
+        self.runs.append(self._copy_run(run))