Commit graph

114 commits

Author SHA1 Message Date
Gabriel Luiz Freitas Almeida
be7cb0763e 📝 docs(langfuse_integration.mdx): update Langfuse integration guide with detailed instructions and explanations
🔀 diff --git a/docs/docs/guides/langfuse_integration.mdx b/docs/docs/guides/langfuse_integration.mdx
🔀 index db23bbdc..51aba962 100644
🔀 --- a/docs/docs/guides/langfuse_integration.mdx
🔀 +++ b/docs/docs/guides/langfuse_integration.mdx
🔀 @@ -1,35 +1,49 @@
🔀 -import ThemedImage from "@theme/ThemedImage";
🔀 -import useBaseUrl from "@docusaurus/useBaseUrl";
🔀 -import ZoomableImage from "/src/theme/ZoomableImage.js";
🔀 -import ReactPlayer from "react-player";
🔀 -
🔀  # Integrating Langfuse with Langflow
🔀
🔀 +## Introduction
🔀 +
🔀 +Langfuse is an open-source tracing and analytics tool designed for LLM applications. Integrating Langfuse with Langflow provides detailed production traces and granular insights into quality, cost, and latency. This integration allows you to monitor and debug your Langflow's chat or APIs easily.
🔀 +
🔀  ## Step-by-Step Instructions
🔀
🔀  ### Step 1: Create a Langfuse account
🔀
🔀 -1. Go to [https://langfuse.com](https://langfuse.com) and click on the "Sign In" button in the top right corner.
🔀 +1. Go to [Langfuse](https://langfuse.com) and click on the "Sign In" button in the top right corner.
🔀  2. Click on the "Sign Up" button and create an account.
🔀 -3. Click on "Settings" and then on "Create new API keys"
🔀 +3. Once logged in, click on "Settings" and then on "Create new API keys."
🔀  4. Copy the Public key and the Secret Key and save them somewhere safe.
🔀 -   {/* Add env variables LANGFLOW_LANGFUSE_SECRET_KEY, LANGFLOW_LANGFUSE_PUBLIC_KEY and LANGFLOW_LANGFUSE_HOST to pass to CallbackHandler */}
🔀 +   {/* Add
2023-08-22 09:47:35 -03:00
Gabriel Luiz Freitas Almeida
75f042c388 📚 docs(sidebars.js): add "langfuse_integration" guide to the "Step-by-Step Guides" section for improved documentation coverage 2023-08-22 07:20:25 -03:00
Gabriel Luiz Freitas Almeida
4e7a993db3 Adds first version of docs 2023-08-21 22:18:55 -03:00
Rodrigo Nader
4c1b342a43 feat: Add documentation for various tools
- Added documentation for BingSearchRun, Calculator, GoogleSearchResults, GoogleSearchRun, GoogleSerperRun, and InfoSQLDatabaseTool components.
2023-08-15 10:14:24 -03:00
Gabriel Luiz Freitas Almeida
3b04048e75 🔥 refactor(custom-component.mdx): remove width property from style to improve responsiveness and avoid fixed width 2023-08-09 09:49:25 -03:00
Gabriel Luiz Freitas Almeida
a64f03da9c 📝 docs(loading_document.mdx): update the "Web Page" field URL to point to the correct documentation URL
📝 docs(CNAME): update the CNAME file to point to the new domain for the documentation

🔧 fix(ApiModal/index.tsx): update the links in the description to point to the correct documentation URL
2023-08-08 14:11:57 -03:00
Gabriel Luiz Freitas Almeida
aac7e92832 📝 docs(custom-component.mdx): update guidelines for loading custom components
🔧 fix(custom-component.mdx): correct the recommended way to load custom components by setting LANGFLOW_COMPONENTS_PATH environment variable instead of using --components-path argument

💡 docs(custom-component.mdx): provide an alternative method to specify the path to custom components using --components-path argument
2023-08-04 13:49:53 -03:00
Gabriel Luiz Freitas Almeida
3e465f6df3 📝 docs(flow-runner.mdx): update example code formatting and fix indentation for better readability
🖼️ chore(flow_runner_code.png): update flow_runner_code.png image
2023-08-01 17:49:58 -03:00
Gabriel Luiz Freitas Almeida
c112a42292 Merge branch 'main' into dev 2023-08-01 16:02:03 -03:00
Gabriel Luiz Freitas Almeida
2f9ffd1d48 🐛 fix(flow-runner.mdx): handle case where document is a list and extract the first element to ensure compatibility with the flow
🔨 refactor(flow-runner.mdx): remove unnecessary comment and unused variable to improve code readability and maintainability
2023-07-31 21:42:08 -03:00
Gabriel Luiz Freitas Almeida
8a6a953179 📝 docs(custom.mdx): add description of the 'repr_value' attribute in the CustomComponent class
📝 docs(custom-component.mdx): update example code and description of the 'repr_value' attribute in the DocumentProcessor class
2023-07-31 21:23:15 -03:00
Gabriel Luiz Freitas Almeida
15643263a8 🔧 chore(docusaurus.config.js): update remarkCodeHike configuration to use the "github-light" theme for better code highlighting aesthetics 2023-07-31 18:58:51 -03:00
Gabriel Luiz Freitas Almeida
f1f1759f02 📝 docs(multiple-vectorstores.mdx): fix code block language from 'txt' to 'text' for clarity and consistency 2023-07-31 18:54:46 -03:00
Gabriel Luiz Freitas Almeida
0907e477fd 📝 docs(custom-component.mdx): improve clarity by emphasizing the --components-path argument using italics
📝 docs(chatprompttemplate_guide.mdx): update the "Prompt" field text to use italics for better readability
2023-07-31 18:46:31 -03:00
Gabriel Luiz Freitas Almeida
1fa00fcf8f 📝 docs(custom-component.mdx): add note about custom components appearing in 'Other' category if using a subdirectory not listed in config.yaml 2023-07-31 18:31:52 -03:00
Gabriel Luiz Freitas Almeida
a5cb741fc5 📝 docs(custom-component.mdx): add instructions for loading custom components outside of the standard interface
📝 docs(custom-component.mdx): update folder structure section to include custom agents directory

📝 docs(custom-component.mdx): add instructions for specifying the path to custom components using the Langflow CLI

📝 docs(custom-component.mdx): add instructions for setting the LANGFLOW_COMPONENTS_PATH environment variable

📝 docs(custom-component.mdx): clarify that Langflow will continue loading components even if there are errors in some of them

📝 docs(custom-component.mdx): add section on interacting with custom components in Langflow's sidebar
2023-07-31 18:15:56 -03:00
Gabriel Luiz Freitas Almeida
b2979bce17 🐛 fix(flow-runner.mdx): remove unnecessary load_flow calls and update get_flow method signature to include tweaks parameter
🚚 chore(flow-runner.mdx): update load_flow references to get_flow
🚚 chore(flow-runner.mdx): remove commented out code
🚚 chore(flow-runner.mdx): update load_flow references to get_flow
2023-07-31 16:03:51 -03:00
Gabriel Luiz Freitas Almeida
92b99f82d9 📝 docs(how-contribute.md): update contribution guide with instructions for running documentation locally using Docusaurus
🐛 fix(how-contribute.md): fix formatting and add missing newline at end of file
2023-07-31 14:56:10 -03:00
Gabriel Luiz Freitas Almeida
ec17b4e9d3 📝 docs(flow-runner.mdx): update explanation of using Document input in FlowRunner class
The change clarifies that using a `Document` as input in the `FlowRunner` class is a straightforward way to pass text data in Langflow, specifically because it can be connected to many loaders. It also mentions that generally, a flow expects a string or a dictionary as input. Additionally, it updates the explanation of extracting the content of a document using the `page_content` attribute, which is a string.
2023-07-31 14:51:09 -03:00
Gabriel Luiz Freitas Almeida
9cc0ae0242 📝 docs(flow-runner.mdx): add explanation about using Document as input in FlowRunner class
The commit adds an explanation about using a `Document` as input in the `FlowRunner` class. It clarifies that using a `Document` is a straightforward way to pass text data in Langflow. Typically, a flow expects a string or a dictionary as input, and if a dictionary is used, it should be built according to the needs of the specific flow. The commit also mentions that the content of a document can be extracted using the `page_content` property and passed as an argument to the selected flow.
2023-07-31 14:37:18 -03:00
Gabriel Luiz Freitas Almeida
1eda86658d 📝 docs(custom.mdx): fix formatting and typos in the CustomComponent class documentation
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
📝 docs(custom.mdx): improve readability and formatting in the CustomComponent class documentation
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
📝 docs(custom.mdx): update CustomComponent class documentation with additional methods and descriptions
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
📝 docs(custom.mdx): update CustomComponent class documentation with corrected method names and descriptions
🔀 docs(custom.mdx): merge changes from the CustomComponent class documentation
2023-07-31 11:48:17 -03:00
Gabriel Luiz Freitas Almeida
e03e306292 📝 docs(flow-runner.mdx): fix typo in line 141, "looks" instead of "look like"
📝 docs(flow-runner.mdx): remove extra blank lines in code examples for better readability
2023-07-31 11:46:23 -03:00
Gabriel Luiz Freitas Almeida
5c42683b40 📝 docs(flow-runner.mdx): add example code for a Flow Runner custom component
ℹ️ The example code demonstrates how to create a custom component called "Flow Runner" that runs other flows using a document as input. The code includes the implementation of the `build_config` and `build` methods.

 feat(flow-runner.mdx): add example code for a Flow Runner custom component to provide a practical example for users to follow
2023-07-31 10:58:37 -03:00
Gabriel Luiz Freitas Almeida
16935ec198 🐛 fix(flow-runner.mdx): fix broken link to langchain.schema module in import statement
🐛 fix(flow-runner.mdx): remove unnecessary focus annotations in code snippets
 feat(flow-runner.mdx): add support for getting flow by name instead of id in build method
 feat(flow-runner.mdx): add caution about unique flow names in version 0.4.0
 feat(flow-runner.mdx): add support for passing document parameter in build method
🐛 fix(flow-runner.mdx): remove redundant Optional type hint for document parameter in build method
🐛 fix(flow-runner.mdx): remove empty line at the end of the file
2023-07-31 10:58:35 -03:00
Rodrigo Nader
7b12bb5e5b review flow-runner example 2023-07-31 02:22:23 -03:00
Rodrigo Nader
060fa07398 change announcement color 2023-07-30 18:05:16 -03:00
Rodrigo Nader
1cba53fcc9 minor 2023-07-30 17:59:12 -03:00
Rodrigo Nader
5a12848e49 minor 2023-07-30 17:53:33 -03:00
Rodrigo Nader
7b03dfabe6 change images 2023-07-28 17:37:28 -03:00
Rodrigo Nader
0bec0ab1db update docs 2023-07-28 17:16:49 -03:00
Rodrigo Nader
6be4799950 improve custom component docs 2023-07-28 15:00:57 -03:00
Gabriel Luiz Freitas Almeida
208b5d4bb8 📝 docs(custom.mdx): improve formatting and add missing punctuation in the table description
🐛 fix(custom.mdx): add missing punctuation in the field descriptions
 feat(custom.mdx): add clarification to the field descriptions and provide examples for some fields
📝 docs(custom.mdx): add missing punctuation in the method description
🐛 fix(custom.mdx): add comment to clarify the purpose of the line
2023-07-28 14:45:05 -03:00
Gabriel Luiz Freitas Almeida
0d57263a0a 📝 docs(custom.mdx): fix typo in the comment, change "top level" to "top-level" for consistency 2023-07-28 14:33:53 -03:00
Gabriel Luiz Freitas Almeida
c6091444d5 📝 docs(custom.mdx): remove outdated information about loading flow and tweaks parameter in CustomComponent class 2023-07-28 14:31:48 -03:00
Gabriel Luiz Freitas Almeida
f82a97b010 📝 docs(prompt-customization.mdx): add line breaks for better readability and remove unnecessary empty lines 2023-07-28 14:26:40 -03:00
Gabriel Luiz Freitas Almeida
1b09ddf667 📝 docs(custom-component.mdx): add a tip admonition with a link to the FlowRunner Component example for more powerful usage of custom components 2023-07-28 14:26:17 -03:00
Gabriel Luiz Freitas Almeida
ab6d6bc803 📝 docs(flow-runner.mdx): update introduction to clarify the purpose of the CustomComponent
📝 docs(flow-runner.mdx): update example description to focus on creating a component to run other flows
2023-07-28 14:25:50 -03:00
Gabriel Luiz Freitas Almeida
231978d1df 🎨 style(docs): update image rendering in examples and guidelines files for better readability and consistency
🔧 chore(docs): fix formatting in chat-widget.mdx file

🎨 style(components.mdx): Remove unnecessary div wrapper and fix indentation
🎨 style(features.mdx): Remove unnecessary div wrapper and fix indentation
🎨 style(prompt-customization.mdx): Remove unnecessary div wrappers and fix indentation
🎨 style(index.mdx): Remove unnecessary div wrapper and fix indentation
2023-07-28 12:59:15 -03:00
Gabriel Luiz Freitas Almeida
6bf7612292 📚 docs(sidebars.js): add "flow-runner" example to the "Examples" section for better documentation coverage 2023-07-28 11:58:58 -03:00
Gabriel Luiz Freitas Almeida
90bb8535ec 📸 feat(docs): add screenshots of flow runner and flow runner code for documentation purposes 2023-07-28 11:57:44 -03:00
Gabriel Luiz Freitas Almeida
1d47d47c4d 📝 docs(custom.mdx): update table formatting and clarify field_type and options usage in custom component documentation
📝 docs(custom-component.mdx): remove is_list from function field and clarify options usage in build_config method
2023-07-28 11:57:13 -03:00
Gabriel Luiz Freitas Almeida
784f813dc5 📝 docs(flow-runner.mdx): update FlowRunner example to improve readability and add field customization in build_config method 2023-07-28 11:56:34 -03:00
Gabriel Luiz Freitas Almeida
734a91b913 feat(flow-runner.mdx): add FlowRunner example to the documentation to demonstrate how to create a custom component that runs other flows 2023-07-28 11:26:50 -03:00
Gabriel Luiz Freitas Almeida
4ad226f35b 📚 docs(custom-component.mdx): remove unnecessary code and examples from the custom component guidelines
📚 docs(custom-component.mdx): remove unnecessary code and examples related to the FlowRunner component from the custom component guidelines
2023-07-28 11:24:16 -03:00
Gabriel Luiz Freitas Almeida
457453656a 📝 docs(custom.mdx): update documentation for Custom Component
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.
2023-07-28 11:23:26 -03:00
Gabriel Luiz Freitas Almeida
28cebb2d39 🔧 chore(docs): update custom-component.mdx
🐛 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
2023-07-28 09:30:56 -03:00
Gabriel Luiz Freitas Almeida
dc2207d194 📝 docs(img): add images for document processor and document processor code
📝 docs(img): add images for document processor and document processor code to enhance documentation and provide visual representation of the process
2023-07-28 09:30:28 -03:00
Gabriel Luiz Freitas Almeida
559778d4b6 🐛 fix(ZoomableImage.js): add style prop to ZoomableImage component to allow custom styling
 feat(ZoomableImage.js): add default style to ZoomableImage component for consistent layout and centering of images
2023-07-28 09:29:18 -03:00
Rodrigo Nader
2ce2be4544 minor 2023-07-27 22:14:05 -03:00
Rodrigo Nader
645f35e186 Enhance custom component docs 2023-07-27 22:08:12 -03:00