Kebijakan ParseDialogflowRequest

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

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

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.

Kebijakan ParseDialogflowRequest memproses WebhookRequest dari agen Dialogflow sebelum mengirim data permintaan ke sistem backend Anda. Kebijakan ini mengekstrak data dari WebhookRequest ke dalam variabel alur yang tersedia untuk Anda selama durasi seluruh panggilan API. Anda dapat menggunakan variabel dalam info tambahan, pencarian, atau logika yang diatur berikutnya. Kebijakan ini sangat berguna jika Anda ingin agen Dialogflow berinteraksi dengan sistem backend lama Anda. Sebelum mengirim data agen ke sistem backend, Anda dapat mem-parsing data dan menyusunnya sedemikian rupa sehingga dapat digunakan oleh sistem backend Anda.

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

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

NOTE: Kebijakan ParseDialogflowRequest hanya mem-parsing objek fulfillmentInfo.tag, sentimentAnalysisResult, dan sessionInfo dalam Permintaan Dialogflow.

`<ParseDialogflowRequest>`

Menentukan kebijakan ParseDialogflowRequest.

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

Tabel berikut memberikan deskripsi umum 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 menunjukkan 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>

Lanjutkan ke 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 flow yang dihasilkan dimulai dengan google.dialogflow, diikuti dengan awalan (my-prefix) seperti yang ditentukan dalam elemen <VariablePrefix>.

This element has the following attributes that are common to all policies:

Attribute	Default	Required?	Description
`name`	N/A	Required	The internal name of the policy. The value of the `name` attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters. Optionally, use the `<DisplayName>` element to label the policy in the management UI proxy editor with a different, natural-language name.
`continueOnError`	false	Optional	Set to `false` to return an error when a policy fails. This is expected behavior for most policies. Set to `true` to have flow execution continue even after a policy fails. See also: Fault rules are triggered ONLY in an error state (about continueOnError) Handling faults within the current flow
`enabled`	true	Optional	Set to `true` to enforce the policy. Set to `false` to turn off the policy. The policy will not be enforced even if it remains attached to a flow.
`async`	false	Deprecated	This attribute is deprecated.

Referensi elemen turunan

Bagian ini menjelaskan elemen turunan <ParseDialogflowRequest>.

`<DisplayName>`

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, more natural-sounding name.

The <DisplayName> element is common to all policies.

Default Value	N/A
Required?	Optional. If you omit `<DisplayName>`, the value of the policy's `name` attribute is used.
Type	String
Parent Element	<`PolicyElement`>
Child Elements	None

The <DisplayName> element uses the following syntax:

Syntax

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

Example

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

The <DisplayName> element has no attributes or child elements.

`<VariablePrefix>`

Menentukan awalan kustom untuk variabel alur. Nilai yang ditentukan dalam elemen ini ditambahkan sebagai awalan ke semua nama variabel yang dihasilkan oleh kebijakan ParseDialogflowRequest. Secara default, semua variabel yang dihasilkan oleh kebijakan diberi awalan 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 diawali dengan google.dialogflow.

Nilai Default	T/A
Wajib?	Opsional
Jenis	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 konfigurasi ini, semua nama variabel dimulai 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 defaultnya adalah CX.

Nilai Default	T/A
Wajib?	Opsional
Jenis	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 error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dijalankan.

Kode kerusakan	Status HTTP	Penyebab	Perbaiki
`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 informasi tentang format sesi yang didukung, lihat Class SessionInfo.
`steps.parsedialogflowrequest.MalformedInput`	`500`	Error ini terjadi jika JSON yang diberikan ke kebijakan ini tidak valid atau salah formatnya.

Error saat deployment

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

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

Variabel error

Setiap kali ada 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 untuk membuat pesan lebih bermakna.

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

Tabel berikut menjelaskan variabel error khusus untuk kebijakan ini.

Variabel	Dari mana	Contoh
`fault.name="FAULT_NAME"`	`FAULT_NAME` adalah nama error, seperti yang tercantum dalam tabel Runtime errors. Nama error adalah bagian terakhir dari kode error.	`fault.name Matches "UnresolvedVariable"`
`ParseDialogflowRequest.POLICY_NAME.failed`	`POLICY_NAME` adalah nama kebijakan yang ditentukan pengguna yang menampilkan error.	`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.

Kebijakan ParseDialogflowRequest Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

<ParseDialogflowRequest>

Contoh

Sintaksis

Permintaan webhook

Kebijakan ParseDialogflowRequest

Variabel alur

Referensi elemen turunan

<DisplayName>

Syntax

Example

<VariablePrefix>

Sintaksis

Contoh

<DialogflowVersion>

Sintaksis

Contoh

Kode error

Error runtime

Error saat deployment

Variabel error

Topik terkait

Kebijakan ParseDialogflowRequest

`<ParseDialogflowRequest>`

`<DisplayName>`

`<VariablePrefix>`

`<DialogflowVersion>`