-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into brace/runnable-tool-docs
- Loading branch information
Showing
128 changed files
with
5,869 additions
and
3,711 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
560 changes: 280 additions & 280 deletions
560
.yarn/releases/yarn-3.4.1.cjs → .yarn/releases/yarn-3.5.1.cjs
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ | |
| "@langchain/textsplitters": "npm:@langchain/textsplitters", | ||
| "@langchain/google-vertexai-web": "npm:@langchain/google-vertexai-web", | ||
| "@langchain/mistralai": "npm:@langchain/mistralai", | ||
| "@langchain/core/": "npm:/@langchain/core/", | ||
| "@langchain/core/": "npm:/@langchain/core@0.2.16/", | ||
| "@langchain/pinecone": "npm:@langchain/pinecone", | ||
| "@langchain/google-common": "npm:@langchain/google-common", | ||
| "@langchain/langgraph": "npm:/@langchain/[email protected]", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
232 changes: 232 additions & 0 deletions
232
docs/core_docs/docs/how_to/callbacks_custom_events.ipynb
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| { | ||
| "cells": [ | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# How to dispatch custom callback events\n", | ||
| "\n", | ||
| ":::info Prerequisites\n", | ||
| "\n", | ||
| "This guide assumes familiarity with the following concepts:\n", | ||
| "\n", | ||
| "- [Callbacks](/docs/concepts/#callbacks)\n", | ||
| "- [Custom callback handlers](/docs/how_to/custom_callbacks)\n", | ||
| "- [Stream Events API](/docs/concepts#streamevents)\n", | ||
| "\n", | ||
| ":::\n", | ||
| "\n", | ||
| "In some situations, you may want to dipsatch a custom callback event from within a [Runnable](/docs/concepts/#runnable-interface) so it can be surfaced\n", | ||
| "in a custom callback handler or via the [Stream Events API](/docs/concepts/#streamevents).\n", | ||
| "\n", | ||
| "For example, if you have a long running tool with multiple steps, you can dispatch custom events between the steps and use these custom events to monitor progress.\n", | ||
| "You could also surface these custom events to an end user of your application to show them how the current task is progressing.\n", | ||
| "\n", | ||
| "To dispatch a custom event you need to decide on two attributes for the event: the `name` and the `data`.\n", | ||
| "\n", | ||
| "| Attribute | Type | Description |\n", | ||
| "|-----------|------|----------------------------------------------------------------------------------------------------------|\n", | ||
| "| name | string | A user defined name for the event. |\n", | ||
| "| data | any | The data associated with the event. This can be anything, though we suggest making it JSON serializable. |\n", | ||
| "\n", | ||
| "\n", | ||
| ":::info\n", | ||
| "- Custom callback events can only be dispatched from within an existing `Runnable`.\n", | ||
| "- If using `streamEvents`, you must use `version: \"v2\"` to consume custom events.\n", | ||
| "- Sending or rendering custom callback events in LangSmith is not yet supported.\n", | ||
| ":::\n", | ||
| "\n", | ||
| "## Stream Events API\n", | ||
| "\n", | ||
| "The most useful way to consume custom events is via the [`.streamEvents()`](/docs/concepts/#streamevents) method.\n", | ||
| "\n", | ||
| "We can use the `dispatchCustomEvent` API to emit custom events from this method. \n", | ||
| "\n", | ||
| "```{=mdx}\n", | ||
| ":::caution Compatibility\n", | ||
| "Dispatching custom callback events requires `@langchain/core>=0.2.16`. See [this guide](/docs/how_to/installation/#installing-integration-packages) for some considerations to take when upgrading `@langchain/core`.\n", | ||
| "\n", | ||
| "The default entrypoint below triggers an import and initialization of [`async_hooks`](https://nodejs.org/api/async_hooks.html) to enable automatic `RunnableConfig` passing, which is not supported in all environments. If you see import issues, you must import from `@langchain/callbacks/dispatch/web` and propagate the `RunnableConfig` object manually (see example below).\n", | ||
| ":::\n", | ||
| "```" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 3, | ||
| "metadata": {}, | ||
| "outputs": [ | ||
| { | ||
| "name": "stdout", | ||
| "output_type": "stream", | ||
| "text": [ | ||
| "{\n", | ||
| " event: 'on_custom_event',\n", | ||
| " run_id: '9eac217d-3a2d-4563-a91f-3bd49bee4b3d',\n", | ||
| " name: 'event1',\n", | ||
| " tags: [],\n", | ||
| " metadata: {},\n", | ||
| " data: { reversed: 'dlrow olleh' }\n", | ||
| "}\n", | ||
| "{\n", | ||
| " event: 'on_custom_event',\n", | ||
| " run_id: '9eac217d-3a2d-4563-a91f-3bd49bee4b3d',\n", | ||
| " name: 'event2',\n", | ||
| " tags: [],\n", | ||
| " metadata: {},\n", | ||
| " data: 5\n", | ||
| "}\n" | ||
| ] | ||
| } | ||
| ], | ||
| "source": [ | ||
| "import { RunnableLambda } from \"@langchain/core/runnables\";\n", | ||
| "import { dispatchCustomEvent } from \"@langchain/core/callbacks/dispatch\";\n", | ||
| "\n", | ||
| "const reflect = RunnableLambda.from(async (value: string) => {\n", | ||
| " await dispatchCustomEvent(\"event1\", { reversed: value.split(\"\").reverse().join(\"\") });\n", | ||
| " await dispatchCustomEvent(\"event2\", 5);\n", | ||
| " return value;\n", | ||
| "});\n", | ||
| "\n", | ||
| "const eventStream = await reflect.streamEvents(\"hello world\", { version: \"v2\" });\n", | ||
| "\n", | ||
| "for await (const event of eventStream) {\n", | ||
| " if (event.event === \"on_custom_event\") {\n", | ||
| " console.log(event);\n", | ||
| " }\n", | ||
| "}" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "If you are in a web environment that does not support `async_hooks`, you must import from the web entrypoint and propagate the config manually instead:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 4, | ||
| "metadata": {}, | ||
| "outputs": [ | ||
| { | ||
| "name": "stdout", | ||
| "output_type": "stream", | ||
| "text": [ | ||
| "{\n", | ||
| " event: 'on_custom_event',\n", | ||
| " run_id: 'dee1e4f0-c5ff-4118-9391-461a0dcc4cb2',\n", | ||
| " name: 'event1',\n", | ||
| " tags: [],\n", | ||
| " metadata: {},\n", | ||
| " data: { reversed: 'dlrow olleh' }\n", | ||
| "}\n", | ||
| "{\n", | ||
| " event: 'on_custom_event',\n", | ||
| " run_id: 'dee1e4f0-c5ff-4118-9391-461a0dcc4cb2',\n", | ||
| " name: 'event2',\n", | ||
| " tags: [],\n", | ||
| " metadata: {},\n", | ||
| " data: 5\n", | ||
| "}\n" | ||
| ] | ||
| } | ||
| ], | ||
| "source": [ | ||
| "import { RunnableConfig, RunnableLambda } from \"@langchain/core/runnables\";\n", | ||
| "import { dispatchCustomEvent as dispatchCustomEventWeb } from \"@langchain/core/callbacks/dispatch/web\";\n", | ||
| "\n", | ||
| "const reflect = RunnableLambda.from(async (value: string, config?: RunnableConfig) => {\n", | ||
| " await dispatchCustomEventWeb(\"event1\", { reversed: value.split(\"\").reverse().join(\"\") }, config);\n", | ||
| " await dispatchCustomEventWeb(\"event2\", 5, config);\n", | ||
| " return value;\n", | ||
| "});\n", | ||
| "\n", | ||
| "const eventStream = await reflect.streamEvents(\"hello world\", { version: \"v2\" });\n", | ||
| "\n", | ||
| "for await (const event of eventStream) {\n", | ||
| " if (event.event === \"on_custom_event\") {\n", | ||
| " console.log(event);\n", | ||
| " }\n", | ||
| "}" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## Callback Handler\n", | ||
| "\n", | ||
| "Let's see how to emit custom events with `dispatchCustomEvent`.\n", | ||
| "\n", | ||
| "Remember, you **must** call `dispatchCustomEvent` from within an existing `Runnable`." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 6, | ||
| "metadata": {}, | ||
| "outputs": [ | ||
| { | ||
| "name": "stdout", | ||
| "output_type": "stream", | ||
| "text": [ | ||
| "event1 { reversed: 'dlrow olleh' } 9c3770ac-c83d-4626-9643-b5fd80eb5431\n", | ||
| "event2 5 9c3770ac-c83d-4626-9643-b5fd80eb5431\n", | ||
| "hello world\n" | ||
| ] | ||
| } | ||
| ], | ||
| "source": [ | ||
| "import { RunnableConfig, RunnableLambda } from \"@langchain/core/runnables\";\n", | ||
| "import { dispatchCustomEvent } from \"@langchain/core/callbacks/dispatch\";\n", | ||
| "\n", | ||
| "const reflect = RunnableLambda.from(async (value: string) => {\n", | ||
| " await dispatchCustomEvent(\"event1\", { reversed: value.split(\"\").reverse().join(\"\") });\n", | ||
| " await dispatchCustomEvent(\"event2\", 5);\n", | ||
| " return value;\n", | ||
| "});\n", | ||
| "\n", | ||
| "await reflect.invoke(\"hello world\", {\n", | ||
| " callbacks: [{\n", | ||
| " handleCustomEvent(eventName, data, runId) {\n", | ||
| " console.log(eventName, data, runId);\n", | ||
| " },\n", | ||
| " }]\n", | ||
| "});" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## Related\n", | ||
| "\n", | ||
| "You've now seen how to emit custom events from within your chains.\n", | ||
| "\n", | ||
| "You can check out the more in depth guide for [stream events](/docs/how_to/streaming/#using-stream-events) for more ways to parse and receive intermediate steps from your chains." | ||
| ] | ||
| } | ||
| ], | ||
| "metadata": { | ||
| "kernelspec": { | ||
| "display_name": "TypeScript", | ||
| "language": "typescript", | ||
| "name": "tslab" | ||
| }, | ||
| "language_info": { | ||
| "codemirror_mode": { | ||
| "mode": "typescript", | ||
| "name": "javascript", | ||
| "typescript": true | ||
| }, | ||
| "file_extension": ".ts", | ||
| "mimetype": "text/typescript", | ||
| "name": "typescript", | ||
| "version": "3.7.2" | ||
| } | ||
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 4 | ||
| } |
Oops, something went wrong.