Halaman ini berlaku untuk Apigee dan Apigee hybrid.
Lihat dokumentasi
Apigee Edge.
Kebijakan SetDialogflowResponse memfasilitasi integrasi Dialogflow dengan Apigee. Untuk mengetahui informasi selengkapnya, lihat Mengintegrasikan Apigee dengan Contact Center AI.
Kebijakan SetDialogflowResponse memproses dan memformat data respons dari sistem backend Anda sebelum mengirimkan data sebagai WebhookResponse ke agen Dialogflow. Agen Dialogflow memerlukan WebhookResponse dalam format tertentu, dan kebijakan SetDialogflowResponse membangun respons dalam format yang diperlukan. Kebijakan ini membuat WebhookResponse dalam format yang diperlukan untuk agen Dialogflow. WebhookResponse memiliki frasa bahasa alami dan parameter lain yang dipahami oleh agen Dialogflow.
Jika Anda adalah integrator layanan backend, Anda tidak perlu meluangkan waktu untuk memahami format WebhookResponse Dialogflow. Kebijakan SetDialogflowResponse siap pakai menangani pemrosesan data respons dengan lancar.
Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaannya, lihat Jenis kebijakan.
<SetDialogflowResponse>
Menentukan kebijakan SetDialogflowResponse.
| Nilai Default | T/A |
| Wajib? | Wajib |
| Jenis | Objek kompleks |
| Elemen Induk | T/A |
| Elemen Turunan |
<DisplayName><Source><DialogflowVersion><NaturalLanguageResponse><Parameters><IgnoreUnresolvedVariables> |
Tabel berikut memberikan deskripsi umum semua elemen turunan
dari elemen SetDialogflowResponse:
| Elemen Turunan | Wajib? | Deskripsi |
|---|---|---|
<DisplayName> |
Opsional | Nama kustom untuk kebijakan. |
<Source> |
Opsional | Menentukan variabel yang akan diuraikan. |
<DialogflowVersion> |
Opsional | Menentukan versi Dialogflow. |
<NaturalLanguageResponse> |
Opsional | Mencakup semua konten yang harus dikirim sebagai objek WebhookResponse.FulfillmentResponse. |
<Parameters> |
Opsional | Elemen induk dari <Parameter>. Menentukan kumpulan parameter yang akan ditetapkan dalam respons Webhook. |
<IgnoreUnresolvedVariables> |
Opsional | Menentukan apakah pemrosesan berhenti saat variabel yang belum diselesaikan ditemukan. |
| Elemen turunan lainnya | ||
<MergeBehavior> |
Opsional | Menentukan perilaku penggabungan untuk pesan respons. |
<Header> |
Opsional | Mengekstrak nilai kolom yang ditentukan di header respons. |
<JSONPath> |
Opsional | Mengekstrak nilai jalur JSON yang ditentukan. |
<Parameter> |
Wajib | Menentukan parameter yang akan ditetapkan dalam objek sessionInfo.parameters respons Webhook. |
<Phrase> |
Wajib | Menentukan frasa (teks) yang akan ditetapkan dalam objek fulfillmentResponse.messages respons Webhook. |
<Phrases> |
Opsional | Elemen induk dari <Phrase>. Menentukan kumpulan frasa bahasa alami yang akan ditetapkan dalam respons Webhook. |
<Ref> |
Opsional | Mengekstrak nilai variabel referensi yang ditentukan. |
<Value> |
Opsional | Menetapkan teks kustom ke parameter yang ditentukan. |
Contoh
Contoh berikut menunjukkan contoh kebijakan SetDialogflowResponse dan WebhookResponse yang dikirim ke agen Dialogflow:
Sintaksis
<?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>
Kebijakan SetDialogflowResponse
Contoh berikut menunjukkan definisi kebijakan 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>
Buka contoh berikutnya untuk melihat respons Webhook yang dibuat oleh kebijakan ini.
Respons webhook
Contoh berikut menunjukkan WebhookResponse yang dikirim ke agen 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 } } }
Elemen ini memiliki atribut berikut yang umum untuk semua kebijakan:
| Atribut | Default | Wajib? | Deskripsi |
|---|---|---|---|
name |
T/A | Wajib |
Nama internal kebijakan. Nilai atribut Secara opsional, gunakan elemen |
continueOnError |
false | Opsional | Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk
sebagian besar kebijakan. Tetapkan ke true agar eksekusi alur berlanjut meskipun setelah kebijakan gagal. Lihat juga:
|
enabled |
benar | Opsional | Tetapkan ke true untuk menerapkan kebijakan. Tetapkan ke false untuk menonaktifkan
kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur. |
async |
false | Tidak digunakan lagi | Atribut ini tidak digunakan lagi. |
Referensi elemen turunan
Bagian ini menjelaskan elemen turunan<SetDialogflowResponse>.
<DisplayName>
Gunakan selain atribut name untuk memberi label pada kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih terdengar alami.
Elemen <DisplayName> umum untuk semua kebijakan.
| Nilai Default | T/A |
| Wajib? | Opsional. Jika Anda menghilangkan <DisplayName>, nilai atribut name kebijakan akan digunakan. |
| Jenis | String |
| Elemen Induk | <PolicyElement> |
| Elemen Turunan | Tidak ada |
Elemen <DisplayName> menggunakan sintaksis berikut:
Sintaks
<PolicyElement> <DisplayName>POLICY_DISPLAY_NAME</DisplayName> ... </PolicyElement>
Contoh
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.
<Source>
Menentukan variabel yang akan diuraikan. Nilai
<Source> secara default adalah message. Nilai message
peka konteks. Dalam alur permintaan, message diselesaikan ke pesan permintaan. Dalam
alur respons, message diselesaikan ke pesan respons.
Meskipun Anda sering menggunakan kebijakan ini untuk mengekstrak informasi dari pesan permintaan atau respons, Anda
dapat menggunakannya untuk mengekstrak informasi dari variabel apa pun. Misalnya, Anda dapat menggunakannya untuk mengekstrak
informasi dari entitas yang dibuat oleh kebijakan AccessEntity, dari data
yang ditampilkan oleh kebijakan ServiceCallout, atau mengekstrak informasi dari objek XML atau JSON.
Jika <Source> tidak dapat diselesaikan, atau diselesaikan ke jenis non-pesan,
kebijakan akan gagal dan Anda akan mendapatkan error runtime.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<SetDialogflowResponse>
|
| Elemen Turunan | Tidak ada |
<Source> menggunakan sintaksis berikut:
Sintaksis
<Source>MESSAGE_VARIABLE</Source>
Contoh
Contoh berikut menetapkan Sumber ke myMessageVar:
<Source>myMessageVar</Source>
<DialogflowVersion>
Menentukan versi Dialogflow. Kebijakan SetDialogflowResponse hanya mendukung versi CX. Jika Anda tidak menentukan elemen ini dalam kebijakan, versi defaultnya adalah CX.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<SetDialogflowResponse>
|
| Elemen Turunan | Tidak ada |
<DialogflowVersion> menggunakan sintaksis berikut:
Sintaksis
<DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>
Contoh
Contoh berikut menetapkan DialogflowVersion ke CX:
<DialogflowVersion>CX</DialogflowVersion>
<IgnoreUnresolvedVariables>
Menentukan apakah pemrosesan berhenti saat variabel yang belum diselesaikan ditemukan.
| Nilai Default | Benar |
| Wajib? | Opsional |
| Jenis | Boolean |
| Elemen Induk |
<SetDialogflowResponse>
|
| Elemen Turunan | Tidak ada |
Setel ke true untuk mengabaikan variabel yang belum diselesaikan dan melanjutkan pemrosesan; jika tidak, setel ke false. Nilai
defaultnya adalah true.
Menetapkan <IgnoreUnresolvedVariables> ke true berbeda dengan menetapkan continueOnError <SetDialogflowResponse> ke true. Jika Anda menetapkan continueOnError ke true, Apigee akan mengabaikan semua error, bukan
hanya error dalam variabel.
Elemen <IgnoreUnresolvedVariables> menggunakan sintaksis berikut:
Sintaksis
<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
Contoh
Contoh berikut menetapkan <IgnoreUnresolvedVariables> ke false:
<IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
<MergeBehavior>
Menentukan perilaku penggabungan untuk pesan respons. Anda dapat menentukan salah satu nilai berikut:
APPEND: Menambahkan pesan ke daftar pesan yang menunggu untuk dikirim ke pengguna.REPLACE: Menggantikan pesan lama dengan pesan baru dalam daftar pesan yang menunggu untuk dikirim kepada pengguna.
APPEND.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<NaturalLanguageResponse>
|
| Elemen Turunan | Tidak ada |
<MergeBehavior> menggunakan sintaksis berikut:
Sintaksis
<MergeBehavior>BEHAVIOR</MergeBehavior>
Contoh
Contoh berikut menetapkan perilaku penggabungan ke APPEND:
<MergeBehavior>APPEND</MergeBehavior>
<NaturalLanguageResponse>
Mencakup semua respons bahasa alami yang ingin Anda kirim ke agen Dialogflow.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | Objek Kompleks |
| Elemen Induk |
<SetDialogflowResponse>
|
| Elemen Turunan |
<MergeBehavior><Phrases> |
<Parameters>
Menentukan kumpulan parameter yang akan ditetapkan dalam respons Webhook. Nama parameter adalah sebagai atribut elemen
<Parameter>.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | Objek Kompleks |
| Elemen Induk |
<SetDialogflowResponse>
|
| Elemen Turunan |
<Parameter>
|
<Parameter>
Menentukan parameter yang akan ditetapkan dalam objek sessionInfo.parameters dari respons Webhook.
Anda dapat menentukan teks statis sebagai nilai parameter atau mengekstrak nilai dari salah satu kolom berikut dalam respons:
- Kolom header respons
- Payload JSON
- Variabel alur
Anda harus menentukan elemen <Parameter> terpisah untuk setiap nilai yang ingin Anda ekstrak.
| Nilai Default | T/A |
| Wajib? | Wajib |
| Jenis | Objek Kompleks |
| Elemen Induk |
<Parameters>
|
| Elemen Turunan |
<Header><JSONPath><Ref><Value> |
<Parameter> memiliki atribut berikut:
| Atribut | Deskripsi | Wajib? | Jenis |
|---|---|---|---|
name |
Nama variabel yang akan dibuat dengan parameter ini. | Ya | String |
Elemen <Parameter> menggunakan sintaksis berikut:
Sintaksis
<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>
Mengekstrak nilai kolom Header
Contoh ini menetapkan parameter timeSpent ke nilai kolom header X-Time-Spent.
<Parameter name="timeSpent">
<Header name="X-Time-Spent"/>
</Parameter>Mengekstrak nilai jalur JSON
Contoh ini menetapkan parameter claimAmount ke nilai kolom claim.amount dalam payload JSON.
<Parameter name="claimAmount"> <JSONPath>$.claim.amount</JSONPath> </Parameter>
Mengekstrak nilai variabel alur
Contoh ini menetapkan parameter myVar ke nilai variabel alur dialogflow.my.var.
<Parameter name="myVar"> <Ref>dialogflow.my.var</Ref> </Parameter>
Menetapkan teks kustom
Contoh ini menetapkan nilai parameter responder ke SYSTEM.
<Parameter name="responder"> <Value>SYSTEM</Value> </Parameter>
<Phrases>
Elemen induk dari <Phrase>. Menentukan daftar frasa bahasa alami yang diurutkan untuk ditetapkan dalam
respons Webhook.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | Objek Kompleks |
| Elemen Induk |
<NaturalLanguageResponse>
|
| Elemen Turunan |
<Phrase>
|
<Phrase>
Menentukan frasa (teks) yang akan ditetapkan dalam objek fulfillmentResponse.messages dari respons Webhook.
Anda dapat menentukan teks statis sebagai nilai frasa atau mengekstrak nilai dari salah satu kolom berikut dalam respons:
- Kolom header respons
- Payload JSON
- Variabel alur
Anda harus menentukan elemen <Phrase> terpisah untuk setiap nilai yang ingin diekstrak.
| Nilai Default | T/A |
| Wajib? | Wajib |
| Jenis | Objek Kompleks |
| Elemen Induk |
<Phrases>
|
| Elemen Turunan |
<Header><JSONPath><Ref><Value> |
Elemen <Phrase> menggunakan sintaksis berikut:
Sintaksis
<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>Mengekstrak nilai kolom Header
Contoh ini menetapkan teks bahasa alami dalam respons ke nilai
kolom header X-Response-Text.
<Phrase>
<Header name="X-Response-Text"/>
</Phrase>Mengekstrak nilai jalur JSON
Contoh ini menetapkan teks bahasa alami dalam respons ke nilai kolom
claim.status.text dalam payload JSON.
<Phrase> <JSONPath>$.claim.status.text</JSONPath> </Phrase>
Mengekstrak nilai variabel alur
Contoh ini menetapkan teks bahasa alami dalam respons ke nilai variabel alur myVar.
<Phrase>
<Ref>myVar</Ref>
</Phrase>
Menetapkan teks kustom
Contoh ini menambahkan teks You call is important to us ke teks bahasa alami dalam respons.
<Phrase> <Value>You call is important to us</Value> </Phrase>
<Header>
Mengekstrak nilai dari kolom yang ditentukan di header respons. Anda dapat menggunakan nilai header untuk menetapkan teks bahasa natural atau parameter respons.
- Untuk mengekstrak nilai header sebagai respons bahasa alami, tentukan elemen
<Header>di dalam elemen<Phrase>. - Untuk mengekstrak nilai header sebagai parameter respons, tentukan elemen
<Header>di dalam elemen<Parameter>.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<Phrase><Parameter> |
| Elemen Turunan | Tidak ada |
<Header> menggunakan sintaksis berikut:
Sintaksis
<Header name="HEADER_FIELD"/>
Contoh 1
Contoh berikut mendapatkan nilai kolom header X-Response-Text sebagai respons bahasa alami:
<Phrase> <Header name="X-Response-Text"/> <Phrase/>
Contoh 2
Contoh berikut mendapatkan nilai kolom header X-Response-Text sebagai parameter respons:
<Parameter name="timeSpent"> <Header name="X-Response-Text"/> <Parameter/>
Variabel alur timeSpent disetel ke nilai kolom header X-Response-Text.
Elemen <Header> memiliki atribut berikut:
| Atribut | Deskripsi | Wajib? | Jenis |
|---|---|---|---|
| nama | Menentukan nama header respons tempat Anda mengekstrak nilai. | Wajib | String |
<JSONPath>
Mengekstrak nilai jalur JSON dalam payload JSON dari panggilan layanan. Anda dapat menggunakan nilai tersebut untuk menetapkan teks bahasa natural atau parameter respons.
- Untuk mengekstrak nilai JSON sebagai teks bahasa alami, tentukan elemen
<JSONPath>di dalam elemen<Phrase>. - Untuk mengekstrak nilai JSON sebagai parameter respons, tentukan elemen
<JSONPath>di dalam elemen<Parameter>.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<Phrase><Parameter> |
| Elemen Turunan | Tidak ada |
<JSONPath> menggunakan sintaksis berikut:
Sintaksis
<JSONPath>JSON_PATH</JSONPath>
Contoh 1
Contoh berikut mendapatkan nilai kolom JSON claim.status.text sebagai respons bahasa alami:
<Phrase> <JSONPath>$.claim.status.text</JSONPath> <Phrase/>
Contoh 2
Contoh berikut mendapatkan nilai kolom JSON claim.amount sebagai parameter respons:
<Parameter name="claimAmount"> <JSONPath>$.claim.amount.</JSONPath> <Parameter/>
Variabel alur claimAmount ditetapkan ke nilai kolom JSON {claim.amount}.
<Ref>
Mengekstrak nilai variabel alur yang ada. Anda dapat menggunakan nilai tersebut untuk menetapkan teks bahasa natural atau parameter respons.
- Untuk mengekstrak nilai variabel sebagai teks bahasa alami, tentukan elemen
<Ref>di dalam elemen<Phrase>. - Untuk mengekstrak nilai variabel sebagai parameter respons, tentukan elemen
<Ref>di dalam elemen<Parameter>.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<Phrase><Parameter> |
| Elemen Turunan | Tidak ada |
<Ref> menggunakan sintaksis berikut:
Sintaksis
<Ref>EXISTING_FLOW_VARIABLE</Ref>
Contoh 1
Contoh berikut mendapatkan nilai variabel alur myVar sebagai respons bahasa alami:
<Phrase> <Ref>myVar</Ref> <Phrase/>
Contoh 2
Contoh berikut mendapatkan nilai variabel alur dialogflow.my.var sebagai parameter respons:
<Parameter name="customVar"> <Ref>dialogflow.my.var</Ref> <Parameter/>
Variabel alur customVar disetel ke nilai variabel dialogflow.my.var.
<Value>
Menetapkan nilai literal ke teks bahasa alami atau parameter respons.
- Untuk menetapkan nilai literal sebagai teks bahasa alami, tentukan elemen
<Value>di dalam elemen<Phrase>. - Untuk menetapkan nilai literal sebagai parameter respons, tentukan elemen
<Value>di dalam elemen<Parameter>.
| Nilai Default | T/A |
| Wajib? | Opsional |
| Jenis | String |
| Elemen Induk |
<Phrase><Parameter> |
| Elemen Turunan | Tidak ada |
<Value> menggunakan sintaksis berikut:
Sintaksis
<Value>CUSTOM_TEXT</Value>
Contoh 1
Contoh berikut menetapkan teks literal You call is important to us sebagai respons bahasa alami:
<Phrase> <Value>You call is important to us</Value> <Phrase/>
Contoh 2
Contoh berikut menetapkan teks literal SYSTEM sebagai parameter respons:
<Parameter name="responder"> <Value>SYSTEM</Value> <Parameter/>
Variabel alur responder ditetapkan ke SYSTEM.
Kode error
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:
|
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:
|
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 |
Topik terkait
Implementasi referensi proxy Apigee dan alur bersama yang menunjukkan penggunaan kebijakan SetDialogflowResponse tersedia di Apigee GitHub. Untuk mengetahui informasi selengkapnya, lihat Implementasi Referensi AI Percakapan.