AWS nova documentation change
Summary
Restructured and expanded examples of prompting techniques, converting table-based examples to conversational format with explicit User/Assistant roles and improved formatting
Security assessment
Changes involve restructuring documentation examples without any security-related content, vulnerabilities, or security feature descriptions. The modifications focus on improving prompt clarity and presentation for classification and reporting use cases.
Diff
diff --git a/nova/latest/nova2-userguide/prompting-provide-examples.md b/nova/latest/nova2-userguide/prompting-provide-examples.md index f6b228028..14e2ff30a 100644 --- a//nova/latest/nova2-userguide/prompting-provide-examples.md +++ b//nova/latest/nova2-userguide/prompting-provide-examples.md @@ -39,3 +39 @@ Here, your user is trying to classify incoming customer support tickets into pre -Role | 0-shot Prompt | 3-shot Prompt ----|---|--- -User | Please classify the following customer support tickets into one of the categories: "Technical Issue," "Billing Inquiry," or "General Inquiry." **Ticket:** "Can you explain why my latest bill is higher than usual? I haven't changed my plan." | Please classify the following customer support tickets into one of the categories: "Technical Issue," "Billing Inquiry," or "General Inquiry." Use these examples to guide your classification: +0-shot prompt @@ -43,3 +40,0 @@ User | Please classify the following customer support tickets into one of the ca - * **Ticket:** "I can't log in to my account. The system keeps giving me an error message." **Category:** Technical Issue - * **Ticket:** "I received an email saying my account will be suspended unless I make a payment. Is this a scam?" **Category:** Billing Inquiry - * **Ticket:** "What are the hours of operation for your customer support team?" **Category:** General Inquiry @@ -47,2 +42 @@ User | Please classify the following customer support tickets into one of the ca -Now, classify the following ticket: **Ticket:** "Can you explain why my latest bill is higher than usual? I haven't changed my plan." -Assistant | The customer support ticket should be classified as a "Billing Inquiry." Here's the reasoning: +User: @@ -50,2 +43,0 @@ Assistant | The customer support ticket should be classified as a "Billing Inqui - * The customer is asking about the reason for a change in their latest bill amount. - * The context revolves around billing and payment, which falls under the category of "Billing Inquiry." @@ -53 +45,40 @@ Assistant | The customer support ticket should be classified as a "Billing Inqui -| Category: Billing Inquiry Explanation: The ticket is asking for an explanation regarding a change in the billing amount, which falls under the billing category as it pertains to questions about charges or payments. + Please classify the following customer support tickets into one of the categories: "Technical Issue," "Billing Inquiry," or "General Inquiry." + + **Ticket:** "Can you explain why my latest bill is higher than usual? I haven't changed my plan." + +Assistant: + + + The customer support ticket should be classified as a "Billing Inquiry." + + Here’s the reasoning: + - The customer is asking about the reason for a change in their latest bill amount. + - The context revolves around billing and payment, which falls under the category of "Billing Inquiry." + +3-shot prompt + + +User: + + + Please classify the following customer support tickets into one of the categories: "Technical Issue," "Billing Inquiry," or "General Inquiry." + Use these examples to guide your classification: + + **Ticket:** "I can't log in to my account. The system keeps giving me an error message." + **Category:** Technical Issue + + **Ticket:** "I received an email saying my account will be suspended unless I make a payment. Is this a scam?" + **Category:** Billing Inquiry + + **Ticket:** "What are the hours of operation for your customer support team?" + **Category:** General Inquiry + + Now, classify the following ticket: + **Ticket:** "Can you explain why my latest bill is higher than usual? I haven't changed my plan." + +Assistant: + + + Category: Billing Inquiry + + Explanation: The ticket is asking for an explanation regarding a change in the billing amount, which falls under the billing category as it pertains to questions about charges or payments. @@ -57,3 +88 @@ In this example, the exemplars are provided as turns, one turn per exemplar, whe -Role | 0 Prompt | 3- shot Prompt (as turns) ----|---|--- -System | Your task is to Classify the following texts into the appropriate categories. The categories to classify are: +0-shot Prompt @@ -61 +89,0 @@ System | Your task is to Classify the following texts into the appropriate categ -###### Categories @@ -63,5 +91 @@ System | Your task is to Classify the following texts into the appropriate categ - * Food - * Entertainment - * Health - * Wealth - * Other +System: @@ -69 +92,0 @@ System | Your task is to Classify the following texts into the appropriate categ -| Your task is to Classify the following texts into the appropriate categories. The categories to classify are: @@ -71 +94 @@ System | Your task is to Classify the following texts into the appropriate categ -###### Categories + Your task is to Classify the following texts into the appropriate categories. The categories to classify are: @@ -73,5 +96,6 @@ System | Your task is to Classify the following texts into the appropriate categ - * Food - * Entertainment - * Health - * Wealth - * Other + Categories: + - Food + - Entertainment + - Health + - Wealth + - Other @@ -78,0 +103 @@ System | Your task is to Classify the following texts into the appropriate categ +User: @@ -80,8 +104,0 @@ System | Your task is to Classify the following texts into the appropriate categ -User | | I love to eat pizza. -Assistant | | Food -User | | I enjoy watching movies. -Assistant | | Entertainment -User | | I am going to the gym after this. -Assistant | | Health -User | I have $20 in my pocket. | I have $20 in my pocket. -Assistant | Category: Wealth Explanation: The text mentions a specific amount of money, which falls under the category of wealth. The presence of a monetary value directly relates to financial status or economic aspect. | Wealth @@ -89 +106,9 @@ Assistant | Category: Wealth Explanation: The text mentions a specific amount of -In this example, you can specify an "Example" section and then list a series of examples within the system prompt. This way of providing exemplars in the prompt is especially useful if your exemplars are long and complex and helps model locate example shots. + I have 20$ in my pocket. + +Assistant: + + + Category: Wealth + + Explanation: The text mentions a specific amount of money, which falls under the category of wealth. The presence of a monetary value directly relates to financial status or economic aspect. + @@ -91,3 +116 @@ In this example, you can specify an "Example" section and then list a series of -Role | 0-shot Prompt | 2-shot Prompt ----|---|--- -System | You are an AI assistant helping to draft professional reports for enterprise stakeholders. Ensure the report is formatted in rich text, with headings, bullet points, and highlighted important tasks. | You are an AI assistant helping to draft professional reports for enterprise stakeholders. Below are a few examples of well-formatted project update reports to guide your response. `<Example 1>` **Project Update Report** _Date:_ January 15, 2023 +3-shot Prompt (as turns) @@ -95 +117,0 @@ System | You are an AI assistant helping to draft professional reports for enter -###### Project Milestones Achieved: @@ -97,3 +119 @@ System | You are an AI assistant helping to draft professional reports for enter - * Successfully launched the new CRM system. - * Integrated the marketing automation tool. - * Completed the employee training sessions. +System: @@ -101,0 +122 @@ System | You are an AI assistant helping to draft professional reports for enter + Your task is to Classify the following texts into the appropriate categories. The categories to classify are: @@ -103 +124,6 @@ System | You are an AI assistant helping to draft professional reports for enter -###### Tasks Completed: + Categories: + - Food + - Entertainment + - Health + - Wealth + - Other @@ -105,3 +131 @@ System | You are an AI assistant helping to draft professional reports for enter - * Developed the user manual. - * Conducted system testing. - * Prepared the training materials. +User: @@ -109,0 +134 @@ System | You are an AI assistant helping to draft professional reports for enter + I love to eat pizza. @@ -111 +136 @@ System | You are an AI assistant helping to draft professional reports for enter -###### Future Plans: +Assistant: @@ -113,3 +137,0 @@ System | You are an AI assistant helping to draft professional reports for enter - * Roll out the CRM system to all departments. - * Schedule follow-up training sessions. - * Monitor system performance and make necessary adjustments. @@ -117 +139 @@ System | You are an AI assistant helping to draft professional reports for enter -**Prepared by:** [Your Name] [Your Position] [Your Contact Information] `<Example 2>` **Project Update Report** _Date:_ February 20, 2023 + Food @@ -119 +141 @@ System | You are an AI assistant helping to draft professional reports for enter -###### Project Milestones Achieved: +User: @@ -121,3 +142,0 @@ System | You are an AI assistant helping to draft professional reports for enter - * Launched the new website. - * Completed the SEO optimization. - * Organized the stakeholder meeting. @@ -124,0 +144 @@ System | You are an AI assistant helping to draft professional reports for enter + I enjoy watching movies. @@ -125,0 +146 @@ System | You are an AI assistant helping to draft professional reports for enter +Assistant: @@ -127 +147,0 @@ System | You are an AI assistant helping to draft professional reports for enter -###### Tasks Completed: @@ -129,3 +149 @@ System | You are an AI assistant helping to draft professional reports for enter - * Designed the website layout. - * Wrote the content for the website. - * Tested the website functionality. + Entertainment @@ -132,0 +151 @@ System | You are an AI assistant helping to draft professional reports for enter +User: @@ -135 +154 @@ System | You are an AI assistant helping to draft professional reports for enter -###### Future Plans: + I am going to the gym after this. @@ -137,3 +156 @@ System | You are an AI assistant helping to draft professional reports for enter - * Implement the analytics tracking. - * Launch the social media campaign. - * Gather feedback from stakeholders. +Assistant: @@ -141,3 +158,29 @@ System | You are an AI assistant helping to draft professional reports for enter -**Prepared by:** [Your Name] [Your Position] [Your Contact Information] -User | Draft a detailed project update report for our stakeholders, summarizing the project milestones achieved, tasks completed, and future plans. | Draft a detailed project update report for our stakeholders, summarizing the project milestones achieved, tasks completed, and future plans. -Assistant | + + Health + +User: + + + I have 20$ in my pocket. + +Assistant: + + + Wealth + +In this example, you can specify an "Example" section and then list a series of examples within the system prompt. This way of providing exemplars in the prompt is especially useful if your exemplars are long and complex and helps model locate example shots.