Skip to content

Commit 07428e8

Browse files
authored
Merge pull request #1399 from sdgilley/sdg-release-prompt-flow
Update how-to/flow-develop.md and images
2 parents 7da5f33 + 6f3a1b5 commit 07428e8

11 files changed

+10
-21
lines changed

articles/ai-studio/how-to/flow-develop.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ms.custom:
88
- ignite-2023
99
- build-2024
1010
ms.topic: how-to
11-
ms.date: 5/21/2024
11+
ms.date: 11/08/2024
1212
ms.reviewer: jinzhong
1313
ms.author: lagayhar
1414
author: lgayhardt
@@ -48,7 +48,8 @@ To create a prompt flow from the gallery in Azure AI Studio:
4848

4949
:::image type="content" source="../media/prompt-flow/create-standard-flow.png" alt-text="Screenshot of selecting and creating a standard flow." lightbox="../media/prompt-flow/create-standard-flow.png":::
5050

51-
1. The prompt flow authoring page opens. You can start authoring your flow now. By default you see a sample flow. This example flow has nodes for the LLM and Python tools.
51+
1. The prompt flow authoring page opens. Select **Start compute session** to have a compute session running for the flow.
52+
1. You can start authoring your flow now. By default you see a sample flow. This example flow has nodes for the LLM and Python tools.
5253

5354
:::image type="content" source="../media/prompt-flow/create-flow-in-out.png" alt-text="Screenshot of flow input and output on the edit prompt flow page." lightbox="../media/prompt-flow/create-flow-in-out.png":::
5455

@@ -63,6 +64,7 @@ To create a prompt flow from the gallery in Azure AI Studio:
6364

6465
:::image type="content" source="../media/prompt-flow/create-flow-connection.png" alt-text="Screenshot of the selected connection and deployment in the LLM tool on the edit prompt flow page." lightbox="../media/prompt-flow/create-flow-connection.png":::
6566

67+
1. In the **Inputs** section, add a value for the topic. For example, "atoms."
6668
1. Select **Run** to run the flow.
6769

6870
:::image type="content" source="../media/prompt-flow/create-flow-run.png" alt-text="Screenshot of where to select run on the edit prompt flow page." lightbox="../media/prompt-flow/create-flow-run.png":::
@@ -83,7 +85,7 @@ To create a prompt flow from the gallery in Azure AI Studio:
8385

8486
Each flow is represented by a folder that contains a `flow.dag.yaml`` file, source code files, and system folders. You can add new files, edit existing files, and delete files. You can also export the files to local, or import files from local.
8587

86-
In addition to inline editing the node in flatten view, you can also turn on the **Raw file mode** toggle and select the file name to edit the file in the opening file tab.
88+
In addition to inline editing the node in the default view, you can also turn on the **Raw file mode** toggle and select the file name to edit the file in the opening file tab.
8789

8890
### Flow input and output
8991

@@ -111,7 +113,10 @@ If the condition isn't met, the node is skipped. The node status is shown as "By
111113
You can test the flow in two ways:
112114

113115
- Run **single node**.
114-
- To run a single node, select the **Run icon** on node in flatten view. Once running is completed, you can quickly check result in **node output section**.
116+
- To run a single node, select the **Run icon** on a node in the default view. Once running is completed, you can quickly check result in **node output section**.
117+
118+
:::image type="content" source="../media/prompt-flow/node-card-run.png" alt-text="Screenshot shows the run button in the node card.":::
119+
115120
- Run **the whole flow**.
116121
- To run the whole flow, select the **Run button** at the right top.
117122

@@ -121,26 +126,10 @@ For the whole flow run, after you execute the flow, you can see the run status i
121126

122127
##### Understand the trace view
123128

124-
The trace kind of a prompt flow is designated as **Flow**. Within the trace view, the clear sequence of the tools used for flow orchestration can be observed.
125-
126-
Each level 2 span under the flow root represents a node in the flow, executed in the form of a function call, hence the span kind is identified as **Function**. You can see the duration of each node execution in the span tree.
127-
128-
In the span tree, LLM calls are easily identifiable as the **LLM** span. These provide information about the duration of the LLM call and the associated token cost.
129-
130-
By selecting a span, you can see the detailed information on the right side. This includes input & output, Raw Json, and Exception, all of which are useful for observation and debugging.
129+
Select the **Trace** tab on the Outputs screen to see a graph that provides information about the duration and associated token cost of the flow. Select flow under node name to see detailed flow overview information in the right pane.
131130

132131
:::image type="content" source="../media/prompt-flow/authoring-trace.png" alt-text=" Screenshot of trace detail." lightbox="../media/prompt-flow/authoring-trace.png":::
133132

134-
> [!NOTE]
135-
> In prompt flow SDK, we defined serval span types, including **LLM**, **Function**, **Embedding**, **Retrieval**, and **Flow**. And the system automatically creates spans with execution information in designated attributes and events.
136-
>
137-
> To learn more about span types, see [Trace span](https://microsoft.github.io/promptflow/reference/trace-span-spec-reference.html).
138-
139-
After the flow run is completed, for checking the results, you can select the **View test results** button to check all historical run records in a list. By default, the run records created in the last 7 days are displayed. You can select the **Filter** to change the condition.
140-
141-
:::image type="content" source="../media/prompt-flow/authoring-test-result.png" alt-text="Screenshot of flow test result."lightbox="../media/prompt-flow/authoring-test-result.png":::
142-
143-
You can also select on the **Name** of the run record to view the detailed information in trace view.
144133

145134
## Develop a chat flow
146135

-132 KB
Loading
-134 KB
Loading
-147 KB
Loading
-205 KB
Loading
-16.5 KB
Loading
-37.5 KB
Loading
-205 KB
Loading
-182 KB
Loading
-119 KB
Loading

0 commit comments

Comments
 (0)