The changes in this commit update the documentation for the Custom Component.
- Clarify that the code must be a class that inherits from the `langflow.CustomComponent` class.
- Explain that the type annotations of the `build` instance method are used to create the fields of the component.
- Provide a table of supported types for the `build` method.
- Introduce the `build_config` instance method for defining configuration fields.
- Describe the format and available keys for the `build_config` method.
- Add usage example for the `build` method.
These changes improve the clarity and completeness of the documentation for the Custom Component, making it easier for users to understand and utilize this feature.
🐛 fix(custom-component.mdx): change class name from BestComponent to DocumentProcessor to improve semantics and clarity
✨ feat(custom-component.mdx): add support for processing the page content of a document based on a selected function
📝 docs(custom-component.mdx): update example and explanations to reflect the changes made in the code
🐛 fix(custom-component.mdx): fix code indentation and remove unused imports
✨ feat(custom-component.mdx): update component name and description to improve clarity and semantics
🐛 fix(custom-component.mdx): update build method parameters and return type to match the actual implementation
✨ feat(custom-component.mdx): add support for configuring fields in the build_config method
🐛 fix(custom-component.mdx): fix code indentation and remove unused imports in the build_config method
✨ feat(custom-component.mdx): add support for configuring fields in the build_config method
✨ feat(custom-component.mdx): add rules and explanations for creating custom components
📝 docs(custom-component.mdx): update rule 1 to specify that the script must contain a single class inheriting from CustomComponent
📝 docs(custom-component.mdx): update rule 2 to specify that the class must have a build method
📝 docs(custom-component.mdx): update rule 3 to specify that the type annotations of the build method will be used to create the fields of the component
📝 docs(custom-component.mdx): update rule 4 to specify that the class can have a build_config method
📝 docs(custom-component.mdx): update rule 4 to provide details on the format of the build_config method
📝 docs(custom-component.mdx): update rule 4 to correct a typo in the display_name key
📝 docs(custom-component.mdx): update rule 4 to provide additional details on the options and multiline keys in the build_config method
📝 docs(custom-component.mdx): add example for creating a FlowRunner component
📝 docs(custom-component.mdx): update example for creating a FlowRunner component to include display_name and description attributes
📝 docs(custom-component.mdx): update example for creating a FlowRunner component to import Document from the schema module
📝 docs(custom-component.mdx): update example for creating a FlowRunner component to add parameters and return type to the build method
- The code changes renamed the file `widget.mdx` to `chat-widget.mdx`.
- The content has been modified to reflect the new name and provide a more detailed description of the Langflow Chat Widget.
- The usage instructions have been updated to reflect the changes.
This commit renames `widget.mdx` to `chat-widget.mdx` and provides more detailed information about the Langflow Chat Widget, including its features, usage in HTML, React, and Angular, and customization options.
✨ feat(custom-component.mdx): add example code for creating a custom component
🔧 chore(custom-component.mdx): update code comments and fix typo in build_config method
📝 docs(widget.mdx): provide example code for adding the 'langflow-chat' tag with necessary attributes to include the Chat Widget in the component's view
The commit adds instructions for using the Chat Widget in an Angular application. It includes steps to insert a script tag in the index.html file, suppress warnings related to custom elements in Angular templates, and additional notes about using the Chat Widget in Angular components.
The commit adds a cautionary message to the agents, chains, embeddings, and LLMs documentation pages, indicating that the documentation is still under construction. The message encourages users to provide feedback and report any issues to help improve the documentation.
- Added new files for chat interface and prompt customization in the guidelines section
- Added descriptions and images for the chat interface and prompt customization features
- Updated the sidebars to include the new documentation pages
📝 docs(loading_document.mdx): update interactive guide URL and add step-by-step instructions for integrating a document into a PromptTemplate variable
📝 docs(sidebars.js): add "chatprompttemplate_guide" to the Guides section
This commit adds a new file `chatprompttemplate_guide.mdx` which contains a step-by-step guide on how to customize and build a chatbot with a custom system message. The guide includes instructions on how to modify the "Basic Chat with Prompt and History" example by integrating the `ChatPromptTemplate`, `SystemMessagePromptTemplate`, and `HumanMessagePromptTemplate` components. It also provides tips on setting the model, defining variables, and testing the chatbot. The guide aims to help users create a personalized chatbot that can interpret and respond based on user-defined system messages.
Co-authored-by: [Author Name] <author@example.com>
✨ feat(loading_document.mdx): add step-by-step instructions on how to define a Prompt variable and connect a WebBaseLoader to it for loading a document into the variable
🔀 chore(loading_document.mdx): reorganize and rephrase the content to improve readability and clarity
This commit adds a new guide file `loading_document.mdx` that provides an overview and example on how to load a document into a Prompt variable. The guide explains the process of defining a Prompt variable in the `PromptTemplate` component, connecting a `WebBaseLoader` to the variable, and building the flow. It also demonstrates how to chat with the document content in the context of a conversation.
The commit also includes an embedded iframe that showcases the functionality described in the guide.
🔧 chore(docusaurus.config.js): update logo alt text to match the updated title
🔧 chore(docusaurus.config.js): update announcementBar content to use consistent naming convention for Langflow
