Política SetDialogflowResponse

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Ícone da política

Visão geral

A política SetDialogflowResponse facilita a integração do Dialogflow com a Apigee. Para mais informações, consulte Como integrar a Apigee ao Contact Center AI.

A política SetDialogflowResponse processa e formata os dados de resposta dos sistemas de back-end antes de enviar os dados como uma WebhookResponse ao agente Dialogflow (bot). Um agente do Dialogflow exige a WebhookResponse em um formato específico, e a política SetDialogflowResponse cria a resposta no formato exigido. A política cria uma WebhookResponse no formato necessário para um agente do Dialogflow. O WebhookResponse tem frases de linguagem natural e outros parâmetros que o agente do Dialogflow entende.

Se você é um integrador de serviços de back-end, não precisa gastar tempo para entender o formato da WebhookResponse do Dialogfow. A política SetDialogflowResponse pronta para uso lida com o processamento dos dados de resposta de forma integrada.

Esta é uma política extensível. O uso dela pode ter implicações no custo ou na utilização, dependendo da sua licença da Apigee. Para informações sobre tipos de política e implicações de uso, consulte Tipos de política.

<SetDialogflowResponse>

Define uma política SetDialogflowResponse.

Valor padrão N/A
Obrigatório? Obrigatório
Tipo Objeto complexo
Elemento pai N/A
Elemento filho <DisplayName>
<Source>
<DialogflowVersion>
<NaturalLanguageResponse>
<Parameters>
<IgnoreUnresolvedVariables>

A tabela a seguir fornece uma descrição de alto nível dos elementos filhos do elemento SetDialogflowResponse:

Elemento filho Obrigatório? Descrição
<DisplayName> Opcional Um nome personalizado para a política.
<Source> Opcional Especifica a variável a ser analisada.
<DialogflowVersion> Opcional Especifica a versão do Dialogflow.
<NaturalLanguageResponse> Opcional Encapsula todo o conteúdo necessário para ser enviado como um objeto WebhookResponse.FulfillmentResponse.
<Parameters> Opcional Elemento pai de <Parameter>. Define o conjunto de parâmetros a serem definidos na resposta do webhook.
<IgnoreUnresolvedVariables> Opcional Determina se o processamento é interrompido quando uma variável não resolvida é encontrada.
Outros elementos filhos
<MergeBehavior> Opcional Especifica o comportamento de mesclagem para as mensagens de resposta.
<Header> Opcional Extrai o valor do campo especificado no cabeçalho da resposta.
<JSONPath> Opcional Extrai o valor do caminho JSON especificado.
<Parameter> Obrigatório Especifica um parâmetro a ser definido no objeto sessionInfo.parameters da resposta do webhook.
<Phrase> Obrigatório Especifica a frase (texto) a ser definida no objeto fulfillmentResponse.messages da resposta do webhook.
<Phrases> Opcional Elemento-pai de <Phrase>. Define o conjunto de frases de linguagem natural a serem definidas na resposta do webhook.
<Ref> Opcional Extrai o valor da variável de referência especificada.
<Value> Opcional Define um texto personalizado para o parâmetro especificado.

Exemplo

No exemplo a seguir, mostramos uma política SetDialogflowResponse de amostra e a WebhookResponse enviada para o agente do Dialogflow:

