AWS connect documentation change
Summary
Updated documentation formatting, terminology (e.g., 'GenAI' instead of 'generative AI'), and API reference styling. Consolidated content about using custom data with AI prompts and modified section headers for consistency.
Security assessment
Changes are editorial improvements and terminology updates without addressing security vulnerabilities or introducing security features. The mention of 'AI Guardrails' in a header change lacks context about security implementations.
Diff
diff --git a/connect/latest/adminguide/custom-data-q.md b/connect/latest/adminguide/custom-data-q.md index ec5f996dd..cc162bc52 100644 --- a/connect/latest/adminguide/custom-data-q.md +++ b/connect/latest/adminguide/custom-data-q.md @@ -5 +5 @@ -Add and update data on a sessionUse custom data with an AI prompt +Adding and Updating Data on a SessionUsing Custom Data with an AI Prompt @@ -7 +7 @@ Add and update data on a sessionUse custom data with an AI prompt -# Add custom data to an Amazon Q in Connect session +# Add Custom Data to a Q in Connect Session @@ -9 +9 @@ Add and update data on a sessionUse custom data with an AI prompt -Amazon Q in Connect supports adding custom data to an Amazon Q in Connect session so that it can be used to drive the generative AI driven solutions presented to agents. Custom data can be used by first adding it to a session using the [UpdateSessionData](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_UpdateSession.html) API, and then using the data added to customize AI prompts. +Amazon Q in Connect supports adding custom data to an Amazon Q in Connect session so that it can be used to drive the GenAI driven solutions presented to agents. Custom data can be used by first adding it to a session using the `UpdateSessionData` API, and then using the data added to customize AI Prompts. @@ -11 +11 @@ Amazon Q in Connect supports adding custom data to an Amazon Q in Connect sessio -## Add and update data on a session +## Adding and Updating Data on a Session @@ -13 +13 @@ Amazon Q in Connect supports adding custom data to an Amazon Q in Connect sessio -You add data to a session by using the [UpdateSessionData](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_UpdateSession.html) API. Use the following sample AWS CLI command. +Data can be added to a Session using the `UpdateSessionData` API by using the following command in the AWS CLI: @@ -24 +24 @@ You add data to a session by using the [UpdateSessionData](https://docs.aws.amaz -Since sessions are created for contacts while customer service agents are using Amazon Connect and Amazon Q in Connect, a useful way to add session data is by using Amazon Connect flow block automation to call the [UpdateSessionData](https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_UpdateSession.html) API to add information to the session as necessary. +Since sessions are created for contacts while customer service agents are using Amazon Connect and Amazon Q in Connect, a useful way to add session data is by using Connect Flow Block automation to call the `UpdateSessionData` API to add information to the session as necessary. @@ -26 +26 @@ Since sessions are created for contacts while customer service agents are using -## Use custom data with an AI prompt +## Using Custom Data with an AI Prompt @@ -28,12 +28 @@ Since sessions are created for contacts while customer service agents are using -After data is added to a session, you can customize your AI prompts to use the data for the generative AI results. - -You specify the custom variable for the data by using the following format: - - * `{{$.Custom.<KEY>}}` - - - - -For example, say a customer needs information related to a specific product. You can create a **Query reformulation** AI prompt that uses the productId that the customer provided during the session. - -The following excerpt from an AI prompt shows {{$.Custom.productId}} being provided to the LLM. +Once data is added to a session, it can be used by AI Prompts to customize the GenAI results delivered by Q in Connect by specifying the variable for the data with the format `{{$.Custom.<KEY>}}`. For example, you can create a `QUERY_REFORMULATION` AI Prompt that uses the `productId` that was added to the Session: @@ -74 +63 @@ The following excerpt from an AI prompt shows {{$.Custom.productId}} being provi -If the value for the custom variable is not available in the session, Amazon Q in Connect interpolates it as an empty string. We recommend providing instructions in the AI prompt so the system considers the presence of the value for any fallback behavior. +If the value for the custom variable is not available in the session, Amazon Q in Connect will interpolate it as an empty string, so it is useful to instruct the system to consider the presence of the value for any fallback behavior. @@ -82 +71 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Set the language or Amazon Q in Connect +Use AI Guardrails @@ -84 +73 @@ Set the language or Amazon Q in Connect -Use generative AI-powered self-service +Monitor Amazon Q in Connect