Merge pull request #8111 from MuyangAmigo/prompt_builder

ntrogh · web-flow · commit b808d00ce5d6 · 2025-03-11T09:52:56.000+01:00
Initial drafts for Prompt Builder doc
diff --git a/docs/intelligentapps/bulkrun.md b/docs/intelligentapps/bulkrun.md
@@ -1,5 +1,5 @@
 ---
-Order: 4
+Order: 5
 Area: intelligentapps
 TOCTitle: Bulk Run
 ContentId: 1124d141-e893-4780-aba7-b6ca13628bc5
diff --git a/docs/intelligentapps/evaluation.md b/docs/intelligentapps/evaluation.md
@@ -1,5 +1,5 @@
 ---
-Order: 5
+Order: 6
 Area: intelligentapps
 TOCTitle: Evaluation
 ContentId: 3342b8ef-72fe-4cca-baad-64ee57c05b5f
diff --git a/docs/intelligentapps/faq.md b/docs/intelligentapps/faq.md
@@ -1,5 +1,5 @@
 ---
-Order: 7
+Order: 8
 Area: intelligentapps
 TOCTitle: FAQ
 ContentId: c35d24d0-5d2c-493d-9635-10601a13848e
diff --git a/docs/intelligentapps/finetune.md b/docs/intelligentapps/finetune.md
@@ -1,5 +1,5 @@
 ---
-Order: 6
+Order: 7
 Area: intelligentapps
 TOCTitle: Finetune
 ContentId: 5b6626b8-98a9-497e-bbc6-e2274885be56
diff --git a/docs/intelligentapps/images/promptbuilder/edit_schema.png b/docs/intelligentapps/images/promptbuilder/edit_schema.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:5d8953b810f78914ee9fc2844f5ed11205bff564a69a0aa69051092f56f29864
+size 259625
diff --git a/docs/intelligentapps/images/promptbuilder/generate_prompt.gif b/docs/intelligentapps/images/promptbuilder/generate_prompt.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e77d7a920d17c0f27c3c41cf7867214547aa0ba7623b8a81ac5d597efdb7c50a
+size 2185033
diff --git a/docs/intelligentapps/images/promptbuilder/promptbuilder.gif b/docs/intelligentapps/images/promptbuilder/promptbuilder.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c7e6896e6fd893529df721761833dfab3145c579fba28a59ccc7c74ccd5b6a7e
+size 2204663
diff --git a/docs/intelligentapps/images/promptbuilder/s1_models.png b/docs/intelligentapps/images/promptbuilder/s1_models.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:9d7eacba378a7d0565a278112cf99b4312f058a76ac978bc48307155a548020b
+size 9366
diff --git a/docs/intelligentapps/images/promptbuilder/structured_output.gif b/docs/intelligentapps/images/promptbuilder/structured_output.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cd180c2d361685ff25012d40ce44e072faa84342cbb21764daf4214ab50feb63
+size 2853269
diff --git a/docs/intelligentapps/images/promptbuilder/view_code.gif b/docs/intelligentapps/images/promptbuilder/view_code.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cc45adff46dedb696b0859ae675c7fabfa3dae14728e2887d749d8e51c39ed57
+size 1732423
diff --git a/docs/intelligentapps/promptbuilder.md b/docs/intelligentapps/promptbuilder.md
@@ -0,0 +1,66 @@
+---
+Order: 4
+Area: intelligentapps
+TOCTitle: Prompt Builder
+ContentId: bd3d7555-3d84-4500-ae95-6dcd39641af0
+PageTitle: Prompt Builder
+DateApproved: 04/09/2025
+MetaDescription: Get Started with creating, iterating and optimizing your prompts in AI Toolkit.
+---
+# Prompt engineering in AI Toolkit
+
+Prompt builder in AI Toolkit streamlines the prompt engineering workflow by generating starter prompts, helping you iterate and refine with each run, breaking down complex tasks through prompt chaining and structured outputs, and providing easy access to code for seamless LLM integration via APIs.
+
+![Getting started with prompt builder](./images/promptbuilder/promptbuilder.gif)
+
+## Create, edit and test prompts
+
+To access the prompt builder, use one of these options:
+- In the AI Toolkit view, select **Prompt Builder**
+- Select **Try in Prompt Builder** from a model card in the model catalog
+
+To test a prompt in the prompt builder, follow these steps:
+1. In **Models**, select a model from the dropdown list, or select **Browse models** to add another model from the model catalog.
+    ![select a model](./images/promptbuilder/s1_models.png)
+2. Enter a **User prompt** and optionally enter a **System prompt**
+   The user prompt is the input that you want to send to the model. The optional system prompt is used to provide instructions with relevant context to guide the model response.
+
+   > [!TIP]
+   > If you don't know how to input these prompts, you can describe your project idea in natural language and let the AI-powered feature generate prompts for you to experiment with.
+   > ![generate prompts with natural language](./images/promptbuilder/generate_prompt.gif)
+3. Select **Run** to send the prompts to the selected model
+4. Optionally, select **Add Prompts** to add more user and assistant prompts to the conversation, or select **Use Response as Assistant Prompt** as the history and context you send to the model to further guide the model's behavior
+5. Repeat the previous steps to iterate over your prompts by observing the model response and making changes to the prompts
+
+## Structured output
+
+Structured output support helps you design prompts to deliver outputs in a structured, predictable format.
+![Use structured output](./images/promptbuilder/structured_output.gif)
+
+To test a prompt in the prompt builder, follow these steps:
+
+1. Select the **Format** dropdown in the **Response** area, and select **json_schema**
+2. Select **Prepare schema**
+3. From the Command Palette, either select **Select local file** to use your own schema, or select **Use an example** to use a predefined schema
+   If you proceed with an example, you can select a schema from the dropdown list
+5. Select **Run** to send the prompts to the selected model
+6. You can also edit the schema by selecting **Edit**
+   ![edit schema](./images/promptbuilder/edit_schema.png)
+
+## Integrate prompt engineering into your application
+
+After experimenting with models and prompts, you can get into coding right away with the automatically generated Python code.
+![view code](./images/promptbuilder/view_code.gif)
+To view the Python code, follow these steps:
+1. Select **View Code**
+1. Select the inference SDK you want to use if it's hosted by GitHub
+
+   AI Toolkit generates the code for the model you selected by using the provider's client SDK. For models hosted by GitHub, you have the option to select the inference SDK you want to use: [Azure AI Inference SDK](https://learn.microsoft.com/python/api/overview/azure/ai-inference-readme?view=azure-python-preview) or the SDK from the model provider, such as [OpenAI SDK](https://platform.openai.com/docs/libraries) or [Mistral API](https://docs.mistral.ai/api).
+1. The generated code snippet is shown in a new editor, where you can copy it into your application.
+1. You can view the generated code snippet in a new file window and copy them into your application.
+   > To authenticate with the model you usually need an API key from the provider. To access models hosted by GitHub, [generate a personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) (PAT) in your GitHub settings
+
+## Next steps
+
+- [Run an evaluation job](/docs/intelligentapps/evaluation.md) for the popular evaluators
+- [Run evaluation](/docs/intelligentapps/evaluation.md) job for the popular evaluators