Sintaxe

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetDialogflowResponse continueOnError="false" enabled="true"
        name="POLICY_NAME">
    <!-- The display name for this policy -->
    <DisplayName>DISPLAY_NAME</DisplayName>
    <!-- The message variable from which the policy extracts the required information -->
    <Source>MESSAGE_VARIABLE</Source>
    <!-- The version of Dialogflow for which this response policy is written up.
         This policy supports only the CX version. This element is optional and
         defaults to CX if unspecified -->
    <DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>
    <!-- A container object to encapsulate all content needed for a natural
         language response to be returned to Dialogflow from the Southbound API -->
    <NaturalLanguageResponse>
        <!-- Defines the merge behavior for existing responses and new responses.
             Refer here for more details -->
        <MergeBehavior>MERGE_BEHAVIOR</MergeBehavior>
        <!-- An ordered list of natural language phrases to be returned to
             Dialogflow from the Southbound API -->
        <Phrases>
            <!-- A phrase is a natural language phrase that Dialogflow agents
                 can send back to their caller/chatting customer -->
            <Phrase>
                <!-- A phrase can be extracted from the response JSON payload of a
                     service callout -->
                <JSONPath>JSON_PATH</JSONPath>
            </Phrase>
            <Phrase>
                <!-- A phrase can be extracted from the response headers of a
                     service callout -->
                <Header name="HEADER_NAME"/>
            </Phrase>
            <Phrase>
                <!-- A phrase refer to the value of an existing flow variable -->
                <Ref>EXISTING_FLOW_VARIABLE</Ref>
            </Phrase>
            <Phrase>
                <!-- A phrase can be static text -->
                <Value>CUSTOM_TEXT</Value>
            </Phrase>
        </Phrases>
    </NaturalLanguageResponse>
    <!-- A container object defining the parameters to be set as session parameters
         in the Webhook response sent to Dialogflow -->
    <Parameters>
        <!-- Defines a single parameter to be set in sessionInfo.parameters object
             of the WebhookResponse object. The name of the parameter is defined
             as an attribute -->
        <Parameter name="PARAMETER_NAME">
            <!-- A parameter's value can be extracted from the response JSON
                 payload of a service callout -->
            <JSONPath>JSON_PATH</JSONPath>
        </Parameter>
        <Parameter name="PARAMETER_NAME">
            <!-- A parameter's value can be extracted from the response headers
                 of a service callout -->
            <Header name="HEADER_NAME"/>
        </Parameter>
        <Parameter name="PARAMETER_NAME">
            <!-- A parameter's value can be refer to the value of an existing flow
                 variable -->
            <Ref>EXISTING_FLOW_VARIABLE</Ref>
        </Parameter>
        <Parameter name="PARAMETER_NAME">
            <!-- A parameter's value can be static text -->
            <Value>CUSTOM_TEXT</Value>
        </Parameter>
    </Parameters>
    <IgnoreUnresolvedVariables>BOOLEAN_VALUE</IgnoreUnresolvedVariables>
</SetDialogflowResponse>

Política SetDialogflowResponse

O exemplo a seguir mostra a definição da política SetDialogflowResponse:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetDialogflowResponse continueOnError="false" enabled="true"
        name="CCAIDialogflowResponse-InsuranceAgent">
    <DisplayName>Insurance Agent Webhook Response Policy</DisplayName>
    <Source>myMessageVar</Source>
    <DialogflowVersion>CX</DialogflowVersion>
    <NaturalLanguageResponse>
        <MergeBehavior>APPEND</MergeBehavior>
        <Phrases>
            <Phrase>
                <JSONPath>$.claim.status.text</JSONPath>
            </Phrase>
            <Phrase>
                <Header name="X-Response-Text"/>
            </Phrase>
            <Phrase>
                <Ref>myVar</Ref>
            </Phrase>
            <Phrase>
                <Value>You call is important to us</Value>
            </Phrase>
        </Phrases>
    </NaturalLanguageResponse>
    <Parameters>
        <Parameter name="claimStatus">
            <JSONPath>$.claim.status.value</JSONPath>
        </Parameter>
        <Parameter name="claimAmount">
            <JSONPath>$.claim.amount</JSONPath>
        </Parameter>
        <Parameter name="timeSpent">
            <Header name="X-Time-Spent"/>
        </Parameter>
        <Parameter name="myVar">
            <Ref>dialogflow.my.var</Ref>
        </Parameter>
        <Parameter name="responder">
            <Value>SYSTEM</Value>
        </Parameter>
    </Parameters>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</SetDialogflowResponse>

Acesse a próxima amostra para ver a resposta do webhook criada por esta política.

Resposta do webhook

O exemplo a seguir mostra uma WebhookResponse enviada para o agente do Dialogflow:

{
    "fulfillmentResponse": {
        "mergeBehavior": "APPEND",
        "messages": [{
            "text": {
                "text": ["Your claim is currently being processed",
                          "Please call back in a couple of days"]
            }
        }]
    },
    "sessionInfo": {
        "parameters": {
            "claimStatus": "PROCESSING",
            "claimAmount": 1000
        }
    }
}

