Se você estiver usando o Amazon Lex V2, consulte o Guia do Amazon Lex V2.

 

Se você estiver usando o Amazon Lex V1, recomendamos atualizar seus bots para o Amazon Lex V2. Não estamos mais adicionando novos atributos à V1 e recomendamos o uso da V2 para todos os novos bots.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

AMAZON.KendraSearchIntent

Para pesquisar documentos indexados com o Amazon Kendra, use a intenção AMAZON.KendraSearchIntent. Quando o Amazon Lex não consegue determinar a próxima ação em uma conversa com o usuário, ele aciona a intenção de pesquisa.

O AMAZON.KendraSearchIntent está disponível somente em inglês (EUA) (en-US) e nas regiões Leste dos EUA (Norte da Virgínia), Oeste dos EUA (Oregon) e Europa (Irlanda).

O Amazon Kendra é um serviço de pesquisa baseado em machine learning que indexa documentos de linguagem natural, como documentos PDF ou arquivos do Microsoft Word. Ele pode pesquisar documentos indexados e retornar os seguintes tipos de respostas a uma pergunta:

Para ver um exemplo de uso de AMAZON.KendraSearchIntent, consulte Exemplo: criar um bot de perguntas frequentes para um índice do .

Se você configurar uma intenção AMAZON.KendraSearchIntent para o bot, o Amazon Lex chamará a intenção sempre que não conseguir determinar o enunciado do usuário para um slot ou uma intenção. Por exemplo, se o bot estiver provocando uma resposta para um tipo de slot chamado "cobertura de pizza" e o usuário disser "O que é pizza?", o Amazon Lex chamará AMAZON.KendraSearchIntent para lidar com a pergunta. Se não houver resposta do Amazon Kendra, a conversa continuará conforme configurado no bot.

Quando AMAZON.KendraSearchIntent e AMAZON.FallbackIntent são usadas no mesmo bot, o Amazon Lex usa as intenções da seguinte forma:

Há três maneiras de usar AMAZON.KendraSearchIntent para fazer uma solicitação ao Amazon Kendra:

Para especificar o parâmetro queryFilterString ao criar um bot ou especificar o campo kendraQueryFilterString ao chamar a ação delegate em uma função do Lambda do diálogo, especifique uma string usada como filtro de atributo para a consulta do Amazon Kendra. Se a string não for um filtro de atributo válido, você receberá uma exceção InvalidBotConfigException em tempo de execução. Para obter mais informações sobre filtros de atributo, consulte Usar atributos de documento para filtrar consultas no Guia do desenvolvedor do Amazon Kendra.

Para ter controle sobre a consulta enviada pelo Amazon Lex para o Amazon Kendra, é possível especificar uma consulta no campo kendraQueryRequestPayload na função do Lambda do diálogo. Se a consulta não for válida, o Amazon Lex retornará uma exceção InvalidLambdaResponseException. Para obter mais informações, consulte a Operação de consulta no Guia do desenvolvedor do Amazon Kendra.

Para obter um exemplo de como usar a AMAZON.KendraSearchIntent, consulte Exemplo: criar um bot de perguntas frequentes para um índice do .

Política do IAM para pesquisa Amazon Kendra

Para usar a intenção AMAZON.KendraSearchIntent, é necessário usar uma função que forneça políticas do AWS Identity and Access Management (IAM) que permitam que o Amazon Lex assuma uma função de runtime que tenha permissão para chamar a intenção Query do Amazon Kendra. As configurações do IAM que você usa dependem do fato de você criar a AMAZON.KendraSearchIntent usando o console do Amazon Lex ou usar um AWS SDK ou a AWS Command Line Interface (AWS CLI). Quando o console é usado, é possível escolher entre adicionar permissão para chamar o Amazon Kendra para a função vinculada ao serviço do Amazon Lex ou usar uma função especificamente para chamar a operação Query do Amazon Kendra. Quando a AWS CLI ou um SDK é usado para criar a intenção, é necessário usar uma função especificamente para chamar a operação Query.

Anexar permissões

É possível usar o console para anexar permissões para acessar a operação Query do Amazon Kendra à função vinculada ao serviço padrão do Amazon Lex. Quando você anexa permissões à função vinculada ao serviço, não precisa criar e gerenciar uma função de runtime especificamente para se conectar ao índice do Amazon Kendra.

O usuário, a função ou o grupo usado para acessar o console do Amazon Lex deve ter permissões para gerenciar políticas de função. Anexe a política do IAM à função de acesso do console. Quando essas permissões são concedidas, a função tem permissões para alterar a política de função vinculada ao serviço existente.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "iam:AttachRolePolicy",
                "iam:PutRolePolicy",
                "iam:GetRolePolicy"
            ],
            "Resource": "arn:aws:iam::*:role/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots"
        },
        {
            "Effect": "Allow",
            "Action": "iam:ListRoles",
            "Resource": "*"
        }
    ]
}

Especificar uma função

É possível usar o console, a AWS CLI ou a API para especificar uma função de runtime a ser usada ao chamar a operação Query do Amazon Kendra.

O usuário, a função ou o grupo utilizado para especificar a função de runtime deve ter a permissão iam:PassRole. A política a seguir define a permissão. É possível usar as chaves de contexto de condição iam:AssociatedResourceArn e iam:PassedToService para limitar ainda mais o escopo das permissões. Para obter mais informações, consulte o do IAM e as Chaves de contexto de condição do AWS STS no Guia do usuário do AWS Identity and Access Management.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": "iam:PassRole",
            "Resource": "arn:aws:iam::account:role/role"
        }
    ]
}

A função de runtime que o Amazon Lex precisa usar para chamar o Amazon Kendra deve ter as permissões kendra:Query. Quando você usa uma função existente do IAM para permissão para chamar a operação Query do Amazon Kendra, a função deve ter a política a seguir anexada.

