Halaman ini diterjemahkan oleh Cloud Translation API.

Kebijakan ParseDialogflowRequest

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

Ringkasan

Kebijakan ParseDialogflowRequest memfasilitasi integrasi Dialogflow dengan Apigee. Untuk mengetahui informasi selengkapnya, lihat Mengintegrasikan Apigee dengan Contact Center AI.

Kebijakan ini merupakan Kebijakan yang dapat diperluas, dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau pemanfaatan, bergantung pada lisensi Apigee Anda. Untuk mengetahui informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

Kebijakan ParseDialogflowRequest memproses WebhookRequest dari agen Dialogflow sebelum mengirimkan data permintaan ke sistem backend Anda. Kebijakan ini mengekstrak data dari WebhookRequest ke dalam variabel alur yang tersedia untuk Anda selama durasi panggilan API keseluruhan. Anda dapat menggunakan variabel tersebut dalam info, pencarian, atau logika terorkestrasi berikutnya. Kebijakan ini sangat berguna jika Anda ingin agen Dialogflow berinteraksi dengan sistem backend lama. Sebelum mengirim data agen ke sistem backend, Anda dapat mengurai data dan menyusunnya dengan cara yang dapat digunakan oleh sistem backend Anda.

Jika Anda adalah integrator layanan backend, Anda tidak perlu meluangkan waktu untuk memahami format Dialogflow WebhookRequest. Kebijakan ParseDialogflowRequest siap pakai menangani pemrosesan data permintaan dengan lancar.

Untuk mengakses WebhookRequest agen Dialogflow Anda di Apigee, Anda harus menetapkan URL Webhook (fulfillment) agen ke ProxyEndPoint yang telah Anda konfigurasi di Apigee. ProxyEndPoint harus dapat diakses secara publik. Untuk informasi selengkapnya, lihat Persyaratan layanan webhook.

CATATAN: Kebijakan ParseDialogflowRequest hanya menguraikan objek fulfillmentInfo.tag, sentimentAnalysisResult, dan sessionInfo dalam Permintaan Dialogflow.

`<ParseDialogflowRequest>`

Menentukan kebijakan ParseDialogflowRequest.

Nilai Default	T/A
Wajib?	Diperlukan
Type	Objek kompleks
Elemen Induk	T/A
Elemen Turunan	`<DialogflowVersion>` `<DisplayName>` `<VariablePrefix>`

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan yang khusus untuk kebijakan ParseDialogflowRequest:

Elemen Turunan	Wajib?	Deskripsi
`<VariablePrefix>`	Opsional	Menentukan awalan kustom untuk variabel alur.
`<DialogflowVersion>`	Opsional	Menentukan versi Dialogflow.

Contoh

Contoh berikut menunjukkan contoh permintaan webhook, kebijakan ParseDialogflowRequest yang sesuai, dan variabel alur yang dihasilkan setelah menerapkan kebijakan:

Sintaksis

<?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>

Permintaan webhook

Contoh berikut menampilkan permintaan webhook (dalam format JSON) dari agen 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
  }
}

Untuk melihat berbagai kolom yang dapat Anda konfigurasi dalam permintaan, lihat WebhookRequest.

Buka contoh berikutnya untuk melihat konfigurasi kebijakan ParseDialogflowRequest.

Kebijakan 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>

Buka contoh berikutnya untuk melihat variabel alur yang dibuat oleh kebijakan.

Variabel alur

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

Semua variabel alur yang dihasilkan dimulai dengan google.dialogflow diikuti dengan awalan (my-prefix) seperti yang ditetapkan dalam elemen <VariablePrefix>.

Elemen ini memiliki atribut berikut yang sama untuk semua kebijakan:

Atribut	Default	Wajib?	Deskripsi
`name`	T/A	Wajib	Nama internal kebijakan. Nilai atribut `name` dapat berisi huruf, angka, spasi, tanda hubung, garis bawah, dan titik. Nilai ini tidak boleh melebihi 255 karakter. Atau, gunakan elemen `<DisplayName>` untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama natural-language yang berbeda.
`continueOnError`	false	Opsional	Setel ke `false` untuk menampilkan error jika kebijakan gagal. Ini adalah perilaku yang wajar untuk sebagian besar kebijakan. Setel ke `true` agar eksekusi alur tetap berlanjut bahkan setelah kebijakan gagal. Lihat juga: Aturan error HANYA dipicu dalam status error (tentang continueOnError) Menangani kesalahan dalam alur saat ini
`enabled`	true	Opsional	Setel ke `true` untuk menerapkan kebijakan. Setel ke `false` untuk menonaktifkan kebijakan. Kebijakan tidak akan diterapkan meskipun tetap melekat pada alur.
`async`	false	Tidak digunakan lagi	Atribut ini sudah tidak digunakan lagi.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <ParseDialogflowRequest>.

`<DisplayName>`

Gunakan selain atribut name untuk memberi label kebijakan di editor proxy UI pengelolaan dengan nama yang berbeda dan lebih alami.

Elemen <DisplayName> bersifat 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:

Sintaksis

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

Contoh

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

Elemen <DisplayName> tidak memiliki atribut atau elemen turunan.

`<VariablePrefix>`

