Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SearchRelevantContent

Searches for relevant content in a Amazon Q Business application based on a query. This operation takes a search query text, the Amazon Q Business application identifier, and optional filters (such as content source and maximum results) as input. It returns a list of relevant content items, where each item includes the content text, the unique document identifier, the document title, the document URI, any relevant document attributes, and score attributes indicating the confidence level of the relevance.

Request Syntax


POST /applications/applicationId/relevant-content HTTP/1.1
Content-type: application/json

{
   "attributeFilter": { 
      "andAllFilters": [ 
         "AttributeFilter"
      ],
      "containsAll": { 
         "name": "string",
         "value": { ... }
      },
      "containsAny": { 
         "name": "string",
         "value": { ... }
      },
      "equalsTo": { 
         "name": "string",
         "value": { ... }
      },
      "greaterThan": { 
         "name": "string",
         "value": { ... }
      },
      "greaterThanOrEquals": { 
         "name": "string",
         "value": { ... }
      },
      "lessThan": { 
         "name": "string",
         "value": { ... }
      },
      "lessThanOrEquals": { 
         "name": "string",
         "value": { ... }
      },
      "notFilter": "AttributeFilter",
      "orAllFilters": [ 
         "AttributeFilter"
      ]
   },
   "contentSource": { ... },
   "maxResults": number,
   "nextToken": "string",
   "queryText": "string"
}

URI Request Parameters

The request uses the following URI parameters.

applicationId

The unique identifier of the Amazon Q Business application to search.

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]{35}

Required: Yes

Request Body

The request accepts the following data in JSON format.

attributeFilter

Enables filtering of responses based on document attributes or metadata fields.

Type: AttributeFilter object

Required: No

contentSource

The source of content to search in.

Type: ContentSource object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

maxResults

The maximum number of results to return.

Type: Integer

Required: No

nextToken

The token for the next set of results. (You received this token from a previous call.)

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

Required: No

queryText

The text to search for.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "relevantContent": [ 
      { 
         "content": "string",
         "documentAttributes": [ 
            { 
               "name": "string",
               "value": { ... }
            }
         ],
         "documentId": "string",
         "documentTitle": "string",
         "documentUri": "string",
         "scoreAttributes": { 
            "scoreConfidence": "string"
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The token to use to retrieve the next set of results, if there are any.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 800.

relevantContent

The list of relevant content items found.

Type: Array of RelevantContent objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

HTTP Status Code: 403

InternalServerException

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.

HTTP Status Code: 500

LicenseNotFoundException

You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.

HTTP Status Code: 400

ResourceNotFoundException

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

HTTP Status Code: 404

ThrottlingException

The request was denied due to throttling. Reduce the number of requests and try again.

HTTP Status Code: 429

ValidationException

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

HTTP Status Code: 400