You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/machine-learning/prompt-flow/get-started-prompt-flow.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,10 +23,10 @@ This article walks you through the main user journey of using prompt flow in Azu
23
23
24
24
- An Azure Machine Learning workspace. The default storage for the workspace must be blob type.
25
25
- An Azure OpenAI account, or an existing Azure OpenAI connection with a deployment. For more information, see [Create a resource and deploy a model using Azure OpenAI](/azure/cognitive-services/openai/how-to/create-resource).
26
-
27
26
>[!NOTE]
28
-
If you want to secure your prompt flow with a virtual network, also follow the instructions at [Secure prompt flow with workspace managed virtual network](how-to-secure-prompt-flow.md#secure-prompt-flow-with-workspace-managed-virtual-network).
27
+
>If you want to secure your prompt flow with a virtual network, also follow the instructions at [Secure prompt flow with workspace managed virtual network](how-to-secure-prompt-flow.md#secure-prompt-flow-with-workspace-managed-virtual-network).
29
28
29
+
<aname="set-up-connection"></a>
30
30
## Set up a connection
31
31
32
32
A connection helps securely store and manage secret keys or other sensitive credentials required for interacting with Large Language Models (LLM) and other external tools such as Azure Content Safety. Connection resources are shared with all members in the workspace.
@@ -43,9 +43,9 @@ A connection helps securely store and manage secret keys or other sensitive cred
43
43
44
44
:::image type="content" source="./media/get-started-prompt-flow/azure-openai-connection.png" alt-text="Screenshot of the Azure OpenAI connection screen." lightbox = "./media/get-started-prompt-flow/azure-openai-connection.png":::
45
45
46
-
Prompt flow supports either **API Key** or **Microsoft Entra ID** authentication for Azure OpenAI resources. For this tutorial, select **API Key**.
46
+
Prompt flow supports either **API Key** or **Microsoft Entra ID** authentication for Azure OpenAI resources. For this tutorial, select **API key** under **Auth Mode**.
47
47
48
-
To get the API information, go to the [Chat playground](https://oai.azure.com/portal/chat) in the Azure OpenAI portal and select your Open AI resource name. Copy the **Key** and paste it into the **API key** field in the add connection form, and copy the **Endpoint** and paste it into the **API base** field in the form.
48
+
To get the API information, go to the [Chat playground](https://oai.azure.com/portal/chat) in the Azure OpenAI portal and select your Azure OpenAI resource name. Copy the **Key** and paste it into the **API key** field in the **Add Azure OpenAI connection** form, and copy the **Endpoint** and paste it into the **API base** field in the form.
49
49
50
50
:::image type="content" source="./media/get-started-prompt-flow/create-aoai-connection.png" alt-text="Screenshot of the chat playground showing the Key and Endpoint for an Azure OpenAI resource." lightbox = "./media/get-started-prompt-flow/create-aoai-connection.png":::
51
51
@@ -65,7 +65,7 @@ In the **Explore gallery**, you can browse the built-in samples and select **Vie
65
65
66
66
This tutorial uses the **Web Classification** sample to walk through the main user journey. Web Classification is a flow demonstrating multiclass classification with a LLM. Given a URL, the flow classifies the URL into a web category with just a few shots, simple summarization, and classification prompts. For example, given a URL `https://www.imdb.com`, it classifies the URL into `Movie`.
67
67
68
-
To clone the sample, select **Clone** on the **Web Classification** tile.
68
+
To clone the sample, select **Clone** on the **Web Classification** tile.
69
69
70
70
:::image type="content" source="./media/get-started-prompt-flow/sample-in-gallery.png" alt-text="Screenshot of create from galley highlighting web classification." lightbox = "./media/get-started-prompt-flow/sample-in-gallery.png":::
71
71
@@ -87,7 +87,7 @@ While the compute session is starting, take a look at the parts of the flow auth
87
87
88
88
- The **Flow** or *flatten* view on the left side of the page is the main working area, where you can author the flow by adding nodes, editing and running nodes inline, or editing the prompt. In the **Inputs** and **Outputs** sections, you can view, add, and edit inputs and outputs.
89
89
90
-
The inputs and outputs are already set when you clone a flow. The flow input schema for the Web Classification sample is `name: url; type: string`, a URL of string type. You can change to another value manually, for example `https://www.imdb.com`.
90
+
The inputs and outputs are already set when you clone a flow. The flow input schema for the Web Classification sample is `name: url; type: string`, a URL of string type. You can change the preset input value to another value manually, for example `https://www.imdb.com`.
91
91
92
92
-**Files** at top right shows the folder and file structure of the flow. Each flow folder contains a *flow.dag.yaml* file, source code files, and system folders. You can create, upload, or download files for testing, deployment, or collaboration.
93
93
@@ -170,7 +170,7 @@ Use the **Batch run & Evaluate** wizard to submit a batch run and optionally to
170
170
171
171
1. On the **Batch run settings** screen of the **Batch run & Evaluate** wizard, select **Add new data**. On the **Add data** screen, provide a **Name** for the dataset, select **Browse** to upload the *data.csv* file you downloaded, and then select **Add**.
172
172
173
-
After you upload the data, or if your workspace has other datasets you want to use, search for and choose the dataset from the dropdown list and preview the first five rows.
173
+
After you upload the data, or if your workspace has another dataset you want to use, search for and choose the dataset from the dropdown list to preview the first five rows.
174
174
175
175
The **Input mapping** feature supports mapping your flow input to any data column in your dataset, even if the column names don't match.
176
176
@@ -206,7 +206,7 @@ In the **Output** table, you can:
206
206
- Select **Export** to **Download current page** as a CSV file or **Download data export script** as a Jupyter notebook file you can run to download outputs locally.
207
207
- Select the **View details** icon next to any row to open the **Trace view** showing the complete details for that row.
208
208
209
-
Accuracy isn't the only metric that can evaluate a classification task. For example, you can also use recall to evaluate. To run other evaluations, select **Evaluate** next to **Visualize outputs** on the **Runs** page, and select other methods to evaluate.
209
+
Accuracy isn't the only metric that can evaluate a classification task. For example, you can also use recall to evaluate. To run other evaluations, select **Evaluate** next to **Visualize outputs** on the **Runs** page, and select other evaluation methods.
210
210
211
211
## Deploy as an endpoint
212
212
@@ -230,13 +230,11 @@ Put the URL you want to test in the input box, and select **Test**. You see the
230
230
231
231
## Clean up resources
232
232
233
-
To conserve compute resources and charges, you can stop your compute session if you're not going to use any more right now. Select the running session and then select **Stop compute session**.
233
+
To conserve compute resources and charges, you can stop your compute session if you're not going to use it anymore right now. Select the running session and then select **Stop compute session**.
234
234
235
235
You can also stop a compute instance by selecting **Compute** from the studio left navigation, selecting your compute instance in the **Compute instances** list, and selecting **Stop**.
236
236
237
-
If you don't plan to use any of the resources that you created in this tutorial, you can delete them so you don't incur any charges.
238
-
239
-
In the Azure portal, search for and select **Resource groups**. Select the resource group from the list, and then select **Delete resource group** from the top menu on the resource group's page.
237
+
If you don't plan to use any of the resources that you created in this tutorial, you can delete them so you don't incur any charges. In the Azure portal, search for and select **Resource groups**. Select the resource group from the list, and then select **Delete resource group** from the top menu on the resource group's page.
0 commit comments