Menentukan awalan kustom untuk variabel alur. Nilai yang ditentukan dalam elemen ini diawali dengan semua nama variabel yang dihasilkan oleh kebijakan ParseDialogflowRequest. Secara default, semua variabel yang dihasilkan oleh kebijakan diawali dengan google.dialogflow. Jika Anda telah menentukan elemen VariablePrefix, awalan kustom Anda akan ditambahkan setelah google.dialogflow. Oleh karena itu, nama variabel dimulai dengan google.dialogflow.CUSTOM_PREFIX.

Jika Anda tidak menentukan elemen VariablePrefix, nama variabel hanya akan diawali dengan google.dialogflow.

Nilai Default	T/A
Wajib?	Opsional
Type	String
Elemen Induk	`<ParseDialogflowRequest>`
Elemen Turunan	Tidak ada

Elemen <VariablePrefix> menggunakan sintaksis berikut:

Sintaksis

<VariablePrefix>VARIABLE_PREFIX</VariablePrefix>

Contoh

Contoh berikut menetapkan VariablePrefix ke my-prefix:

<VariablePrefix>my-custom-prefix</VariablePrefix>

Sesuai dengan konfigurasi ini, semua nama variabel diawali dengan google.dialogflow.my-custom-prefix.

`<DialogflowVersion>`

Menentukan versi Dialogflow. Kebijakan ParseDialogflowRequest hanya mendukung versi CX. Jika Anda tidak menentukan elemen ini dalam kebijakan, versi akan ditetapkan secara default ke CX.

Nilai Default	T/A
Wajib?	Opsional
Type	String
Elemen Induk	T/A
Elemen Turunan	Tidak ada

Elemen <DialogflowVersion> menggunakan sintaksis berikut:

Sintaksis

<DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>

Contoh

Contoh berikut menetapkan DialogflowVersion ke CX:

<DialogflowVersion>CX</DialogflowVersion>

Kode error

Bagian ini menjelaskan kode kesalahan dan pesan error yang ditampilkan dan variabel kesalahan yang disetel oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui apakah Anda mengembangkan aturan kesalahan untuk menangani kesalahan. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani kesalahan.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kesalahan	Status HTTP	Penyebab	Perbaikan
`steps.parsedialogflowrequest.InvalidSessionInfo`	`500`	Error ini terjadi jika ada kolom sessionInfo.session yang tidak valid dalam permintaan Dialogflow. Webhook dapat menggunakan kolom ini untuk mengidentifikasi sesi. Untuk mengetahui informasi tentang format sesi yang didukung, lihat Class SessionInfo.
`steps.parsedialogflowrequest.MalformedInput`	`500`	Error ini terjadi jika JSON yang diberikan untuk kebijakan ini tidak valid atau formatnya salah.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Nama error	Penyebab	Perbaikan
`UnsupportedOperation`	Error ini terjadi jika Anda telah menentukan versi Dialogflow yang tidak didukung dalam elemen `DialogflowVersion`. Kebijakan ParseDialogflowRequest hanya mendukung versi `CX`.

Variabel kesalahan

Setiap kali terjadi error eksekusi dalam kebijakan, Apigee akan menghasilkan pesan error. Anda dapat melihat pesan error ini dalam respons error. Sering kali, pesan error yang dihasilkan sistem mungkin tidak relevan dalam konteks produk Anda. Anda mungkin ingin menyesuaikan pesan error berdasarkan jenis error agar pesan menjadi lebih bermakna.

Untuk menyesuaikan pesan error, Anda dapat menggunakan aturan kesalahan atau kebijakan RaiseFault. Untuk mengetahui informasi tentang perbedaan antara aturan fault dan kebijakan RaiseFault, lihat kebijakan FaultRules vs. RaiseFault. Anda harus memeriksa kondisi menggunakan elemen Condition di aturan fault dan kebijakan RaiseFault. Apigee menyediakan variabel kesalahan yang unik untuk setiap kebijakan dan nilai variabel kesalahan ditetapkan saat kebijakan memicu error runtime. Dengan menggunakan variabel ini, Anda dapat memeriksa kondisi error tertentu dan mengambil tindakan yang sesuai. Untuk mengetahui informasi selengkapnya tentang cara memeriksa kondisi error, lihat Mem-build kondisi.

Tabel berikut menjelaskan variabel kesalahan khusus untuk kebijakan ini.

Variabel	Dari mana	Contoh
`fault.name="FAULT_NAME"`	`FAULT_NAME` adalah nama kesalahan, seperti yang tercantum dalam tabel Error runtime. Nama kesalahan adalah bagian terakhir dari kode kesalahan.	`fault.name Matches "UnresolvedVariable"`
`ParseDialogflowRequest.POLICY_NAME.failed`	`POLICY_NAME` adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan.	`ParseDialogflowRequest.My-Parse-Dialogflow-Req.failed = true`

Untuk informasi selengkapnya tentang error kebijakan, lihat Yang perlu Anda ketahui tentang error kebijakan.

Topik terkait

Implementasi referensi proxy Apigee dan alur bersama yang menunjukkan penggunaan kebijakan ParseDialogflowRequest tersedia di GitHub Apigee. Untuk mengetahui informasi selengkapnya, lihat Implementasi Referensi AI Percakapan.