From 08e5e98d8453babb5031a90c2859e33149dc8214 Mon Sep 17 00:00:00 2001 From: carlosrcoelho Date: Thu, 22 Jun 2023 10:41:44 -0300 Subject: [PATCH] Adjusted broken links. Added more info in some sections. --- docs/.docusaurus/client-modules.js | 10 +- .../site-docs-gcp-deployment-md-960.json | 2 +- .../site-docs-jina-deployment-md-0be.json | 2 +- .../version-current-metadata-prop-751.json | 4 +- .../docusaurus-debug-all-content-673.json | 10 +- docs/.docusaurus/docusaurus.config.mjs | 4 +- docs/.docusaurus/registry.js | 6 +- docs/.docusaurus/routes.js | 18 ++-- docs/.docusaurus/routesChunkNames.json | 36 +++---- docs/docs/gcp-deployment.md | 12 ++- docs/docs/how-contribute.md | 18 +++- docs/docs/jina-deployment.md | 102 ++++++++++-------- docs/docs/multiple-vectorstores.mdx | 2 +- docs/docs/python-function.mdx | 9 +- docs/docs/serp-api-tool.mdx | 6 +- 15 files changed, 136 insertions(+), 105 deletions(-) diff --git a/docs/.docusaurus/client-modules.js b/docs/.docusaurus/client-modules.js index c49ad1f52..6df0849d8 100644 --- a/docs/.docusaurus/client-modules.js +++ b/docs/.docusaurus/client-modules.js @@ -1,7 +1,7 @@ export default [ - require('/Users/rodrigonader/Repositories/logspace/langflow/docs/node_modules/infima/dist/css/default/default.css'), - require('/Users/rodrigonader/Repositories/logspace/langflow/docs/node_modules/@docusaurus/theme-classic/lib/prism-include-languages'), - require('/Users/rodrigonader/Repositories/logspace/langflow/docs/node_modules/@docusaurus/theme-classic/lib/nprogress'), - require('/Users/rodrigonader/Repositories/logspace/langflow/docs/src/css/custom.css'), - require('/Users/rodrigonader/Repositories/logspace/langflow/docs/node_modules/docusaurus-plugin-image-zoom/lib/zoom'), + require('/home/carlos/repo/logspace/langflow/docs/node_modules/infima/dist/css/default/default.css'), + require('/home/carlos/repo/logspace/langflow/docs/node_modules/@docusaurus/theme-classic/lib/prism-include-languages'), + require('/home/carlos/repo/logspace/langflow/docs/node_modules/@docusaurus/theme-classic/lib/nprogress'), + require('/home/carlos/repo/logspace/langflow/docs/src/css/custom.css'), + require('/home/carlos/repo/logspace/langflow/docs/node_modules/docusaurus-plugin-image-zoom/lib/zoom'), ]; diff --git a/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-gcp-deployment-md-960.json b/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-gcp-deployment-md-960.json index a9b06c481..0392ae774 100644 --- a/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-gcp-deployment-md-960.json +++ b/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-gcp-deployment-md-960.json @@ -2,7 +2,7 @@ "unversionedId": "gcp-deployment", "id": "gcp-deployment", "title": "Deploy on Google Cloud Platform", - "description": "Run Langflow from a New Google Cloud Project", + "description": "Run LangFlow from a New Google Cloud Project", "source": "@site/docs/gcp-deployment.md", "sourceDirName": ".", "slug": "/gcp-deployment", diff --git a/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-jina-deployment-md-0be.json b/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-jina-deployment-md-0be.json index 6f95eb1f9..cd22fb37e 100644 --- a/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-jina-deployment-md-0be.json +++ b/docs/.docusaurus/docusaurus-plugin-content-docs/default/site-docs-jina-deployment-md-0be.json @@ -2,7 +2,7 @@ "unversionedId": "jina-deployment", "id": "jina-deployment", "title": "Deploy on Jina AI Cloud", - "description": "Langflow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.", + "description": "LangFlow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.", "source": "@site/docs/jina-deployment.md", "sourceDirName": ".", "slug": "/jina-deployment", diff --git a/docs/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json b/docs/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json index 516819331..197855361 100644 --- a/docs/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json +++ b/docs/.docusaurus/docusaurus-plugin-content-docs/default/version-current-metadata-prop-751.json @@ -223,7 +223,7 @@ "gcp-deployment": { "id": "gcp-deployment", "title": "Deploy on Google Cloud Platform", - "description": "Run Langflow from a New Google Cloud Project", + "description": "Run LangFlow from a New Google Cloud Project", "sidebar": "docs" }, "github-issues": { @@ -265,7 +265,7 @@ "jina-deployment": { "id": "jina-deployment", "title": "Deploy on Jina AI Cloud", - "description": "Langflow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.", + "description": "LangFlow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.", "sidebar": "docs" }, "midjourney-prompt-chain": { diff --git a/docs/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json b/docs/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json index 31632ecf6..5490f0df4 100644 --- a/docs/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json +++ b/docs/.docusaurus/docusaurus-plugin-debug/default/docusaurus-debug-all-content-673.json @@ -13,9 +13,9 @@ "tagsPath": "/tags", "isLast": true, "routePriority": -1, - "sidebarFilePath": "/Users/rodrigonader/Repositories/logspace/langflow/docs/sidebars.js", - "contentPath": "/Users/rodrigonader/Repositories/logspace/langflow/docs/docs", - "contentPathLocalized": "/Users/rodrigonader/Repositories/logspace/langflow/docs/i18n/en/docusaurus-plugin-content-docs/current", + "sidebarFilePath": "/home/carlos/repo/logspace/langflow/docs/sidebars.js", + "contentPath": "/home/carlos/repo/logspace/langflow/docs/docs", + "contentPathLocalized": "/home/carlos/repo/logspace/langflow/docs/i18n/en/docusaurus-plugin-content-docs/current", "docs": [ { "unversionedId": "buffer-memory", @@ -201,7 +201,7 @@ "unversionedId": "gcp-deployment", "id": "gcp-deployment", "title": "Deploy on Google Cloud Platform", - "description": "Run Langflow from a New Google Cloud Project", + "description": "Run LangFlow from a New Google Cloud Project", "source": "@site/docs/gcp-deployment.md", "sourceDirName": ".", "slug": "/gcp-deployment", @@ -358,7 +358,7 @@ "unversionedId": "jina-deployment", "id": "jina-deployment", "title": "Deploy on Jina AI Cloud", - "description": "Langflow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.", + "description": "LangFlow integrates with langchain-serve to provide a one-command deployment to Jina AI Cloud.", "source": "@site/docs/jina-deployment.md", "sourceDirName": ".", "slug": "/jina-deployment", diff --git a/docs/.docusaurus/docusaurus.config.mjs b/docs/.docusaurus/docusaurus.config.mjs index 84623a39f..a0ec03b52 100644 --- a/docs/.docusaurus/docusaurus.config.mjs +++ b/docs/.docusaurus/docusaurus.config.mjs @@ -32,11 +32,11 @@ export default { { "docs": { "routeBasePath": "/", - "sidebarPath": "/Users/rodrigonader/Repositories/logspace/langflow/docs/sidebars.js", + "sidebarPath": "/home/carlos/repo/logspace/langflow/docs/sidebars.js", "path": "docs" }, "theme": { - "customCss": "/Users/rodrigonader/Repositories/logspace/langflow/docs/src/css/custom.css" + "customCss": "/home/carlos/repo/logspace/langflow/docs/src/css/custom.css" } } ] diff --git a/docs/.docusaurus/registry.js b/docs/.docusaurus/registry.js index d69c967ec..3e1a2407b 100644 --- a/docs/.docusaurus/registry.js +++ b/docs/.docusaurus/registry.js @@ -30,7 +30,7 @@ export default { 'content---multiple-vectorstores-3-c-5-02d': [() => import(/* webpackChunkName: 'content---multiple-vectorstores-3-c-5-02d' */ '@site/docs/multiple-vectorstores.mdx'), '@site/docs/multiple-vectorstores.mdx', require.resolveWeak('@site/docs/multiple-vectorstores.mdx')], 'content---python-functionc-5-e-14f': [() => import(/* webpackChunkName: 'content---python-functionc-5-e-14f' */ '@site/docs/python-function.mdx'), '@site/docs/python-function.mdx', require.resolveWeak('@site/docs/python-function.mdx')], 'content---serp-api-toolaea-bee': [() => import(/* webpackChunkName: 'content---serp-api-toolaea-bee' */ '@site/docs/serp-api-tool.mdx'), '@site/docs/serp-api-tool.mdx', require.resolveWeak('@site/docs/serp-api-tool.mdx')], - 'plugin---46-c-fdc': [() => import(/* webpackChunkName: 'plugin---46-c-fdc' */ '/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json'), '/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json', require.resolveWeak('/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json')], - 'plugin---docusaurus-debugf-67-8e6': [() => import(/* webpackChunkName: 'plugin---docusaurus-debugf-67-8e6' */ '/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json'), '/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json', require.resolveWeak('/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json')], - 'plugin---markdown-pagea-28-82c': [() => import(/* webpackChunkName: 'plugin---markdown-pagea-28-82c' */ '/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json'), '/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json', require.resolveWeak('/Users/rodrigonader/Repositories/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json')], + 'plugin---8-d-8-3f8': [() => import(/* webpackChunkName: 'plugin---8-d-8-3f8' */ '/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json'), '/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json', require.resolveWeak('/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json')], + 'plugin---docusaurus-debug-667-210': [() => import(/* webpackChunkName: 'plugin---docusaurus-debug-667-210' */ '/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json'), '/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json', require.resolveWeak('/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-debug/default/plugin-route-context-module-100.json')], + 'plugin---markdown-page-3-a-8-829': [() => import(/* webpackChunkName: 'plugin---markdown-page-3-a-8-829' */ '/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json'), '/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json', require.resolveWeak('/home/carlos/repo/logspace/langflow/docs/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json')], 'versionMetadata---935-fcf': [() => import(/* webpackChunkName: 'versionMetadata---935-fcf' */ '~docs/default/version-current-metadata-prop-751.json'), '~docs/default/version-current-metadata-prop-751.json', require.resolveWeak('~docs/default/version-current-metadata-prop-751.json')],}; diff --git a/docs/.docusaurus/routes.js b/docs/.docusaurus/routes.js index d17bcae25..8c3e76596 100644 --- a/docs/.docusaurus/routes.js +++ b/docs/.docusaurus/routes.js @@ -4,47 +4,47 @@ import ComponentCreator from '@docusaurus/ComponentCreator'; export default [ { path: '/__docusaurus/debug', - component: ComponentCreator('/__docusaurus/debug', 'd49'), + component: ComponentCreator('/__docusaurus/debug', '437'), exact: true }, { path: '/__docusaurus/debug/config', - component: ComponentCreator('/__docusaurus/debug/config', 'c5a'), + component: ComponentCreator('/__docusaurus/debug/config', 'f3c'), exact: true }, { path: '/__docusaurus/debug/content', - component: ComponentCreator('/__docusaurus/debug/content', 'c19'), + component: ComponentCreator('/__docusaurus/debug/content', '5ed'), exact: true }, { path: '/__docusaurus/debug/globalData', - component: ComponentCreator('/__docusaurus/debug/globalData', '338'), + component: ComponentCreator('/__docusaurus/debug/globalData', '6e2'), exact: true }, { path: '/__docusaurus/debug/metadata', - component: ComponentCreator('/__docusaurus/debug/metadata', '39f'), + component: ComponentCreator('/__docusaurus/debug/metadata', '00b'), exact: true }, { path: '/__docusaurus/debug/registry', - component: ComponentCreator('/__docusaurus/debug/registry', 'e70'), + component: ComponentCreator('/__docusaurus/debug/registry', '46d'), exact: true }, { path: '/__docusaurus/debug/routes', - component: ComponentCreator('/__docusaurus/debug/routes', 'b1f'), + component: ComponentCreator('/__docusaurus/debug/routes', 'ce2'), exact: true }, { path: '/markdown-page', - component: ComponentCreator('/markdown-page', 'b57'), + component: ComponentCreator('/markdown-page', 'd68'), exact: true }, { path: '/', - component: ComponentCreator('/', '5b5'), + component: ComponentCreator('/', '6c4'), routes: [ { path: '/', diff --git a/docs/.docusaurus/routesChunkNames.json b/docs/.docusaurus/routesChunkNames.json index 67ab1e63b..dcd3eaa75 100644 --- a/docs/.docusaurus/routesChunkNames.json +++ b/docs/.docusaurus/routesChunkNames.json @@ -1,58 +1,58 @@ { - "/__docusaurus/debug-d49": { + "/__docusaurus/debug-437": { "__comp": "__comp---theme-debug-config-23-a-2ff", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" } }, - "/__docusaurus/debug/config-c5a": { + "/__docusaurus/debug/config-f3c": { "__comp": "__comp---theme-debug-config-23-a-2ff", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" } }, - "/__docusaurus/debug/content-c19": { + "/__docusaurus/debug/content-5ed": { "__comp": "__comp---theme-debug-contentba-8-ce7", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" }, "allContent": "allContent---docusaurus-debug-content-246-9aa" }, - "/__docusaurus/debug/globalData-338": { + "/__docusaurus/debug/globalData-6e2": { "__comp": "__comp---theme-debug-global-dataede-0fa", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" } }, - "/__docusaurus/debug/metadata-39f": { + "/__docusaurus/debug/metadata-00b": { "__comp": "__comp---theme-debug-site-metadata-68-e-3d4", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" } }, - "/__docusaurus/debug/registry-e70": { + "/__docusaurus/debug/registry-46d": { "__comp": "__comp---theme-debug-registry-679-501", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" } }, - "/__docusaurus/debug/routes-b1f": { + "/__docusaurus/debug/routes-ce2": { "__comp": "__comp---theme-debug-routes-946-699", "__context": { - "plugin": "plugin---docusaurus-debugf-67-8e6" + "plugin": "plugin---docusaurus-debug-667-210" } }, - "/markdown-page-b57": { + "/markdown-page-d68": { "__comp": "__comp---theme-mdx-page-1-f-3-b90", "__context": { - "plugin": "plugin---markdown-pagea-28-82c" + "plugin": "plugin---markdown-page-3-a-8-829" }, "content": "content---markdown-page-393-028" }, - "/-5b5": { + "/-6c4": { "__comp": "__comp---theme-doc-page-1-be-9be", "__context": { - "plugin": "plugin---46-c-fdc" + "plugin": "plugin---8-d-8-3f8" }, "versionMetadata": "versionMetadata---935-fcf" }, diff --git a/docs/docs/gcp-deployment.md b/docs/docs/gcp-deployment.md index 0b18f7b36..2a34ab767 100644 --- a/docs/docs/gcp-deployment.md +++ b/docs/docs/gcp-deployment.md @@ -1,16 +1,18 @@ # Deploy on Google Cloud Platform -## Run Langflow from a New Google Cloud Project +## Run LangFlow from a New Google Cloud Project -This guide will help you set up a Langflow development VM in a Google Cloud Platform project using Google Cloud Shell. +This guide will help you set up a LangFlow development VM in a Google Cloud Platform project using Google Cloud Shell. -> **Note**: When Cloud Shell opens, be sure to select **Trust repo**. Some `gcloud` commands might not run in an ephemeral Cloud Shell environment. +:::note +When Cloud Shell opens, be sure to select **Trust repo**. Some `gcloud` commands might not run in an ephemeral Cloud Shell environment. +::: ## Standard VM [![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/logspace-ai/langflow&working_dir=scripts&shellonly=true&tutorial=walkthroughtutorial.md) -This script sets up a Debian-based VM with the Langflow package, Nginx, and the necessary configurations to run the Langflow Dev environment. +This script sets up a Debian-based VM with the LangFlow package, Nginx, and the necessary configurations to run the LangFlow Dev environment. --- @@ -18,7 +20,7 @@ This script sets up a Debian-based VM with the Langflow package, Nginx, and the [![Open in Cloud Shell - Spot Instance](https://gstatic.com/cloudssh/images/open-btn.svg)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/genome21/langflow&working_dir=scripts&shellonly=true&tutorial=walkthroughtutorial_spot.md) -When running as a [spot (preemptible) instance](https://cloud.google.com/compute/docs/instances/preemptible), the code and VM will behave the same way as in a regular instance, executing the startup script to configure the environment, install necessary dependencies, and run the Langflow application. However, **due to the nature of spot instances, the VM may be terminated at any time if Google Cloud needs to reclaim the resources**. This makes spot instances suitable for fault-tolerant, stateless, or interruptible workloads that can handle unexpected terminations and restarts. +When running as a [spot (preemptible) instance](https://cloud.google.com/compute/docs/instances/preemptible), the code and VM will behave the same way as in a regular instance, executing the startup script to configure the environment, install necessary dependencies, and run the LangFlow application. However, **due to the nature of spot instances, the VM may be terminated at any time if Google Cloud needs to reclaim the resources**. This makes spot instances suitable for fault-tolerant, stateless, or interruptible workloads that can handle unexpected terminations and restarts. --- diff --git a/docs/docs/how-contribute.md b/docs/docs/how-contribute.md index 2030dfae5..4277deb2f 100644 --- a/docs/docs/how-contribute.md +++ b/docs/docs/how-contribute.md @@ -10,8 +10,24 @@ To contribute to this project, please follow a ["fork and pull request"](https:/ Please do not try to push directly to this repo unless you are a maintainer. --- +## Local development -## Run Locally +You can develop LangFlow using docker compose, or locally. + +We provide a .vscode/launch.json file for debugging the backend in VSCode, which is a lot faster than using docker compose. + +Setting up hooks: +```bash +make init +``` + +This will install the pre-commit hooks, which will run `make format` on every commit. + +It is advised to run `make lint` before pushing to the repository. + +--- + +## Run locally LangFlow can run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system. diff --git a/docs/docs/jina-deployment.md b/docs/docs/jina-deployment.md index e23b30248..ba35c1430 100644 --- a/docs/docs/jina-deployment.md +++ b/docs/docs/jina-deployment.md @@ -1,6 +1,6 @@ # Deploy on Jina AI Cloud -Langflow integrates with langchain-serve to provide a one-command deployment to [Jina AI Cloud](https://github.com/jina-ai/langchain-serve). +LangFlow integrates with langchain-serve to provide a one-command deployment to [Jina AI Cloud](https://github.com/jina-ai/langchain-serve). Start by installing `langchain-serve` with @@ -23,65 +23,79 @@ langflow --jcloud **Complete (example) output:** ```text - 🚀 Deploying Langflow server on Jina AI Cloud - ╭───────────────────────── 🎉 Flow is available! ──────────────────────────╮ - │ │ - │ ID langflow-e3dd8820ec │ - │ Gateway (Websocket) wss://langflow-e3dd8820ec.wolf.jina.ai │ - │ Dashboard https://dashboard.wolf.jina.ai/flow/e3dd8820ec │ - │ │ - ╰──────────────────────────────────────────────────────────────────────────╯ - ╭──────────────┬──────────────────────────────────────────────────────────────────────────────╮ - │ App ID │ langflow-e3dd8820ec │ - ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ - │ Phase │ Serving │ - ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ - │ Endpoint │ wss://langflow-e3dd8820ec.wolf.jina.ai │ - ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ - │ App logs │ dashboards.wolf.jina.ai │ - ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ - │ Swagger UI │ https://langflow-e3dd8820ec.wolf.jina.ai/docs │ - ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ - │ OpenAPI JSON │ https://langflow-e3dd8820ec.wolf.jina.ai/openapi.json │ - ╰──────────────┴──────────────────────────────────────────────────────────────────────────────╯ + 🚀 Deploying Langflow server on Jina AI Cloud + ╭───────────────────────── 🎉 Flow is available! ──────────────────────────╮ + │ │ + │ ID langflow-e3dd8820ec │ + │ Gateway (Websocket) wss://langflow-e3dd8820ec.wolf.jina.ai │ + │ Dashboard https://dashboard.wolf.jina.ai/flow/e3dd8820ec │ + │ │ + ╰──────────────────────────────────────────────────────────────────────────╯ + ╭──────────────┬──────────────────────────────────────────────────────────────────────────────╮ + │ App ID │ langflow-e3dd8820ec │ + ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ + │ Phase │ Serving │ + ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ + │ Endpoint │ wss://langflow-e3dd8820ec.wolf.jina.ai │ + ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ + │ App logs │ dashboards.wolf.jina.ai │ + ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ + │ Swagger UI │ https://langflow-e3dd8820ec.wolf.jina.ai/docs │ + ├──────────────┼──────────────────────────────────────────────────────────────────────────────┤ + │ OpenAPI JSON │ https://langflow-e3dd8820ec.wolf.jina.ai/openapi.json │ + ╰──────────────┴──────────────────────────────────────────────────────────────────────────────╯ - 🎉 Langflow server successfully deployed on Jina AI Cloud 🎉 - 🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): https://langflow-e3dd8820ec.wolf.jina.ai/ - 📖 Read more about managing the server: https://github.com/jina-ai/langchain-serve + 🎉 Langflow server successfully deployed on Jina AI Cloud 🎉 + 🔗 Click on the link to open the server (please allow ~1-2 minutes for the server to startup): https://langflow-e3dd8820ec.wolf.jina.ai/ + 📖 Read more about managing the server: https://github.com/jina-ai/langchain-serve ``` -## API Usage +## API Usage (with python) -You can use Langflow directly on your browser or the API endpoints on Jina AI Cloud to interact with the server. +You can use LangFlow directly on your browser or the API endpoints on Jina AI Cloud to interact with the server. ```python - import json - import requests +import requests - FLOW_PATH = "Time_traveller.json" +BASE_API_URL = "https://langflow-e3dd8820ec.wolf.jina.ai/api/v1/predict" +FLOW_ID = "864c4f98-2e59-468b-8e13-79cd8da07468" +# You can tweak the flow by adding a tweaks dictionary +# e.g {"OpenAI-XXXXX": {"model_name": "gpt-4"}} +TWEAKS = { +"ChatOpenAI-g4jEr": {}, +"ConversationChain-UidfJ": {} +} - # HOST = 'http://localhost:7860' - HOST = 'https://langflow-f1ed20e309.wolf.jina.ai' - API_URL = f'{HOST}/predict' +def run_flow(message: str, flow_id: str, tweaks: dict = None) -> dict: + """ + Run a flow with a given message and optional tweaks. - def predict(message): - with open(FLOW_PATH, "r") as f: - json_data = json.load(f) - payload = {'exported_flow': json_data, 'message': message} - response = requests.post(API_URL, json=payload) - return response.json() + :param message: The message to send to the flow + :param flow_id: The ID of the flow to run + :param tweaks: Optional tweaks to customize the flow + :return: The JSON response from the flow + """ + api_url = f"{BASE_API_URL}/{flow_id}" + payload = {"message": message} - predict('Take me to 1920s Bangalore') + if tweaks: + payload["tweaks"] = tweaks + + response = requests.post(api_url, json=payload) + return response.json() + +# Setup any tweaks you want to apply to the flow +print(run_flow("Your message", flow_id=FLOW_ID, tweaks=TWEAKS)) ``` ```json - { - "result": "Great choice! Bangalore in the 1920s was a vibrant city with a rich cultural and political scene. Here are some suggestions for things to see and do:\n\n1. Visit the Bangalore Palace - built in 1887, this stunning palace is a perfect example of Tudor-style architecture. It was home to the Maharaja of Mysore and is now open to the public.\n\n2. Attend a performance at the Ravindra Kalakshetra - this cultural center was built in the 1920s and is still a popular venue for music and dance performances.\n\n3. Explore the neighborhoods of Basavanagudi and Malleswaram - both of these areas have retained much of their old-world charm and are great places to walk around and soak up the atmosphere.\n\n4. Check out the Bangalore Club - founded in 1868, this exclusive social club was a favorite haunt of the British expat community in the 1920s.\n\n5. Attend a meeting of the Indian National Congress - founded in 1885, the INC was a major force in the Indian independence movement and held many meetings and rallies in Bangalore in the 1920s.\n\nHope you enjoy your trip to 1920s Bangalore!" - } +{ + "result": "Great choice! Bangalore in the 1920s was a vibrant city with a rich cultural and political scene. Here are some suggestions for things to see and do:\n\n1. Visit the Bangalore Palace - built in 1887, this stunning palace is a perfect example of Tudor-style architecture. It was home to the Maharaja of Mysore and is now open to the public.\n\n2. Attend a performance at the Ravindra Kalakshetra - this cultural center was built in the 1920s and is still a popular venue for music and dance performances.\n\n3. Explore the neighborhoods of Basavanagudi and Malleswaram - both of these areas have retained much of their old-world charm and are great places to walk around and soak up the atmosphere.\n\n4. Check out the Bangalore Club - founded in 1868, this exclusive social club was a favorite haunt of the British expat community in the 1920s.\n\n5. Attend a meeting of the Indian National Congress - founded in 1885, the INC was a major force in the Indian independence movement and held many meetings and rallies in Bangalore in the 1920s.\n\nHope you enjoy your trip to 1920s Bangalore!" +} ``` :::info -Read more about resource customization, cost, and management of Langflow apps on Jina AI Cloud in the **[langchain-serve](https://github.com/jina-ai/langchain-serve)** repository. +Read more about resource customization, cost, and management of LangFlow apps on Jina AI Cloud in the **[langchain-serve](https://github.com/jina-ai/langchain-serve)** repository. ::: \ No newline at end of file diff --git a/docs/docs/multiple-vectorstores.mdx b/docs/docs/multiple-vectorstores.mdx index 6464863d8..98f90b114 100644 --- a/docs/docs/multiple-vectorstores.mdx +++ b/docs/docs/multiple-vectorstores.mdx @@ -47,7 +47,7 @@ import ZoomableImage from '/src/theme/ZoomableImage.js'; - [`OpenAIEmbedding`](https://python.langchain.com/docs/modules/data_connection/text_embedding/integrations/openai) - [`Chroma`](https://python.langchain.com/docs/modules/data_connection/vectorstores/integrations/chroma) - [`VectorStoreInfo`](https://python.langchain.com/docs/modules/data_connection/vectorstores/) -- [`ChatOpenAI`](https://python.langchain.com/docs/modules/model_io/models/chat/integrations/openai) +- [`OpenAI`](https://python.langchain.com/docs/modules/model_io/models/llms/integrations/openai) - [`VectorStoreRouterToolkit`](https://python.langchain.com/docs/modules/agents/toolkits/vectorstore) - [`VectorStoreRouterAgent`](https://python.langchain.com/docs/modules/agents/toolkits/vectorstore) diff --git a/docs/docs/python-function.mdx b/docs/docs/python-function.mdx index 4c0433630..eee3bb2b6 100644 --- a/docs/docs/python-function.mdx +++ b/docs/docs/python-function.mdx @@ -24,7 +24,7 @@ The `AgentInitializer` component is a quick way to construct an agent from the m :::info -The `PythonFunction` is a custom component that uses the LangChain 🦜🔗 tool decorator. Learn more about it [here](https://python.langchain.com/en/latest/modules/agents/tools/custom_tools.html#using-the-tool-decorator). +The `PythonFunction` is a custom component that uses the LangChain 🦜🔗 tool decorator. Learn more about it [here](https://python.langchain.com/docs/modules/agents/tools/how_to/custom_tools). ::: @@ -44,8 +44,7 @@ import ZoomableImage from '/src/theme/ZoomableImage.js'; #### Download Flow :::note LangChain Components 🦜🔗 -- [`OpenAI`](https://python.langchain.com/docs/modules/model_io/models/llms/integrations/openai) -- [`Tool`](https://python.langchain.com/docs/modules/agents/tools/) -- [`ConversationBufferMemory`](https://python.langchain.com/docs/modules/memory/how_to/buffer) -- [`initialize_agent`](https://python.langchain.com/docs/modules/agents/) +- [`PythonFunctionTool`](https://python.langchain.com/docs/modules/agents/tools/how_to/custom_tools) +- [`ChatOpenAI`](https://python.langchain.com/docs/modules/model_io/models/chat/integrations/openai) +- [`AgentInitializer`](https://python.langchain.com/docs/modules/agents/) ::: diff --git a/docs/docs/serp-api-tool.mdx b/docs/docs/serp-api-tool.mdx index 6ceddc0cd..e8a71511a 100644 --- a/docs/docs/serp-api-tool.mdx +++ b/docs/docs/serp-api-tool.mdx @@ -19,7 +19,7 @@ The `ZeroShotAgent` takes the `LLMChain` and the `Search` tool as inputs, using :::info -Learn more about the Serp API [here](https://python.langchain.com/en/latest/modules/agents/tools/examples/google_serper.html). +Learn more about the Serp API [here](https://python.langchain.com/docs/modules/agents/tools/integrations/serpapi). ::: ## ⛓️ LangFlow Example @@ -38,9 +38,9 @@ import ZoomableImage from '/src/theme/ZoomableImage.js'; #### Download Flow :::note LangChain Components 🦜🔗 -- [`SerpAPI`](https://python.langchain.com/docs/modules/agents/tools/integrations/serpapi) - [`ZeroShotPrompt`](https://python.langchain.com/docs/modules/model_io/prompts/prompt_templates/) -- [`ChatOpenAI`](https://python.langchain.com/docs/modules/model_io/models/llms/integrations/openai) +- [`OpenAI`](https://python.langchain.com/docs/modules/model_io/models/llms/integrations/openai) - [`LLMChain`](https://python.langchain.com/docs/modules/chains/foundational/llm_chain) +- [`Search`](https://python.langchain.com/docs/modules/agents/tools/integrations/serpapi) - [`ZeroShotAgent`](https://python.langchain.com/docs/modules/agents/how_to/custom_mrkl_agent) ::: \ No newline at end of file