Kebijakan SetDialogflowResponse

Halaman ini berlaku untuk Apigee dan Apigee Hybrid.

Baca dokumentasi Apigee Edge.

ikon kebijakan

Ringkasan

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 mengirim data tersebut 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 agen Dialogflow.

Jika Anda adalah integrator layanan backend, Anda tidak perlu meluangkan waktu untuk memahami format Dialoglfow WebhookResponse. Kebijakan SetDialogflowResponse siap pakai menangani pemrosesan data respons dengan lancar.

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.

<SetDialogflowResponse>

Menentukan kebijakan SetDialogflowResponse.

Nilai Default T/A
Wajib? Diperlukan
Type Objek kompleks
Elemen Induk T/A
Elemen Turunan <DisplayName>
<Source>
<DialogflowVersion>
<NaturalLanguageResponse>
<Parameters>
<IgnoreUnresolvedVariables>

Tabel berikut memberikan deskripsi tingkat tinggi dari semua elemen turunan elemen SetDialogflowResponse:

Elemen Turunan Wajib? Deskripsi
<DisplayName> Opsional Nama kustom untuk kebijakan.
<Source> Opsional Menentukan variabel yang akan diurai.
<DialogflowVersion> Opsional Menentukan versi Dialogflow.
<NaturalLanguageResponse> Opsional Mengenkapsulasi semua konten yang perlu 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 terselesaikan 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> Diperlukan Menentukan parameter yang akan ditetapkan dalam objek sessionInfo.parameters dari respons Webhook.
<Phrase> Diperlukan Menentukan frasa (teks) yang akan ditetapkan dalam objek fulfillmentResponse.messages dari respons Webhook.
<Phrases> Opsional Elemen induk dari <Phrase>. Mendefinisikan kumpulan frasa natural language yang akan ditetapkan dalam respons Webhook.
<Ref> Opsional Mengekstrak nilai variabel referensi yang ditentukan.
<Value> Opsional Menyetel 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 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:
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 <SetDialogflowResponse>.

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

<Source>

Menentukan variabel yang akan diuraikan. Nilai <Source> ditetapkan secara default ke message. Nilai message bersifat sensitif konteks. Dalam alur permintaan, message me-resolve pesan permintaan. Dalam alur respons, message me-resolve ke pesan respons.

Meskipun kebijakan ini sering digunakan 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 entity 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 di-resolve menjadi jenis non-pesan, kebijakan akan gagal dan Anda akan mengalami error runtime.

Nilai Default T/A
Wajib? Opsional
Type String
Elemen Induk <SetDialogflowResponse>
Elemen Turunan Tidak ada
Elemen <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 akan ditetapkan secara default ke CX.

Nilai Default T/A
Wajib? Opsional
Type String
Elemen Induk <SetDialogflowResponse>
Elemen Turunan Tidak ada
Elemen <DialogflowVersion> menggunakan sintaksis berikut:

Sintaksis

<DialogflowVersion>DIALOGFLOW_VERSION</DialogflowVersion>

Contoh

Contoh berikut menetapkan DialogflowVersion ke CX:

<DialogflowVersion>CX</DialogflowVersion>

<IgnoreUnresolvedVariables>

Menentukan apakah pemrosesan berhenti ketika variabel yang belum terselesaikan ditemukan.

Nilai Default Benar
Wajib? Opsional
Type Boolean
Elemen Induk <SetDialogflowResponse>
Elemen Turunan Tidak ada

Tetapkan ke true untuk mengabaikan variabel yang belum terselesaikan dan melanjutkan pemrosesan; jika tidak, 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: Mengganti pesan lama dengan pesan baru di daftar pesan yang menunggu untuk dikirim ke pengguna.
Jika Anda tidak menentukan elemen tersebut, perilaku defaultnya adalah APPEND.
Nilai Default T/A
Wajib? Opsional
Type String
Elemen Induk <NaturalLanguageResponse>
Elemen Turunan Tidak ada
Elemen <MergeBehavior> menggunakan sintaksis berikut:

Sintaksis

<MergeBehavior>BEHAVIOR</MergeBehavior>

Contoh

Contoh berikut menetapkan perilaku penggabungan ke APPEND:

<MergeBehavior>APPEND</MergeBehavior>

<NaturalLanguageResponse>

Melakukan enkapsulasi semua respons natural language yang ingin Anda kirim ke agen Dialogflow.

Nilai Default T/A
Wajib? Opsional
Type Objek Kompleks
Elemen Induk <SetDialogflowResponse>
Elemen Turunan <MergeBehavior>
<Phrases>

<Parameters>

Menentukan kumpulan parameter yang akan ditetapkan dalam respons Webhook. Nama parameter adalah sebagai atribut dari elemen <Parameter>.

Nilai Default T/A
Wajib? Opsional
Type 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 parameter value 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 diekstrak.

Nilai Default T/A
Wajib? Diperlukan
Type Objek Kompleks
Elemen Induk <Parameters>
Elemen Turunan <Header>
<JSONPath>
<Ref>
<Value>
Elemen <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 flow

Contoh ini menetapkan parameter myVar ke nilai variabel alur dialogflow.my.var.

<Parameter name="myVar">
   <Ref>dialogflow.my.var</Ref>
</Parameter>
       

Tetapkan 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 natural language yang diurutkan untuk ditetapkan dalam respons Webhook.

Nilai Default T/A
Wajib? Opsional
Type Objek Kompleks
Elemen Induk <NaturalLanguageResponse>
Elemen Turunan <Phrase>

<Phrase>

