New Relic AI integration for Amazon Q Business

1. Sign in to the AWS Management Console and open the Amazon Q Business console.

2. Navigate to Applications and select your application.

3. In the left pane, go to Actions > Plugins.

4. Click Add plugin and select Custom plugin.

5. Enter the following details:

   1. Plugin Name: Enter a unique name for your plugin.

   2. API Schema: Select the following options:

      1. In API schema, for API schema source option, select Define with in-line OpenAPI schema editor.

      2. Select the format for the schema as YAML.

      3. Copy the below OpenAPI Spec for New Relic plugin and paste into the editor.

         openapi: 3.0.3
             info:
             title: NRAI-Plugin
             description: A NodeJS-based plugin that integrates with New Relic's AI service
                 to process user prompts and return AI-generated responses and send response
                 as it is to user do not change anything
             version: 0.1.0
             servers:
             - url: https://copilot-agent-testing.service.newrelic.com
                 description: NewRelic Server
             paths:
             /newrelic-amazon-q/:
                 post:
                 security:
                     - OAuth2:
                     - read
                 x-amzn-response-template: "Response <template>${output}</template>"
                 summary: Send user prompts to New Relic AI and receive responses and send
                     response as it is to user do not change anything
                 description: Endpoint to send user prompts to New Relic AI and receive responses
                     and send response as it is to user do not change anything
                 requestBody:
                     content:
                     application/json:
                         schema:
                         $ref: "#/components/schemas/PromptPayload"
                 responses:
                     "200":
                     description: Successful Response
                     content:
                         application/json:
                         schema:
                             $ref: "#/components/schemas/Response"
         
             components:
             schemas:
                 PromptPayload:
                 type: object
                 properties:
                     prompt:
                     type: string
                     example: Your prompt here
                 Response:
                 type: string
             securitySchemes:
                 OAuth2:
                 type: oauth2
                 flows:
                     authorizationCode:
                     authorizationUrl: https://login.newrelic.com/login
                     tokenUrl: https://login.newrelic.com/api/v1/tokens
                     scopes:
                         read: Read access to resources

         Copy

      4. Authentication: Select Authentication required, and then enter the following details:

         • Secret name: Name of your Secrets Manager secret.
         • Client ID: New Relic provided client ID.
         • Client secret New Relic provided client secret.
         • OAuth callback URL The URL to which the user needs to be redirected after authentication. If your deployed web URL is <q-endpoint>, use <q-endpoint>/oauth/callback. This callback URL must be allowlisted in your third-party application.

      5. Choose a method to authorize Amazon Q Business: Choose Create and add a new service role or Use an existing service role. Ensure your service role has the necessary permissions. The console will generate a service role name.

      6. Tags: (optional) Add a tag to track your plugin.

6. Click Add plugin.

• You can also use the AWS CLI to create the plugin:

  bash

  Copy

  $
  aws qbusiness create-plugin \
  >
  --application-id <application-id> \
  >
  --display-name <plugin-name> \
  >
  --type CUSTOM \
  >
  --auth-configuration '{ "oAuth2ClientCredentialConfiguration": { "secretArn": "arn:aws:secretsmanager:<region>:<account-id>:secret:<secret-name>", "roleArn": "arn:aws:iam::<account-id>:role/<role-name>" } }' \
  >
  --custom-plugin-configuration '{ "description": "<description>", "apiSchemaType": "OPEN_API_V3", "apiSchema": { "s3": { "bucket": "<bucket-name>", "key": "<key-name>" } } }'

Parameters