This element has the following attributes that are common to all policies:

Attribute Default Required? Description
name N/A Required

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.
continueOnError false Optional Set to false to return an error when a policy fails. This is expected behavior for most policies. Set to true to have flow execution continue even after a policy fails. See also:
enabled true Optional Set to true to enforce the policy. Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.
async   false Deprecated This attribute is deprecated.

Referência a elementos filhos

Esta seção descreve os elementos filhos de <SetDialogflowResponse>.

<DisplayName>

Use além do atributo name para rotular a política no editor de proxy da IU de gerenciamento com um nome de som diferente e mais natural.

O elemento <DisplayName> é comum a todas as políticas.

Valor padrão N/A
Obrigatório? Opcional. Se você omitir <DisplayName>, o valor do atributo name da política será usado
Tipo String
Elemento pai <PolicyElement>
Elemento filho Nenhum

O elemento <DisplayName> usa a seguinte sintaxe:

Sintaxe

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

Exemplo

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

O elemento <DisplayName> não tem atributos ou elementos filhos.

<Source>

Especifica a variável a ser analisada. O valor de <Source> é definido por padrão como message. O valor message diferencia o contexto. Em um fluxo de solicitação, message resolve a mensagem de solicitação. Em um fluxo de resposta, message é resolvido para a mensagem de resposta.

Muitas vezes, quando você usa essa política para extrair informações de uma mensagem de resposta ou solicitação, é possível usá-la para extrair informações de qualquer variável. Por exemplo, é possível usá-la para extrair informações de uma entidade criada pela política AccessEntity, de dados retornados pela política ServiceCallout ou de um objeto JSON ou XML.

Se <Source> não puder ser resolvido ou for resolvido para um tipo que não é de mensagem, a política falhará e você receberá um erro no ambiente de execução.

Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <SetDialogflowResponse>
Elemento filho Nenhum
O elemento <Source> usa a seguinte sintaxe:

Sintaxe

<Source>MESSAGE_VARIABLE</Source>

Exemplo

O exemplo a seguir define a origem como myMessageVar:

<Source>myMessageVar</Source>

<DialogflowVersion>

Especifica a versão do Dialogflow. A política SetDialogflowResponse é compatível apenas com a versão CX. Se você não especificar esse elemento na sua política, a versão padrão será CX.

Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <SetDialogflowResponse>
Elemento filho Nenhum
O elemento <DialogflowVersion> usa a seguinte sintaxe:

Sintaxe

<DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>

Exemplo

O exemplo a seguir define a DialogflowVersion como CX:

<DialogflowVersion>CX</DialogflowVersion>

<IgnoreUnresolvedVariables>

Determina se o processamento é interrompido quando uma variável não resolvida é encontrada.

Valor padrão Verdadeiro
Obrigatório? Opcional
Tipo Booleano
Elemento pai <SetDialogflowResponse>
Elemento filho Nenhum

Defina como true para ignorar variáveis não resolvidas e continuar o processamento. Caso contrário, false. O valor padrão é true.

Definir <IgnoreUnresolvedVariables> como true é diferente de definir o continueOnError do <SetDialogflowResponse> como true. Se você definir continueOnError como true, a Apigee vai ignorar todos os erros, e não apenas os erros nas variáveis.

O elemento <IgnoreUnresolvedVariables> usa a seguinte sintaxe:

Sintaxe

 <IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

Exemplo

O exemplo a seguir define <IgnoreUnresolvedVariables> como false:

       <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>

<MergeBehavior>

Define o comportamento de mesclagem para as mensagens de resposta. É possível especificar qualquer um dos seguintes valores:

  • APPEND: anexa as mensagens à lista de mensagens que aguardam o envio para o usuário.
  • REPLACE: substitui as mensagens mais antigas por mensagens mais recentes na lista de mensagens que aguardam o envio para o usuário.
Se você não especificar o elemento, o comportamento padrão será APPEND.
Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <NaturalLanguageResponse>
Elemento filho Nenhum
O elemento <MergeBehavior> usa a seguinte sintaxe:

Sintaxe

<MergeBehavior>BEHAVIOR</MergeBehavior>

