Skip to content

docs: add notes to flows #3861

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

Merged
merged 67 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
67 commits
Select commit Hold shift + click to select a range
51062db
add-note
mendonk Sep 19, 2024
1a17cd8
notes
mendonk Sep 19, 2024
3166030
vector-store-rag-notes
mendonk Sep 19, 2024
52d3f07
vector-store-rag-notes
mendonk Sep 19, 2024
74c99bf
comma
mendonk Sep 19, 2024
bfa1176
comma
mendonk Sep 19, 2024
d88dd7a
revert
mendonk Sep 19, 2024
9305a19
add-notes
mendonk Sep 19, 2024
e26e225
another-way
mendonk Sep 19, 2024
2e46fe8
revert
mendonk Sep 19, 2024
464a9cd
revert
mendonk Sep 19, 2024
27633d8
fix
mendonk Sep 19, 2024
46e3656
descriptions
mendonk Sep 19, 2024
6c3434a
lightbulb
mendonk Sep 19, 2024
e60f0a9
deployed-size
mendonk Sep 19, 2024
3dfaa90
size
mendonk Sep 19, 2024
6c1dd6f
size
mendonk Sep 19, 2024
e55c4dd
resizing-is-true
mendonk Sep 19, 2024
bacef93
targethandle
mendonk Sep 19, 2024
d9ee0e4
double
mendonk Sep 19, 2024
c88bc76
set-components
mendonk Sep 19, 2024
77ddeae
pin
mendonk Sep 19, 2024
40e1819
notes
mendonk Sep 19, 2024
19b34a7
fix
mendonk Sep 19, 2024
742e676
dont-change-code
mendonk Sep 19, 2024
bc68dbc
Merge branch 'main' into docs-add-notes
mendonk Sep 19, 2024
716c36a
cleanup
mendonk Sep 20, 2024
a3b4038
Merge branch 'main' into docs-add-notes
mendonk Sep 20, 2024
e78babd
update example
anovazzi1 Sep 23, 2024
d1631f9
fix postion on example
anovazzi1 Sep 23, 2024
0cc40f0
Merge branch 'main' into docs-add-notes
mendonk Sep 23, 2024
9d2d310
Merge branch 'main' into docs-add-notes
mendonk Sep 30, 2024
249c0de
fix-descriptions
mendonk Sep 30, 2024
b0023f3
swap-link
mendonk Sep 30, 2024
9fce8b3
newline-and-lightbulb
mendonk Sep 30, 2024
2779f55
another-docs-link
mendonk Sep 30, 2024
4fb823a
play-button
mendonk Sep 30, 2024
fadf43e
remove-double
mendonk Sep 30, 2024
079dab0
update NODE_FORMAT_ATTRIBUTES to prevent description updates on examples
anovazzi1 Sep 30, 2024
10cd1bf
Update AstraDB documentation link
anovazzi1 Sep 30, 2024
7a3a545
Merge remote-tracking branch 'origin/main' into docs-add-notes
anovazzi1 Sep 30, 2024
d30fe05
update documentation on code
anovazzi1 Sep 30, 2024
39b0f03
Merge branch 'main' into docs-add-notes
anovazzi1 Oct 1, 2024
8a5e30c
✨ (chatInputOutputUser-shard-0.spec.ts): update the test to click on …
Cristhianzl Oct 1, 2024
54d957b
🐛 (Basic Prompting.spec.ts): fix clicking on "Playground" element by …
Cristhianzl Oct 1, 2024
a521dc7
✨ (Blog Writer.spec.ts): update test to click on the last element wit…
Cristhianzl Oct 1, 2024
1f65892
✨ (Dynamic Agent.spec.ts): update test to click on the last element w…
Cristhianzl Oct 1, 2024
4400bd1
🐛 (decisionFlow.spec.ts): fix clicking on "Playground" button by sele…
Cristhianzl Oct 1, 2024
7c96ed0
🐛 (generalBugs-shard-3.spec.ts): fix clicking on "Playground" button …
Cristhianzl Oct 1, 2024
ffa5600
🐛 (generalBugs-shard-0.spec.ts): fix clicking on "Playground" button …
Cristhianzl Oct 1, 2024
c887074
🐛 (general-bugs-shard-3836.spec.ts): fix clicking on "Playground" but…
Cristhianzl Oct 1, 2024
6a06eb9
✨ (chatInputOutputUser-shard-2.spec.ts): update test to click on the …
Cristhianzl Oct 1, 2024
f7a3d4d
✨ (stop-button-playground.spec.ts): update test to click on the last …
Cristhianzl Oct 1, 2024
79ce365
🐛 (limit-file-size-upload.spec.ts): fix selector to click on the last…
Cristhianzl Oct 1, 2024
15d636c
✨ (fileUploadComponent.spec.ts): update test to click on the last ele…
Cristhianzl Oct 1, 2024
ae24105
✨ (chatInputOutput.spec.ts): update test to click on the last occurre…
Cristhianzl Oct 1, 2024
afe20db
🐛 (generalBugs-shard-9.spec.ts): fix clicking on "Playground" element…
Cristhianzl Oct 1, 2024
6502052
🐛 (Document QA.spec.ts): fix clicking on "Playground" element by sele…
Cristhianzl Oct 1, 2024
7dda29a
✨ (similarity.spec.ts): update click method to target the last occurr…
Cristhianzl Oct 1, 2024
28d66da
🐛 (Simple Agent.spec.ts): fix clicking on "Playground" button by sele…
Cristhianzl Oct 1, 2024
684ff7d
✨ (textInputOutput.spec.ts): update test script to target the last oc…
Cristhianzl Oct 1, 2024
0fc0a81
✨ (Travel Planning Agent.spec.ts): Update the selector for the "Playg…
Cristhianzl Oct 1, 2024
6681e12
🐛 (Vector Store.spec.ts): fix clicking on "Playground" element by sel…
Cristhianzl Oct 1, 2024
aeed6c6
Merge branch 'main' into docs-add-notes
Cristhianzl Oct 1, 2024
80f99a7
✨ (generalBugs-shard-9.spec.ts): add click action on the last element…
Cristhianzl Oct 1, 2024
8db438c
Merge branch 'docs-add-notes' of github.com:langflow-ai/langflow into…
Cristhianzl Oct 1, 2024
613b2d6
Merge branch 'main' into docs-add-notes
anovazzi1 Oct 1, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/backend/base/langflow/base/constants.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

