You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

begin.mdx 3.7KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. ---
  2. sidebar_position: 1
  3. slug: /begin_component
  4. ---
  5. # Begin component
  6. The starting component in a workflow.
  7. ---
  8. The **Begin** component sets an opening greeting or accepts inputs from the user. It is automatically populated onto the canvas when you create an agent, whether from a template or from scratch (from a blank template). There should be only one **Begin** component in the workflow.
  9. ## Scenarios
  10. A **Begin** component is essential in all cases. Every agent includes a **Begin** component, which cannot be deleted.
  11. ## Configurations
  12. Click the component to display its **Configuration** window. Here, you can set an opening greeting and the input parameters (global variables) for the agent.
  13. ### ID
  14. The ID is the unique identifier for the component within the workflow. Unlike the IDs of other components, the ID of the **Begin** component *cannot* be changed.
  15. ### Opening greeting
  16. An opening greeting is the agent's first message to the user. It can be a welcoming remark or an instruction to guide the user forward.
  17. ### Global variables
  18. You can set global variables within the **Begin** component, which can be either required or optional. Once established, users will need to provide values for these variables when interacting or chatting with the agent. Click **+ Add variable** to add a global variable, each with the following attributes:
  19. - **Key**: *Required*
  20. The unique variable name.
  21. - **Name**: *Required*
  22. A descriptive name providing additional details about the variable.
  23. For example, if **Key** is set to `lang`, you can set its **Name** to `Target language`.
  24. - **Type**: *Required*
  25. The type of the variable:
  26. - **line**: Accepts a single line of text without line breaks.
  27. - **paragraph**: Accepts multiple lines of text, including line breaks.
  28. - **options**: Requires the user to select a value for this variable from a dropdown menu. And you are required to set *at least* one option for the dropdown menu.
  29. - **file**: Requires the user to upload one or multiple files.
  30. - **integer**: Accepts an integer as input.
  31. - **boolean**: Requires the user to toggle between on and off.
  32. - **Optional**: A toggle indicating whether the variable is optional.
  33. ## Examples
  34. As mentioned earlier, the **Begin** component is indispensable for an agent. Still, you can take a look at our three-step interpreter agent template, where the **Begin** component takes two global variables:
  35. 1. Click the **Agent** tab at the top center of the page to access the **Agent** page.
  36. 2. Click **+ Create agent** on the top right of the page to open the **agent template** page.
  37. 3. On the **agent template** page, hover over the **Interpreter** card and click **Use this template**.
  38. 4. Name your new agent and click **OK** to enter the workflow editor.
  39. 5. Click on the **Begin** component to display its **Configuration** window.
  40. ## Frequently asked questions
  41. ### Is the uploaded file in a knowledge base?
  42. No. Files uploaded to an agent as input are not stored in a knowledge base and will not be chunked using RAGFlow's built-in chunk methods. However, RAGFlow's built-in OSR, DLR, and TSR models will still be applied to process the document.
  43. ### How to upload a webpage or file from a URL?
  44. If you set the type of a variable as **file**, your users will be able to upload a file either from their local device or from an accessible URL. For example:
  45. ![upload_file](https://github.com/user-attachments/assets/7ad2a352-0807-4b74-b8d1-d09e5cd37997)
  46. ### File size limit for an uploaded file
  47. The maximum file size for each uploaded file is determined by the variable `MAX_CONTENT_LENGTH` in `/docker/.env`. It defaults to 128 MB. If you change the default file size, ensure you also update the value of `client_max_body_size` in `/docker/nginx/nginx.conf` accordingly.