Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Panoramica
Il criterio ParseDialogflowRequest facilita l'integrazione di Dialogflow con Apigee. Per ulteriori informazioni, consulta la pagina Integrazione di Apigee con Contact Center AI.
Queste norme sono estensibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o di utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni di utilizzo, consulta Tipi di criteri.
Il criterio ParseDialogflowRequest elabora WebhookRequest da un agente Dialogflow prima di inviare i dati della richiesta ai tuoi sistemi di backend. Il criterio estrae i dati da WebhookRequest nelle variabili di flusso disponibili per tutta la durata della chiamata API. Puoi utilizzare le variabili nei successivi callout, ricerche o logica orchestrata. Questo criterio è particolarmente utile se vuoi che l'agente Dialogflow interagisca con i tuoi sistemi backend legacy. Prima di inviare i dati dell'agente ai sistemi di backend, puoi analizzarli e strutturarli in modo che possano essere utilizzati dai tuoi sistemi di backend.
Se sei un integratore di servizio di backend, non devi perdere tempo a capire il formato di Dialogflow WebhookRequest. Il criterio ParseDialogflowRequest predefinito gestisce l'elaborazione dei dati della richiesta in modo semplice.
Per accedere a WebhookRequest dell'agente Dialogflow in Apigee, devi impostare l'URL webhook (fulfillment) dell'agente su ProxyEndpoint che hai configurato in Apigee. ProxyEndPoint deve essere accessibile pubblicamente. Per maggiori 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 del criterio 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 ParseDialogflowRequest corrispondente 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) da 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 del criterio ParseDialogflowRequest.
Criterio 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 dal prefisso (my-prefix) 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 all'elemento secondario
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
viene aggiunto come prefisso a tutti i nomi delle variabili generati dal criterio ParseDialogflowRequest. Per impostazione predefinita, tutte le variabili
generate dai criteri hanno il prefisso google.dialogflow. Se hai specificato l'elemento VariablePrefix, il prefisso personalizzato viene aggiunto dopo google.dialogflow. Pertanto, il nome della variabile inizia con
google.dialogflow.CUSTOM_PREFIX.
Se non specifichi l'elemento VariablePrefix, il nome della variabile
ha come prefisso solo 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. Il criterio ParseDialogflowRequest supporta solo la versione CX. Se non specifichi questo elemento nel criterio, 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
Questa sezione descrive i codici di errore e i messaggi di errore restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi durante l'esecuzione del criterio.
| Codice guasto | Stato HTTP | Causa | Correggi |
|---|---|---|---|
steps.parsedialogflowrequest.InvalidSessionInfo |
500 |
Questo errore si verifica se in una richiesta Dialogflow è presente un campo sessionInfo.session non valido. Un webhook può utilizzare questo campo per identificare una sessione. Per informazioni sul formato della sessione supportato, consulta Class SessionInfo. | |
steps.parsedialogflowrequest.MalformedInput |
500 |
Questo errore si verifica quando il JSON fornito a questo criterio non è valido o non ha un formato corretto. |
Errori di deployment
Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.
| Nome dell'errore | Causa | Correggi |
|---|---|---|
UnsupportedOperation |
Questo errore si verifica se hai specificato una versione di Dialogflow non supportata nell'elemento
DialogflowVersion. Il criterio ParseDialogflowRequest supporta
solo la versione CX. |
Variabili di errore
Ogni volta che si verificano errori di esecuzione in un criterio, Apigee genera messaggi di errore. Puoi visualizzare questi messaggi di errore nella risposta di errore. Spesso i messaggi di errore generati dal sistema potrebbero non essere pertinenti nel contesto del tuo prodotto. Ti consigliamo di personalizzare i messaggi di errore in base al tipo di errore per renderli più significativi.
Per personalizzare i messaggi di errore, puoi utilizzare le regole di errore o il criterio RaiseFault. Per informazioni sulle differenze tra le regole di errore e il criterio RaiseFault, consulta Regole di errore e criterio RaiseFault.
Devi verificare la presenza di condizioni utilizzando l'elemento Condition sia nelle regole di errore sia nel criterio RaiseFault.
Apigee fornisce variabili di errore univoche per ogni criterio e i valori delle variabili di errore vengono impostati quando un criterio attiva errori di runtime.
Utilizzando queste variabili, puoi verificare la presenza di condizioni di errore specifiche e intraprendere le azioni appropriate. Per ulteriori informazioni sul controllo delle condizioni
di errore, consulta Condizioni di compilazione.
La tabella seguente descrive le variabili di errore specifiche per questo criterio.
| Variabili | Dove | Esempio |
|---|---|---|
fault.name="FAULT_NAME" |
FAULT_NAME è il nome dell'errore, come indicato nella tabella Errori di runtime. Il nome dell'errore è l'ultima parte del codice dell'errore. | fault.name Matches "UnresolvedVariable" |
ParseDialogflowRequest.POLICY_NAME.failed |
POLICY_NAME è il nome specificato dall'utente del criterio che ha generato l'errore. | ParseDialogflowRequest.My-Parse-Dialogflow-Req.failed = true |
Argomenti correlati
Le implementazioni di riferimento dei proxy Apigee e dei flussi condivisi che mostrano l'utilizzo del criterio ParseDialogflowRequest sono disponibili su Apigee GitHub. Per ulteriori informazioni, vedi Implementazioni di riferimento dell'IA conversazionale.