GetSession

Mengembalikan informasi sesi untuk bot tertentu, alias, dan ID pengguna.

Minta Sintaks

GET /bot/botName/alias/botAlias/user/userId/session/?checkpointLabelFilter=checkpointLabelFilter HTTP/1.1

Parameter Permintaan URI

Permintaan menggunakan parameter URI berikut.

botAlias

Alias yang digunakan untuk bot yang berisi data sesi.

Diperlukan: Ya

botName

Nama bot yang berisi data sesi.

Diperlukan: Ya

checkpointLabelFilter

String yang digunakan untuk memfilter maksud yang dikembalikan dalam recentIntentSummaryView struktur.

Saat Anda menentukan filter, hanya maksud dengan checkpointLabel bidangnya disetel ke string itu yang dikembalikan.

Batasan Panjang: Panjang minimum 1. Panjang maksimum 255.

Pola: [a-zA-Z0-9-]+

userId

ID pengguna aplikasi klien. Amazon Lex menggunakan ini untuk mengidentifikasi percakapan pengguna dengan bot Anda.

Kendala Panjang: Panjang minimum 2. Panjang maksimum 100.

Pola: [0-9a-zA-Z._:-]+

Wajib: Ya

Isi Permintaan

Permintaan tidak memiliki isi permintaan.

Sintaks Respons

HTTP/1.1 200
Content-type: application/json

{
   "activeContexts": [ 
      { 
         "name": "string",
         "parameters": { 
            "string" : "string" 
         },
         "timeToLive": { 
            "timeToLiveInSeconds": number,
            "turnsToLive": number
         }
      }
   ],
   "dialogAction": { 
      "fulfillmentState": "string",
      "intentName": "string",
      "message": "string",
      "messageFormat": "string",
      "slots": { 
         "string" : "string" 
      },
      "slotToElicit": "string",
      "type": "string"
   },
   "recentIntentSummaryView": [ 
      { 
         "checkpointLabel": "string",
         "confirmationStatus": "string",
         "dialogActionType": "string",
         "fulfillmentState": "string",
         "intentName": "string",
         "slots": { 
            "string" : "string" 
         },
         "slotToElicit": "string"
      }
   ],
   "sessionAttributes": { 
      "string" : "string" 
   },
   "sessionId": "string"
}

Elemen Respons

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

Layanan mengembalikan data berikut dalam format JSON.

activeContexts

Daftar konteks aktif untuk sesi tersebut. Konteks dapat diatur ketika maksud terpenuhi atau dengan memanggilPostContent,PostText, atau PutSession operasi.

Anda dapat menggunakan konteks untuk mengontrol maksud yang dapat menindaklanjuti intent, atau untuk memodifikasi operasi aplikasi Anda.

Tipe: Array objek ActiveContext

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 20 item.

dialogAction

Menjelaskan keadaan bot saat ini.

Tipe: Objek DialogAction

recentIntentSummaryView

Array informasi tentang maksud yang digunakan dalam sesi. Array dapat berisi maksimal tiga ringkasan. Jika lebih dari tiga maksud digunakan dalam sesi, recentIntentSummaryView operasi berisi informasi tentang tiga maksud terakhir yang digunakan.

Jika Anda mengatur checkpointLabelFilter parameter dalam permintaan, array hanya berisi maksud dengan label yang ditentukan.

Tipe: Array objek IntentSummary

Anggota Array: Jumlah minimum 0 item. Jumlah maksimum 3 item.

sessionAttributes

Peta pasangan kunci/nilai yang mewakili informasi konteks khusus sesi. Ini berisi informasi aplikasi yang diteruskan antara Amazon Lex dan aplikasi klien.

Tipe: Peta string ke string

sessionId

Pengenal unik untuk sesi tersebut.

Jenis: String

Kesalahan

BadRequestException

Validasi permintaan gagal, tidak ada pesan yang dapat digunakan dalam konteksnya, atau pembuatan bot gagal, masih dalam proses, atau berisi perubahan yang belum dibangun.

Kode Status HTTP: 400

InternalFailureException

Kesalahan layanan internal. Coba lagi panggilannya.

Kode Status HTTP: 500

LimitExceededException

Melebihi batas.

Kode Status HTTP: 429

NotFoundException

Sumber daya (seperti bot Amazon Lex atau alias) yang disebut tidak ditemukan.

Kode Status HTTP: 404

Lihat Juga

Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini:

• AWS Antarmuka Baris Perintah

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK untuk V3 JavaScript

• AWS SDK for PHP V3

• AWS SDK untuk Python

• AWS SDK for Ruby V3