Menentukan frasa (text) 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? Diperlukan
Type 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 natural language sebagai respons terhadap nilai kolom header X-Response-Text.

<Phrase>
     <Header name="X-Response-Text"/>
</Phrase>

Mengekstrak nilai jalur JSON

Contoh ini menetapkan teks natural language sebagai respons terhadap nilai kolom claim.status.text dalam payload JSON.

<Phrase>
   <JSONPath>$.claim.status.text</JSONPath>
</Phrase>

Mengekstrak nilai variabel flow

Contoh ini menetapkan teks natural language sebagai respons terhadap nilai variabel alur myVar.

<Phrase>
   <Ref>myVar</Ref>
</Phrase>
       

Tetapkan teks kustom

Contoh ini menambahkan teks You call is important to us ke natural language teks dalam respons.

<Phrase>
   <Value>You call is important to us</Value>
</Phrase>

Mengekstrak nilai dari kolom yang ditentukan di header respons. Anda dapat menggunakan nilai header untuk menyetel natural language text atau parameter respons.

  • Untuk mengekstrak nilai header sebagai respons natural language, 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
Type String
Elemen Induk <Phrase>
<Parameter>
Elemen Turunan Tidak ada
Elemen <Header> menggunakan sintaksis berikut:

Sintaksis

<Header name="HEADER_FIELD"/>

Contoh 1

Contoh berikut mendapatkan nilai kolom header X-Response-Text sebagai respons natural language:

<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
name Menentukan nama header respons tempat Anda mengekstrak nilai. Diperlukan String

<JSONPath>

Mengekstrak nilai jalur JSON dalam payload JSON info layanan. Anda dapat menggunakan nilai ini untuk menetapkan natural language text atau parameter respons.

  • Untuk mengekstrak nilai JSON sebagai natural language, 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
Type String
Elemen Induk <Phrase>
<Parameter>
Elemen Turunan Tidak ada
Elemen <JSONPath> menggunakan sintaksis berikut:

Sintaksis

<JSONPath>JSON_PATH</JSONPath>

Contoh 1

Contoh berikut mendapatkan nilai kolom JSON claim.status.text sebagai respons natural language:

<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 flow yang ada. Anda dapat menggunakan nilai ini untuk menetapkan natural language text atau parameter respons.

  • Untuk mengekstrak nilai variabel sebagai natural language text, 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
Type String
Elemen Induk <Phrase>
<Parameter>
Elemen Turunan Tidak ada
Elemen <Ref> menggunakan sintaksis berikut:

Sintaksis

<Ref>EXISTING_FLOW_VARIABLE</Ref>

Contoh 1

Contoh berikut mendapatkan nilai variabel alur myVar sebagai respons natural language:

<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 natural language atau parameter respons.

  • Untuk menetapkan nilai literal sebagai natural language text, 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
Type String
Elemen Induk <Phrase>
<Parameter>
Elemen Turunan Tidak ada
Elemen <Value> menggunakan sintaksis berikut:

Sintaksis

<Value>CUSTOM_TEXT</Value>

Contoh 1

Contoh berikut menetapkan teks literal You call is important to us sebagai respons natural language:

<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 disetel ke SYSTEM.

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
steps.setdialogflowresponse.ExecutionFailed 500 Error ini terjadi saat eksekusi kebijakan gagal karena pengecualian umum. Pesan kesalahan memiliki detail pengecualian.
steps.setdialogflowresponse.InvalidSourceType 500 Error ini terjadi jika variabel yang ditentukan dalam elemen <Source> bukan jenis message.
steps.setdialogflowresponse.MalformedInput 500 Error ini terjadi jika JSON yang diberikan untuk kebijakan ini tidak valid atau formatnya salah.
steps.setdialogflowresponse.SourceMessageNotAvailable 500 Error ini terjadi jika variabel message yang ditentukan dalam elemen Source kebijakan adalah:
  • Di luar cakupan (tidak tersedia di alur spesifik tempat kebijakan dijalankan)
  • atau
  • Tidak dapat diselesaikan (tidak ditentukan)
steps.setdialogflowresponse.UnresolvedHeader 500 Error ini terjadi jika elemen Header memiliki header yang tidak valid. Misalnya, jika elemen Header memiliki nilai X-Response-Text, dan tidak ada X-Response-Text di header respons, Anda akan mendapatkan error ini.
steps.setdialogflowresponse.UnresolvedJSONPath 500 Error ini terjadi jika elemen JSONPath memiliki jalur yang tidak valid. Misalnya, jika elemen JSONPath memiliki nilai {claim.status.value}, dan tidak ada objek status dalam payload JSON, Anda akan mendapatkan error ini.
steps.setdialogflowresponse.UnresolvedVariable 500

Error ini terjadi jika variabel yang ditentukan dalam kebijakan SetDialogflowResponse adalah:

  • Di luar cakupan (tidak tersedia di alur spesifik tempat kebijakan sedang dijalankan)
  • atau
  • Tidak dapat diselesaikan (tidak ditentukan)

Error saat deployment

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

Nama error Penyebab
UnsupportedOperation Error ini terjadi jika Anda telah menentukan versi Dialogflow yang tidak didukung dalam elemen DialogflowVersion. Kebijakan SetDialogflowResponse 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"
setdialogflowresponse.POLICY_NAME.failed POLICY_NAME adalah nama kebijakan yang ditentukan pengguna yang menampilkan kesalahan. setdialogflowresponse.My-Set-Dialogflow-Response.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 SetDialogflowResponse tersedia di GitHub Apigee. Untuk mengetahui informasi selengkapnya, lihat Implementasi Referensi AI Percakapan.