Exemplo

O exemplo a seguir define o comportamento de mesclagem como APPEND:

<MergeBehavior>APPEND</MergeBehavior>

<NaturalLanguageResponse>

Encapsula toda a resposta de linguagem natural que você quer enviar para o agente do Dialogflow.

Valor padrão N/A
Obrigatório? Opcional
Tipo Objeto complexo
Elemento pai <SetDialogflowResponse>
Elemento filho <MergeBehavior>
<Phrases>

<Parameters>

Define o conjunto de parâmetros a serem definidos na resposta do webhook. O nome do parâmetro é um atributo do elemento <Parameter>.

Valor padrão N/A
Obrigatório? Opcional
Tipo Objeto complexo
Elemento pai <SetDialogflowResponse>
Elemento filho <Parameter>

<Parameter>

Especifica um parâmetro a ser definido no objeto sessionInfo.parameters da resposta do webhook.

É possível especificar um texto estático como um valor de parâmetro ou extrair o valor de qualquer um dos seguintes campos na resposta:

  • Campos de cabeçalho de resposta
  • Payload do JSON
  • Variáveis de fluxo

É necessário definir um elemento <Parameter> separado para cada valor que você quiser extrair.

Valor padrão N/A
Obrigatório? Obrigatório
Tipo Objeto complexo
Elemento pai <Parameters>
Elemento filho <Header>
<JSONPath>
<Ref>
<Value>
O elemento <Parameter> tem os seguintes atributos:
Atributo Descrição Obrigatório? Tipo
name O nome da variável a ser criada com este parâmetro. Sim String

O elemento <Parameter> usa a seguinte sintaxe:

Sintaxe

<Parameters>
  <Parameter name="PARAMETER_NAME">
  <Header name="HEADER_NAME"/>
</Parameter>
<Parameter name="PARAMETER_NAME">
  <JSONPath>JSON_PATH</JSONPath>
</Parameter>
<Parameter name="PARAMETER_NAME">
  <Ref>EXISTING_FLOW_VARIABLE</Ref>
</Parameter>
<Parameter name="PARAMETER_NAME">
  <Value>CUSTOM_TEXT</Value>
</Parameter>
</Parameters>

Extrair valor do campo do cabeçalho

Este exemplo define o parâmetro timeSpent como o valor do campo do cabeçalho X-Time-Spent.

<Parameter name="timeSpent">
     <Header name="X-Time-Spent"/>
</Parameter>

Extrair valor do caminho JSON

Este exemplo define o parâmetro claimAmount como o valor do campo claim.amount no payload JSON.

<Parameter name="claimAmount">
   <JSONPath>$.claim.amount</JSONPath>
</Parameter>

Extrair o valor da variável de fluxo

Este exemplo define o parâmetro myVar como o valor da variável de fluxo dialogflow.my.var.

<Parameter name="myVar">
   <Ref>dialogflow.my.var</Ref>
</Parameter>

Definir texto personalizado

Este exemplo define o valor do parâmetro responder como SYSTEM.

<Parameter name="responder">
   <Value>SYSTEM</Value>
</Parameter>

<Phrases>

Elemento-pai de <Phrase>. Define a lista ordenada de frases de linguagem natural a serem definidas na resposta do webhook.

Valor padrão N/A
Obrigatório? Opcional
Tipo Objeto complexo
Elemento pai <NaturalLanguageResponse>
Elemento filho <Phrase>

<Phrase>

Especifica a frase (texto) a ser definida no objeto fulfillmentResponse.messages da resposta do webhook.

É possível especificar um texto estático como um valor de frase ou extrair o valor de qualquer um dos seguintes campos na resposta:

  • Campos de cabeçalho de resposta
  • Payload do JSON
  • Variáveis de fluxo

Defina um elemento <Phrase> separado para cada valor que você quiser extrair.

Valor padrão N/A
Obrigatório? Obrigatório
Tipo Objeto complexo
Elemento pai <Phrases>
Elemento filho <Header>
<JSONPath>
<Ref>
<Value>

O elemento <Phrase> usa a seguinte sintaxe:

Sintaxe

