diff --git a/404.html b/404.html index c3f04360f7..86f8797d51 100644 --- a/404.html +++ b/404.html @@ -16,7 +16,7 @@ - +
diff --git a/Concepts/concepts-flows.html b/Concepts/concepts-flows.html index 1331dfbbde..34f9667444 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 fed3e1e14f..2872719433 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 39e1269f6d..6e8baa6dea 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 bd27a5e80a..bde4219a9e 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 7cb505bcdf..81c6e3f3ad 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 8e8ec1e269..5add07ef32 100644 --- a/api.html +++ b/api.html @@ -16,7 +16,7 @@ - + diff --git a/api/add-user.html b/api/add-user.html index 19c4e9b3bc..6f145ebe03 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 4a7d8fc1b0..1a362d0448 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 c94661f84f..f484fd5c5e 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 bcaec19d51..81846aeb0c 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 d99d944384..d28489e662 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 3a637a7246..193f49eb1b 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 ef084e5399..54f57cc941 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 72d3948ca2..0971a0536f 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 5cb9a16fd7..515f324914 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 02eeb655b3..d7f3f792d5 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 dbd662f4e3..12df9c663b 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 0057e0969c..8eba9bc56d 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 ec6e84a8ce..07bfe2d2d7 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 f447a250d5..cac912f140 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 0344055fdc..494fce3648 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 f4f8fa3885..8f41229f79 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 e259c63820..ca0f91071b 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 f565ac3aba..2597810327 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 580bb2eaa4..15756ee092 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 54d7868f05..d6ae7c66ad 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 0a47c0d764..a93669798a 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 8354b4b614..de2aa200b3 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 d56ab526d7..a0d1a8ad88 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 23d3419a8d..1a0d42285c 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 f8203fd5bb..f8b31737cb 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 74a7fcee9c..5db1808ba4 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 7370a8f792..73099c7537 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 81f0d99537..c844668ddb 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 dc6167cc3a..59ac08b38b 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 2fbbdcd0be..18a1810c91 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 5eb069b382..2ccb7a4991 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 cd392ab3e6..11ac649599 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 d281f131fb..c0ea4d2751 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 361994ec78..a0f9397e13 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 6180bca500..5f94796915 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 c30e3469ea..9761de66fe 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 13a2c19dc5..be8f0d7315 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 5e9dad1d33..1b77d4b403 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 dd658666d6..572bbf06c0 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 fe5bcea0f0..c0f2555821 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 b02d102d21..97f954512f 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 ffaedce224..d23d016da1 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 caa6f08dfe..1c563a1ef9 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 0fc5a384d5..877c99ffbd 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 47e76941d4..fc000d9894 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 7fc5ef19de..6feb53376d 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 250ed193e8..070d07cae5 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 ff3802fa9d..58e8a4190c 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 99330300ba..957b37b6bf 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 7fad4374a2..9c8d79af7f 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 d066d175ce..77c31a1616 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 044e64ecda..c367e3b657 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 76189741e8..c8343b1272 100644 --- a/api/logout.html +++ b/api/logout.html @@ -16,7 +16,7 @@ - + diff --git a/api/logs.html b/api/logs.html index d038cd565d..201031f525 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 0ad97689fc..147a275fb3 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 2b4c11f777..07025dfbaa 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 32bc0eb877..6d82500865 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 02b06cf4aa..592cea82f1 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 fc9a48e0b3..f9f49eac90 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 8758bae210..f6e5e1b0c0 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 ce56fe376d..12ecd35672 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 2620ee6319..e378eac667 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 f3a1ec599f..6fd0f233a6 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 afed8033a9..74131a6124 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 db5dedc5b7..84db332ca9 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 440338d9d6..c71b106ede 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 63fc5bbd42..4850107467 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 895756c52b..b8a04406c8 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 d35f97185c..400166802c 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 e21b84bd18..d69d6a6ac1 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 e8f602f51b..a16bd22049 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 37e2ee5cb5..6870f70975 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 41cfd287b9..5193dff4e9 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 f39ffcd4e6..ca733f0bc7 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 4456234abc..f722ecc42d 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 3997c26056..47a199bca2 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 8db5a010f5..fe7e86011f 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 4fc77023d8..9532fe1256 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 81c8cd4cbf..5538483094 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 e57e469b50..2221ebaf59 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 6fcc964659..890937b49c 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 7c8e84357d..3acb3b50ab 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 b746bfc640..1c17ab3fe2 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 be8cebed7f..ce59f14c5f 100644 --- a/api/webhook-run-flow.html +++ b/api/webhook-run-flow.html @@ -16,7 +16,7 @@ - + diff --git a/assets/js/2ab0d4f5.fd0aac36.js b/assets/js/2ab0d4f5.8ad681f9.js similarity index 50% rename from assets/js/2ab0d4f5.fd0aac36.js rename to assets/js/2ab0d4f5.8ad681f9.js index 3506401505..c7515314f0 100644 --- a/assets/js/2ab0d4f5.fd0aac36.js +++ b/assets/js/2ab0d4f5.8ad681f9.js @@ -1 +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":"{context} variable in the PromptThis component implements a Vector Store using Astra DB with search capabilities.
For more information, see the DataStax documentation.
| Name | Display Name | Info |
|---|---|---|
| collection_name | Collection Name | The name of the collection within Astra DB where the vectors will be stored (required) |
| token | Astra DB Application Token | Authentication token for accessing Astra DB (required) |
| api_endpoint | API Endpoint | API endpoint URL for the Astra DB service (required) |
| search_input | Search Input | Query string for similarity search |
| ingest_data | Ingest Data | Data to be ingested into the vector store |
| namespace | Namespace | Optional namespace within Astra DB to use for the collection |
| embedding_choice | Embedding Model or Astra Vectorize | Determines whether to use an Embedding Model or Astra Vectorize for the collection |
| embedding | Embedding Model | Allows an embedding model configuration (when using Embedding Model) |
| provider | Vectorize Provider | Provider for Astra Vectorize (when using Astra Vectorize) |
| metric | Metric | Optional distance metric for vector comparisons |
| batch_size | Batch Size | Optional number of data to process in a single batch |
| setup_mode | Setup Mode | Configuration mode for setting up the vector store (options: "Sync", "Async", "Off", default: "Sync") |
| pre_delete_collection | Pre Delete Collection | Boolean flag to determine whether to delete the collection before creating a new one |
| number_of_results | Number of Results | Number of results to return in similarity search (default: 4) |
| search_type | Search Type | Search type to use (options: "Similarity", "Similarity with score threshold", "MMR (Max Marginal Relevance)") |
| search_score_threshold | Search Score Threshold | Minimum similarity score threshold for search results |
| search_filter | Search Metadata Filter | Optional dictionary of filters to apply to the search query |
| Name | Display Name | Info |
|---|---|---|
| token | Astra DB Application Token | The authentication token for accessing Astra DB. |
| environment | Environment | The environment for the Astra DB API Endpoint. For example, dev or prod. |
| database_name | Database | The database name for the Astra DB instance. |
| api_endpoint | Astra DB API Endpoint | The API endpoint for the Astra DB instance. This supersedes the database selection. |
| collection_name | Collection | The name of the collection within Astra DB where the vectors are stored. |
| keyspace | Keyspace | An optional keyspace within Astra DB to use for the collection. |
| embedding_choice | Embedding Model or Astra Vectorize | Choose an embedding model or use Astra vectorize. |
| embedding_model | Embedding Model | Specify the embedding model. Not required for Astra vectorize collections. |
| number_of_results | Number of Search Results | The number of search results to return (default: 4). |
| search_type | Search Type | The search type to use. The options are Similarity, Similarity with score threshold, and MMR (Max Marginal Relevance). |
| search_score_threshold | Search Score Threshold | The minimum similarity score threshold for search results when using the Similarity with score threshold option. |
| advanced_search_filter | Search Metadata Filter | An optional dictionary of filters to apply to the search query. |
| autodetect_collection | Autodetect Collection | A boolean flag to determine whether to autodetect the collection. |
| content_field | Content Field | A field to use as the text content field for the vector store. |
| deletion_field | Deletion Based On Field | When provided, documents in the target collection with metadata field values matching the input metadata field value are deleted before new data is loaded. |
| ignore_invalid_documents | Ignore Invalid Documents | A boolean flag to determine whether to ignore invalid documents at runtime. |
| astradb_vectorstore_kwargs | AstraDBVectorStore Parameters | An optional dictionary of additional parameters for the AstraDBVectorStore. |
| Name | Display Name | Info |
|---|---|---|
| vector_store | Vector Store | Astra DB vector store instance configured with the specified parameters. |
| search_results | Search Results | The results of the similarity search as a list of Data objects. |
| Name | Display Name | Info |
|---|---|---|
| vector_store | Vector Store | Astra DB vector store instance configured with the specified parameters. |
| search_results | Search Results | The results of the similarity search as a list of Data objects. |
The Astra DB Vector Store component offers two methods for generating embeddings.
+Embedding Model: Use your own embedding model by connecting an Embeddings component in Langflow.
+Astra Vectorize: Use Astra DB's built-in embedding generation service. When creating a new collection, choose the embeddings provider and models, including NVIDIA's NV-Embed-QA model hosted by Datastax.
The embedding model selection is made when creating a new collection and cannot be changed later.
For an example of using the Astra DB Vector Store component with an embedding model, see the Vector Store RAG starter project.
+For more information, see the Astra DB Serverless documentation.
This component implements a Vector Store using AstraDB with graph capabilities. For more information, see the Astra DB Serverless documentation.
@@ -202,6 +215,6 @@ For more information, see the Inputs| Name | Type | Description |
|---|---|---|
| search_type | String | Type of search, such as "Similarity" or "MMR" |
| input_value | String | Search query |
| weaviate_url | String | Default instance URL |
| search_by_text | Boolean | Indicates whether to search by text |
| api_key | SecretString | Optional API key for authentication |
| index_name | String | Optional index name |
| text_key | String | Default text extraction key |
| embedding | Embeddings | Model used |
| attributes | List[String] | Optional additional attributes |
| Name | Type | Description |
|---|---|---|
| search_results | List[Data] | Results of similarity search |
| Name | Type | Description |
|---|---|---|
| search_results | List[Data] | Results of similarity search |