AWS quick documentation change
Summary
Major restructuring and rewrite of the editing flows user guide, updating terminology, step configurations, and removing outdated sections like 'Sequential flow' and 'Quick data vs general knowledge'. The guide now uses a more concise, bullet-point style for step configuration and updates navigation instructions.
Security assessment
The changes are purely editorial and structural, focusing on improving clarity, updating terminology, and reflecting current product features. There is no mention of security vulnerabilities, access controls, authentication, data protection, or any other security-related concepts. The changes are routine documentation updates.
Diff
diff --git a/quick/latest/userguide/editing-flows.md b/quick/latest/userguide/editing-flows.md index 6e254f230..24ab8d64f 100644 --- a//quick/latest/userguide/editing-flows.md +++ b//quick/latest/userguide/editing-flows.md @@ -5 +5 @@ -Accessing the Flow editorConfiguring step typesPrompt writing for output stepsAdding and removing stepsSequential flowQuick data vs general knowledgePublishing changesUpdating Flow detailsBest practices for editing flows +Accessing the Flow editorConfiguring step typesPrompt writing for stepsAdding and removing stepsPublishing changesUpdating Flow detailsBest practices for editing flows @@ -9 +9 @@ Accessing the Flow editorConfiguring step typesPrompt writing for output stepsAd -Once you've created your flow, you can edit and configure it to meet your specific requirements. This section describes how to modify your flow's components, structure, and settings. +After creating a flow, you can edit and configure it in the Flow editor. @@ -13,2 +12,0 @@ Once you've created your flow, you can edit and configure it to meet your specif -To edit an existing flow: - @@ -17 +15 @@ To edit an existing flow: - 2. In the navigation pane, choose _Flows_. + 2. In the navigation pane, choose **Flows**. @@ -21,2 +19 @@ To edit an existing flow: - 4. Choose the flow name to open it in the Flow editor. - + 4. Choose the flow tile, or choose the ellipsis (⋮) and select **Open**. @@ -26 +22,0 @@ To edit an existing flow: -The Flows editor provides a visual interface where you can modify your flow's components, connections, and settings. @@ -30 +26 @@ The Flows editor provides a visual interface where you can modify your flow's co -Each type of step in a flow has specific configuration options. This section describes how to configure each step type. +Most steps with a prompt field support @ references to include data from previous steps. See each step's configuration for specific limitations. @@ -32 +28 @@ Each type of step in a flow has specific configuration options. This section des -### Configuring input text steps +### Configuring text input steps @@ -34 +30 @@ Each type of step in a flow has specific configuration options. This section des -Input text steps collect text input from users. To configure an input text step: +In Editor mode, add or select a text input step. In the configuration panel, set the following: @@ -36 +32 @@ Input text steps collect text input from users. To configure an input text step: - 1. Select the input text step in the Flow editor. + * **Title** : A name for the step. @@ -38 +34 @@ Input text steps collect text input from users. To configure an input text step: - 2. In the configuration panel, set the following options: + * **Placeholder** : Optional text that appears inside the input field when it is empty. This text is not used for the flow run. @@ -40 +36 @@ Input text steps collect text input from users. To configure an input text step: - * _Label_ : The text that appears above the input field. + * **Default Value** : Optional. The value provided if the user doesn't enter an input. @@ -42 +38 @@ Input text steps collect text input from users. To configure an input text step: - * _Placeholder_ : Optional text that appears inside the input field when it's empty. + * **Allow override of default value** : Toggle to let users replace the default value at runtime. @@ -44 +39,0 @@ Input text steps collect text input from users. To configure an input text step: - * _Default value_ : Optional text that pre-fills the input field. @@ -46 +40,0 @@ Input text steps collect text input from users. To configure an input text step: - * _Required_ : Toggle to specify whether the input is required. @@ -48 +41,0 @@ Input text steps collect text input from users. To configure an input text step: - 3. Choose _Save_ to save your changes. @@ -49,0 +43 @@ Input text steps collect text input from users. To configure an input text step: +### Configuring file upload steps @@ -50,0 +45 @@ Input text steps collect text input from users. To configure an input text step: +In Editor mode, add or select a file upload step. In the configuration panel, set the following: @@ -51,0 +47 @@ Input text steps collect text input from users. To configure an input text step: + * **Title** : A name for the step. @@ -53 +49 @@ Input text steps collect text input from users. To configure an input text step: -### Configuring file upload steps + * **Default file** : Optional. Upload a document, image, or video to use if the user doesn't provide one. You can upload one file per step. @@ -55 +51 @@ Input text steps collect text input from users. To configure an input text step: -File upload steps allow users to upload files to your flow. To configure a file upload step: + * **Allow override of default value** : Toggle to let users replace the default file at runtime. @@ -57 +52,0 @@ File upload steps allow users to upload files to your flow. To configure a file - 1. Select the file upload step in the Flow editor. @@ -59 +53,0 @@ File upload steps allow users to upload files to your flow. To configure a file - 2. In the configuration panel, set the following options: @@ -61 +54,0 @@ File upload steps allow users to upload files to your flow. To configure a file - * _Label_ : The text that appears above the upload control. @@ -63 +56 @@ File upload steps allow users to upload files to your flow. To configure a file - * _Upload default file_ : Upload a default file that can be used during flow run. +### Configuring general knowledge steps @@ -65 +58 @@ File upload steps allow users to upload files to your flow. To configure a file - * _Allow override of default files_ : Enable runtime users to override default files. +In Editor mode, add or select a general knowledge step. In the configuration panel, set the following: @@ -67 +60 @@ File upload steps allow users to upload files to your flow. To configure a file - 3. Choose _Save_ to save your changes. + * **Output preference** : Choose one: @@ -68,0 +62 @@ File upload steps allow users to upload files to your flow. To configure a file + * **Fast responses** — Across image, video, and text inputs. @@ -69,0 +64 @@ File upload steps allow users to upload files to your flow. To configure a file + * **Versatility and performance** — Balanced capabilities for diverse tasks. @@ -70,0 +66 @@ File upload steps allow users to upload files to your flow. To configure a file + * **Prompt** : Write the prompt that instructs the model what to generate. @@ -72 +68 @@ File upload steps allow users to upload files to your flow. To configure a file -###### Note + * **Creativity Level** : Optional. Adjust the slider from low to high to control the randomness of the response. @@ -74 +69,0 @@ File upload steps allow users to upload files to your flow. To configure a file -File uploads are processed according to the capabilities of the selected model. Some models have limitations on file types and sizes they can process. @@ -76 +70,0 @@ File uploads are processed according to the capabilities of the selected model. -### Configuring general knowledge steps @@ -78 +71,0 @@ File uploads are processed according to the capabilities of the selected model. -General knowledge steps display text responses from models to users. To configure a general knowledge step: @@ -80 +73 @@ General knowledge steps display text responses from models to users. To configur - 1. Select the general knowledge step from the add step menu in the Flow editor. +For more information, see [General knowledge](./ai-response-steps.html#general-knowledge-step). @@ -82 +75 @@ General knowledge steps display text responses from models to users. To configur - 2. In the configuration panel, set the following options: +### Configuring Quick data steps @@ -84 +77 @@ General knowledge steps display text responses from models to users. To configur - * _Output preference_ : Choose output response preference from Faster responses or Versatility and Performance. +In Editor mode, add or select a Quick data step. In the configuration panel, set the following: @@ -86 +79 @@ General knowledge steps display text responses from models to users. To configur - * _Prompt_ : Write the prompt that instructs the model what to generate. You can use @ references to include data from previous steps. + * **Prompt** : Write the prompt that instructs what content to retrieve. @@ -88 +81 @@ General knowledge steps display text responses from models to users. To configur - * _Advanced settings_ : Configure model specific parameters such as creativity level to manage randomness of the LLM response. + * **Link specific resources** : Select spaces and knowledge bases to get insights from. By default, responses are generated from all knowledge sources the user has access to. @@ -90 +82,0 @@ General knowledge steps display text responses from models to users. To configur - 3. Choose _Save_ to save your changes. @@ -93,0 +86 @@ General knowledge steps display text responses from models to users. To configur +### Configuring web search steps @@ -95 +88 @@ General knowledge steps display text responses from models to users. To configur -### Configuring Quick suite data steps +In Editor mode, add or select a web search step. In the configuration panel, set the following: @@ -97 +90 @@ General knowledge steps display text responses from models to users. To configur -Quick suite data steps display text responses from internet search to users. To configure a Quick suite data: + * **Prompt** : Write the prompt that instructs what content to search for on the web. @@ -99 +91,0 @@ Quick suite data steps display text responses from internet search to users. To - 1. Select the Quick suite data step from the add step menu in the Flow editor. @@ -101 +92,0 @@ Quick suite data steps display text responses from internet search to users. To - 2. In the configuration panel, set the following options: @@ -103 +93,0 @@ Quick suite data steps display text responses from internet search to users. To - * _Prompt_ : Write the prompt that instructs what content to generate from the web. You can use @ references to include data from previous steps. @@ -105 +95 @@ Quick suite data steps display text responses from internet search to users. To - * _Link specific resources_ : Select spaces and knowledge bases that you would like to get insights from. By default, responses are generated from all knowledge sources user has access to. +### Configuring research steps @@ -107 +97 @@ Quick suite data steps display text responses from internet search to users. To - 3. Choose _Save_ to save your changes. +In Editor mode, add or select a research step. In the configuration panel, set the following: @@ -108,0 +99 @@ Quick suite data steps display text responses from internet search to users. To + * **Title** : A name for the step. @@ -109,0 +101 @@ Quick suite data steps display text responses from internet search to users. To + * **Research objective** : Describe what you want to research. @@ -110,0 +103 @@ Quick suite data steps display text responses from internet search to users. To + * **File uploads** : Optional. Upload default files to help guide your research. @@ -112 +105 @@ Quick suite data steps display text responses from internet search to users. To -### Configuring web steps + * **Research materials** : @@ -114 +107 @@ Quick suite data steps display text responses from internet search to users. To -Web steps display text responses from internet search to users. To configure a web step: + * **Preferred websites** : Optional. Specify websites or types of websites the agent should prioritize (for example, government websites, academic journals). @@ -116 +109 @@ Web steps display text responses from internet search to users. To configure a w - 1. Select the web step from the add step menu in the Flow editor. + * **Websites to avoid** : Optional. Specify websites or types of websites to exclude (for example, social media, blogs). @@ -118 +111 @@ Web steps display text responses from internet search to users. To configure a w - 2. In the configuration panel, set the following options: + * **Data and apps** : Select all data and apps, or choose specific ones. @@ -120 +112,0 @@ Web steps display text responses from internet search to users. To configure a w - * _Prompt_ : Write the prompt that instructs what content to generate from the web. You can use @ references to include data from previous steps. @@ -122 +113,0 @@ Web steps display text responses from internet search to users. To configure a w - 3. Choose _Save_ to save your changes. @@ -124,0 +116 @@ Web steps display text responses from internet search to users. To configure a w +### Configuring chat agent steps @@ -125,0 +118 @@ Web steps display text responses from internet search to users. To configure a w +In Editor mode, add or select a chat agent step. In the configuration panel, set the following: @@ -127 +120 @@ Web steps display text responses from internet search to users. To configure a w -For more information about writing effective prompts, see Prompt writing for output steps. + * **Title** : A name for the step. @@ -129 +122 @@ For more information about writing effective prompts, see Prompt writing for out -### Configuring output image steps + * **Chat agent** : Select the agent to use. @@ -131 +124 @@ For more information about writing effective prompts, see Prompt writing for out -Output image steps generate and display images to users. To configure an output image step: + * **Prompt instruction** : Write the prompt that instructs the agent. @@ -133 +126 @@ Output image steps generate and display images to users. To configure an output - 1. Select the output image step in the Flow editor. + * **Data and apps** : Optionally narrow down the selected data and apps to refine your use case. @@ -135 +128 @@ Output image steps generate and display images to users. To configure an output - 2. In the configuration panel, set the following options: + * **Web search** : Toggle to enable or disable web search for the agent. @@ -137 +129,0 @@ Output image steps generate and display images to users. To configure an output - * _Prompt_ : Write the prompt that describes the image to generate. You can use @ references to include data from previous steps. @@ -139 +130,0 @@ Output image steps generate and display images to users. To configure an output - * _Advanced settings_ : Configure mode-specific parameters such as creativity level (defines the randomness of the LLM response), Exclude (a parameter to define what not to include), and image seed (control the determinism of the images generated). @@ -141 +131,0 @@ Output image steps generate and display images to users. To configure an output - 3. Choose _Save_ to save your changes. @@ -142,0 +133 @@ Output image steps generate and display images to users. To configure an output +### Configuring UI Agent steps @@ -143,0 +135 @@ Output image steps generate and display images to users. To configure an output +In Editor mode, add or select a UI Agent step. In the configuration panel, set the following: @@ -144,0 +137 @@ Output image steps generate and display images to users. To configure an output + * **Title** : A name for the step. @@ -146 +139 @@ Output image steps generate and display images to users. To configure an output -### Configuring output Quick Sight steps + * **UI Agent Instructions** : Write the instructions for the UI agent. Use single, complete URLs for faster, more accurate results. @@ -148 +140,0 @@ Output image steps generate and display images to users. To configure an output -Output Quick Sight steps display Quick Sight visualizations to users. To configure an output Quick Sight step: @@ -150 +141,0 @@ Output Quick Sight steps display Quick Sight visualizations to users. To configu - 1. Select the output Quick Sight step in the Flow editor. @@ -152 +142,0 @@ Output Quick Sight steps display Quick Sight visualizations to users. To configu - 2. In the configuration panel, set the following options: @@ -154 +144 @@ Output Quick Sight steps display Quick Sight visualizations to users. To configu - * _Quick Sight source_ : Choose from Dashboard or a Topic. +### Configuring Create Image steps @@ -156 +146 @@ Output Quick Sight steps display Quick Sight visualizations to users. To configu - * _Prompt_ : Describe insights you want to get from your Quick Sight dashboard or topic. You can use @ references to include data from previous steps. +In Editor mode, add or select a Create Image step. In the configuration panel, set the following: @@ -158 +148 @@ Output Quick Sight steps display Quick Sight visualizations to users. To configu - 3. Choose _Apply_ to save your changes. + * **Prompt** : Describe the image to generate. @@ -159,0 +150 @@ Output Quick Sight steps display Quick Sight visualizations to users. To configu