<Phrases>
  <Phrase>
    <Header name="HEADER_NAME"/>
  </Phrase>
  <Phrase>
    <JSONPath>JSON_PATH</JSONPath>
  </Phrase>
  <Phrase>
    <Ref>EXISTING_FLOW_VARIABLE</Ref>
  </Phrase>
  <Phrase>
    <Value>CUSTOM_TEXT</Value>
  </Phrase>
</Phrases>

Extrair valor do campo do cabeçalho

Este exemplo define um texto de linguagem natural na resposta como o valor do campo do cabeçalho X-Response-Text.

<Phrase>
     <Header name="X-Response-Text"/>
</Phrase>

Extrair valor do caminho JSON

Este exemplo define um texto de linguagem natural na resposta como o valor do campo claim.status.text no payload JSON.

<Phrase>
   <JSONPath>$.claim.status.text</JSONPath>
</Phrase>

Extrair o valor da variável de fluxo

Este exemplo define um texto de linguagem natural na resposta como o valor da variável de fluxo myVar.

<Phrase>
   <Ref>myVar</Ref>
</Phrase>

Definir texto personalizado

Este exemplo adiciona o texto You call is important to us ao texto de linguagem natural na resposta.

<Phrase>
   <Value>You call is important to us</Value>
</Phrase>

Extrai o valor do campo especificado no cabeçalho da resposta. É possível usar o valor do cabeçalho para definir um texto de linguagem natural ou um parâmetro de resposta.

  • Para extrair o valor do cabeçalho como uma resposta de linguagem natural, especifique o elemento <Header> dentro do elemento <Phrase>.
  • Para extrair o valor do cabeçalho como um parâmetro de resposta, especifique o elemento <Header> dentro do elemento <Parameter>.
Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <Phrase>
<Parameter>
Elemento filho Nenhum
O elemento <Header> usa a seguinte sintaxe:

Sintaxe

<Header name="HEADER_FIELD"/>

Exemplo 1

O exemplo a seguir recebe o valor do campo do cabeçalho X-Response-Text como uma resposta de linguagem natural:

<Phrase>
  <Header name="X-Response-Text"/>
<Phrase/>

Exemplo 2

O exemplo a seguir recebe o valor do campo do cabeçalho X-Response-Text como um parâmetro de resposta:

<Parameter name="timeSpent">
  <Header name="X-Response-Text"/>
<Parameter/>

A variável de fluxo timeSpent é definida como o valor do campo do cabeçalho X-Response-Text.

O elemento <Header> tem os seguintes atributos:

Atributo Descrição Obrigatório ? Tipo
nome Especifica o nome do cabeçalho de resposta de qual será extraído o valor. Obrigatório String

<JSONPath>

Extrai o valor de um caminho JSON em um payload JSON da chamada de serviço. É possível usar o valor para definir um texto de linguagem natural ou um parâmetro de resposta.

  • Para extrair o valor JSON como um texto de linguagem natural, especifique o elemento <JSONPath> dentro do elemento <Phrase>.
  • Para extrair o valor JSON como um parâmetro de resposta, especifique o elemento <JSONPath> dentro do elemento <Parameter>.
Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <Phrase>
<Parameter>
Elemento filho Nenhum
O elemento <JSONPath> usa a seguinte sintaxe:

Sintaxe

<JSONPath>JSON_PATH</JSONPath>

Exemplo 1

O exemplo a seguir recebe o valor do campo JSON claim.status.text como uma resposta de linguagem natural:

<Phrase>
  <JSONPath>$.claim.status.text</JSONPath>
<Phrase/>

Exemplo 2

O exemplo a seguir recebe o valor do campo JSON claim.amount como um parâmetro de resposta:

<Parameter name="claimAmount">
  <JSONPath>$.claim.amount.</JSONPath>
<Parameter/>

A variável de fluxo claimAmount é definida como o valor do campo JSON {claim.amount}.

<Ref>

Extrai o valor de uma variável de fluxo existente. É possível usar o valor para definir um texto de linguagem natural ou um parâmetro de resposta.

  • Para extrair o valor de uma variável como um texto de linguagem natural, especifique o elemento <Ref> dentro do elemento <Phrase>.
  • Para extrair o valor de uma variável como um parâmetro de resposta, especifique o elemento <Ref> dentro do elemento <Parameter>.
Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <Phrase>
<Parameter>
Elemento filho Nenhum
O elemento <Ref> usa a seguinte sintaxe:

