AWS nova documentation change
Summary
Reformatted documentation examples, updated section headings, improved grounding prompt instructions, restructured output format examples, and enhanced code block presentations for clarity.
Security assessment
Changes focus on improving documentation clarity and formatting without addressing security vulnerabilities. The grounding prompt update emphasizes preventing hallucinations but doesn't reference any specific security flaw or incident. No security features were added or modified.
Diff
diff --git a/nova/latest/nova2-userguide/advanced-prompting-techniques.md b/nova/latest/nova2-userguide/advanced-prompting-techniques.md index 7b67d9bc6..9bcb725d9 100644 --- a//nova/latest/nova2-userguide/advanced-prompting-techniques.md +++ b//nova/latest/nova2-userguide/advanced-prompting-techniques.md @@ -121,3 +121 @@ We recommend that you provide the model with trusted information relevant to the -The following shows an example: - -###### Example Grounding prompt template +Prompt template @@ -135 +133,9 @@ The following shows an example: -This table shows how grounding context can prevent the model from hallucinating. +This example shows how grounding context can prevent the model from hallucinating. + +System: + + + In this session, the model has access to search results and a user's question, your job is to answer the user's question using only information from the search results. Model Instructions:- DO NOT USE INFORMATION THAT IS NOT IN SEARCH RESULTS! + +User: + @@ -137,4 +143,3 @@ This table shows how grounding context can prevent the model from hallucinating. -Role | Prompt ----|--- -System | In this session, the model has access to search results and a user's question, your job is to answer the user's question using only information from the search results. Model Instructions:- DO NOT USE INFORMATION THAT IS NOT IN SEARCH RESULTS! -User | What were the economic impacts of the COVID-19 pandemic on the United States in 2020? Resource: Search Results: In 2020, the United States experienced significant economic impacts due to the COVID-19 pandemic. The U.S. economy contracted by 3.5% in 2020, according to the Bureau of Economic Analysis. Unemployment rates surged to 14.7% in April 2020, the highest since the Great Depression, before gradually declining. Small businesses faced severe challenges, with millions of firms closing permanently. Additionally, consumer spending dropped sharply as people reduced non-essential expenditures and saved more. Government intervention played a critical role in mitigating these impacts through stimulus packages and support programs, such as the Paycheck Protection Program (PPP) for small businesses and direct payments to individuals. Despite these measures, the economic recovery remained uneven across different sectors and regions. + What were the economic impacts of the COVID-19 pandemic on the United States in 2020? + + Resource: Search Results: In 2020, the United States experienced significant economic impacts due to the COVID-19 pandemic. The U.S. economy contracted by 3.5% in 2020, according to the Bureau of Economic Analysis. Unemployment rates surged to 14.7% in April 2020, the highest since the Great Depression, before gradually declining. Small businesses faced severe challenges, with millions of firms closing permanently. Additionally, consumer spending dropped sharply as people reduced non-essential expenditures and saved more. Government intervention played a critical role in mitigating these impacts through stimulus packages and support programs, such as the Paycheck Protection Program (PPP) for small businesses and direct payments to individuals. Despite these measures, the economic recovery remained uneven across different sectors and regions. @@ -204 +209 @@ After you extract key information based on the user's task, you can use the extr -### Use Nova web grounding +### Use Nova Web Grounding @@ -219 +224 @@ To ensure consistent and structured output formats, you can use structured outpu -For example, if the downstream parser expects specific naming conventions for keys in a JSON object, you should specify the response schema at the end of the prompt. Additionally, if you prefer responses to be in JSON format without any preamble text, instruct the model accordingly. That is, explicitly state `PLEASE GENERATE ONLY THE JSON OUTPUT. DO NOT PROVIDE ANY PREAMBLE.` to ensure clean output. +For example, if the downstream parser expects specific naming conventions for keys in a JSON object, you should specify the response schema at the end of the prompt. Additionally, if you prefer responses to be in JSON format without any preamble text, instruct the model accordingly. That is, explicitly state **Please generate only the JSON output. DO NOT provide any preamble.** to ensure clean output. @@ -234 +239,2 @@ The following are examples of common formatting schemas. -**JSON:** +JSON + @@ -242 +249 @@ The following are examples of common formatting schemas. - "key3": [{ + key3: [{ @@ -245,4 +252 @@ The following are examples of common formatting schemas. - ... - }] - } - ``` + ...}``` @@ -251 +255,2 @@ The following are examples of common formatting schemas. -**XML:** +XML + @@ -254 +259 @@ The following are examples of common formatting schemas. - ML_format = """Write your response following the XML format below: + XML_format = """Write your response following the XML format below: @@ -273 +278,2 @@ The following are examples of common formatting schemas. -**Markdown:** +Markdown + @@ -284 +292 @@ The following are examples of common formatting schemas. - ( Bulleted list of instructions with each with bold title.) + ( Bulleted list of instructions with each with bold title. @@ -349,4 +359,92 @@ Adding the Output Schema section with the appropriate schema makes the model pre -Role | Unspecific Prompt | Specific Prompt ----|---|--- -User | Provide details about the best selling full-frame cameras in past three years. Answer in JSON format with keys like name, brand, price and a summary. | Provide details about the best selling full-frame cameras in past three years. You MUST answer in JSON format only. Write your response following the the format below: [{ "name": "name goes here", "brand": "brand goes here", "price": "price goes here", "summary": "summary goes here" }] -Assistant | ```json [ { "name": "Sony Alpha A7R IV", "brand": "Sony", "price": "Approximately $3,500", "summary": "The Sony Alpha A7R IV is renowned for its exceptional image quality, thanks to a 61-megapixel full-frame sensor. It also features 4K video recording and a robust build, making it a favorite among professional photographers and videographers." }, { "name": "Canon EOS R5", "brand": "Canon", "price": "Approximately $3,900", "summary": "The Canon EOS R5 combines high-resolution imaging with advanced video capabilities. It houses a 45-megapixel sensor, 8K video recording, and impressive autofocus performance, appealing to both photography and filmmaking professionals." }, { "name": "Nikon Z7 II", "brand": "Nikon", "price": "Approximately $2,800", "summary": "The Nikon Z7 II offers a 45.7-megapixel full-frame sensor and is praised for its high resolution and excellent dynamic range. It also supports 4K video recording and features a versatile Z-mount lens system, making it a strong contender in the full-frame market." }, { "name": "Fujifilm GFX 100S", "brand": "Fujifilm", "price": "Approximately $7,000", "summary": "While not a traditional full-frame camera, the Fujifilm GFX 100S stands out with its 102-megapixel medium format sensor. It is lauded for its stunning detail and color reproduction, though it comes at a higher price point and is aimed at specialized users." } ] ``` | [ { "name": "Nikon D850", "brand": "Nikon", "price": "$3,296.95", "summary": "The Nikon D850 is a professional full-frame DSLR camera known for its exceptional image quality, 45.7-megapixel resolution, 7 fps continuous shooting, and 4K video capabilities." }, { "name": "Canon EOS 5D Mark IV", "brand": "Canon", "price": "$3,499.00", "summary": "The Canon EOS 5D Mark IV is a popular full-frame DSLR appreciated for its 30.4-megapixel sensor, 4K video recording, robust build quality, and reliable autofocus system." }, { "name": "Sony A7R III", "brand": "Sony", "price": "$3,198.00", "summary": "The Sony A7R III is a high-resolution full-frame mirrorless camera renowned for its 42.4-megapixel sensor, excellent low-light performance, and versatile lens compatibility." }, { "name": "Fujifilm GFX 100S", "brand": "Fujifilm", "price": "$5,999.99", "summary": "The Fujifilm GFX 100S is a medium format mirrorless camera that stands out for its 102-megapixel sensor, high dynamic range, and exceptional color reproduction." }, { "name": "Sony A7 III", "brand": "Sony", "price": "$1,998.00", "summary": "The Sony A7 III is a full-frame mirrorless camera popular among enthusiasts and professionals for its 24.2-megapixel sensor, fast autofocus, and 4K video capabilities." } ] +Unspecific Prompt + + +User: + + + Provide details about the best selling full-frame cameras in past three years. + Answer in JSON format with keys like name, brand, price and a summary. + +Assistant: + + + ```json + [ + { + "name": "Sony Alpha A7R IV", + "brand": "Sony", + "price": "Approximately $3,500", + "summary": "The Sony Alpha A7R IV is renowned for its exceptional image quality, thanks to a 61-megapixel full-frame sensor. It also features 4K video recording and a robust build, making it a favorite among professional photographers and videographers." + }, + { + "name": "Canon EOS R5", + "brand": "Canon", + "price": "Approximately $3,900", + "summary": "The Canon EOS R5 combines high-resolution imaging with advanced video capabilities. It houses a 45-megapixel sensor, 8K video recording, and impressive autofocus performance, appealing to both photography and filmmaking professionals." + }, + { + "name": "Nikon Z7 II", + "brand": "Nikon", + "price": "Approximately $2,800", + "summary": "The Nikon Z7 II offers a 45.7-megapixel full-frame sensor and is praised for its high resolution and excellent dynamic range. It also supports 4K video recording and features a versatile Z-mount lens system, making it a strong contender in the full-frame market." + }, + { + "name": "Fujifilm GFX 100S", + "brand": "Fujifilm", + "price": "Approximately $7,000", + "summary": "While not a traditional full-frame camera, the Fujifilm GFX 100S stands out with its 102-megapixel medium format sensor. It is lauded for its stunning detail and color reproduction, though it comes at a higher price point and is aimed at specialized users." + } + ] + ``` + +Specific Prompt + + +User: + + + Provide details about the best selling full-frame cameras in past three years. + You MUST answer in JSON format only. Write your response following the the format below: + [{ + “name”: “name goes here”, + “brand”: “brand goes here”, + “price”: “price goes here“, + "summary": "summary goes here" + }] + + +Assistant: + + + [ + { + "name": "Nikon D850", + "brand": "Nikon", + "price": "$3,296.95", + "summary": "The Nikon D850 is a professional full-frame DSLR camera known for its exceptional image quality, 45.7-megapixel resolution, 7 fps continuous shooting, and 4K video capabilities." + }, + { + "name": "Canon EOS 5D Mark IV", + "brand": "Canon", + "price": "$3,499.00", + "summary": "The Canon EOS 5D Mark IV is a popular full-frame DSLR appreciated for its 30.4-megapixel sensor, 4K video recording, robust build quality, and reliable autofocus system." + }, + { + "name": "Sony A7R III", + "brand": "Sony", + "price": "$3,198.00", + "summary": "The Sony A7R III is a high-resolution full-frame mirrorless camera renowned for its 42.4-megapixel sensor, excellent low-light performance, and versatile lens compatibility." + }, + { + "name": "Fujifilm GFX 100S", + "brand": "Fujifilm", + "price": "$5,999.99", + "summary": "The Fujifilm GFX 100S is a medium format mirrorless camera that stands out for its 102-megapixel sensor, high dynamic range, and exceptional color reproduction." + }, + { + "name": "Sony A7 III", + "brand": "Sony", + "price": "$1,998.00", + "summary": "The Sony A7 III is a full-frame mirrorless camera popular among enthusiasts and professionals for its 24.2-megapixel sensor, fast autofocus, and 4K video capabilities." + } + ] @@ -358,5 +456,54 @@ Another approach is to prefill the model's response by including the desired ini -Role | Prompt ----|--- -User | Provide details about the best selling full-frame cameras in past three years. Your response should be in JSON format, with the following keys: name, brand, year, price, summary. -Assistant (Prefilling) | ```json -Assistant | { "cameras": [ { "name": "Sony Alpha A7 III", "brand": "Sony", "year": 2018, "price": "$1999", "summary": "The Sony Alpha A7 III is a highly acclaimed full-frame mirrorless camera known for its excellent image quality, advanced autofocus system, and 4K video capabilities." }, { "name": "Canon EOS R5", "brand": "Canon", "year": 2020, "price": "$3899", "summary": "The Canon EOS R5 is a top-tier full-frame mirrorless camera that offers stunning 45MP images, 8K video recording, and exceptional performance in various lighting conditions." }, { "name": "Nikon Z7 II", "brand": "Nikon", "year": 2020, "price": "$2999", "summary": "The Nikon Z7 II is a flagship full-frame mirrorless camera with a 45.7MP sensor, superb image quality, and advanced video recording features." }, { "name": "Fujifilm GFX 100S", "brand": "Fujifilm", "year": 2020, "price": "$7999", "summary": "The Fujifilm GFX 100S is a medium format mirrorless camera known for its impressive 102MP sensor, beautiful film simulations, and versatile lens options." }, { "name": "Sony Alpha A7R IV", "brand": "Sony", "year": 2019, "price": "$3499", "summary": "The Sony Alpha A7R IV features a 61MP sensor, excellent low-light performance, and advanced video capabilities, making it a favorite among professional photographers." } ] } ``` +User: + + + Provide details about the best selling full-frame cameras in past three years. + Your response should be in JSON format, with the following keys: name, brand, year, price, summary. + +Assistant (Prefilling): + + + ```json + +Assistant: + + + { + "cameras": [ + { + "name": "Sony Alpha A7 III", + "brand": "Sony", + "year": 2018, + "price": "$1999", + "summary": "The Sony Alpha A7 III is a highly acclaimed full-frame mirrorless camera known for its excellent image quality, advanced autofocus system, and 4K video capabilities." + }, + { + "name": "Canon EOS R5", + "brand": "Canon", + "year": 2020, + "price": "$3899", + "summary": "The Canon EOS R5 is a top-tier full-frame mirrorless camera that offers stunning 45MP images, 8K video recording, and exceptional performance in various lighting conditions." + }, + { + "name": "Nikon Z7 II", + "brand": "Nikon", + "year": 2020, + "price": "$2999", + "summary": "The Nikon Z7 II is a flagship full-frame mirrorless camera with a 45.7MP sensor, superb image quality, and advanced video recording features."