Skip to content

Latest commit

 

History

History
50 lines (47 loc) · 3.21 KB

README.md

File metadata and controls

50 lines (47 loc) · 3.21 KB
Raw

Custom plugins integration

In addition to built-in plugins, Amazon Q can be integrated with various third-party applications. Users can leverage natural language to query information and perform actions seamlessly.

Setting up a System & Plugin

  1. Download the CloudFormation template onto your local machine.
  2. Open the AWS Management Console and navigate to AWS CloudFormation.
  3. Select Create stack with New resources (standard), then Choose an existing template, Upload a template file, click on Choose file and then upload the Cloudformation template you downloaded, and click Next.
    custom-1
  4. Input a stack name custom-plugin-restaurant-stack, Then select Next.
    custom-2
  5. Scroll down to the bottom, and check "I acknowledge that AWS CloudFormation might create IAM resources.". Then select Next.
  6. Scroll down to the bottom of the page and click Submit. Wait around 5 minutes until the CloudFormation stack status to be CREATE_COMPLETE.
    custom-3
  7. Go to Outputs tab and Copy the value of the ApiEndpoint key and save it, as you’ll need it for the custom plugin configuration.
    custom-4

Custom plugin setup

  1. Navigate to Amazon Q Business.
  2. Click on the Plugins section under Enhancements, click Add Plugin.
    custom-5
    Then select Custom plugin.
    custom-6
  3. Provide Plugin name restaurant-booking-plugin and Description API for booking a table in the restaurant.
    custom-7
  4. Download the API schema to your local machine.
  5. Under API schema, select Define with in-line OpenAPI schema editor.
    Select YAML as the format.
    Copy the API schema content that you previously downloaded and edit the URL value on line 7 with the API Gateway endpoint saved in the previous section (step 7).
    custom-8
  6. In Authentication section, select No authentication required, and click Add plugin.
    custom-9
  7. Wait a few minutes. The plugin will be ready to use.
    custom-10

Conversing with a System

  1. Open the Q application, you can see Plugins, click it, and select restaurant-booking-plugin.
    custom-11
  2. Let's book a restaurant table. Using the chat It's Pup. I want to reserve a table for 5 people, at 8:00pm on the 5th of December 2024.
    custom-12
    The system replies with the booking ID, which can be used for other querys/actions.
    Next, check the booking detail.
    check the detail of booking id {booking_id}, please.
    custom-13
    Let's cancel the booking.
    I change my mind. Can you cancel f2e62626?
    custom-14
    You can also refer to specific times in relation to the present, such as tomorrow or next week.
    I want to book for 10 people at 13:00 tomorrow under Doit.
    custom-15