Sintaxe

<Ref>EXISTING_FLOW_VARIABLE</Ref>

Exemplo 1

O exemplo a seguir recebe o valor da variável de fluxo myVar como uma resposta de linguagem natural:

<Phrase>
  <Ref>myVar</Ref>
<Phrase/>

Exemplo 2

O exemplo a seguir recebe o valor da variável de fluxo dialogflow.my.var como um parâmetro de resposta:

<Parameter name="customVar">
  <Ref>dialogflow.my.var</Ref>
<Parameter/>

A variável de fluxo customVar é definida como o valor da variável dialogflow.my.var.

<Value>

Define um valor literal para um texto de linguagem natural ou um parâmetro de resposta.

  • Para definir o valor literal como um texto de linguagem natural, especifique o elemento <Value> dentro do elemento <Phrase>.
  • Para definir o valor literal como um parâmetro de resposta, especifique o elemento <Value> dentro do elemento <Parameter>.
Valor padrão N/A
Obrigatório? Opcional
Tipo String
Elemento pai <Phrase>
<Parameter>
Elemento filho Nenhum
O elemento <Value> usa a seguinte sintaxe:

Sintaxe

<Value>CUSTOM_TEXT</Value>

Exemplo 1

O exemplo a seguir define o texto literal You call is important to us como uma resposta de linguagem natural:

<Phrase>
  <Value>You call is important to us</Value>
<Phrase/>

Exemplo 2

O exemplo a seguir define o texto literal SYSTEM como um parâmetro de resposta:

<Parameter name="responder">
  <Value>SYSTEM</Value>
<Parameter/>

A variável de fluxo responder está definida como SYSTEM.

Códigos de erro

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
steps.setdialogflowresponse.ExecutionFailed 500 This error occurs when the execution of the policy failed because of a generic exception. The fault message has the details of the exception.
steps.setdialogflowresponse.InvalidSourceType 500 This error occurs if the variable specified in the <Source> element is not of message type.
steps.setdialogflowresponse.MalformedInput 500 This error occurs when the JSON provided to this policy is invalid or malformed.
steps.setdialogflowresponse.SourceMessageNotAvailable 500 This error occurs if the message variable specified in the Source element of the policy is either:
  • Out of scope (not available in the specific flow where the policy is executed)
    • or
  • Can't be resolved (is not defined)
steps.setdialogflowresponse.UnresolvedHeader 500 This error occurs if the Header element has an invalid header. For example, if the Header element has the value X-Response-Text, and there is no X-Response-Text in the response header, you will get this error.
steps.setdialogflowresponse.UnresolvedJSONPath 500 This error occurs if the JSONPath element has an invalid path. For example, if the JSONPath element has the value {claim.status.value}, and there is no status object in the JSON payload, you will get this error.
steps.setdialogflowresponse.UnresolvedVariable 500

This error occurs if a variable specified in the SetDialogflowResponse policy is either:

  • Out of scope (not available in the specific flow where the policy is being executed)
    • or
  • Can't be resolved (is not defined)

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Cause
UnsupportedOperation This error occurs if you have specified unsupported Dialogflow version in the DialogflowVersion element. The SetDialogflowResponse policy supports only the CX version.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

The following table describes the fault variables specific to this policy.

Variables Where Example
fault.name="FAULT_NAME" FAULT_NAME is the name of the fault, as listed in the Runtime errors table. The fault name is the last part of the fault code. fault.name Matches "UnresolvedVariable"
setdialogflowresponse.POLICY_NAME.failed POLICY_NAME is the user-specified name of the policy that threw the fault. setdialogflowresponse.My-Set-Dialogflow-Response.failed = true
For more information about policy errors, see What you need to know about policy errors.

Temas relacionados

As implementações de referência de proxies e fluxos compartilhados da Apigee que mostram o uso da política SetDialogflowResponse estão disponíveis no GitHub da Apigee. Para mais informações, consulte Implementações de referências do Conversation AI.