Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza
Apigee Edge documentazione.
La policy ParseDialogflowRequest facilita l'integrazione di Dialogflow con Apigee. Per ulteriori informazioni, consulta Integrare Apigee con Contact Center AI.
Questa policy è una policy estensibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di policy e sulle implicazioni di utilizzo, consulta Tipi di policy.
La policy ParseDialogflowRequest elabora WebhookRequest da un agente Dialogflow prima di inviare i dati della richiesta ai sistemi di backend. La policy estrae i dati da WebhookRequest nelle variabili di flusso disponibili per tutta la durata della chiamata API. Puoi utilizzare le variabili nelle chiamate successive, nelle ricerche o nella logica orchestrata. Questa policy è particolarmente utile se vuoi che l'agente Dialogflow interagisca con i tuoi sistemi di backend legacy. Prima di inviare i dati dell'agente ai sistemi di backend, puoi analizzarli e strutturarli in modo che possano essere utilizzati dai sistemi di backend.
Se sei un integratore di servizio di backend, non devi perdere tempo a comprendere il formato di Dialogflow WebhookRequest. La policy ParseDialogflowRequest predefinita gestisce l' elaborazione dei dati della richiesta senza problemi.
Per accedere a WebhookRequest dell'agente Dialogflow in Apigee, devi impostare l'URL webhook (fulfillment) dell'agente su ProxyEndPoint configurato in Apigee. ProxyEndPoint deve essere accessibile pubblicamente. Per ulteriori informazioni, consulta Requisiti del servizio webhook.
<ParseDialogflowRequest>
Definisce una policy ParseDialogflowRequest.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Oggetto complesso |
| Elemento principale | N/D |
| Elementi secondari |
<DialogflowVersion><DisplayName><VariablePrefix> |
La tabella seguente fornisce una descrizione di alto livello degli elementi secondari specifici della policy ParseDialogflowRequest:
| Elemento secondario | Obbligatorio? | Descrizione |
|---|---|---|
<VariablePrefix> |
Facoltativo | Specifica un prefisso personalizzato per le variabili di flusso. |
<DialogflowVersion> |
Facoltativo | Specifica la versione di Dialogflow. |
Esempio
L'esempio seguente mostra una richiesta webhook di esempio, la policy corrispondente
ParseDialogflowRequest e le variabili di flusso generate dopo l'applicazione della
policy:
Sintassi
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ParseDialogflowRequest continueOnError="false" enabled="true" name="POLICY_NAME"> <!-- The display name for this policy --> <DisplayName>DISPLAY_NAME</DisplayName> <!-- The optional prefix to be added to all variables created from the Dialogflow Webhook request. Note that all variables created from the WebhookRequest object will be within a container named "google.dialogflow" --> <VariablePrefix>CUSTOM_PREFIX</VariablePrefix> <!-- The version of Dialogflow for which this request 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> </ParseDialogflowRequest>
Richiesta webhook
L'esempio seguente mostra la richiesta webhook (in formato JSON) di un agente Dialogflow.
{
"fulfillmentInfo": {
"tag": "check-claim-status"
},
"sessionInfo": {
"session": "projects/apigee-test/locations/global/agents/ea45003d-3f5c-46ba-ac6b-f4c6dc8db707/sessions/5ea2e8-7c1-cf4-2cf-8e4d89e72",
"parameters": {
"claimId": "1234",
"policyId": "abcd"
}
},
"sentimentAnalysisResult": {
"score": -0.7,
"magnitude": 0.7
}
}Per visualizzare i vari campi che puoi configurare nella richiesta, consulta WebhookRequest.
Vai all'esempio successivo per visualizzare la configurazione della policy ParseDialogflowRequest.
Policy ParseDialogflowRequest
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ParseDialogflowRequest continueOnError="false" enabled="true" name="DialogflowRequest-InsuranceAgent"> <DisplayName>Insurance Agent Webhook Request Policy</DisplayName> <VariablePrefix>my-prefix</VariablePrefix> <DialogflowVersion>CX</DialogflowVersion> </ParseDialogflowRequest>
Vai all'esempio successivo per visualizzare le variabili di flusso create dalla policy.
Variabili di flusso
google.dialogflow.my-prefix.fulfillment.tag = "check-claim-status" google.dialogflow.my-prefix.session.id = "5ea2e8-7c1-cf4-2cf-8e4d89e72" google.dialogflow.my-prefix.session.project.id = "apigee-test" google.dialogflow.my-prefix.session.agent.id = "ea45003d-3f5c-46ba-ac6b-f4c6dc8db707" google.dialogflow.my-prefix.session.parameters.claimId = "1234" google.dialogflow.my-prefix.session.parameters.policyId = "abcd" google.dialogflow.my-prefix.sentimentAnalysisResultScore = -0.7 google.dialogflow.my-prefix.sentimentAnalysisResultMagnitude = 0.7
Tutte le variabili di flusso generate iniziano con google.dialogflow seguito da
il prefisso (my-prefix) come specificato nell'elemento <VariablePrefix>.
Questo elemento ha i seguenti attributi comuni a tutti i criteri:
| Attributo | Predefinito | Obbligatorio? | Descrizione |
|---|---|---|---|
name |
N/D | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Se vuoi, utilizza l'elemento |
continueOnError |
falso | Facoltativo | Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche:
|
enabled |
true | Facoltativo | Imposta su true per applicare il criterio. Imposta su false per disattivare il
criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso. |
async |
falso | Ritirato | Questo attributo è stato ritirato. |
Riferimento agli elementi secondari
Questa sezione descrive gli elementi secondari di<ParseDialogflowRequest>.
<DisplayName>
Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e più naturale.
L'elemento <DisplayName> è comune a tutti i criteri.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo. Se ometti <DisplayName>, viene utilizzato il valore dell'attributo name del criterio. |
| Tipo | Stringa |
| Elemento principale | <PolicyElement> |
| Elementi secondari | Nessuno |
La sintassi dell'elemento <DisplayName> è la seguente:
Sintassi
<PolicyElement> <DisplayName>POLICY_DISPLAY_NAME</DisplayName> ... </PolicyElement>
Esempio
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
L'elemento <DisplayName> non ha attributi o elementi secondari.
<VariablePrefix>
Specifica un prefisso personalizzato per le variabili di flusso. Il valore specificato in questo elemento è preceduto da tutti i nomi delle variabili generate dalla policy ParseDialogflowRequest. Per impostazione predefinita, tutte le variabili
generate dalla policy sono precedute da google.dialogflow. Se hai
specificato l'elemento VariablePrefix, il prefisso personalizzato viene aggiunto dopo
google.dialogflow. Di conseguenza, il nome della variabile inizia con
google.dialogflow.CUSTOM_PREFIX.
Se non specifichi l'elemento VariablePrefix, il nome della variabile
è preceduto solo da google.dialogflow.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo |
| Tipo | Stringa |
| Elemento principale |
<ParseDialogflowRequest>
|
| Elementi secondari | Nessuno |
<VariablePrefix> utilizza la seguente sintassi:
Sintassi
<VariablePrefix>VARIABLE_PREFIX</VariablePrefix>
Esempio
L'esempio seguente imposta VariablePrefix su my-prefix:
<VariablePrefix>my-custom-prefix</VariablePrefix>
In base a questa configurazione, tutti i nomi delle variabili iniziano con google.dialogflow.my-custom-prefix.
<DialogflowVersion>
Specifica la versione di Dialogflow. La policy ParseDialogflowRequest supporta solo la versione CX. Se non specifichi questo elemento nella policy, la versione predefinita è CX.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo |
| Tipo | Stringa |
| Elemento principale | N/D |
| Elementi secondari | Nessuno |
<DialogflowVersion> utilizza la seguente sintassi:
Sintassi
<DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>
Esempio
L'esempio seguente imposta DialogflowVersion su CX:
<DialogflowVersion>CX</DialogflowVersion>
Codici di errore
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 | Fix |
|---|---|---|---|
steps.parsedialogflowrequest.InvalidSessionInfo |
500 |
This error occurs if there is an invalid sessionInfo.session field in a Dialogflow request. A Webhook can use this field to identify a session. For information about the supported session format, see Class SessionInfo. | |
steps.parsedialogflowrequest.MalformedInput |
500 |
This error occurs when the JSON provided to this policy is invalid or malformed. |
Deployment errors
These errors can occur when you deploy a proxy containing this policy.
| Error name | Cause | Fix |
|---|---|---|
UnsupportedOperation |
This error occurs if you have specified unsupported Dialogflow version in the
DialogflowVersion element. The ParseDialogflowRequest policy supports
only 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" |
ParseDialogflowRequest.POLICY_NAME.failed |
POLICY_NAME is the user-specified name of the policy that threw the fault. | ParseDialogflowRequest.My-Parse-Dialogflow-Req.failed = true |
Argomenti correlati
Le implementazioni di riferimento dei proxy Apigee e dei flussi condivisi che mostrano l'utilizzo della policy ParseDialogflowRequest sono disponibili su Apigee GitHub. Per ulteriori informazioni, consulta Implementazioni di riferimento di AI conversazionale.