É possível usar o console do IAM, a API do IAM ou a AWS CLI para criar uma política e anexá-la a uma função. Essas instruções usam a CLI da AWS para criar a função e as políticas.

É possível optar por atualizar a função vinculada ao serviço do Amazon Lex ou usar uma função que você criou ao criar o AMAZON.KendraSearchIntent para o bot. O procedimento a seguir mostra como escolher o perfil do IAM a ser usado.

Usar atributos de solicitação e sessão como filtros

Para filtrar a resposta do Amazon Kendra a itens relacionados à conversa atual, use atributos de sessão e solicitação como filtros adicionando o parâmetro queryFilterString ao criar o bot. Especifique um espaço reservado para o atributo ao criar a intenção e, depois, o Amazon Lex V2 substituirá um valor antes de chamar o Amazon Kendra. Para obter mais informações sobre atributos de solicitação, consulte Definição de atributos de solicitação. Para obter mais informações sobre atributos de sessão, consulte Definição dos atributos da sessão.

Veja a seguir um exemplo de parâmetro queryFilterString que usa uma string para filtrar a consulta do Amazon Kendra.

"{"equalsTo": {"key": "City", "value": {"stringValue": "Seattle"}}}"

Veja a seguir um exemplo de um parâmetro queryFilterString que usa um atributo de sessão chamado "SourceURI" para filtrar a consulta do Amazon Kendra.

"{"equalsTo": {"key": "SourceURI","value": {"stringValue": "[FileURL]"}}}"

Veja a seguir um exemplo de parâmetro queryFilterString que usa um atributo de solicitação chamado "DepartmentName" para filtrar a consulta do Amazon Kendra.

"{"equalsTo": {"key": "Department","value": {"stringValue": "((DepartmentName))"}}}"

Os filtros AMAZON.KendraSearchInteng usam o mesmo formato dos filtros de pesquisa do Amazon Kendra. Para obter mais informações, consulte Usar atributos de documento para filtrar os resultados da pesquisa no Guia do desenvolvedor do Amazon Kendra.

A string do filtro de consulta usada com o AMAZON.KendraSearchIntent deve usar letras minúsculas para a primeira letra de cada filtro. Por exemplo, veja a seguir um filtro de consulta válido para o AMAZON.KendraSearchIntent.

{
    "andAllFilters": [
        {
            "equalsTo": {
                "key": "City",
                "value": {
                    "stringValue": "Seattle"
                }
            }
        },
        {
            "equalsTo": {
                "key": "State",
                "value": {
                    "stringValue": "Washington"
                }
            }
        }
    ]
}

Usar a resposta da pesquisa

O Amazon Kendra retorna a resposta a uma pesquisa na instrução conclusion da intenção. A intenção deve ter uma instrução conclusion, a menos que uma função do Lambda de atendimento produza uma mensagem de conclusão.

O Amazon Kendra tem quatro tipos de respostas.

As respostas são retornadas em atributos request. Pode haver até cinco respostas para cada atributo, numeradas de 1 a 5. Para obter mais informações sobre respostas, consulte Tipos de resposta no Guia do desenvolvedor do Amazon Kendra.

A instrução conclusion deve ter um ou mais grupos de mensagens. Cada grupo de mensagens contém uma ou mais mensagens. Cada mensagem pode conter uma ou mais variáveis de espaço reservado que são substituídas por atributos de solicitação na resposta do Amazon Kendra. Deve haver pelo menos uma mensagem no grupo de mensagens em que todas as variáveis na mensagem são substituídas por valores de atributo de solicitação na resposta de tempo de execução, ou deve haver uma mensagem no grupo sem variáveis de espaço reservado. Os atributos de solicitação são ativados com parênteses duplos ("((" "))"). As mensagens do grupo de mensagens a seguir correspondem a qualquer resposta do Amazon Kendra:

Usar uma função do Lambda para gerenciar a solicitação e a resposta

A intenção AMAZON.KendraSearchIntent pode usar o hook de código de diálogo e o hook de código de atendimento para gerenciar a solicitação ao Amazon Kendra e a resposta. Utilize a função do Lambda do hook de código de diálogo quando quiser modificar a consulta enviada ao Amazon Kendra e a função do Lambda de hook de código de atendimento quando quiser modificar a resposta.

Criar uma consulta com o hook de código de diálogo

É possível usar o hook de código de diálogo para criar uma consulta para enviar ao Amazon Kendra. O uso do hook de código de diálogo é opcional. Se você não especificar um hook de código de diálogo, o Amazon Lex criará uma consulta a partir do enunciado do usuário e usará a queryFilterString fornecida quando você configurou a intenção, se você a tiver fornecido.

É possível usar dois campos na resposta do hook de código de diálogo para modificar a solicitação ao Amazon Kendra:

Depois de criar o filtro ou a sequência de caracteres de consulta, você envia a resposta para o Amazon Lex com o dialogAction campo da resposta definido comodelegate. O Amazon Lex envia a consulta para a Amazon Kendra e, em seguida, retorna a resposta da consulta ao hook do código de atendimento.

Usar o hook de código de atendimento para a resposta

Depois que o envia uma consulta ao , a resposta da consulta é retornada para a função de cumprimento do . O evento de entrada para o hook de código contém a resposta completa do Amazon Kendra. Os dados da consulta estão na mesma estrutura que os retornados pela operação do . Para obter mais informações, consulte Sintaxe de resposta de consulta no Guia do desenvolvedor do .

O hook de código de atendimento é opcional. Se não houver nenhum ou se o hook de código não retornar uma mensagem na resposta, o Amazon Lex usará a instrução conclusion para respostas.