Jika Anda menggunakan Amazon Lex V2, lihat panduan Amazon Lex V2 sebagai gantinya.
Jika Anda menggunakan Amazon Lex V1, kami sarankan untuk meningkatkan bot Anda ke Amazon Lex V2. Kami tidak lagi menambahkan fitur baru ke V1 dan sangat menyarankan menggunakan V2 untuk semua bot baru.
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
GetBot
Mengembalikan informasi metadata untuk bot tertentu. Anda harus memberikan nama bot dan versi bot atau alias.
Operasi ini memerlukan izin utuk tindakan lex:GetBot
.
Minta Sintaks
GET /bots/name
/versions/versionoralias
HTTP/1.1
Parameter Permintaan URI
Permintaan menggunakan parameter URI berikut.
- name
-
Nama bot. Namanya peka huruf besar/kecil.
Kendala Panjang: Panjang minimum 2. Panjang maksimum 50.
Pola:
^([A-Za-z]_?)+$
Diperlukan: Ya
- versionoralias
-
Versi atau alias bot.
Diperlukan: Ya
Isi Permintaan
Permintaan tidak memiliki isi permintaan.
Sintaks Respons
HTTP/1.1 200
Content-type: application/json
{
"abortStatement": {
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
},
"checksum": "string",
"childDirected": boolean,
"clarificationPrompt": {
"maxAttempts": number,
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
},
"createdDate": number,
"description": "string",
"detectSentiment": boolean,
"enableModelImprovements": boolean,
"failureReason": "string",
"idleSessionTTLInSeconds": number,
"intents": [
{
"intentName": "string",
"intentVersion": "string"
}
],
"lastUpdatedDate": number,
"locale": "string",
"name": "string",
"nluIntentConfidenceThreshold": number,
"status": "string",
"version": "string",
"voiceId": "string"
}
Elemen Respons
Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.
Layanan mengembalikan data berikut dalam format JSON.
- abortStatement
-
Pesan yang dikembalikan Amazon Lex ketika pengguna memilih untuk mengakhiri percakapan tanpa menyelesaikannya. Untuk informasi selengkapnya, lihat PutBot.
Tipe: Objek Statement
- checksum
-
Checksum bot yang digunakan untuk mengidentifikasi revisi spesifik dari versi bot.
$LATEST
Jenis: String
- childDirected
-
Untuk setiap bot Amazon Lex yang dibuat dengan Layanan Pembuatan Model Amazon Lex, Anda harus menentukan apakah penggunaan Amazon Lex Anda terkait dengan situs web, program, atau aplikasi lain yang diarahkan atau ditargetkan, secara keseluruhan atau sebagian, untuk anak-anak di bawah usia 13 tahun dan tunduk pada Undang-Undang Perlindungan Privasi Online Anak (COPPA) dengan menentukan
true
ataufalse
di lapangan.childDirected
Dengan menentukantrue
dichildDirected
lapangan, Anda mengonfirmasi bahwa penggunaan Amazon Lex Anda terkait dengan situs web, program, atau aplikasi lain yang diarahkan atau ditargetkan, secara keseluruhan atau sebagian, untuk anak-anak di bawah usia 13 tahun dan tunduk pada COPPA. Dengan menentukanfalse
dichildDirected
lapangan, Anda mengonfirmasi bahwa penggunaan Amazon Lex Anda tidak terkait dengan situs web, program, atau aplikasi lain yang diarahkan atau ditargetkan, secara keseluruhan atau sebagian, untuk anak-anak di bawah usia 13 tahun dan tunduk pada COPPA. Anda tidak boleh menentukan nilai default untukchildDirected
bidang yang tidak secara akurat mencerminkan apakah penggunaan Amazon Lex Anda terkait dengan situs web, program, atau aplikasi lain yang diarahkan atau ditargetkan, secara keseluruhan atau sebagian, untuk anak-anak di bawah usia 13 tahun dan tunduk pada COPPA.Jika penggunaan Amazon Lex Anda terkait dengan situs web, program, atau aplikasi lain yang diarahkan secara keseluruhan atau sebagian, untuk anak-anak di bawah usia 13 tahun, Anda harus mendapatkan persetujuan orang tua yang dapat diverifikasi berdasarkan COPPA. Untuk informasi mengenai penggunaan Amazon Lex sehubungan dengan situs web, program, atau aplikasi lain yang diarahkan atau ditargetkan, secara keseluruhan atau sebagian, untuk anak-anak di bawah usia 13 tahun, lihat FAQ Amazon Lex
. Jenis: Boolean
- clarificationPrompt
-
Pesan Amazon Lex menggunakan ketika tidak memahami permintaan pengguna. Untuk informasi selengkapnya, lihat PutBot.
Tipe: Objek Prompt
- createdDate
-
Tanggal bot dibuat.
Tipe: Timestamp
- description
-
Deskripsi bot.
Jenis: String
Batasan Panjang: Panjang minimum 0. Panjang maksimum 200.
- detectSentiment
-
Menunjukkan apakah ucapan pengguna harus dikirim ke Amazon Comprehend untuk analisis sentimen.
Jenis: Boolean
- enableModelImprovements
-
Menunjukkan apakah bot menggunakan peningkatan akurasi.
true
menunjukkan bahwa bot menggunakan perbaikan, jika tidak,false
.Jenis: Boolean
- failureReason
-
Jika
status
yaFAILED
, Amazon Lex menjelaskan mengapa gagal membangun bot.Jenis: String
- idleSessionTTLInSeconds
-
Waktu maksimum dalam hitungan detik Amazon Lex menyimpan data yang dikumpulkan dalam percakapan. Untuk informasi selengkapnya, lihat PutBot.
Jenis: Integer
Rentang yang Valid: Nilai minimum 60. Nilai maksimum 86400.
- intents
-
Susunan objek
intent
. Untuk informasi selengkapnya, lihat PutBot.Tipe: Array objek Intent
- lastUpdatedDate
-
Tanggal bot diperbarui. Saat Anda membuat sumber daya, tanggal pembuatan dan tanggal terakhir diperbarui adalah sama.
Tipe: Timestamp
- locale
-
Target lokal untuk bot.
Jenis: String
Nilai yang Valid:
de-DE | en-AU | en-GB | en-IN | en-US | es-419 | es-ES | es-US | fr-FR | fr-CA | it-IT | ja-JP | ko-KR
- name
-
Nama bot.
Jenis: String
Kendala Panjang: Panjang minimum 2. Panjang maksimum 50.
Pola:
^([A-Za-z]_?)+$
- nluIntentConfidenceThreshold
-
Skor yang menentukan di mana Amazon Lex menyisipkan
AMAZON.FallbackIntent
AMAZON.KendraSearchIntent
,, atau keduanya saat mengembalikan maksud alternatif dalam respons PostContentatau PostText.AMAZON.FallbackIntent
dimasukkan jika skor kepercayaan untuk semua maksud di bawah nilai ini.AMAZON.KendraSearchIntent
hanya dimasukkan jika dikonfigurasi untuk bot.Tipe: Ganda
Rentang yang Valid: Nilai minimum 0. Nilai maksimum 1.
- status
-
Status bot.
Ketika statusnya adalah
BUILDING
Amazon Lex sedang membangun bot untuk pengujian dan penggunaan.Jika status botnya
READY_BASIC_TESTING
, Anda dapat menguji bot menggunakan ucapan persis yang ditentukan dalam maksud bot. Ketika bot siap untuk pengujian penuh atau dijalankan, statusnya adalahREADY
.Jika ada masalah dengan membangun bot, statusnya
FAILED
danfailureReason
bidang menjelaskan mengapa bot tidak dibangun.Jika bot disimpan tetapi tidak dibangun, statusnya adalah
NOT_BUILT
.Jenis: String
Nilai yang Valid:
BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT
- version
-
Versi bot. Untuk bot baru, versinya selalu
$LATEST
.Jenis: String
Batasan Panjang: Panjang minimum 1. Panjang maksimum adalah 64.
Pola:
\$LATEST|[0-9]+
- voiceId
-
ID suara Amazon Polly yang digunakan Amazon Lex untuk interaksi suara dengan pengguna. Untuk informasi selengkapnya, lihat PutBot.
Tipe: String
Kesalahan
- BadRequestException
-
Permintaan tidak terbentuk dengan baik. Misalnya, nilai tidak valid atau bidang wajib hilang. Periksa nilai bidang, dan coba lagi.
Kode Status HTTP: 400
- InternalFailureException
-
Terjadi kesalahan internal Amazon Lex. Coba permintaan Anda lagi.
Kode Status HTTP: 500
- LimitExceededException
-
Permintaan melebihi batas. Coba permintaan Anda lagi.
Kode Status HTTP: 429
- NotFoundException
-
Sumber daya yang ditentukan dalam permintaan tidak ditemukan. Periksa sumber daya dan coba lagi.
Kode Status HTTP: 404
Lihat Juga
Untuk informasi selengkapnya tentang penggunaan API ini di salah satu AWS SDK khusus bahasa, lihat berikut ini: