AWS connect documentation change
Summary
Added detailed YAML field documentation for AI prompts including required/optional fields for MESSAGES and TEXT_COMPLETIONS formats. Updated section headers and API references.
Security assessment
Changes focus on clarifying configuration options for AI prompts without mentioning security controls, vulnerabilities, or security features.
Diff
diff --git a/connect/latest/adminguide/customize-q.md index 2a70bd559..6ba88269b 100644 --- a/connect/latest/adminguide/customize-q.md +++ b/connect/latest/adminguide/customize-q.md @@ -5 +5 @@ -AI PromptsCreating the YAML for AI PromptsCreating the AI PromptCreating an AI Prompt VersionAccessing System AI PromptsAI AgentsUsing AI Agents to override Knowledge Base configurationCreating AI Agent VersionsSetting AI Agents for use with Amazon Q in Connect +AI PromptsCreating the YAML for AI PromptsAvailable YAML fields for AI promptsCreating the AI promptCreating an AI Prompt VersionAccessing System AI PromptsAI AgentsUsing AI Agents to override Knowledge Base configurationCreating AI Agent VersionsSetting AI Agents for use with Amazon Q in Connect @@ -161 +161 @@ The second format is the `TEXT_COMPLETIONS` format. It is to be used when creati -## Creating the AI Prompt +## Available YAML fields for AI prompts @@ -163 +163,41 @@ The second format is the `TEXT_COMPLETIONS` format. It is to be used when creati -Once we have created the YAML files for the AI Prompt, we can call the `CreateAIPrompt` API to create it. For the TEXT_COMPLETIONS format, we would invoke the API via [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/qconnect/) like so: +**YAML fields for the`MESSAGES` format:** + + * **anthropic_version** – (Required) The anthropic version. The value must be `bedrock-2023-05-31`. + + * **messages** – (Required) List of input messages. + + * **role** – (Required) The role of the conversation turn. Valid values are user and assistant. + + * **content** – (Required) The content of the conversation turn. + + * **system** – (Optional) The system prompt for the request. A system prompt is a way of providing context and instructions to Anthropic Claude, such as specifying a particular goal or role. For more information, see [System prompts](https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/system-prompts) in the Anthropic documentation. + + * **tools** \- (Optional) List of tools that the model may use. + + * **name** – (Required) The name of the tool. + + * **description** – (Required) The description of the tool. + + * **input_schema** – (Required) A [JSON Schema](https://json-schema.org/) object defining the expected parameters for the tool. + +See an [input_schema example](https://docs.anthropic.com/en/docs/build-with-claude/tool-use#specifying-tools) in the Anthropic Claude documentation. The supported JSON schema objects are as follows: + + * **type** – (Required) + + * **properties** – (Required) + + * **required** – (Required) + + + + +###### YAML fields for the TEXT_COMPLETIONS format: + + * **prompt** \- (Required) The prompt that you want Claude to complete. + + + + +## Creating the AI prompt + +Once we have created the YAML files for the AI prompt, we can call the `CreateAIPrompt` API to create it. For the TEXT_COMPLETIONS format, we would invoke the API via [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/qconnect/) like so: