diff --git a/Concepts/concepts-flows.html b/Concepts/concepts-flows.html
index 99e5e20599..bd7be68df0 100644
--- a/Concepts/concepts-flows.html
+++ b/Concepts/concepts-flows.html
@@ -16,7 +16,7 @@
-
+
diff --git a/Deployment/deployment-docker.html b/Deployment/deployment-docker.html
index 22e64f8d8e..f167e0d544 100644
--- a/Deployment/deployment-docker.html
+++ b/Deployment/deployment-docker.html
@@ -16,7 +16,7 @@
-
+
diff --git a/agents-overview.html b/agents-overview.html
index 526735fbe7..c32917294a 100644
--- a/agents-overview.html
+++ b/agents-overview.html
@@ -16,7 +16,7 @@
-
+
diff --git a/agents-tool-calling-agent-component.html b/agents-tool-calling-agent-component.html
index 761757b4df..0839fd31f6 100644
--- a/agents-tool-calling-agent-component.html
+++ b/agents-tool-calling-agent-component.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api-reference-api-examples.html b/api-reference-api-examples.html
index 6466f56c25..dd991ac80e 100644
--- a/api-reference-api-examples.html
+++ b/api-reference-api-examples.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api.html b/api.html
index 11bc156f16..f94fe51208 100644
--- a/api.html
+++ b/api.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/add-user.html b/api/add-user.html
index a80532f68b..64492b9108 100644
--- a/api/add-user.html
+++ b/api/add-user.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/auto-login.html b/api/auto-login.html
index 98f4f09c75..4f1bd05c2f 100644
--- a/api/auto-login.html
+++ b/api/auto-login.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/build-flow.html b/api/build-flow.html
index 889146d307..da2ee8aaaa 100644
--- a/api/build-flow.html
+++ b/api/build-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/build-vertex-stream.html b/api/build-vertex-stream.html
index a0a5f0ccfb..c6684a6531 100644
--- a/api/build-vertex-stream.html
+++ b/api/build-vertex-stream.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/build-vertex.html b/api/build-vertex.html
index 182a01904c..ad5377611d 100644
--- a/api/build-vertex.html
+++ b/api/build-vertex.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/check-if-store-has-api-key.html b/api/check-if-store-has-api-key.html
index 5d44de9c54..5408ea8b0a 100644
--- a/api/check-if-store-has-api-key.html
+++ b/api/check-if-store-has-api-key.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/check-if-store-is-enabled.html b/api/check-if-store-is-enabled.html
index 11759f3640..307da4141d 100644
--- a/api/check-if-store-is-enabled.html
+++ b/api/check-if-store-is-enabled.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/create-api-key-route.html b/api/create-api-key-route.html
index 4fbcd35927..78fcd8d636 100644
--- a/api/create-api-key-route.html
+++ b/api/create-api-key-route.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/create-flow.html b/api/create-flow.html
index 2bfae4785c..b2059dc822 100644
--- a/api/create-flow.html
+++ b/api/create-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/create-flows.html b/api/create-flows.html
index 1bd4919764..490823586a 100644
--- a/api/create-flows.html
+++ b/api/create-flows.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/create-folder.html b/api/create-folder.html
index e20ab5c3e8..01cfad59ff 100644
--- a/api/create-folder.html
+++ b/api/create-folder.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/create-upload-file.html b/api/create-upload-file.html
index bc25ee00df..d633970922 100644
--- a/api/create-upload-file.html
+++ b/api/create-upload-file.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/create-variable.html b/api/create-variable.html
index 80fea1d0c3..bc20943d83 100644
--- a/api/create-variable.html
+++ b/api/create-variable.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/custom-component-update.html b/api/custom-component-update.html
index 88f4fe6072..4b31c0be93 100644
--- a/api/custom-component-update.html
+++ b/api/custom-component-update.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/custom-component.html b/api/custom-component.html
index 83521f3352..dcf5d54b0f 100644
--- a/api/custom-component.html
+++ b/api/custom-component.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-api-key-route.html b/api/delete-api-key-route.html
index f3a7e83034..50f2f34773 100644
--- a/api/delete-api-key-route.html
+++ b/api/delete-api-key-route.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-file.html b/api/delete-file.html
index a3e6f51d4d..981ef99e9a 100644
--- a/api/delete-file.html
+++ b/api/delete-file.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-flow.html b/api/delete-flow.html
index 5e4a54de47..bebbb06496 100644
--- a/api/delete-flow.html
+++ b/api/delete-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-folder.html b/api/delete-folder.html
index 731b00c6e9..2cc34afa25 100644
--- a/api/delete-folder.html
+++ b/api/delete-folder.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-messages-session.html b/api/delete-messages-session.html
index 92adb84417..e761828386 100644
--- a/api/delete-messages-session.html
+++ b/api/delete-messages-session.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-messages.html b/api/delete-messages.html
index a03111114b..bfb66e9e8a 100644
--- a/api/delete-messages.html
+++ b/api/delete-messages.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-multiple-flows.html b/api/delete-multiple-flows.html
index 4c0eb51488..03945aa192 100644
--- a/api/delete-multiple-flows.html
+++ b/api/delete-multiple-flows.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-user.html b/api/delete-user.html
index c83124074a..47d1026a2b 100644
--- a/api/delete-user.html
+++ b/api/delete-user.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-variable.html b/api/delete-variable.html
index 0805c853e0..4b4c2163c0 100644
--- a/api/delete-variable.html
+++ b/api/delete-variable.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/delete-vertex-builds.html b/api/delete-vertex-builds.html
index 5c26c1f1bc..12e503a897 100644
--- a/api/delete-vertex-builds.html
+++ b/api/delete-vertex-builds.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/download-component.html b/api/download-component.html
index 13e7def338..328c8d9946 100644
--- a/api/download-component.html
+++ b/api/download-component.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/download-file-1.html b/api/download-file-1.html
index e1c7324404..716176d626 100644
--- a/api/download-file-1.html
+++ b/api/download-file-1.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/download-file.html b/api/download-file.html
index fa19b3cfae..a8dcf99c99 100644
--- a/api/download-file.html
+++ b/api/download-file.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/download-image.html b/api/download-image.html
index 7bab8d8f6e..1f75c61d27 100644
--- a/api/download-image.html
+++ b/api/download-image.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/download-multiple-file.html b/api/download-multiple-file.html
index 3a50805df0..3ce4af747f 100644
--- a/api/download-multiple-file.html
+++ b/api/download-multiple-file.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/download-profile-picture.html b/api/download-profile-picture.html
index c598d6af38..9adadcbf0d 100644
--- a/api/download-profile-picture.html
+++ b/api/download-profile-picture.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/experimental-run-flow.html b/api/experimental-run-flow.html
index bc8b8b2039..072cffc167 100644
--- a/api/experimental-run-flow.html
+++ b/api/experimental-run-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-all.html b/api/get-all.html
index b865d3800a..e6b3b900eb 100644
--- a/api/get-all.html
+++ b/api/get-all.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-api-keys-route.html b/api/get-api-keys-route.html
index fc8ec33cb0..5d9ed86a02 100644
--- a/api/get-api-keys-route.html
+++ b/api/get-api-keys-route.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-components.html b/api/get-components.html
index 9a4e4d4924..ee7a27aace 100644
--- a/api/get-components.html
+++ b/api/get-components.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-config.html b/api/get-config.html
index 63634b6a79..4337004058 100644
--- a/api/get-config.html
+++ b/api/get-config.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-list-of-components-liked-by-user.html b/api/get-list-of-components-liked-by-user.html
index 34cdc2d334..fde2a70824 100644
--- a/api/get-list-of-components-liked-by-user.html
+++ b/api/get-list-of-components-liked-by-user.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-messages.html b/api/get-messages.html
index 2a90c6839e..faff5eacf6 100644
--- a/api/get-messages.html
+++ b/api/get-messages.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-starter-projects.html b/api/get-starter-projects.html
index 10735dc115..03e46e7afb 100644
--- a/api/get-starter-projects.html
+++ b/api/get-starter-projects.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-tags.html b/api/get-tags.html
index d922470c01..073f5cb038 100644
--- a/api/get-tags.html
+++ b/api/get-tags.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-task-status.html b/api/get-task-status.html
index 8ce9cc4a6f..37899459c5 100644
--- a/api/get-task-status.html
+++ b/api/get-task-status.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-transactions.html b/api/get-transactions.html
index ff4edf7647..a5813317ba 100644
--- a/api/get-transactions.html
+++ b/api/get-transactions.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-version.html b/api/get-version.html
index 01032809cd..f1054b9aa4 100644
--- a/api/get-version.html
+++ b/api/get-version.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/get-vertex-builds.html b/api/get-vertex-builds.html
index 352090bc44..8a557b7148 100644
--- a/api/get-vertex-builds.html
+++ b/api/get-vertex-builds.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/handle-messages.html b/api/handle-messages.html
index 90bff44f98..8b77350e85 100644
--- a/api/handle-messages.html
+++ b/api/handle-messages.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/handle-sse.html b/api/handle-sse.html
index be593b1b17..23837d5a8e 100644
--- a/api/handle-sse.html
+++ b/api/handle-sse.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/health-check.html b/api/health-check.html
index dd99d59ec2..e5b8567523 100644
--- a/api/health-check.html
+++ b/api/health-check.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/health.html b/api/health.html
index e16f6ddabb..173a9a0b8c 100644
--- a/api/health.html
+++ b/api/health.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/like-component.html b/api/like-component.html
index f3449d1a87..754b591a19 100644
--- a/api/like-component.html
+++ b/api/like-component.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/list-files.html b/api/list-files.html
index a523c9217d..2df997ea3e 100644
--- a/api/list-files.html
+++ b/api/list-files.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/list-profile-pictures.html b/api/list-profile-pictures.html
index 7c1e9211fa..b41fd22e77 100644
--- a/api/list-profile-pictures.html
+++ b/api/list-profile-pictures.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/login-to-get-access-token.html b/api/login-to-get-access-token.html
index a2063c7a21..b8afc83baa 100644
--- a/api/login-to-get-access-token.html
+++ b/api/login-to-get-access-token.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/logout.html b/api/logout.html
index c294b58c62..dac2c09c88 100644
--- a/api/logout.html
+++ b/api/logout.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/logs.html b/api/logs.html
index bf40c0461a..c91a06868b 100644
--- a/api/logs.html
+++ b/api/logs.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/patch-user.html b/api/patch-user.html
index 9e79f02422..345a8de020 100644
--- a/api/patch-user.html
+++ b/api/patch-user.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/post-validate-code.html b/api/post-validate-code.html
index a93649dd06..6d62285030 100644
--- a/api/post-validate-code.html
+++ b/api/post-validate-code.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/post-validate-prompt.html b/api/post-validate-prompt.html
index 6b423195b1..923515a874 100644
--- a/api/post-validate-prompt.html
+++ b/api/post-validate-prompt.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/process-1.html b/api/process-1.html
index 7ec3a1dde5..00de4eb9d0 100644
--- a/api/process-1.html
+++ b/api/process-1.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/process.html b/api/process.html
index e56c6993df..a5e6f07809 100644
--- a/api/process.html
+++ b/api/process.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-all-users.html b/api/read-all-users.html
index 6d741bd1bf..d616b36d8c 100644
--- a/api/read-all-users.html
+++ b/api/read-all-users.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-basic-examples.html b/api/read-basic-examples.html
index 9bac671e4d..ef5c623379 100644
--- a/api/read-basic-examples.html
+++ b/api/read-basic-examples.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-current-user.html b/api/read-current-user.html
index 059514ea13..7df7436845 100644
--- a/api/read-current-user.html
+++ b/api/read-current-user.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-flow.html b/api/read-flow.html
index f26a165bbf..efd0145e23 100644
--- a/api/read-flow.html
+++ b/api/read-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-flows.html b/api/read-flows.html
index 1ac5d55eb3..8630fff1f6 100644
--- a/api/read-flows.html
+++ b/api/read-flows.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-folder.html b/api/read-folder.html
index 2f4cf50009..b226e17c7a 100644
--- a/api/read-folder.html
+++ b/api/read-folder.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-folders.html b/api/read-folders.html
index b04347562a..cce04d88c7 100644
--- a/api/read-folders.html
+++ b/api/read-folders.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/read-variables.html b/api/read-variables.html
index 4531cf0fa1..4c5f9396f8 100644
--- a/api/read-variables.html
+++ b/api/read-variables.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/refresh-token.html b/api/refresh-token.html
index 64eb40951d..211762b91c 100644
--- a/api/refresh-token.html
+++ b/api/refresh-token.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/reset-password.html b/api/reset-password.html
index f51735b0ed..ba2bfa9204 100644
--- a/api/reset-password.html
+++ b/api/reset-password.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/retrieve-vertices-order.html b/api/retrieve-vertices-order.html
index 245c37cd83..7c72641d0a 100644
--- a/api/retrieve-vertices-order.html
+++ b/api/retrieve-vertices-order.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/save-store-api-key.html b/api/save-store-api-key.html
index c5b96d93fb..7aa11fcde0 100644
--- a/api/save-store-api-key.html
+++ b/api/save-store-api-key.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/share-component.html b/api/share-component.html
index 4a0574fd80..19dd3a9427 100644
--- a/api/share-component.html
+++ b/api/share-component.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/simplified-run-flow.html b/api/simplified-run-flow.html
index 6d0a53fb25..e55552287e 100644
--- a/api/simplified-run-flow.html
+++ b/api/simplified-run-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/stream-logs.html b/api/stream-logs.html
index 96f9a7f9e1..9f1ce12e05 100644
--- a/api/stream-logs.html
+++ b/api/stream-logs.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/update-flow.html b/api/update-flow.html
index 439037914b..b86865b33c 100644
--- a/api/update-flow.html
+++ b/api/update-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/update-folder.html b/api/update-folder.html
index 6038818e14..9acffed0c8 100644
--- a/api/update-folder.html
+++ b/api/update-folder.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/update-message.html b/api/update-message.html
index 7742b40423..e16a227379 100644
--- a/api/update-message.html
+++ b/api/update-message.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/update-session-id.html b/api/update-session-id.html
index 58a8e7d648..12365f1a8c 100644
--- a/api/update-session-id.html
+++ b/api/update-session-id.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/update-shared-component.html b/api/update-shared-component.html
index 2ae7525353..255d038a56 100644
--- a/api/update-shared-component.html
+++ b/api/update-shared-component.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/update-variable.html b/api/update-variable.html
index 65e5938ff8..027a234421 100644
--- a/api/update-variable.html
+++ b/api/update-variable.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/upload-file-1.html b/api/upload-file-1.html
index 357877445d..360c485c2a 100644
--- a/api/upload-file-1.html
+++ b/api/upload-file-1.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/upload-file-2.html b/api/upload-file-2.html
index 15b5194fb1..08ff1c3ac2 100644
--- a/api/upload-file-2.html
+++ b/api/upload-file-2.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/upload-file.html b/api/upload-file.html
index b3d00710c0..eb727edc04 100644
--- a/api/upload-file.html
+++ b/api/upload-file.html
@@ -16,7 +16,7 @@
-
+
diff --git a/api/webhook-run-flow.html b/api/webhook-run-flow.html
index 5190688d7d..c20c3f8d90 100644
--- a/api/webhook-run-flow.html
+++ b/api/webhook-run-flow.html
@@ -16,7 +16,7 @@
-
+
diff --git a/assets/js/2ab0d4f5.24e5697f.js b/assets/js/2ab0d4f5.24e5697f.js
deleted file mode 100644
index b44cf193f9..0000000000
--- a/assets/js/2ab0d4f5.24e5697f.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[1845],{28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(96540);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}},83640:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"type":"api","id":"simplified-run-flow","title":"Simplified Run Flow","description":"","slug":"/simplified-run-flow","frontMatter":{},"api":{"tags":["Base"],"description":"Executes a specified flow by ID with support for streaming and telemetry.\\n\\nThis endpoint executes a flow identified by ID or name, with options for streaming the response\\nand tracking execution metrics. It handles both streaming and non-streaming execution modes.\\n\\nArgs:\\n background_tasks (BackgroundTasks): FastAPI background task manager\\n flow (FlowRead | None): The flow to execute, loaded via dependency\\n input_request (SimplifiedAPIRequest | None): Input parameters for the flow\\n stream (bool): Whether to stream the response\\n api_key_user (UserRead): Authenticated user from API key\\n request (Request): The incoming HTTP request\\n\\nReturns:\\n Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results\\n or a RunResponse with the complete execution results\\n\\nRaises:\\n HTTPException: For flow not found (404) or invalid input (400)\\n APIException: For internal execution errors (500)\\n\\nNotes:\\n - Supports both streaming and non-streaming execution modes\\n - Tracks execution time and success/failure via telemetry\\n - Handles graceful client disconnection in streaming mode\\n - Provides detailed error handling with appropriate HTTP status codes\\n - In streaming mode, uses EventManager to handle events:\\n - \\"add_message\\": New messages during execution\\n - \\"token\\": Individual tokens during streaming\\n - \\"end\\": Final execution result","operationId":"simplified_run_flow_api_v1_run__flow_id_or_name__post","security":[{"API key query":[]},{"API key header":[]}],"parameters":[{"name":"flow_id_or_name","in":"path","required":true,"schema":{"type":"string","title":"Flow Id Or Name"}},{"name":"stream","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Stream"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"input_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Value","description":"The input value"},"input_type":{"anyOf":[{"type":"string","enum":["chat","text","any"]},{"type":"null"}],"title":"Input Type","description":"The input type","default":"chat"},"output_type":{"anyOf":[{"type":"string","enum":["chat","text","any","debug"]},{"type":"null"}],"title":"Output Type","description":"The output type","default":"chat"},"output_component":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output Component","description":"If there are multiple output components, you can specify the component to get the output from.","default":""},"tweaks":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"type":"object","title":"Tweaks","description":"A dictionary of tweaks to adjust the flow\'s execution. Allows customizing flow behavior dynamically. All tweaks are overridden by the input values.","examples":[{"Component Name":{"parameter_name":"value"},"component_id":{"parameter_name":"value"},"parameter_name":"value"}]},{"type":"null"}],"description":"The tweaks"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id","description":"The session id"}},"type":"object","title":"SimplifiedAPIRequest"},{"type":"null"}],"title":"Input Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"method":"post","path":"/api/v1/run/{flow_id_or_name}","securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"api/v1/login"}}},"API key query":{"type":"apiKey","in":"query","name":"x-api-key"},"API key header":{"type":"apiKey","in":"header","name":"x-api-key"}},"info":{"title":"Langflow","version":"1.1.4"},"postman":{"name":"Simplified Run Flow","description":{"content":"Executes a specified flow by ID with support for streaming and telemetry.\\n\\nThis endpoint executes a flow identified by ID or name, with options for streaming the response\\nand tracking execution metrics. It handles both streaming and non-streaming execution modes.\\n\\nArgs:\\n background_tasks (BackgroundTasks): FastAPI background task manager\\n flow (FlowRead | None): The flow to execute, loaded via dependency\\n input_request (SimplifiedAPIRequest | None): Input parameters for the flow\\n stream (bool): Whether to stream the response\\n api_key_user (UserRead): Authenticated user from API key\\n request (Request): The incoming HTTP request\\n\\nReturns:\\n Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results\\n or a RunResponse with the complete execution results\\n\\nRaises:\\n HTTPException: For flow not found (404) or invalid input (400)\\n APIException: For internal execution errors (500)\\n\\nNotes:\\n - Supports both streaming and non-streaming execution modes\\n - Tracks execution time and success/failure via telemetry\\n - Handles graceful client disconnection in streaming mode\\n - Provides detailed error handling with appropriate HTTP status codes\\n - In streaming mode, uses EventManager to handle events:\\n - \\"add_message\\": New messages during execution\\n - \\"token\\": Individual tokens during streaming\\n - \\"end\\": Final execution result","type":"text/plain"},"url":{"path":["api","v1","run",":flow_id_or_name"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"stream","value":"false"},{"disabled":false,"key":"user_id","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"flow_id_or_name"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\\n \\"input_value\\": \\"\\",\\n \\"input_type\\": \\"\\",\\n \\"output_type\\": \\"\\",\\n \\"output_component\\": \\"\\",\\n \\"tweaks\\": {\\n \\"pariatur_e5\\": \\"\\"\\n },\\n \\"session_id\\": \\"\\"\\n}","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"query","key":"in"}]}}},"source":"@site/openapi.json","sourceDirName":".","permalink":"/api/simplified-run-flow","previous":{"title":"Get All","permalink":"/api/get-all"},"next":{"title":"Webhook Run Flow","permalink":"/api/webhook-run-flow"}}');var s=t(74848),r=t(28453);const a={},o="Simplified Run Flow",l=[];function d(e){const n={h1:"h1",header:"header",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"simplified-run-flow",children:"Simplified Run Flow"})}),"\n",(0,s.jsx)(n.p,{children:"Executes a specified flow by ID with support for streaming and telemetry."}),"\n",(0,s.jsx)(n.p,{children:"This endpoint executes a flow identified by ID or name, with options for streaming the response\nand tracking execution metrics. It handles both streaming and non-streaming execution modes."}),"\n",(0,s.jsx)(n.p,{children:"Args:\nbackground_tasks (BackgroundTasks): FastAPI background task manager\nflow (FlowRead | None): The flow to execute, loaded via dependency\ninput_request (SimplifiedAPIRequest | None): Input parameters for the flow\nstream (bool): Whether to stream the response\napi_key_user (UserRead): Authenticated user from API key\nrequest (Request): The incoming HTTP request"}),"\n",(0,s.jsx)(n.p,{children:"Returns:\nUnion[StreamingResponse, RunResponse]: Either a streaming response for real-time results\nor a RunResponse with the complete execution results"}),"\n",(0,s.jsx)(n.p,{children:"Raises:\nHTTPException: For flow not found (404) or invalid input (400)\nAPIException: For internal execution errors (500)"}),"\n",(0,s.jsx)(n.p,{children:"Notes:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Supports both streaming and non-streaming execution modes"}),"\n",(0,s.jsx)(n.li,{children:"Tracks execution time and success/failure via telemetry"}),"\n",(0,s.jsx)(n.li,{children:"Handles graceful client disconnection in streaming mode"}),"\n",(0,s.jsx)(n.li,{children:"Provides detailed error handling with appropriate HTTP status codes"}),"\n",(0,s.jsxs)(n.li,{children:["In streaming mode, uses EventManager to handle events:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"add_message": New messages during execution'}),"\n",(0,s.jsx)(n.li,{children:'"token": Individual tokens during streaming'}),"\n",(0,s.jsx)(n.li,{children:'"end": Final execution result'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"flow_id_or_name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Flow Id Or Name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"stream"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Stream"})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"user_id"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" User Id"})]})})]})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Request Body "}),(0,s.jsx)("div",{})]})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("td",{children:(0,s.jsx)("span",{style:{opacity:"0.6"},children:" undefined"})})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(n.p,{children:"Successful Response"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("td",{children:(0,s.jsx)("span",{style:{opacity:"0.6"},children:" undefined"})})})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"422"})}),(0,s.jsx)("div",{children:(0,s.jsx)(n.p,{children:"Validation Error"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"detail"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"loc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" undefined[]"})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"msg"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Message"})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"type"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Error Type"})]})})]})})]})})})]})})]})})]})]})]})}function c(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}}}]);
\ No newline at end of file
diff --git a/assets/js/2ab0d4f5.c8c2bf13.js b/assets/js/2ab0d4f5.c8c2bf13.js
new file mode 100644
index 0000000000..b9059ebd52
--- /dev/null
+++ b/assets/js/2ab0d4f5.c8c2bf13.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[1845],{28453:(e,n,t)=>{t.d(n,{R:()=>a,x:()=>o});var i=t(96540);const s={},r=i.createContext(s);function a(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:a(e.components),i.createElement(r.Provider,{value:n},e.children)}},83640:(e,n,t)=>{t.r(n),t.d(n,{contentTitle:()=>o,default:()=>c,frontMatter:()=>a,metadata:()=>i,toc:()=>l});const i=JSON.parse('{"type":"api","id":"simplified-run-flow","title":"Simplified Run Flow","description":"","slug":"/simplified-run-flow","frontMatter":{},"api":{"tags":["Base"],"description":"Executes a specified flow by ID with support for streaming and telemetry.\\n\\nThis endpoint executes a flow identified by ID or name, with options for streaming the response\\nand tracking execution metrics. It handles both streaming and non-streaming execution modes.\\n\\nArgs:\\n background_tasks (BackgroundTasks): FastAPI background task manager\\n flow (FlowRead | None): The flow to execute, loaded via dependency\\n input_request (SimplifiedAPIRequest | None): Input parameters for the flow\\n stream (bool): Whether to stream the response\\n api_key_user (UserRead): Authenticated user from API key\\n request (Request): The incoming HTTP request\\n\\nReturns:\\n Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results\\n or a RunResponse with the complete execution results\\n\\nRaises:\\n HTTPException: For flow not found (404) or invalid input (400)\\n APIException: For internal execution errors (500)\\n\\nNotes:\\n - Supports both streaming and non-streaming execution modes\\n - Tracks execution time and success/failure via telemetry\\n - Handles graceful client disconnection in streaming mode\\n - Provides detailed error handling with appropriate HTTP status codes\\n - In streaming mode, uses EventManager to handle events:\\n - \\"add_message\\": New messages during execution\\n - \\"token\\": Individual tokens during streaming\\n - \\"end\\": Final execution result","operationId":"simplified_run_flow_api_v1_run__flow_id_or_name__post","security":[{"API key query":[]},{"API key header":[]}],"parameters":[{"name":"flow_id_or_name","in":"path","required":true,"schema":{"type":"string","title":"Flow Id Or Name"}},{"name":"stream","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Stream"}},{"name":"user_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"properties":{"input_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Input Value","description":"The input value"},"input_type":{"anyOf":[{"type":"string","enum":["chat","text","any"]},{"type":"null"}],"title":"Input Type","description":"The input type","default":"chat"},"output_type":{"anyOf":[{"type":"string","enum":["chat","text","any","debug"]},{"type":"null"}],"title":"Output Type","description":"The output type","default":"chat"},"output_component":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Output Component","description":"If there are multiple output components, you can specify the component to get the output from.","default":""},"tweaks":{"anyOf":[{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"object"}]},"type":"object","title":"Tweaks","description":"A dictionary of tweaks to adjust the flow\'s execution. Allows customizing flow behavior dynamically. All tweaks are overridden by the input values.","examples":[{"Component Name":{"parameter_name":"value"},"component_id":{"parameter_name":"value"},"parameter_name":"value"}]},{"type":"null"}],"description":"The tweaks"},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id","description":"The session id"}},"type":"object","title":"SimplifiedAPIRequest"},{"type":"null"}],"title":"Input Request"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}},"method":"post","path":"/api/v1/run/{flow_id_or_name}","securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"api/v1/login"}}},"API key query":{"type":"apiKey","in":"query","name":"x-api-key"},"API key header":{"type":"apiKey","in":"header","name":"x-api-key"}},"info":{"title":"Langflow","version":"1.1.4"},"postman":{"name":"Simplified Run Flow","description":{"content":"Executes a specified flow by ID with support for streaming and telemetry.\\n\\nThis endpoint executes a flow identified by ID or name, with options for streaming the response\\nand tracking execution metrics. It handles both streaming and non-streaming execution modes.\\n\\nArgs:\\n background_tasks (BackgroundTasks): FastAPI background task manager\\n flow (FlowRead | None): The flow to execute, loaded via dependency\\n input_request (SimplifiedAPIRequest | None): Input parameters for the flow\\n stream (bool): Whether to stream the response\\n api_key_user (UserRead): Authenticated user from API key\\n request (Request): The incoming HTTP request\\n\\nReturns:\\n Union[StreamingResponse, RunResponse]: Either a streaming response for real-time results\\n or a RunResponse with the complete execution results\\n\\nRaises:\\n HTTPException: For flow not found (404) or invalid input (400)\\n APIException: For internal execution errors (500)\\n\\nNotes:\\n - Supports both streaming and non-streaming execution modes\\n - Tracks execution time and success/failure via telemetry\\n - Handles graceful client disconnection in streaming mode\\n - Provides detailed error handling with appropriate HTTP status codes\\n - In streaming mode, uses EventManager to handle events:\\n - \\"add_message\\": New messages during execution\\n - \\"token\\": Individual tokens during streaming\\n - \\"end\\": Final execution result","type":"text/plain"},"url":{"path":["api","v1","run",":flow_id_or_name"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"key":"stream","value":"false"},{"disabled":false,"key":"user_id","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"flow_id_or_name"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"{\\n \\"input_value\\": \\"\\",\\n \\"input_type\\": \\"\\",\\n \\"output_type\\": \\"\\",\\n \\"output_component\\": \\"\\",\\n \\"tweaks\\": {\\n \\"aliquipeec\\": \\"\\",\\n \\"sit_a\\": \\"\\"\\n },\\n \\"session_id\\": \\"\\"\\n}","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"{{apiKey}}","key":"value"},{"type":"any","value":"query","key":"in"}]}}},"source":"@site/openapi.json","sourceDirName":".","permalink":"/api/simplified-run-flow","previous":{"title":"Get All","permalink":"/api/get-all"},"next":{"title":"Webhook Run Flow","permalink":"/api/webhook-run-flow"}}');var s=t(74848),r=t(28453);const a={},o="Simplified Run Flow",l=[];function d(e){const n={h1:"h1",header:"header",li:"li",p:"p",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"simplified-run-flow",children:"Simplified Run Flow"})}),"\n",(0,s.jsx)(n.p,{children:"Executes a specified flow by ID with support for streaming and telemetry."}),"\n",(0,s.jsx)(n.p,{children:"This endpoint executes a flow identified by ID or name, with options for streaming the response\nand tracking execution metrics. It handles both streaming and non-streaming execution modes."}),"\n",(0,s.jsx)(n.p,{children:"Args:\nbackground_tasks (BackgroundTasks): FastAPI background task manager\nflow (FlowRead | None): The flow to execute, loaded via dependency\ninput_request (SimplifiedAPIRequest | None): Input parameters for the flow\nstream (bool): Whether to stream the response\napi_key_user (UserRead): Authenticated user from API key\nrequest (Request): The incoming HTTP request"}),"\n",(0,s.jsx)(n.p,{children:"Returns:\nUnion[StreamingResponse, RunResponse]: Either a streaming response for real-time results\nor a RunResponse with the complete execution results"}),"\n",(0,s.jsx)(n.p,{children:"Raises:\nHTTPException: For flow not found (404) or invalid input (400)\nAPIException: For internal execution errors (500)"}),"\n",(0,s.jsx)(n.p,{children:"Notes:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:"Supports both streaming and non-streaming execution modes"}),"\n",(0,s.jsx)(n.li,{children:"Tracks execution time and success/failure via telemetry"}),"\n",(0,s.jsx)(n.li,{children:"Handles graceful client disconnection in streaming mode"}),"\n",(0,s.jsx)(n.li,{children:"Provides detailed error handling with appropriate HTTP status codes"}),"\n",(0,s.jsxs)(n.li,{children:["In streaming mode, uses EventManager to handle events:","\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:'"add_message": New messages during execution'}),"\n",(0,s.jsx)(n.li,{children:'"token": Individual tokens during streaming'}),"\n",(0,s.jsx)(n.li,{children:'"end": Final execution result'}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"flow_id_or_name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Flow Id Or Name"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"})]})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"stream"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Stream"})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"user_id"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" User Id"})]})})]})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Request Body "}),(0,s.jsx)("div",{})]})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("td",{children:(0,s.jsx)("span",{style:{opacity:"0.6"},children:" undefined"})})})})]}),"\n",(0,s.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("th",{style:{textAlign:"left"},children:"Responses"})})}),(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"200"})}),(0,s.jsx)("div",{children:(0,s.jsx)(n.p,{children:"Successful Response"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsx)("td",{children:(0,s.jsx)("span",{style:{opacity:"0.6"},children:" undefined"})})})})]})})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsxs)("div",{style:{display:"flex"},children:[(0,s.jsx)("div",{style:{marginRight:"var(--ifm-table-cell-padding)"},children:(0,s.jsx)("code",{children:"422"})}),(0,s.jsx)("div",{children:(0,s.jsx)(n.p,{children:"Validation Error"})})]}),(0,s.jsx)("div",{children:(0,s.jsxs)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:[(0,s.jsx)("thead",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("th",{style:{textAlign:"left"},children:[(0,s.jsx)("span",{children:"Schema "}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("div",{})]})})}),(0,s.jsx)("tbody",{children:(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"detail"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" object[]"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,s.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-optional)"},children:" OPTIONAL"}),(0,s.jsx)("table",{style:{display:"table",width:"100%",marginTop:"var(--ifm-table-cell-padding)",marginBottom:"0px"},children:(0,s.jsxs)("tbody",{children:[(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"loc"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" undefined[]"})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"msg"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Message"})]})}),(0,s.jsx)("tr",{children:(0,s.jsxs)("td",{children:[(0,s.jsx)("code",{children:"type"}),(0,s.jsx)("span",{style:{opacity:"0.6"},children:" Error Type"})]})})]})})]})})})]})})]})})]})]})]})}function c(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}}}]);
\ No newline at end of file
diff --git a/assets/js/5e834a3c.8c192c17.js b/assets/js/5e834a3c.8c192c17.js
new file mode 100644
index 0000000000..1f4e593769
--- /dev/null
+++ b/assets/js/5e834a3c.8c192c17.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[8245],{2255:(e,t,n)=>{n.r(t),n.d(t,{CH:()=>a,assets:()=>l,chCodeConfig:()=>h,contentTitle:()=>d,default:()=>g,frontMatter:()=>c,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"Integrations/Nvidia/integrations-nvidia-ingest","title":"Integrate Nvidia Ingest with Langflow","description":"The NVIDIA Ingest component integrates with the NVIDIA nv-ingest microservice for data ingestion, processing, and extraction of text files.","source":"@site/docs/Integrations/Nvidia/integrations-nvidia-ingest.md","sourceDirName":"Integrations/Nvidia","slug":"/integrations-nvidia-ingest","permalink":"/integrations-nvidia-ingest","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Integrate Nvidia Ingest with Langflow","slug":"/integrations-nvidia-ingest"},"sidebar":"docs","previous":{"title":"Notion Meeting Notes Agent","permalink":"/integrations/notion/notion-agent-meeting-notes"},"next":{"title":"Join the Langflow community","permalink":"/contributing-community"}}');var i=n(74848),o=n(28453),r=n(24754);const c={title:"Integrate Nvidia Ingest with Langflow",slug:"/integrations-nvidia-ingest"},d=void 0,l={},a={annotations:r.hk,Code:r.Cy},h={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:!0,showCopyButton:!0,themeName:"github-dark"},x=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Use the NVIDIA Ingest component in a flow",id:"use-the-nvidia-ingest-component-in-a-flow",level:2},{value:"NVIDIA Ingest component parameters",id:"parameters",level:2},{value:"Inputs",id:"inputs",level:3},{value:"Outputs",id:"outputs",level:3}];function p(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,o.R)(),...e.components};return a||u("CH",!1),a.Code||u("CH.Code",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component integrates with the ",(0,i.jsx)(t.a,{href:"https://github.com/NVIDIA/nv-ingest",children:"NVIDIA nv-ingest"})," microservice for data ingestion, processing, and extraction of text files."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"nv-ingest"})," service supports multiple extraction methods for PDF, DOCX, and PPTX file types, and includes pre- and post-processing services like splitting, chunking, and embedding generation."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component imports the NVIDIA ",(0,i.jsx)(t.code,{children:"Ingestor"})," client, ingests files with requests to the NVIDIA ingest endpoint, and outputs the processed content as a list of ",(0,i.jsx)(t.a,{href:"/concepts-objects#data-object",children:"Data"})," objects. ",(0,i.jsx)(t.code,{children:"Ingestor"})," accepts additional configuration options for data extraction from other text formats. To configure these options, see the ",(0,i.jsx)(t.a,{href:"/integrations-nvidia-ingest#parameters",children:"component parameters"}),"."]}),"\n",(0,i.jsx)(t.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["An NVIDIA Ingest endpoint. For more information on setting up an NVIDIA Ingest endpoint, see the ",(0,i.jsx)(t.a,{href:"https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart",children:"NVIDIA Ingest quickstart"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component requires the installation of additional dependencies to your Langflow environment. To install the dependencies in a virtual environment, run the following commands."]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"If you have the Langflow repository cloned and installed from source:"}),"\n"]}),"\n",(0,i.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"source **",props:{style:{color:"#79C0FF"}}},{content:"YOUR_LANGFLOW_VENV",props:{style:{color:"#A5D6FF"}}},{content:"**",props:{style:{color:"#79C0FF"}}},{content:"/bin/activate",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"uv ",props:{style:{color:"#FFA657"}}},{content:"sync ",props:{style:{color:"#A5D6FF"}}},{content:"--extra ",props:{style:{color:"#79C0FF"}}},{content:"nv-ingest",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"uv ",props:{style:{color:"#FFA657"}}},{content:"run langflow run",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"If you are installing Langflow from the Python Package Index:"}),"\n"]}),"\n",(0,i.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"source **",props:{style:{color:"#79C0FF"}}},{content:"YOUR_LANGFLOW_VENV",props:{style:{color:"#A5D6FF"}}},{content:"**",props:{style:{color:"#79C0FF"}}},{content:"/bin/activate",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"uv ",props:{style:{color:"#FFA657"}}},{content:"pip install 'langflow[nv-ingest]'",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"uv ",props:{style:{color:"#FFA657"}}},{content:"run langflow run",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"use-the-nvidia-ingest-component-in-a-flow",children:"Use the NVIDIA Ingest component in a flow"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component accepts ",(0,i.jsx)(t.strong,{children:"Message"})," inputs and outputs ",(0,i.jsx)(t.strong,{children:"Data"}),". The component calls a NVIDIA Ingest microservice's endpoint to ingest a local file and extract the text."]}),"\n",(0,i.jsx)(t.p,{children:"To use the NVIDIA Ingest component in your flow, follow these steps:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["In the component library, click the ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component, and then drag it onto the canvas."]}),"\n",(0,i.jsxs)(t.li,{children:["In the ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingestion URL"})," field, enter the URL of the NVIDIA Ingest endpoint.\nOptionally, add the endpoint URL as a ",(0,i.jsx)(t.strong,{children:"Global variable"}),":","\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Settings"}),", and then click ",(0,i.jsx)(t.strong,{children:"Global Variables"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Add New"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:["Name your variable. Paste your endpoint in the ",(0,i.jsx)(t.strong,{children:"Value"})," field."]}),"\n",(0,i.jsxs)(t.li,{children:["In the ",(0,i.jsx)(t.strong,{children:"Apply To Fields"})," field, select the field you want to globally apply this variable to. In this case, select ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingestion URL"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Save Variable"}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["In the ",(0,i.jsx)(t.strong,{children:"Path"})," field, enter the path to the file you want to ingest."]}),"\n",(0,i.jsx)(t.li,{children:"Select which text type to extract from the file.\nThe component supports text, charts, and tables."}),"\n",(0,i.jsxs)(t.li,{children:["Select whether to split the text into chunks.\nModify the splitting parameters in the component's ",(0,i.jsx)(t.strong,{children:"Configuration"})," tab."]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Run"})," to ingest the file."]}),"\n",(0,i.jsxs)(t.li,{children:["To confirm the component is ingesting the file, open the ",(0,i.jsx)(t.strong,{children:"Logs"})," pane to view the output of the flow."]}),"\n",(0,i.jsxs)(t.li,{children:["To store the processed data in a vector database, add an ",(0,i.jsx)(t.strong,{children:"AstraDB Vector"})," component to your flow, and connect the ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component to the ",(0,i.jsx)(t.strong,{children:"AstraDB Vector"})," component with a ",(0,i.jsx)(t.strong,{children:"Data"})," output."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"NVIDIA Ingest component flow",src:n(76102).A+"",width:"1934",height:"1486"})}),"\n",(0,i.jsxs)(t.ol,{start:"10",children:["\n",(0,i.jsx)(t.li,{children:"Run the flow.\nInspect your Astra DB vector database to view the processed data."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"NVIDIA Ingest component parameters"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component has the following parameters."]}),"\n",(0,i.jsxs)(t.p,{children:["For more information, see the ",(0,i.jsx)(t.a,{href:"https://nvidia.github.io/nv-ingest/user-guide/",children:"NV-Ingest documentation"}),"."]}),"\n",(0,i.jsx)(t.h3,{id:"inputs",children:"Inputs"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Display Name"}),(0,i.jsx)(t.th,{children:"Info"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"base_url"}),(0,i.jsx)(t.td,{children:"NVIDIA Ingestion URL"}),(0,i.jsx)(t.td,{children:"The URL of the NVIDIA Ingestion API."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"path"}),(0,i.jsx)(t.td,{children:"Path"}),(0,i.jsx)(t.td,{children:"File path to process."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"extract_text"}),(0,i.jsx)(t.td,{children:"Extract Text"}),(0,i.jsxs)(t.td,{children:["Extract text from documents. Default: ",(0,i.jsx)(t.code,{children:"True"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"extract_charts"}),(0,i.jsx)(t.td,{children:"Extract Charts"}),(0,i.jsxs)(t.td,{children:["Extract text from charts. Default: ",(0,i.jsx)(t.code,{children:"False"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"extract_tables"}),(0,i.jsx)(t.td,{children:"Extract Tables"}),(0,i.jsxs)(t.td,{children:["Extract text from tables. Default: ",(0,i.jsx)(t.code,{children:"True"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"text_depth"}),(0,i.jsx)(t.td,{children:"Text Depth"}),(0,i.jsxs)(t.td,{children:["The level at which text is extracted. Support for 'block', 'line', and 'span' varies by document type. Default: ",(0,i.jsx)(t.code,{children:"document"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_text"}),(0,i.jsx)(t.td,{children:"Split Text"}),(0,i.jsxs)(t.td,{children:["Split text into smaller chunks. Default: ",(0,i.jsx)(t.code,{children:"True"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_by"}),(0,i.jsx)(t.td,{children:"Split By"}),(0,i.jsxs)(t.td,{children:["How to split into chunks. 'size' splits by number of characters. Default: ",(0,i.jsx)(t.code,{children:"word"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_length"}),(0,i.jsx)(t.td,{children:"Split Length"}),(0,i.jsxs)(t.td,{children:["The size of each chunk based on the 'split_by' method. Default: ",(0,i.jsx)(t.code,{children:"200"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_overlap"}),(0,i.jsx)(t.td,{children:"Split Overlap"}),(0,i.jsxs)(t.td,{children:["The number of segments to overlap from the previous chunk. Default: ",(0,i.jsx)(t.code,{children:"20"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"max_character_length"}),(0,i.jsx)(t.td,{children:"Max Character Length"}),(0,i.jsxs)(t.td,{children:["The maximum number of characters in each chunk. Default: ",(0,i.jsx)(t.code,{children:"1000"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"sentence_window_size"}),(0,i.jsx)(t.td,{children:"Sentence Window Size"}),(0,i.jsxs)(t.td,{children:["The number of sentences to include from previous and following chunks when ",(0,i.jsx)(t.code,{children:"split_by=sentence"}),". Default: ",(0,i.jsx)(t.code,{children:"0"}),"."]})]})]})]}),"\n",(0,i.jsx)(t.h3,{id:"outputs",children:"Outputs"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component outputs a list of ",(0,i.jsx)(t.a,{href:"/concepts-objects#data-object",children:"Data"})," objects where each object contains:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"text"}),": The extracted content.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"For text documents: The extracted text content."}),"\n",(0,i.jsx)(t.li,{children:"For tables and charts: The extracted table/chart content."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"file_path"}),": The source file name and path."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"document_type"}),': The type of the document ("text" or "structured").']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"description"}),": Additional description of the content."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["The output varies based on the ",(0,i.jsx)(t.code,{children:"document_type"}),":"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["Documents with ",(0,i.jsx)(t.code,{children:'document_type: "text"'})," contain:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Raw text content extracted from documents, for example, paragraphs from PDFs or DOCX files."}),"\n",(0,i.jsxs)(t.li,{children:["Content stored directly in the ",(0,i.jsx)(t.code,{children:"text"})," field."]}),"\n",(0,i.jsxs)(t.li,{children:["Content extracted using the ",(0,i.jsx)(t.code,{children:"extract_text"})," parameter."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["Documents with ",(0,i.jsx)(t.code,{children:'document_type: "structured"'})," contain:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Text extracted from tables and charts and processed to preserve structural information."}),"\n",(0,i.jsxs)(t.li,{children:["Content extracted using the ",(0,i.jsx)(t.code,{children:"extract_tables"})," and ",(0,i.jsx)(t.code,{children:"extract_charts"})," parameters."]}),"\n",(0,i.jsxs)(t.li,{children:["Content stored in the ",(0,i.jsx)(t.code,{children:"text"})," field after being processed from the ",(0,i.jsx)(t.code,{children:"table_content"})," metadata."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:"Images are currently not supported and will be skipped during processing."})})]})}function g(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},76102:(e,t,n)=>{n.d(t,{A:()=>s});const s=n.p+"assets/images/nvidia-component-ingest-astra-ac58faad6d13d928d400455962bf6028.png"}}]);
\ No newline at end of file
diff --git a/assets/js/5e834a3c.965aeff7.js b/assets/js/5e834a3c.965aeff7.js
deleted file mode 100644
index 17354dc030..0000000000
--- a/assets/js/5e834a3c.965aeff7.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[8245],{2255:(e,t,n)=>{n.r(t),n.d(t,{CH:()=>h,assets:()=>l,chCodeConfig:()=>a,contentTitle:()=>d,default:()=>g,frontMatter:()=>c,metadata:()=>s,toc:()=>x});const s=JSON.parse('{"id":"Integrations/Nvidia/integrations-nvidia-ingest","title":"Integrate Nvidia Ingest with Langflow","description":"The NVIDIA Ingest component integrates with the NVIDIA nv-ingest microservice for data ingestion, processing, and extraction of text files.","source":"@site/docs/Integrations/Nvidia/integrations-nvidia-ingest.md","sourceDirName":"Integrations/Nvidia","slug":"/integrations-nvidia-ingest","permalink":"/integrations-nvidia-ingest","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"Integrate Nvidia Ingest with Langflow","slug":"/integrations-nvidia-ingest"},"sidebar":"docs","previous":{"title":"Notion Meeting Notes Agent","permalink":"/integrations/notion/notion-agent-meeting-notes"},"next":{"title":"Join the Langflow community","permalink":"/contributing-community"}}');var i=n(74848),r=n(28453),o=n(24754);const c={title:"Integrate Nvidia Ingest with Langflow",slug:"/integrations-nvidia-ingest"},d=void 0,l={},h={annotations:o.hk,Code:o.Cy},a={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:!0,showCopyButton:!0,themeName:"github-dark"},x=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Use the NVIDIA Ingest component in a flow",id:"use-the-nvidia-ingest-component-in-a-flow",level:2},{value:"NVIDIA Ingest component parameters",id:"parameters",level:2},{value:"Inputs",id:"inputs",level:3},{value:"Outputs",id:"outputs",level:3}];function p(e){const t={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return h||u("CH",!1),h.Code||u("CH.Code",!0),(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component integrates with the ",(0,i.jsx)(t.a,{href:"https://github.com/NVIDIA/nv-ingest",children:"NVIDIA nv-ingest"})," microservice for data ingestion, processing, and extraction of text files."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.code,{children:"nv-ingest"})," service supports multiple extraction methods for PDF, DOCX, and PPTX file types, and includes pre- and post-processing services like splitting, chunking, and embedding generation."]}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component imports the NVIDIA ",(0,i.jsx)(t.code,{children:"Ingestor"})," client, ingests files with requests to the NVIDIA ingest endpoint, and outputs the processed content as a list of ",(0,i.jsx)(t.a,{href:"/concepts-objects#data-object",children:"Data"})," objects. ",(0,i.jsx)(t.code,{children:"Ingestor"})," accepts additional configuration options for data extraction from other text formats. To configure these options, see the ",(0,i.jsx)(t.a,{href:"/integrations-nvidia-ingest#parameters",children:"component parameters"}),"."]}),"\n",(0,i.jsx)(t.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["An NVIDIA Ingest endpoint. For more information on setting up an NVIDIA Ingest endpoint, see the ",(0,i.jsx)(t.a,{href:"https://github.com/NVIDIA/nv-ingest?tab=readme-ov-file#quickstart",children:"NVIDIA Ingest quickstart"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component requires the installation of additional dependencies to your Langflow environment. To install the dependencies in a virtual environment, run the following commands:"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(h.Code,{codeConfig:a,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"source **",props:{style:{color:"#79C0FF"}}},{content:"YOUR_LANGFLOW_VENV",props:{style:{color:"#A5D6FF"}}},{content:"**",props:{style:{color:"#79C0FF"}}},{content:"/bin/activate",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"uv ",props:{style:{color:"#FFA657"}}},{content:"sync ",props:{style:{color:"#A5D6FF"}}},{content:"--extra ",props:{style:{color:"#79C0FF"}}},{content:"nv-ingest",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"uv ",props:{style:{color:"#FFA657"}}},{content:"run langflow run",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,i.jsx)(t.h2,{id:"use-the-nvidia-ingest-component-in-a-flow",children:"Use the NVIDIA Ingest component in a flow"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component accepts ",(0,i.jsx)(t.strong,{children:"Message"})," inputs and outputs ",(0,i.jsx)(t.strong,{children:"Data"}),". The component calls a NVIDIA Ingest microservice's endpoint to ingest a local file and extract the text."]}),"\n",(0,i.jsx)(t.p,{children:"To use the NVIDIA Ingest component in your flow, follow these steps:"}),"\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["In the component library, click the ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component, and then drag it onto the canvas."]}),"\n",(0,i.jsxs)(t.li,{children:["In the ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingestion URL"})," field, enter the URL of the NVIDIA Ingest endpoint.\nOptionally, add the endpoint URL as a ",(0,i.jsx)(t.strong,{children:"Global variable"}),":","\n",(0,i.jsxs)(t.ol,{children:["\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Settings"}),", and then click ",(0,i.jsx)(t.strong,{children:"Global Variables"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Add New"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:["Name your variable. Paste your endpoint in the ",(0,i.jsx)(t.strong,{children:"Value"})," field."]}),"\n",(0,i.jsxs)(t.li,{children:["In the ",(0,i.jsx)(t.strong,{children:"Apply To Fields"})," field, select the field you want to globally apply this variable to. In this case, select ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingestion URL"}),"."]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Save Variable"}),"."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["In the ",(0,i.jsx)(t.strong,{children:"Path"})," field, enter the path to the file you want to ingest."]}),"\n",(0,i.jsx)(t.li,{children:"Select which text type to extract from the file.\nThe component supports text, charts, and tables."}),"\n",(0,i.jsxs)(t.li,{children:["Select whether to split the text into chunks.\nModify the splitting parameters in the component's ",(0,i.jsx)(t.strong,{children:"Configuration"})," tab."]}),"\n",(0,i.jsxs)(t.li,{children:["Click ",(0,i.jsx)(t.strong,{children:"Run"})," to ingest the file."]}),"\n",(0,i.jsxs)(t.li,{children:["To confirm the component is ingesting the file, open the ",(0,i.jsx)(t.strong,{children:"Logs"})," pane to view the output of the flow."]}),"\n",(0,i.jsxs)(t.li,{children:["To store the processed data in a vector database, add an ",(0,i.jsx)(t.strong,{children:"AstraDB Vector"})," component to your flow, and connect the ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component to the ",(0,i.jsx)(t.strong,{children:"AstraDB Vector"})," component with a ",(0,i.jsx)(t.strong,{children:"Data"})," output."]}),"\n"]}),"\n",(0,i.jsx)(t.p,{children:(0,i.jsx)(t.img,{alt:"NVIDIA Ingest component flow",src:n(76102).A+"",width:"1934",height:"1486"})}),"\n",(0,i.jsxs)(t.ol,{start:"10",children:["\n",(0,i.jsx)(t.li,{children:"Run the flow.\nInspect your Astra DB vector database to view the processed data."}),"\n"]}),"\n",(0,i.jsx)(t.h2,{id:"parameters",children:"NVIDIA Ingest component parameters"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component has the following parameters."]}),"\n",(0,i.jsxs)(t.p,{children:["For more information, see the ",(0,i.jsx)(t.a,{href:"https://nvidia.github.io/nv-ingest/user-guide/",children:"NV-Ingest documentation"}),"."]}),"\n",(0,i.jsx)(t.h3,{id:"inputs",children:"Inputs"}),"\n",(0,i.jsxs)(t.table,{children:[(0,i.jsx)(t.thead,{children:(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.th,{children:"Name"}),(0,i.jsx)(t.th,{children:"Display Name"}),(0,i.jsx)(t.th,{children:"Info"})]})}),(0,i.jsxs)(t.tbody,{children:[(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"base_url"}),(0,i.jsx)(t.td,{children:"NVIDIA Ingestion URL"}),(0,i.jsx)(t.td,{children:"The URL of the NVIDIA Ingestion API."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"path"}),(0,i.jsx)(t.td,{children:"Path"}),(0,i.jsx)(t.td,{children:"File path to process."})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"extract_text"}),(0,i.jsx)(t.td,{children:"Extract Text"}),(0,i.jsxs)(t.td,{children:["Extract text from documents. Default: ",(0,i.jsx)(t.code,{children:"True"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"extract_charts"}),(0,i.jsx)(t.td,{children:"Extract Charts"}),(0,i.jsxs)(t.td,{children:["Extract text from charts. Default: ",(0,i.jsx)(t.code,{children:"False"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"extract_tables"}),(0,i.jsx)(t.td,{children:"Extract Tables"}),(0,i.jsxs)(t.td,{children:["Extract text from tables. Default: ",(0,i.jsx)(t.code,{children:"True"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"text_depth"}),(0,i.jsx)(t.td,{children:"Text Depth"}),(0,i.jsxs)(t.td,{children:["The level at which text is extracted. Support for 'block', 'line', and 'span' varies by document type. Default: ",(0,i.jsx)(t.code,{children:"document"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_text"}),(0,i.jsx)(t.td,{children:"Split Text"}),(0,i.jsxs)(t.td,{children:["Split text into smaller chunks. Default: ",(0,i.jsx)(t.code,{children:"True"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_by"}),(0,i.jsx)(t.td,{children:"Split By"}),(0,i.jsxs)(t.td,{children:["How to split into chunks. 'size' splits by number of characters. Default: ",(0,i.jsx)(t.code,{children:"word"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_length"}),(0,i.jsx)(t.td,{children:"Split Length"}),(0,i.jsxs)(t.td,{children:["The size of each chunk based on the 'split_by' method. Default: ",(0,i.jsx)(t.code,{children:"200"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"split_overlap"}),(0,i.jsx)(t.td,{children:"Split Overlap"}),(0,i.jsxs)(t.td,{children:["The number of segments to overlap from the previous chunk. Default: ",(0,i.jsx)(t.code,{children:"20"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"max_character_length"}),(0,i.jsx)(t.td,{children:"Max Character Length"}),(0,i.jsxs)(t.td,{children:["The maximum number of characters in each chunk. Default: ",(0,i.jsx)(t.code,{children:"1000"}),"."]})]}),(0,i.jsxs)(t.tr,{children:[(0,i.jsx)(t.td,{children:"sentence_window_size"}),(0,i.jsx)(t.td,{children:"Sentence Window Size"}),(0,i.jsxs)(t.td,{children:["The number of sentences to include from previous and following chunks when ",(0,i.jsx)(t.code,{children:"split_by=sentence"}),". Default: ",(0,i.jsx)(t.code,{children:"0"}),"."]})]})]})]}),"\n",(0,i.jsx)(t.h3,{id:"outputs",children:"Outputs"}),"\n",(0,i.jsxs)(t.p,{children:["The ",(0,i.jsx)(t.strong,{children:"NVIDIA Ingest"})," component outputs a list of ",(0,i.jsx)(t.a,{href:"/concepts-objects#data-object",children:"Data"})," objects where each object contains:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"text"}),": The extracted content.","\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"For text documents: The extracted text content."}),"\n",(0,i.jsx)(t.li,{children:"For tables and charts: The extracted table/chart content."}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"file_path"}),": The source file name and path."]}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"document_type"}),': The type of the document ("text" or "structured").']}),"\n",(0,i.jsxs)(t.li,{children:[(0,i.jsx)(t.code,{children:"description"}),": Additional description of the content."]}),"\n"]}),"\n",(0,i.jsxs)(t.p,{children:["The output varies based on the ",(0,i.jsx)(t.code,{children:"document_type"}),":"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["Documents with ",(0,i.jsx)(t.code,{children:'document_type: "text"'})," contain:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Raw text content extracted from documents, for example, paragraphs from PDFs or DOCX files."}),"\n",(0,i.jsxs)(t.li,{children:["Content stored directly in the ",(0,i.jsx)(t.code,{children:"text"})," field."]}),"\n",(0,i.jsxs)(t.li,{children:["Content extracted using the ",(0,i.jsx)(t.code,{children:"extract_text"})," parameter."]}),"\n"]}),"\n"]}),"\n",(0,i.jsxs)(t.li,{children:["\n",(0,i.jsxs)(t.p,{children:["Documents with ",(0,i.jsx)(t.code,{children:'document_type: "structured"'})," contain:"]}),"\n",(0,i.jsxs)(t.ul,{children:["\n",(0,i.jsx)(t.li,{children:"Text extracted from tables and charts and processed to preserve structural information."}),"\n",(0,i.jsxs)(t.li,{children:["Content extracted using the ",(0,i.jsx)(t.code,{children:"extract_tables"})," and ",(0,i.jsx)(t.code,{children:"extract_charts"})," parameters."]}),"\n",(0,i.jsxs)(t.li,{children:["Content stored in the ",(0,i.jsx)(t.code,{children:"text"})," field after being processed from the ",(0,i.jsx)(t.code,{children:"table_content"})," metadata."]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(t.admonition,{type:"note",children:(0,i.jsx)(t.p,{children:"Images are currently not supported and will be skipped during processing."})})]})}function g(e={}){const{wrapper:t}={...(0,r.R)(),...e.components};return t?(0,i.jsx)(t,{...e,children:(0,i.jsx)(p,{...e})}):p(e)}function u(e,t){throw new Error("Expected "+(t?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}},76102:(e,t,n)=>{n.d(t,{A:()=>s});const s=n.p+"assets/images/nvidia-component-ingest-astra-ac58faad6d13d928d400455962bf6028.png"}}]);
\ No newline at end of file
diff --git a/assets/js/d8246fb2.882c714c.js b/assets/js/d8246fb2.882c714c.js
deleted file mode 100644
index 6e066dfbe1..0000000000
--- a/assets/js/d8246fb2.882c714c.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[6877],{4558:(e,t,o)=>{o.d(t,{A:()=>n});const n=o.p+"assets/images/api-pane-97a01b20a262676d4e21906df0e29f46.png"},57025:(e,t,o)=>{o.r(t),o.d(t,{CH:()=>p,assets:()=>h,chCodeConfig:()=>u,contentTitle:()=>d,default:()=>x,frontMatter:()=>a,metadata:()=>n,toc:()=>y});const n=JSON.parse('{"id":"Concepts/concepts-api","title":"API pane","description":"The\xa0API\xa0pane presents code templates for integrating your flow into external applications.","source":"@site/docs/Concepts/concepts-api.md","sourceDirName":"Concepts","slug":"/concepts-api","permalink":"/concepts-api","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"API pane","slug":"/concepts-api"},"sidebar":"docs","previous":{"title":"Langflow objects","permalink":"/concepts-objects"},"next":{"title":"Agents","permalink":"/components-agents"}}');var s=o(74848),r=o(28453),l=o(24754),c=o(65537),i=o(79329);const a={title:"API pane",slug:"/concepts-api"},d=void 0,h={},p={annotations:l.hk,Code:l.Cy},u={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:!0,showCopyButton:!0,themeName:"github-dark"},y=[{value:"Chat Widget",id:"chat-widget",level:2},{value:"Embed the chat widget into HTML",id:"embed-the-chat-widget-into-html",level:3},{value:"Embed the chat widget with React",id:"embed-the-chat-widget-with-react",level:3},{value:"Embed the chat widget with Angular",id:"embed-the-chat-widget-with-angular",level:3},{value:"Chat widget configuration",id:"chat-widget-configuration",level:2},{value:"Tweaks",id:"tweaks",level:2},{value:"Send image files to your flow with the API",id:"send-image-files-to-your-flow-with-the-api",level:2},{value:"Webhook cURL",id:"webhook-curl",level:2}];function g(e){const t={a:"a",admonition:"admonition",code:"code",em:"em",h2:"h2",h3:"h3",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,r.R)(),...e.components};return p||j("CH",!1),p.Code||j("CH.Code",!0),(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("style",{dangerouslySetInnerHTML:{__html:'[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }'}}),"\n","\n",(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"API"}),"\xa0pane presents code templates for integrating your flow into external applications."]}),"\n",(0,s.jsx)(t.p,{children:(0,s.jsx)(t.img,{src:o(4558).A+"",width:"3236",height:"1760"})}),"\n",(0,s.jsxs)(c.A,{children:[(0,s.jsx)(i.A,{value:"curl",label:"curl",default:!0,children:(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"cURL"}),"\xa0tab displays sample code for posting a query to your flow. Modify the\xa0",(0,s.jsx)(t.code,{children:"input_value"}),"\xa0to change your input message. Copy the code and run it to post a query to your flow and get the result."]})}),(0,s.jsxs)(i.A,{value:"Python API",label:"Python API",children:[(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"Python API"}),"\xa0tab displays code to interact with your flow using the Python HTTP ",(0,s.jsx)(t.code,{children:"requests"})," library."]}),(0,s.jsxs)(t.p,{children:["To use the ",(0,s.jsx)(t.code,{children:"requests"})," library:"]}),(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:"Copy and paste the code into a Python script."}),"\n",(0,s.jsx)(t.li,{children:"Run the script and pass your message with it."}),"\n"]}),(0,s.jsx)(p.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"python3 python",props:{style:{color:"#C9D1D9"}}},{content:"-",props:{style:{color:"#FF7B72"}}},{content:"test",props:{style:{color:"#C9D1D9"}}},{content:"-",props:{style:{color:"#FF7B72"}}},{content:"script.py ",props:{style:{color:"#C9D1D9"}}},{content:"--",props:{style:{color:"#FFA198",fontStyle:"italic"}}},{content:"message",props:{style:{color:"#C9D1D9"}}},{content:"=",props:{style:{color:"#FF7B72"}}},{content:'"tell me about something interesting"',props:{style:{color:"#A5D6FF"}}}]}],lang:"python"},annotations:[]}]})]}),(0,s.jsxs)(i.A,{value:"JS API",label:"JS API",default:!0,children:[(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"JavaScript API"}),"\xa0tab displays code to interact with your flow in JavaScript."]}),(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsx)(t.li,{children:"Copy and paste the code into a JavaScript file."}),"\n",(0,s.jsx)(t.li,{children:"Run the script with any necessary arguments for your flow:"}),"\n"]}),(0,s.jsx)(p.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:'node test-script.js "tell me about something interesting"',props:{}}]}],lang:"text"},annotations:[]}]}),(0,s.jsx)(t.p,{children:"The response content depends on your flow. Make sure the endpoint returns a successful response."})]}),(0,s.jsxs)(i.A,{value:"Python code",label:"Python code",default:!0,children:[(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"Python Code"}),"\xa0tab displays code to interact with your flow's\xa0",(0,s.jsx)(t.code,{children:".json"}),"\xa0file using the Langflow runtime."]}),(0,s.jsx)(t.p,{children:"To use your code in a Python application using the Langflow runtime, you have to first download your flow\u2019s JSON file."}),(0,s.jsxs)(t.ol,{children:["\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsxs)(t.p,{children:["In your ",(0,s.jsx)(t.strong,{children:"Workspace"}),", click ",(0,s.jsx)(t.strong,{children:"Settings"}),", and then select ",(0,s.jsx)(t.strong,{children:"Export"}),"."]}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Download the flow to your local machine. Make sure the flow path in the script matches the flow\u2019s location on your machine."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Copy and paste the code from the API tab into a Python script file."}),"\n"]}),"\n",(0,s.jsxs)(t.li,{children:["\n",(0,s.jsx)(t.p,{children:"Run the script:"}),"\n"]}),"\n"]}),(0,s.jsx)(p.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"python python",props:{style:{color:"#C9D1D9"}}},{content:"-",props:{style:{color:"#FF7B72"}}},{content:"test",props:{style:{color:"#C9D1D9"}}},{content:"-",props:{style:{color:"#FF7B72"}}},{content:"script.py",props:{style:{color:"#C9D1D9"}}}]}],lang:"python"},annotations:[]}]})]})]}),"\n",(0,s.jsx)(t.h2,{id:"chat-widget",children:"Chat Widget"}),"\n",(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"Chat Widget HTML"}),"\xa0tab displays code that can be inserted in the\xa0",(0,s.jsx)(t.code,{children:""}),"\xa0of your HTML to interact with your flow."]}),"\n",(0,s.jsxs)(t.p,{children:["The\xa0",(0,s.jsx)(t.strong,{children:"Langflow Chat Widget"}),"\xa0is a powerful web component that enables communication with a Langflow project. This widget allows for a chat interface embedding, allowing the integration of Langflow into web applications effortlessly."]}),"\n",(0,s.jsx)(t.p,{children:"You can get the HTML code embedded with the chat by clicking the Code button at the Sidebar after building a flow."}),"\n",(0,s.jsx)(t.p,{children:"Clicking the Chat Widget HTML tab, you'll get the code to be inserted. Read below to learn how to use it with HTML, React and Angular."}),"\n",(0,s.jsx)(t.h3,{id:"embed-the-chat-widget-into-html",children:"Embed the chat widget into HTML"}),"\n",(0,s.jsxs)(t.p,{children:["To embed the chat widget into any HTML page, insert the code snippet. inside a\xa0",(0,s.jsx)(t.code,{children:""}),"\xa0tag."]}),"\n",(0,s.jsx)(p.Code,{codeConfig:u,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"<",props:{style:{color:"#C9D1D9"}}},{content:"script ",props:{style:{color:"#7EE787"}}},{content:"src",props:{style:{color:"#79C0FF"}}},{content:"=",props:{style:{color:"#C9D1D9"}}},{content:'"https://cdn.jsdelivr.net/gh/logspace-ai/langflow-embedded-chat@v1.0.7/dist/build/static/js/bundle.min.js"',props:{style:{color:"#A5D6FF"}}},{content:'"',props:{style:{color:"#FFA198",fontStyle:"italic"}}},{content:">",props:{style:{color:"#C9D1D9"}}},{content:"script",props:{style:{color:"#7EE787"}}},{content:">",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:"",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:" <",props:{style:{color:"#C9D1D9"}}},{content:"langflow-chat",props:{style:{color:"#7EE787"}}}]},{tokens:[{content:" window_title",props:{style:{color:"#79C0FF"}}},{content:"=",props:{style:{color:"#C9D1D9"}}},{content:'"Basic Prompting"',props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:" flow_id",props:{style:{color:"#79C0FF"}}},{content:"=",props:{style:{color:"#C9D1D9"}}},{content:'"801abb1e-19b9-4278-9632-179b6d84f126"',props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:" host_url",props:{style:{color:"#79C0FF"}}},{content:"=",props:{style:{color:"#C9D1D9"}}},{content:'"http://localhost:7860"',props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"",props:{style:{color:"#C9D1D9"}}}]},{tokens:[{content:" >",props:{style:{color:"#C9D1D9"}}},{content:"langflow-chat",props:{style:{color:"#7EE787"}}},{content:">",props:{style:{color:"#C9D1D9"}}}]}],lang:"html"},annotations:[]}]}),"\n",(0,s.jsx)(t.h3,{id:"embed-the-chat-widget-with-react",children:"Embed the chat widget with React"}),"\n",(0,s.jsxs)(t.p,{children:["To embed the Chat Widget using React, insert this\xa0",(0,s.jsx)(t.code,{children:"
+
diff --git a/components-custom-components.html b/components-custom-components.html
index 08a87d7529..55a0913231 100644
--- a/components-custom-components.html
+++ b/components-custom-components.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-data.html b/components-data.html
index 0ca2883650..ac7bdcf327 100644
--- a/components-data.html
+++ b/components-data.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-embedding-models.html b/components-embedding-models.html
index 195a9f4e6e..352caffcf9 100644
--- a/components-embedding-models.html
+++ b/components-embedding-models.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-helpers.html b/components-helpers.html
index c913330a99..404a302d51 100644
--- a/components-helpers.html
+++ b/components-helpers.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-io.html b/components-io.html
index 521ffe275e..de7c423a74 100644
--- a/components-io.html
+++ b/components-io.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-loaders.html b/components-loaders.html
index ce8c0aa5b3..164395380c 100644
--- a/components-loaders.html
+++ b/components-loaders.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-logic.html b/components-logic.html
index b6f58109e8..8487f3d4b1 100644
--- a/components-logic.html
+++ b/components-logic.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-memories.html b/components-memories.html
index 0adb1c28ef..a3a6bb4a4f 100644
--- a/components-memories.html
+++ b/components-memories.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-models.html b/components-models.html
index e34d151ed9..88b9b46dc7 100644
--- a/components-models.html
+++ b/components-models.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-processing.html b/components-processing.html
index 13c7649e10..b63f8794a2 100644
--- a/components-processing.html
+++ b/components-processing.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-prompts.html b/components-prompts.html
index 23f526fa1c..a04d5baa2f 100644
--- a/components-prompts.html
+++ b/components-prompts.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-tools.html b/components-tools.html
index ee179791db..0ac4b06f4c 100644
--- a/components-tools.html
+++ b/components-tools.html
@@ -16,7 +16,7 @@
-
+
diff --git a/components-vector-stores.html b/components-vector-stores.html
index 6ba8394082..c218361c67 100644
--- a/components-vector-stores.html
+++ b/components-vector-stores.html
@@ -16,7 +16,7 @@
-
+
diff --git a/concepts-api.html b/concepts-api.html
index 0b5f2a97ab..5c8916ece3 100644
--- a/concepts-api.html
+++ b/concepts-api.html
@@ -16,7 +16,7 @@
-
+
@@ -43,7 +43,7 @@
Download the flow to your local machine. Make sure the flow path in the script matches the flow’s location on your machine.
-
Copy and paste the code from the API tab into a Python script file.
+
Copy and paste the code from the Python Code tab into a Python script file.
An NVIDIA Ingest endpoint. For more information on setting up an NVIDIA Ingest endpoint, see the NVIDIA Ingest quickstart.
-
The NVIDIA Ingest component requires the installation of additional dependencies to your Langflow environment. To install the dependencies in a virtual environment, run the following commands:
-
+
The NVIDIA Ingest component requires the installation of additional dependencies to your Langflow environment. To install the dependencies in a virtual environment, run the following commands.
+
+
If you have the Langflow repository cloned and installed from source:
_10
source **YOUR_LANGFLOW_VENV**/bin/activate
_10
uv sync --extra nv-ingest
_10
uv run langflow run
+
+
If you are installing Langflow from the Python Package Index:
The NVIDIA Ingest component accepts Message inputs and outputs Data. The component calls a NVIDIA Ingest microservice's endpoint to ingest a local file and extract the text.
To use the NVIDIA Ingest component in your flow, follow these steps: