|
1 | 1 | { |
2 | 2 | "version": "2.0", |
3 | | - "service": "<p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.</p> <p>Amazon Q automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q directly using natural language or keywords to answer customer requests.</p> <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html\">Use Amazon Q in Connect for generative AI powered agent assistance in real-time</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", |
| 3 | + "service": "<note> <p> <b>Powered by Amazon Bedrock</b>: Amazon Web Services implements <a href=\"https://docs.aws.amazon.com/bedrock/latest/userguide/abuse-detection.html\">automated abuse detection</a>. Because Amazon Q in Connect is built on Amazon Bedrock, users can take full advantage of the controls implemented in Amazon Bedrock to enforce safety, security, and the responsible use of artificial intelligence (AI).</p> </note> <p>Amazon Q in Connect is a generative AI customer service assistant. It is an LLM-enhanced evolution of Amazon Connect Wisdom that delivers real-time recommendations to help contact center agents resolve customer issues quickly and accurately.</p> <p>Amazon Q automatically detects customer intent during calls and chats using conversational analytics and natural language understanding (NLU). It then provides agents with immediate, real-time generative responses and suggested actions, and links to relevant documents and articles. Agents can also query Amazon Q directly using natural language or keywords to answer customer requests.</p> <p>Use the Amazon Q in Connect APIs to create an assistant and a knowledge base, for example, or manage content by uploading custom files.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/amazon-q-connect.html\">Use Amazon Q in Connect for generative AI powered agent assistance in real-time</a> in the <i>Amazon Connect Administrator Guide</i>.</p>", |
4 | 4 | "operations": { |
5 | 5 | "CreateAssistant": "<p>Creates an Amazon Q in Connect assistant.</p>", |
6 | 6 | "CreateAssistantAssociation": "<p>Creates an association between an Amazon Q in Connect assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.</p>", |
7 | 7 | "CreateContent": "<p>Creates Amazon Q content. Before to calling this API, use <a href=\"https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html\">StartContentUpload</a> to upload an asset.</p>", |
8 | 8 | "CreateKnowledgeBase": "<p>Creates a knowledge base.</p> <note> <p>When using this API, you cannot reuse <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/Welcome.html\">Amazon AppIntegrations</a> DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an <code>InvalidRequestException</code> error. </p> <p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href=\"https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_DeleteKnowledgeBase.html\">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html\">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href=\"https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html\">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>", |
9 | | - "CreateQuickResponse": "<p>Creates a Amazon Q quick response.</p>", |
| 9 | + "CreateQuickResponse": "<p>Creates an Amazon Q quick response.</p>", |
10 | 10 | "CreateSession": "<p>Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Amazon Q session for each contact on which Amazon Q is enabled.</p>", |
11 | 11 | "DeleteAssistant": "<p>Deletes an assistant.</p>", |
12 | 12 | "DeleteAssistantAssociation": "<p>Deletes an assistant association.</p>", |
|
31 | 31 | "ListQuickResponses": "<p>Lists information about quick response.</p>", |
32 | 32 | "ListTagsForResource": "<p>Lists the tags for the specified resource.</p>", |
33 | 33 | "NotifyRecommendationsReceived": "<p>Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with <a href=\"https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a> and a <code>waitTimeSeconds</code> input for long-polling behavior and avoiding duplicate recommendations.</p>", |
| 34 | + "PutFeedback": "<p>Provides feedback against the specified assistant for the specified target. This API only supports generative targets.</p>", |
34 | 35 | "QueryAssistant": "<p>Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use <a href=\"https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html\">GetRecommendations</a>. </p>", |
35 | 36 | "RemoveKnowledgeBaseTemplateUri": "<p>Removes a URI template from a knowledge base.</p>", |
36 | 37 | "SearchContent": "<p>Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.</p>", |
37 | | - "SearchQuickResponses": "<p>Searches existing Amazon Q quick responses in a Amazon Q knowledge base.</p>", |
| 38 | + "SearchQuickResponses": "<p>Searches existing Amazon Q quick responses in an Amazon Q knowledge base.</p>", |
38 | 39 | "SearchSessions": "<p>Searches for sessions.</p>", |
39 | 40 | "StartContentUpload": "<p>Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use <a href=\"https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_CreateContent.html\">CreateContent</a> to finalize the content creation process or <a href=\"https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_UpdateContent.html\">UpdateContent</a> to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.</p>", |
40 | 41 | "StartImportJob": "<p>Start an asynchronous job to import Amazon Q resources from an uploaded source file. Before calling this API, use <a href=\"https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html\">StartContentUpload</a> to upload an asset that contains the resource data.</p> <ul> <li> <p>For importing Amazon Q quick responses, you need to upload a csv file including the quick responses. For information about how to format the csv file for importing quick responses, see <a href=\"https://docs.aws.amazon.com/console/connect/quick-responses/add-data\">Import quick responses</a>.</p> </li> </ul>", |
|
123 | 124 | } |
124 | 125 | }, |
125 | 126 | "AssistantCapabilityConfiguration": { |
126 | | - "base": "<p>The capability configuration for a Amazon Q assistant. </p>", |
| 127 | + "base": "<p>The capability configuration for an Amazon Q assistant. </p>", |
127 | 128 | "refs": { |
128 | 129 | "AssistantData$capabilityConfiguration": "<p>The configuration information for the Amazon Q assistant capability. </p>", |
129 | 130 | "AssistantSummary$capabilityConfiguration": "<p>The configuration information for the Amazon Q assistant capability. </p>" |
|
281 | 282 | "DataDetails$contentData": "<p>Details about the content data.</p>" |
282 | 283 | } |
283 | 284 | }, |
| 285 | + "ContentFeedbackData": { |
| 286 | + "base": "<p>Information about the feedback.</p>", |
| 287 | + "refs": { |
| 288 | + "PutFeedbackRequest$contentFeedback": "<p>Information about the feedback provided.</p>", |
| 289 | + "PutFeedbackResponse$contentFeedback": "<p>Information about the feedback provided.</p>" |
| 290 | + } |
| 291 | + }, |
284 | 292 | "ContentMetadata": { |
285 | 293 | "base": null, |
286 | 294 | "refs": { |
|
551 | 559 | "Filter$operator": "<p>The operator to use for comparing the field’s value with the provided value.</p>" |
552 | 560 | } |
553 | 561 | }, |
| 562 | + "GenerativeContentFeedbackData": { |
| 563 | + "base": "<p>The feedback information for a generative target type.</p>", |
| 564 | + "refs": { |
| 565 | + "ContentFeedbackData$generativeContentFeedbackData": "<p>Information about the feedback for a generative target type.</p>" |
| 566 | + } |
| 567 | + }, |
554 | 568 | "GenerativeDataDetails": { |
555 | 569 | "base": "<p>Details about generative data.</p>", |
556 | 570 | "refs": { |
|
1008 | 1022 | "QuickResponseQueryField$priority": "<p>The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.</p>" |
1009 | 1023 | } |
1010 | 1024 | }, |
| 1025 | + "PutFeedbackRequest": { |
| 1026 | + "base": null, |
| 1027 | + "refs": { |
| 1028 | + } |
| 1029 | + }, |
| 1030 | + "PutFeedbackResponse": { |
| 1031 | + "base": null, |
| 1032 | + "refs": { |
| 1033 | + } |
| 1034 | + }, |
1011 | 1035 | "QueryAssistantRequest": { |
1012 | 1036 | "base": null, |
1013 | 1037 | "refs": { |
|
1315 | 1339 | "RecommendationData$type": "<p>The type of recommendation.</p>" |
1316 | 1340 | } |
1317 | 1341 | }, |
| 1342 | + "Relevance": { |
| 1343 | + "base": null, |
| 1344 | + "refs": { |
| 1345 | + "GenerativeContentFeedbackData$relevance": "<p>The relevance of the feedback.</p>" |
| 1346 | + } |
| 1347 | + }, |
1318 | 1348 | "RelevanceLevel": { |
1319 | 1349 | "base": null, |
1320 | 1350 | "refs": { |
|
1586 | 1616 | "TagResourceRequest$tags": "<p>The tags used to organize, track, or control access for this resource.</p>" |
1587 | 1617 | } |
1588 | 1618 | }, |
| 1619 | + "TargetType": { |
| 1620 | + "base": null, |
| 1621 | + "refs": { |
| 1622 | + "PutFeedbackRequest$targetType": "<p>The type of the feedback target.</p>", |
| 1623 | + "PutFeedbackResponse$targetType": "<p>The type of the feedback target.</p>" |
| 1624 | + } |
| 1625 | + }, |
1589 | 1626 | "TextData": { |
1590 | 1627 | "base": "<p>Details about the source content text data.</p>", |
1591 | 1628 | "refs": { |
|
1700 | 1737 | "KnowledgeBaseAssociationData$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.</p>", |
1701 | 1738 | "KnowledgeBaseData$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.</p>", |
1702 | 1739 | "KnowledgeBaseSummary$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it.</p>", |
| 1740 | + "PutFeedbackRequest$targetId": "<p>The identifier of the feedback target.</p>", |
| 1741 | + "PutFeedbackResponse$assistantId": "<p>The identifier of the Amazon Q assistant.</p>", |
| 1742 | + "PutFeedbackResponse$targetId": "<p>The identifier of the feedback target.</p>", |
1703 | 1743 | "QuickResponseData$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
1704 | 1744 | "QuickResponseData$quickResponseId": "<p>The identifier of the quick response.</p>", |
1705 | 1745 | "QuickResponseSearchResultData$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
|
1751 | 1791 | "ListQuickResponsesRequest$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
1752 | 1792 | "NotifyRecommendationsReceivedRequest$assistantId": "<p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
1753 | 1793 | "NotifyRecommendationsReceivedRequest$sessionId": "<p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
| 1794 | + "PutFeedbackRequest$assistantId": "<p>The identifier of the Amazon Q assistant.</p>", |
| 1795 | + "PutFeedbackResponse$assistantArn": "<p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>", |
1754 | 1796 | "QueryAssistantRequest$assistantId": "<p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
1755 | 1797 | "QueryAssistantRequest$sessionId": "<p>The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
1756 | 1798 | "RemoveKnowledgeBaseTemplateUriRequest$knowledgeBaseId": "<p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>", |
|
0 commit comments