Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: concepts folder #5576

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

docs: concepts folder #5576

wants to merge 22 commits into from

Conversation

mendonk
Copy link
Collaborator

@mendonk mendonk commented Jan 7, 2025

This pull request includes significant changes to the documentation for components and the API pane.

  • Components Overview: The content from components-overview.md has been moved and expanded in a new file concepts-components.md. This includes detailed explanations of component functionalities, menus, ports, and code examples. [1] [2]

  • Component Code Example: Added a detailed example of a RecursiveCharacterTextSplitterComponent class, explaining its inputs, methods, and usage within a flow.

@mendonk mendonk self-assigned this Jan 7, 2025
@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jan 7, 2025
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Jan 7, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 7, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
docs/docs/Concepts/concepts-api.md Outdated Show resolved Hide resolved
docs/docs/Concepts/concepts-components.md Show resolved Hide resolved
docs/docs/Concepts/concepts-components.md Outdated Show resolved Hide resolved
docs/docs/Concepts/concepts-overview.md Show resolved Hide resolved
"output_type": "chat",
"input_type": "chat",
"tweaks": {
"session_id": "YOUR_SESSION_ID"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This may not be correct! Might require testing
Component wise session id would be inside the tweaks of respective components.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@edwinjosechittilappilly

Like this:

curl -X POST "http://127.0.0.1:7860/api/v1/run/$FLOW_ID" \   
   -H 'Content-Type: application/json' \
   -d '{
       "tweaks": {
           "session_id": "custom_session_123"
       },
       "input_value": "message",
       "input_type": "chat",
       "output_type": "chat"
   }'
{"session_id":"801abb1e-19b9-4278-9632-179b6d84f126","outputs":[{"inputs":{"input_value":"message"},"outputs":[{"results":{"message":{"text_key":"text","data":{"timestamp":"2025-01-10 15:34:27","sender":"Machine","sender_name":"AI","session_id":"801abb1e-19b9-4278-9632-179b6d84f126","text":"Absolutely! It sounds like you're ready to dive into something exciting. What kind of project or idea do you have in mind? Whether it's a new app, a creative writing piece, or even a machine learning model, I'm here to help you brainstorm, plan, and get started. Let’s turn your vision into reality!","files":[],"error":"False","edit":"False","properties":{"text_color":"","background_color":"","edited":"False","source":{"id":"OpenAIModel-Uksag","display_name":"OpenAI","source":"gpt-4o-mini"},"icon":"OpenAI","allow_markdown":"False","positive_feedback":"None","state":"complete","targets":[]},

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 9, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 10, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 10, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jan 10, 2025
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 size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Where does Langflow store flows when running locally? docs: how does Langflow run components?
2 participants