Skip to content

docs: rag chatbot tutorial#8929

Merged
mendonk merged 23 commits into
mainfrom
docs-rag-chatbot-tutorial
Jul 10, 2025
Merged

docs: rag chatbot tutorial#8929
mendonk merged 23 commits into
mainfrom
docs-rag-chatbot-tutorial

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Jul 8, 2025

Preview build

Add a tutorial on embedding vector data, and then create a javascript application to interact with the flow.

Summary by CodeRabbit

  • Documentation
    • Added a tutorial on creating a chatbot that interacts with user-uploaded files.
    • Added a tutorial on building a vector RAG chatbot using a vector database.
    • Included a sample fake resume for tutorial demonstrations.
    • Updated the sidebar to include a new "Tutorials" section with links to the new guides.

@mendonk mendonk requested review from aimurphy and melienherrera July 8, 2025 11:44
@mendonk mendonk self-assigned this Jul 8, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 8, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Three new tutorial documents and a sample resume file were added to the documentation. The sidebar configuration was updated to include a new "Tutorials" section under "Get started," listing the two new tutorials. No changes were made to application code or exported entities.

Changes

File(s) Change Summary
docs/docs/Tutorials/chat-with-files.md,
docs/docs/Tutorials/chat-with-rag.md
Added two new tutorial documents: one for creating a chatbot with files, one for a vector RAG chatbot.
docs/docs/Tutorials/fake-resume.txt Added a sample fake resume file for tutorial demonstration.
docs/sidebars.js Updated sidebar to include a "Tutorials" section with links to the new tutorials.

Suggested labels

documentation, size:L, lgtm

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-rag-chatbot-tutorial

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jul 8, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 8, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 8, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (8)
docs/sidebars.js (1)

10-17: Consider promoting “Tutorials” to a top-level category (optional).

Placing Tutorials under Get started is fine, but the doc set already has several top-level categories (Templates, Concepts, Components, …). A top-level Tutorials section would be more discoverable and future-proof as the list grows.
No action required if you prefer the current hierarchy.

docs/docs/Tutorials/chat-with-rag.md (3)

105-108: Unify list marker style.

Use the same bullet marker across the doc (conventionally -) instead of switching to *, which triggers MD004.

-    * `LANGFLOW_SERVER_ADDRESS`: Your Langflow server's domain. …
-    * `FLOW_ID`: Your flow's UUID or custom endpoint name. …
-    * `LANGFLOW_API_KEY`: A valid Langflow API key. …
+    - `LANGFLOW_SERVER_ADDRESS`: Your Langflow server's domain. …
+    - `FLOW_ID`: Your flow's UUID or custom endpoint name. …
+    - `LANGFLOW_API_KEY`: A valid Langflow API key. …

196-204: Add a language identifier to the fenced code block.

The response example is currently

```                  
…JSON omitted…
```

Without a language tag MD040 is raised and syntax highlighting is lost.

-```
+```text

211-212: Match bullet style with earlier change.

Replace * with - to stay consistent:

-* [Model Context Protocol (MCP) servers](/mcp-server)
-* [Langflow deployment overview](/deployment-overview)
+- [Model Context Protocol (MCP) servers](/mcp-server)
+- [Langflow deployment overview](/deployment-overview)
docs/docs/Tutorials/chat-with-files.md (3)

55-63: Switch to a uniform dash list marker.

Same MD004 issue as in the RAG tutorial.

-    * `LANGFLOW_SERVER_ADDRESS`: …
-    * `FLOW_ID`: …
-    * File Component name: …
-    * Input value: …
-    * File path: …
-    * Session ID: …
-    * Langflow API key: …
+    - `LANGFLOW_SERVER_ADDRESS`: …
+    - `FLOW_ID`: …
+    - File component name: …
+    - Input value: …
+    - File path: …
+    - Session ID: …
+    - Langflow API key: …

138-142: Add language tag to fenced “Response” block.

-```
+```text