STREAM_INFO_TEXT = "Stream the response from the model. Streaming works only in Chat."

NODE_FORMAT_ATTRIBUTES = ["beta", "icon", "display_name", "description", "output_types", "edited", "metadata"]
NODE_FORMAT_ATTRIBUTES = ["beta", "icon", "display_name", "output_types", "edited", "metadata"]


FIELD_FORMAT_ATTRIBUTES = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
class AstraVectorStoreComponent(LCVectorStoreComponent):
display_name: str = "Astra DB"
description: str = "Implementation of Vector Store using Astra DB with search capabilities"
documentation: str = "https://python.langchain.com/docs/integrations/vectorstores/astradb"
documentation: str = "https://docs.langflow.org/starter-projects-vector-store-rag"
name = "AstraDB"
icon: str = "AstraDB"

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,87 +6,87 @@
"data": {
"sourceHandle": {
"dataType": "ChatInput",
"id": "ChatInput-jbtaD",
"id": "ChatInput-AwB1F",
"name": "message",
"output_types": [
"Message"
]
},
"targetHandle": {
"fieldName": "user_input",
"id": "Prompt-0SBd6",
"id": "Prompt-bHLxK",
"inputTypes": [
"Message",
"Text"
],
"type": "str"
}
},
"id": "reactflow__edge-ChatInput-jbtaD{œdataTypeœ:œChatInputœ,œidœ:œChatInput-jbtaDœ,œnameœ:œmessageœ,œoutput_typesœ:[œMessageœ]}-Prompt-0SBd6{œfieldNameœ:œuser_inputœ,œidœ:œPrompt-0SBd6œ,œinputTypesœ:[œMessageœ,œTextœ],œtypeœ:œstrœ}",
"source": "ChatInput-jbtaD",
"sourceHandle": "{œdataTypeœ: œChatInputœ, œidœ: œChatInput-jbtaDœ, œnameœ: œmessageœ, œoutput_typesœ: [œMessageœ]}",
"target": "Prompt-0SBd6",
"targetHandle": "{œfieldNameœ: œuser_inputœ, œidœ: œPrompt-0SBd6œ, œinputTypesœ: [œMessageœ, œTextœ], œtypeœ: œstrœ}"
"id": "reactflow__edge-ChatInput-AwB1F{œdataTypeœ:œChatInputœ,œidœ:œChatInput-AwB1Fœ,œnameœ:œmessageœ,œoutput_typesœ:[œMessageœ]}-Prompt-bHLxK{œfieldNameœ:œuser_inputœ,œidœ:œPrompt-bHLxKœ,œinputTypesœ:[œMessageœ,œTextœ],œtypeœ:œstrœ}",
"source": "ChatInput-AwB1F",
"sourceHandle": "{œdataTypeœ: œChatInputœ, œidœ: œChatInput-AwB1Fœ, œnameœ: œmessageœ, œoutput_typesœ: [œMessageœ]}",
"target": "Prompt-bHLxK",
"targetHandle": "{œfieldNameœ: œuser_inputœ, œidœ: œPrompt-bHLxKœ, œinputTypesœ: [œMessageœ, œTextœ], œtypeœ: œstrœ}"
},
{
"className": "",
"data": {
"sourceHandle": {
"dataType": "Prompt",
"id": "Prompt-0SBd6",
"id": "Prompt-bHLxK",
"name": "prompt",
"output_types": [
"Message"
]
},
"targetHandle": {
"fieldName": "input_value",
"id": "OpenAIModel-HBuxy",
"id": "OpenAIModel-tnzXU",
"inputTypes": [
"Message"
],
"type": "str"
}
},
"id": "reactflow__edge-Prompt-0SBd6{œdataTypeœ:œPromptœ,œidœ:œPrompt-0SBd6œ,œnameœ:œpromptœ,œoutput_typesœ:[œMessageœ]}-OpenAIModel-HBuxy{œfieldNameœ:œinput_valueœ,œidœ:œOpenAIModel-HBuxyœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}",
"source": "Prompt-0SBd6",
"sourceHandle": "{œdataTypeœ: œPromptœ, œidœ: œPrompt-0SBd6œ, œnameœ: œpromptœ, œoutput_typesœ: [œMessageœ]}",
"target": "OpenAIModel-HBuxy",
"targetHandle": "{œfieldNameœ: œinput_valueœ, œidœ: œOpenAIModel-HBuxyœ, œinputTypesœ: [œMessageœ], œtypeœ: œstrœ}"
"id": "reactflow__edge-Prompt-bHLxK{œdataTypeœ:œPromptœ,œidœ:œPrompt-bHLxKœ,œnameœ:œpromptœ,œoutput_typesœ:[œMessageœ]}-OpenAIModel-tnzXU{œfieldNameœ:œinput_valueœ,œidœ:œOpenAIModel-tnzXUœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}",
"source": "Prompt-bHLxK",
"sourceHandle": "{œdataTypeœ: œPromptœ, œidœ: œPrompt-bHLxKœ, œnameœ: œpromptœ, œoutput_typesœ: [œMessageœ]}",
"target": "OpenAIModel-tnzXU",
"targetHandle": "{œfieldNameœ: œinput_valueœ, œidœ: œOpenAIModel-tnzXUœ, œinputTypesœ: [œMessageœ], œtypeœ: œstrœ}"
},
{
"className": "",
"data": {
"sourceHandle": {
"dataType": "OpenAIModel",
"id": "OpenAIModel-HBuxy",
"id": "OpenAIModel-tnzXU",
"name": "text_output",
"output_types": [
"Message"
]
},
"targetHandle": {
"fieldName": "input_value",
"id": "ChatOutput-WG5tg",
"id": "ChatOutput-wbcyd",
"inputTypes": [
"Message"
],
"type": "str"
}
},
"id": "reactflow__edge-OpenAIModel-HBuxy{œdataTypeœ:œOpenAIModelœ,œidœ:œOpenAIModel-HBuxyœ,œnameœ:œtext_outputœ,œoutput_typesœ:[œMessageœ]}-ChatOutput-WG5tg{œfieldNameœ:œinput_valueœ,œidœ:œChatOutput-WG5tgœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}",
"source": "OpenAIModel-HBuxy",
"sourceHandle": "{œdataTypeœ: œOpenAIModelœ, œidœ: œOpenAIModel-HBuxyœ, œnameœ: œtext_outputœ, œoutput_typesœ: [œMessageœ]}",
"target": "ChatOutput-WG5tg",
"targetHandle": "{œfieldNameœ: œinput_valueœ, œidœ: œChatOutput-WG5tgœ, œinputTypesœ: [œMessageœ], œtypeœ: œstrœ}"
"id": "reactflow__edge-OpenAIModel-tnzXU{œdataTypeœ:œOpenAIModelœ,œidœ:œOpenAIModel-tnzXUœ,œnameœ:œtext_outputœ,œoutput_typesœ:[œMessageœ]}-ChatOutput-wbcyd{œfieldNameœ:œinput_valueœ,œidœ:œChatOutput-wbcydœ,œinputTypesœ:[œMessageœ],œtypeœ:œstrœ}",
"source": "OpenAIModel-tnzXU",
"sourceHandle": "{œdataTypeœ: œOpenAIModelœ, œidœ: œOpenAIModel-tnzXUœ, œnameœ: œtext_outputœ, œoutput_typesœ: [œMessageœ]}",
"target": "ChatOutput-wbcyd",
"targetHandle": "{œfieldNameœ: œinput_valueœ, œidœ: œChatOutput-wbcydœ, œinputTypesœ: [œMessageœ], œtypeœ: œstrœ}"
}
],
"nodes": [
{
"data": {
"description": "Get chat inputs from the Playground.",
"display_name": "Chat Input",
"id": "ChatInput-jbtaD",
"id": "ChatInput-AwB1F",
"node": {
"base_classes": [
"Message"
Expand Down Expand Up @@ -285,25 +285,25 @@
"type": "ChatInput"
},
"dragging": false,
"height": 309,
"id": "ChatInput-jbtaD",
"height": 297,
"id": "ChatInput-AwB1F",
"position": {
"x": -493.6459512396177,
"y": 1083.200545525551
"x": 54.0197580905824,
"y": 777.1114693911709
},
"positionAbsolute": {
"x": -493.6459512396177,
"y": 1083.200545525551
"x": 54.0197580905824,
"y": 777.1114693911709
},
"selected": false,
"type": "genericNode",
"width": 384
},
{
"data": {
"description": "Create a prompt template with dynamic variables.",
"description": "Create a prompt template with dynamic variables. If using an OutputParser, you must include {format_instructions} as an additional variable.",
"display_name": "Prompt",
"id": "Prompt-0SBd6",
"id": "Prompt-bHLxK",
"node": {
"base_classes": [
"Message"
Expand Down Expand Up @@ -405,33 +405,33 @@
"type": "Prompt"
},
"dragging": false,
"height": 423,
"id": "Prompt-0SBd6",
"height": 411,
"id": "Prompt-bHLxK",
"position": {
"x": 56.354011530798516,
"y": 1157.2005405164796
"x": 577.3727711743836,
"y": 853.9773971889889
},
"positionAbsolute": {
"x": 56.354011530798516,
"y": 1157.2005405164796
"x": 577.3727711743836,
"y": 853.9773971889889
},
"selected": false,
"type": "genericNode",
"width": 384
},
{
"data": {
"description": "Display a chat message in the Playground.",
"description": "Display a chat message in the Playground.\n\n💡 Click the ▶️ to run the flow.",
"display_name": "Chat Output",
"id": "ChatOutput-WG5tg",
"id": "ChatOutput-wbcyd",
"node": {
"base_classes": [
"Message"
],
"beta": false,
"conditional_paths": [],
"custom_fields": {},
"description": "Display a chat message in the Playground.",
"description": "Display a chat message in the Playground.\n\n💡 Click the ▶️ to run the flow.",
"display_name": "Chat Output",
"documentation": "",
"edited": false,
Expand Down Expand Up @@ -600,25 +600,25 @@
"type": "ChatOutput"
},
"dragging": false,
"height": 309,
"id": "ChatOutput-WG5tg",
"height": 297,
"id": "ChatOutput-wbcyd",
"position": {
"x": 1219.477374823274,
"y": 1200.950216973985
"x": 1760.7152955011902,
"y": 903.6717604714486
},
"positionAbsolute": {
"x": 1219.477374823274,
"y": 1200.950216973985
"x": 1760.7152955011902,
"y": 903.6717604714486
},
"selected": false,
"type": "genericNode",
"width": 384
},
{
"data": {
"description": "Generates text using OpenAI LLMs.",
"description": "Generates text using OpenAI LLMs.\n\n💡 Be sure to add your **OpenAI API Key**",
"display_name": "OpenAI",
"id": "OpenAIModel-HBuxy",
"id": "OpenAIModel-tnzXU",
"node": {
"base_classes": [
"LanguageModel",
Expand All @@ -627,7 +627,7 @@
"beta": false,
"conditional_paths": [],
"custom_fields": {},
"description": "Generates text using OpenAI LLMs.",
"description": "Generates text using OpenAI LLMs.\n\n💡 Be sure to add your **OpenAI API Key**",
"display_name": "OpenAI",
"documentation": "",
"edited": false,
Expand Down Expand Up @@ -917,31 +917,63 @@
"type": "OpenAIModel"
},
"dragging": false,
"height": 623,
"id": "OpenAIModel-HBuxy",
"height": 595,
"id": "OpenAIModel-tnzXU",
"position": {
"x": 664.0296638933031,
"y": 1026.5966174731725
"x": 1165.97061248482,
"y": 768.6307079517978
},
"positionAbsolute": {
"x": 664.0296638933031,
"y": 1026.5966174731725
"x": 1165.97061248482,
"y": 768.6307079517978
},
"selected": false,
"type": "genericNode",
"width": 384
},
{
"data": {
"id": "undefined-XuFCr",
"node": {
"description": "### ✅ Basic Prompting (Hello, World) README\n\nPerform basic prompting with an OpenAI model. *Psst: look out for the* '💡' *emoji for tips in components.*\n\n#### Extra notes on these Components\n- **Chat Input:** Sends natural language instructions to the OpenAI model.\n- **OpenAI Model:** Processes the prompt and generates a response.\n- **Chat Output:** Processes the prompt and generates a response.\n#### Get started\n- Input your **OpenAI API key** to the **OpenAI Model component**\n- Select the **Playground** to interact with the chatbot.\n\nFor more details, see the [flow overview doc](https://docs.langflow.org/starter-projects-basic-prompting).",
"display_name": "Read Me",
"documentation": "",
"template": {
"backgroundColor": "indigo"
}
}
},
"dragging": false,
"height": 800,
"id": "undefined-XuFCr",
"position": {
"x": -580.3704460174015,
"y": 498.2202393425737
},
"positionAbsolute": {
"x": -580.3704460174015,
"y": 498.2202393425737
},
"resizing": false,
"selected": false,
"style": {
"height": 800,
"width": 532
},
"type": "noteNode",
"width": 532
}
],
"viewport": {
"x": 427.12410642709614,
"y": -361.39815091467085,
"zoom": 0.5562299357713679
"x": 208.20796881231723,
"y": -76.87392199339831,
"zoom": 0.4810857801741779
}
},
"description": "This flow will get you experimenting with the basics of the UI, the Chat and the Prompt component. \n\nTry changing the Template in it to see how the model behaves. \nYou can change it to this and a Text Input into the `type_of_person` variable : \"Answer the user as if you were a pirate.\n\nUser: {user_input}\n\nAnswer: \" ",
"endpoint_name": null,
"id": "b0e19aab-2095-41ee-b91c-1168790cc68b",
"id": "fd36e130-512d-48e6-96cc-f1e03c5d3a18",
"is_component": false,
"last_tested_version": "1.0.9",
"last_tested_version": "1.0.18",
"name": "Basic Prompting (Hello, World)"
}
Loading