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 Integrazione di Apigee con Contact Center AI.
Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o 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 la richiesta WebhookRequest da un agente Dialogflow prima di inviare i dati della richiesta ai sistemi di backend. Il criterio estrae i dati da WebhookRequest nelle variabili di flusso disponibili per l'intera durata dell'intera chiamata API. Puoi utilizzare le variabili nei callout, nelle ricerche o nella logica orchestrata successivi. Questo criterio è 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 i sistemi di backend possano utilizzarli.
Se sei un integratore di servizio di backend, non devi dedicare tempo a comprendere il formato di Dialogflow WebhookRequest. Il criterio ParseDialogflowRequest pronto all'uso gestisce l'elaborazione dei dati delle richieste senza problemi.
Per accedere alla richiesta webhook dell'agente Dialogflow in Apigee, devi impostare l'URL webhook (fulfillment) dell'agente sul ProxyEndPoint che hai configurato in Apigee. ProxyEndPoint deve essere accessibile pubblicamente. Per maggiori informazioni, consulta la sezione Requisiti del servizio webhook.
<ParseDialogflowRequest>
Definisce un criterio ParseDialogflowRequest.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Oggetto complesso |
| Elemento principale | N/D |
| Elementi secondari |
<DialogflowVersion><DisplayName><VariablePrefix> |
La seguente tabella fornisce una descrizione generale 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, il criterio ParseDialogflowRequest corrispondente e le variabili di flusso generate dopo l'applicazione del criterio:
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, vedi WebhookRequest.
Vai all'esempio successivo per visualizzare la configurazione dei criteri 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 vedere le variabili di flusso create dal criterio.
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) come specificato nell'elemento <VariablePrefix>.
Questo elemento ha i seguenti attributi comuni a tutti i criteri:
| Attributo | Predefinito | Obbligatorio? | Descrizione |
|---|---|---|---|
name |
N/A | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
continueOnError |
falso | Facoltativo | Imposta su false per restituire un errore in caso di errore del criterio. Questo è un comportamento previsto per
la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un errore nel 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 | Deprecato | Questo attributo è stato ritirato. |
Riferimento elemento secondario
In questa sezione vengono descritti gli elementi secondari di<ParseDialogflowRequest>.
<DisplayName>
Utilizzalo in aggiunta 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/A |
| Obbligatorio? | Facoltativo. Se ometti <DisplayName>, viene utilizzato il valore dell'attributo name del criterio. |
| Tipo | Stringa |
| Elemento principale | <PolicyElement> |
| Elementi secondari | Nessuna esperienza |
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 di variabili generati dal criterio ParseDialogflowRequest. Per impostazione predefinita, tutte le variabili generate dal criterio hanno il prefisso 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
ha come prefisso solo google.dialogflow.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo |
| Tipo | Stringa |
| Elemento principale |
<ParseDialogflowRequest>
|
| Elementi secondari | Nessun valore |
<VariablePrefix> utilizza la seguente sintassi:
Sintassi
<VariablePrefix>VARIABLE_PREFIX</VariablePrefix>
Esempio
Nell'esempio seguente viene impostato il valore {5}variabile su my-prefix:
<VariablePrefix>my-custom-prefix</VariablePrefix>
Secondo 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, per impostazione predefinita la versione sarà CX.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo |
| Tipo | Stringa |
| Elemento principale | N/D |
| Elementi secondari | Nessun valore |
<DialogflowVersion> utilizza la seguente sintassi:
Sintassi
<DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>
Esempio
Nell'esempio seguente viene impostato il valore DialogflowVersion su CX:
<DialogflowVersion>CX</DialogflowVersion>
Codici di errore
Questa sezione descrive i codici e i messaggi di errore che vengono restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi quando il criterio viene eseguito.
| Codice di errore | 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 di sessione supportato, vedi Class SessionInfo. | |
steps.parsedialogflowrequest.MalformedInput |
500 |
Questo errore si verifica quando il JSON fornito a questo criterio non è valido o è in un formato non valido. |
Errori di deployment
Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.
| Nome 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. Molte volte, i messaggi di errore generati dal sistema potrebbero non essere pertinenti nel contesto del prodotto. Per rendere i messaggi più significativi, potresti voler personalizzare i messaggi in base al tipo.
Per personalizzare i messaggi di errore, puoi utilizzare regole di errore o il criterio AlzaFault. Per
informazioni sulle differenze tra le regole di errore e il criterio AlzaFault, consulta
Confronto tra le regole di errore e il criterio AlzaFault.
Devi verificare le condizioni utilizzando l'elemento Condition sia nelle regole di errore sia nel criterio AlzaFault.
Apigee fornisce variabili di errore univoche per ciascun criterio e i relativi valori vengono impostati quando un criterio attiva gli errori di runtime.
Utilizzando queste variabili, puoi verificare le condizioni di errore specifiche e intraprendere le azioni appropriate. Per saperne di più sul controllo delle condizioni di errore, consulta Condizioni degli edifici.
La tabella seguente descrive le variabili di errore specifiche di questo criterio.
| Variabili | Dove | Esempio |
|---|---|---|
fault.name="FAULT_NAME" |
FAULT_NAME è il nome dell'errore, come elencato nella tabella Errori di runtime. Il nome del guasto è l'ultima parte del codice di 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 di proxy e flussi condivisi Apigee che mostrano l'utilizzo del criterio ParseDialogflowRequest sono disponibili su GitHub di Apigee. Per maggiori informazioni, consulta Implementazioni di riferimento per l'IA conversazionale.