170-173: Keep list style consistent (dash vs asterisk).

-* [Model Context Protocol (MCP) servers](/mcp-server)
-* [Langflow deployment overview](/deployment-overview)
+- [Model Context Protocol (MCP) servers](/mcp-server)
+- [Langflow deployment overview](/deployment-overview)
docs/docs/Tutorials/fake-resume.txt (1)

1-6: Minor formatting nit – separate the heading from the name.

Currently the first line mixes the intro text and the candidate’s name, making parsing harder for readers or automated tools:

-Here's a sample fake resume for educational purposes: Emily J. Wilson
+Here's a sample fake resume for educational purposes  
+**Emily J. Wilson**
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7aeb687 and 62fb7b6.

⛔ Files ignored due to path filters (3)
  • docs/static/img/tutorial-chat-file-loader.png is excluded by !**/*.png
  • docs/static/img/tutorial-chatbot-chat-flow.png is excluded by !**/*.png
  • docs/static/img/tutorial-chatbot-embed-files.png is excluded by !**/*.png
📒 Files selected for processing (4)
  • docs/docs/Tutorials/chat-with-files.md (1 hunks)
  • docs/docs/Tutorials/chat-with-rag.md (1 hunks)
  • docs/docs/Tutorials/fake-resume.txt (1 hunks)
  • docs/sidebars.js (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`docs/docs/**/*.{md,mdx}`: All documentation content must be placed within the '...

docs/docs/**/*.{md,mdx}: All documentation content must be placed within the 'docs/' directory, organized into subdirectories such as 'getting-started', 'components', 'integrations', 'administration', 'contributing', and 'api-reference'.
All documentation markdown files must start with a frontmatter block containing at least 'title' and 'description' fields.
Use admonitions (:::tip, :::warning, :::danger) in markdown files to highlight important information, warnings, or critical issues.
Reference images in documentation using the '/img/' path and provide descriptive alt text in markdown.
Use code blocks with language identifiers and optional titles for code examples in markdown documentation.
Documentation content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

List of files the instruction was applied to:

  • docs/docs/Tutorials/chat-with-rag.md
  • docs/docs/Tutorials/chat-with-files.md
`docs/sidebars.js`: Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.

docs/sidebars.js: Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

List of files the instruction was applied to:

  • docs/sidebars.js
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.682Z
Learning: Applies to docs/sidebars.js : Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.
docs/sidebars.js (2)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.682Z
Learning: Applies to docs/sidebars.js : Sidebar navigation must be configured and updated in 'docs/sidebars.js' to reflect the current documentation structure.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: Sidebar and navigation should be kept current to ensure users can easily find all documentation sections and cross-references.
docs/docs/Tutorials/chat-with-files.md (1)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/testing.mdc:0-0
Timestamp: 2025-06-30T14:41:58.849Z
Learning: Applies to {src/backend/tests/**/*.py,tests/**/*.py} : Test Langflow's 'Message' objects and chat functionality by asserting correct properties and structure.
🪛 LanguageTool
docs/docs/Tutorials/fake-resume.txt

[grammar] ~6-~6: Use proper spacing conventions.
Context: ...and visibility and driving sales growth. Work Experience: Marketing Director, Gre...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~9-~9: Use proper spacing conventions.
Context: ... in a 25% increase in brand recognition. Managed a team of marketing specialists ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~10-~10: Use proper spacing conventions.
Context: ...rease in sales within the first quarter. Senior Marketing Manager, BlueSky Ventur...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~12-~12: Use proper spacing conventions.
Context: ...ement by 50% and follower growth by 20%. Collaborated with the sales team to alig...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~13-~13: Use proper spacing conventions.
Context: ... in a 15% increase in sales conversions. Marketing Coordinator, Starlight Media (...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~15-~15: Use proper spacing conventions.
Context: ...luding product launches and trade shows. Developed content for marketing material...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~16-~16: Use proper spacing conventions.
Context: ... brochures, flyers, and email campaigns. Education: Master of Business Administra...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~30-~30: Use proper spacing conventions.
Context: ...tion References: Available upon request. This resume is entirely fictional and sh...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

docs/docs/Tutorials/chat-with-rag.md

[grammar] ~8-~8: Use proper spacing conventions.
Context: ...'; import TabItem from '@theme/TabItem'; Create a chatbot application that uses R...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~13-~13: Use proper spacing conventions.
Context: ...onents-vector-stores). ## Prerequisites - [A running Langflow instance](/get-starte...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~16-~16: Use proper spacing conventions.
Context: ...arted-installation) - An OpenAI API key ## Create a vector RAG flow 1. In Langflow...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~18-~18: Place a period at the end of declarative sentences.
Context: ...penai.com/) ## Create a vector RAG flow 1. In Langflow, click New Flow, and the...

(QB_NEW_EN_OTHER_ERROR_IDS_000178)


[grammar] ~21-~21: Use proper spacing conventions.
Context: ...to the OpenAI Embeddings components. 3. Replace both Astra DB vector store c...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~24-~24: Use proper spacing conventions.
Context: ...Your loading flow should look like this: File loader chat flow Your chat flow should look like this: ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~28-~28: Use proper spacing conventions.
Context: ... Your chat flow should look like this: Chat with RAG flow The flow is complete. In the next se...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~32-~32: There might be a problem here.
Context: ...hat-flow.png) The flow is complete. In the next section, you will embed fil...

(QB_NEW_EN_MERGED_MATCH)


[grammar] ~33-~33: There might be a mistake here.
Context: ... you will embed files into your database, and then create a chatbot to chat with ...

(QB_NEW_EN_OTHER)


[grammar] ~33-~33: Use proper spacing conventions.
Context: ...then create a chatbot to chat with them. ## Load and embed a file You have two opti...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~35-~35: Place a period at the end of declarative sentences.
Context: ...hat with them. ## Load and embed a file You have two options for loading and emb...

(QB_NEW_EN_OTHER_ERROR_IDS_000178)


[grammar] ~37-~37: There might be a mistake here.
Context: ...a file into your vector database: the UI, or the /v2/files endpoint. The UI is...

(QB_NEW_EN_OTHER)


[grammar] ~37-~37: Use proper spacing conventions.
Context: ...se: the UI, or the /v2/files endpoint. The UI is the easiest method. ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~39-~39: Use proper spacing conventions.
Context: ...endpoint. The UI is the easiest method. 1. In the File component, click File. 2. Select the local file you want to upload, and then click Open. The file is loaded to your Langflow server. 3. To run the embedding flow, in the vector store component, click Run component. The file is split by chunk overlap and chunk size, and then the chunked files are embedded by the Embeddings component into the vector database. To upload files with the API, send a request to the flow's File component containing the uploaded path to your file. The fastest way to form this request is with the Langflow File Upload Utility. For example: js // Node 18+ example using global fetch, FormData, and Blob import fs from 'fs/promises'; // 1. Prepare the form data with the file to upload const fileBuffer = await fs.readFile('FILE_NAME'); const data = new FormData(); data.append('file', new Blob([fileBuffer]), 'FILE_NAME'); const headers = { 'x-api-key': 'LANGFLOW_API_KEY' }; // 2. Upload the file to Langflow const uploadRes = await fetch('LANGFLOW_SERVER_ADDRESS/api/v2/files/', { method: 'POST', headers, body: data }); const uploadData = await uploadRes.json(); const uploadedPath = uploadData.path; // 3. Call the Langflow run endpoint with the uploaded file path const payload = { input_value: "Analyze this file", output_type: "chat", input_type: "text", tweaks: { 'FILE_COMPONENT_NAME': { path: uploadedPath } } }; const runRes = await fetch('LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID', { method: 'POST', headers: { 'Content-Type': 'application/json', 'x-api-key': 'LANGFLOW_API_KEY' }, body: JSON.stringify(payload) }); const langflowData = await runRes.json(); // Output only the message console.log(langflowData.outputs?.[0]?.outputs?.[0]?.results?.message?.data?.text); ## Chat with your flow from a JavaScript ap...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~99-~99: Place a period at the end of declarative sentences.
Context: ... your flow from a JavaScript application With your files loaded and embedded in y...

(QB_NEW_EN_OTHER_ERROR_IDS_000178)


[grammar] ~101-~101: Use proper spacing conventions.
Context: ...vaScript chatbot to chat with your data. 1. To construct the chatbot, gather the fol...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~103-~103: Use proper spacing conventions.
Context: ...atbot, gather the following information: Replace the following values: * `LAN...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~106-~106: Use proper spacing conventions.
Context: ...ess** pane](/concepts-publish#api-pane). * FLOW_ID: Your flow's UUID or custom endpoint na...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~107-~107: Use proper spacing conventions.
Context: ...ess** pane](/concepts-publish#api-pane). * LANGFLOW_API_KEY: A valid Langflow API key. To create an...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~108-~108: Use proper spacing conventions.
Context: ...see API keys. 2. Copy the following script into a JavaScr...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~110-~110: Use proper spacing conventions.
Context: ...ation you gathered in the previous step: js #!/usr/bin/env node const readline = require('readline'); const fetch = require('node-fetch'); const API_KEY = 'LANGFLOW_API_KEY'; const SERVER = 'LANGFLOW_SERVER_ADDRESS'; const FLOW_ID = 'FLOW_ID'; const rl = readline.createInterface({ input: process.stdin, output: process.stdout }); async function sendMessage(message) { try { const response = await fetch(`${SERVER}/api/v1/run/${FLOW_ID}`, { method: 'POST', headers: { 'Content-Type': 'application/json', 'x-api-key': API_KEY }, body: JSON.stringify({ output_type: 'chat', input_type: 'chat', input_value: message, session_id: 'user_1' }) }); const data = await response.json(); return data.outputs?.[0]?.outputs?.[0]?.results?.message?.data?.text || 'No response'; } catch (error) { return `Error: ${error.message}`; } } function chat() { console.log('🤖 Langflow RAG Chatbot (type "quit" to exit)\n'); const ask = () => { rl.question('👤 You: ', async (input) => { if (['quit', 'exit', 'bye'].includes(input.trim().toLowerCase())) { console.log('👋 Goodbye!'); rl.close(); return; } const response = await sendMessage(input.trim()); console.log(`🤖 Assistant: ${response}\n`); ask(); }); }; ask(); } chat(); The script creates a Node application th...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~167-~167: Use proper spacing conventions.
Context: ...ith the content in your vector database. The script uses the chat input and out...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~169-~169: There might be a problem here.
Context: ... to communicate with your Langflow flow. Chat maintains ongoing conversation con...

(QB_NEW_EN_MERGED_MATCH)


[grammar] ~172-~172: Use proper spacing conventions.
Context: ...t with it more with follow-up questions. json { "outputs": [{ "outputs": [{ "results": { "message": { "data": { "text": "The actual response text" } } } }] }] } 3. Save and run the script to send the requ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~189-~189: Use proper spacing conventions.
Context: ... to send the requests and test the flow.

Response The following is an example of a respons...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~209-~209: Use proper spacing conventions.
Context: ... ```

## Next steps * [Model Context Protocol (MCP) servers](/m...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

docs/docs/Tutorials/chat-with-files.md

[grammar] ~8-~8: Use proper spacing conventions.
Context: ...'; import TabItem from '@theme/TabItem'; Create a chatbot application that chats ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~10-~10: Use proper spacing conventions.
Context: ...th files loaded from your local machine. ## Prerequisites - [A running Langflow ins...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~12-~12: Use proper spacing conventions.
Context: ...om your local machine. ## Prerequisites - [A running Langflow instance](/get-starte...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~15-~15: Use proper spacing conventions.
Context: ...arted-installation) - An OpenAI API key ## Create a file loader chat flow 1. In La...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~17-~17: Place a period at the end of declarative sentences.
Context: ...keys) ## Create a file loader chat flow 1. In Langflow, click New Flow, and the...

(QB_NEW_EN_OTHER_ERROR_IDS_000178)


[grammar] ~19-~19: Use proper spacing conventions.
Context: ...select the Basic prompting template. 2. Add your OpenAI API key to the **Lan...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~20-~20: Use proper spacing conventions.
Context: ...key to the Language Model component. 3. To confirm that the chatbot responds as ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~21-~21: Use proper spacing conventions.
Context: ... Playground and then ask a question. The LLM should respond as the Prompt...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~22-~22: Use proper spacing conventions.
Context: ...d as the Prompt component specifies. With the basic flow responding correctly...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~23-~23: Use proper spacing conventions.
Context: ...* component to accept additional inputs. 4. In the Prompt component, open the **...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~24-~24: Use proper spacing conventions.
Context: ... current prompt with the following text: text ChatInput: {chat-input} File: {file} The Prompt component adds ports to a...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~31-~31: Use proper spacing conventions.
Context: ..., in this case, a chat input and a file. :::tip The port names are for illust...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~33-~33: There might be a mistake here.
Context: ...se, a chat input and a file. :::tip The port names are for illustrative pur...

(QB_NEW_EN_OTHER)


[grammar] ~34-~34: There might be a problem here.
Context: ...fter the component they're connected to. ::: 5. Add a [File component](/compone...

(QB_NEW_EN_MERGED_MATCH)


[grammar] ~35-~35: Use proper spacing conventions.
Context: ... component they're connected to. ::: 5. Add a [File component](/components-data#...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~37-~37: Use proper spacing conventions.
Context: ... to the Prompt component's file input. Your flow should look like this: ![...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~39-~39: Use proper spacing conventions.
Context: ...t. Your flow should look like this: File loader chat flow The flow is complete. If you'd like,...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~43-~43: There might be a problem here.
Context: ...e-loader.png) The flow is complete. If you'd like, add files to the File co...

(QB_NEW_EN_MERGED_MATCH)


[grammar] ~44-~44: There might be a problem here.
Context: ...nd chat with it within the Langflow IDE. In the next section, you will load file...

(QB_NEW_EN_MERGED_MATCH)


[grammar] ~45-~45: Use proper spacing conventions.
Context: ...ith your flow from a Python application. ## Send requests to your flow from a Python...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~47-~47: Place a period at the end of declarative sentences.
Context: ...s to your flow from a Python application With your flow running locally, send a r...

(QB_NEW_EN_OTHER_ERROR_IDS_000178)


[grammar] ~49-~49: Use proper spacing conventions.
Context: ...d a chat message, and get a result back. :::tip To easily construct file upload r...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~52-~52: Use proper spacing conventions.
Context: ...flow-file-upload-examples.onrender.com). ::: 1. To construct the request, gather...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~53-~53: Use proper spacing conventions.
Context: ...-file-upload-examples.onrender.com). ::: 1. To construct the request, gather the fol...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~55-~55: Use proper spacing conventions.
Context: ...ther the following values from Langflow. * LANGFLOW_SERVER_ADDRESS: The default value is 127.0.0.1:7860....

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~57-~57: Use proper spacing conventions.
Context: ...: The default value is 127.0.0.1:7860. * FLOW_ID: The UUID of your flow, or the endpoint...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~58-~58: Use proper spacing conventions.
Context: ...low, or the endpoint name you've chosen. * File Component name: To find the ID of y...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~59-~59: Use proper spacing conventions.
Context: ...ple, the component name is File-KZP68. * Input value: This is the message you wan...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~61-~61: Use proper spacing conventions.
Context: ...om the same file location as the script. * Session ID: Optional. For more informati...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~62-~62: Use proper spacing conventions.
Context: ...ormation, see session ID. * Langflow API key: Required. To create an...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~63-~63: Use proper spacing conventions.
Context: ...see API keys. 2. Replace the values in the script below. ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~65-~65: Use proper spacing conventions.
Context: ... Replace the values in the script below.

Python python # Python example using requests import requests import json # 1. Set the upload URL url = "http://LANGFLOW_SERVER_ADDRESS/api/v2/files/" # 2. Prepare the file and payload payload = {} files = [ ('file', ('fake-resume.txt', open('fake-resume.txt', 'rb'), 'application/octet-stream')) ] headers = { 'Accept': 'application/json', 'x-api-key': 'LANGFLOW_API_KEY' } # 3. Upload the file to Langflow response = requests.request("POST", url, headers=headers, data=payload, files=files) print(response.text) # 4. Get the uploaded file path from the response uploaded_data = response.json() uploaded_path = uploaded_data.get('path') # 5. Call the Langflow run endpoint with the uploaded file path run_url = "http://LANGFLOW_SERVER_ADDRESS/api/v1/run/FLOW_ID" run_payload = { "input_value": "Evaluate this resume for a job opening in my Marketing department.", "output_type": "chat", "input_type": "chat", "tweaks": { "File-KZP68": { "path": uploaded_path } } } run_headers = { 'Content-Type': 'application/json', 'Accept': 'application/json', 'x-api-key': 'LANGFLOW_API_KEY' } run_response = requests.post(run_url, headers=run_headers, data=json.dumps(run_payload)) langflow_data = run_response.json() # Output only the message message = None try: message = langflow_data['outputs'][0]['outputs'][0]['results']['message']['data']['text'] except (KeyError, IndexError, TypeError): pass print(message)
This script contains two requests. ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~126-~126: Use proper spacing conventions.
Context: ... This script contains two requests. The first request uploads `fake-resume.t...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~128-~128: Use proper spacing conventions.
Context: ...4988-ab1c-7c430214f8d5/fake-resume.txt`. The second request sends a chat message ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~130-~130: There might be a problem here.
Context: ...low flow at the /api/v1/run/ endpoint. The tweaks parameter includes the pat...

(QB_NEW_EN_MERGED_MATCH)


[grammar] ~131-~131: Use proper spacing conventions.
Context: ...ed file as the variable uploaded_path. 3. Run the script to send the request. ...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~133-~133: Use proper spacing conventions.
Context: ... 3. Run the script to send the request.

Response {"id":"793ba3d8-5e7a-4499-8b89-d9a7b6325fee","name":"fake-resume (1)","path":"02791d46-812f-4988-ab1c-7c430214f8d5/fake-resume.txt","size":1779,"provider":null} The resume for Emily J. Wilson presents a strong candidate for a position in your Marketing department. Here are some key points to consider: ### Strengths: 1. **Experience**: With over 8 years in marketing, Emily has held progressively responsible positions, culminating in her current role as Marketing Director. This indicates a solid foundation in the field. 2. **Quantifiable Achievements**: The resume highlights specific accomplishments, such as a 25% increase in brand recognition and a 30% sales increase after launching new product lines. These metrics demonstrate her ability to drive results. 3. **Diverse Skill Set**: Emily's skills encompass various aspects of marketing, including strategy development, team management, social media marketing, event planning, and data analysis. This versatility can be beneficial in a dynamic marketing environment. 4. **Educational Background**: Her MBA and a Bachelor's degree in Marketing provide a strong academic foundation, which is often valued in marketing roles. 5. **Certifications**: The Certified Marketing Professional (CMP) and Google Analytics Certification indicate a commitment to professional development and staying current with industry standards. ### Areas for Improvement: 1. **Specificity in Skills**: While the skills listed are relevant, providing examples of how she has applied these skills in her previous roles could strengthen her resume further. 2. **References**: While stating that references are available upon request is standard, including a couple of testimonials or notable endorsements could enhance credibility. 3. **Formatting**: Ensure that the resume is visually appealing and easy to read. Clear headings and bullet points help in quickly identifying key information. ### Conclusion: Overall, Emily J. Wilson's resume reflects a well-rounded marketing professional with a proven track record of success. If her experience aligns with the specific needs of your Marketing department, she could be a valuable addition to your team. Consider inviting her for an interview to further assess her fit for the role.
The initial output contains the JSON res...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~166-~166: Use proper spacing conventions.
Context: ...nal path where Langflow stores the file. The LLM then retrieves this file and cor...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~168-~168: Use proper spacing conventions.
Context: ...bility of the resume for a job position. ## Next steps * [Model Context Protocol (M...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)


[grammar] ~170-~170: Use proper spacing conventions.
Context: ...esume for a job position. ## Next steps * [Model Context Protocol (MCP) servers](/m...

(QB_NEW_EN_OTHER_ERROR_IDS_000007)

🪛 markdownlint-cli2 (0.17.2)
docs/docs/Tutorials/chat-with-rag.md

106-106: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


107-107: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


108-108: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


112-112: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)


173-173: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)


196-196: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


196-196: Code block style
Expected: indented; Actual: fenced

(MD046, code-block-style)


211-211: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


212-212: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

docs/docs/Tutorials/chat-with-files.md

57-57: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


58-58: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


59-59: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


60-60: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


61-61: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


62-62: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


63-63: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


138-138: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


172-172: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)


173-173: Unordered list style
Expected: dash; Actual: asterisk

(MD004, ul-style)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: build-and-deploy

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 8, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 8, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 8, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Build failure! ❌

yarn run v1.22.22 $ docusaurus build [INFO] [en] Creating an optimized production build... [info] [webpackbar] Compiling Client [info] [webpackbar] Compiling Server [success] [webpackbar] Server: Compiled with some errors in 1.06m [webpack.cache.PackFileCacheStrategy] Skipped not serializable cache item 'Compilation/modules|/home/runner/work/langflow/langflow/docs/node_modules/@docusaurus/mdx-loader/lib/index.js??ruleSet[1].rules[8].use[0]!/home/runner/work/langflow/langflow/docs/docs/Tutorials/chat-with-rag.md': No serializer registered for VFileMessage while serializing webpack/lib/cache/PackFileCacheStrategy.PackContentItems -> webpack/lib/NormalModule -> webpack/lib/ModuleBuildError -> Error -> VFileMessage [success] [webpackbar] Client: Compiled with some errors in 1.61m [ERROR] Client bundle compiled with errors therefore further build is impossible. Error: MDX compilation failed for file "/home/runner/work/langflow/langflow/docs/docs/Tutorials/chat-with-rag.md" Cause: Expected a closing tag for <details> (24:5-24:14) before the end of listItem Details: { "column": 1, "message": "Expected a closing tag for <details> (24:5-24:14) before the end of listItem", "line": 22, "name": "22:1-33:253", "place": { "start": { "_bufferIndex": 0, "_index": 36, "line": 22, "column": 1, "offset": 891 }, "end": { "_bufferIndex": -1, "_index": 19, "line": 33, "column": 253, "offset": 1901 } }, "reason": "Expected a closing tag for <details> (24:5-24:14) before the end of listItem", "ruleId": "end-tag-mismatch", "source": "mdast-util-mdx-jsx" } error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 10, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@mendonk mendonk enabled auto-merge July 10, 2025 17:01
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 10, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 10, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 10, 2025

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@mendonk mendonk disabled auto-merge July 10, 2025 17:45
Copy link
Copy Markdown
Contributor

@melienherrera melienherrera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on all changes LGTM

@mendonk mendonk added this pull request to the merge queue Jul 10, 2025
Merged via the queue into main with commit 41216f8 Jul 10, 2025
14 checks passed
@mendonk mendonk deleted the docs-rag-chatbot-tutorial branch July 10, 2025 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants