Skip to content

Create Query Suggestions Block List

kendra_create_query_suggestions_block_list R Documentation

Creates a block list to exlcude certain queries from suggestions

Description

Creates a block list to exlcude certain queries from suggestions.

Any query that contains words or phrases specified in the block list is blocked or filtered out from being shown as a suggestion.

You need to provide the file location of your block list text file in your S3 bucket. In your text file, enter each block word or phrase on a separate line.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

create_query_suggestions_block_list is currently not supported in the Amazon Web Services GovCloud (US-West) region.

For an example of creating a block list for query suggestions using the Python SDK, see Query suggestions block list.

Usage

kendra_create_query_suggestions_block_list(IndexId, Name, Description,
  SourceS3Path, ClientToken, RoleArn, Tags)

Arguments

IndexId

[required] The identifier of the index you want to create a query suggestions block list for.

Name

[required] A name for the block list.

For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Description

A description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

SourceS3Path

[required] The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

ClientToken

A token that you provide to identify the request to create a query suggestions block list.

RoleArn

[required] The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the block list text file. For more information, see IAM access roles for Amazon Kendra.

Tags

A list of key-value pairs that identify or categorize the block list. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Value

A list with the following syntax: 

list(
  Id = "string"
)

Request syntax

svc$create_query_suggestions_block_list(
  IndexId = "string",
  Name = "string",
  Description = "string",
  SourceS3Path = list(
    Bucket = "string",
    Key = "string"
  ),
  ClientToken = "string",
  RoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)