サポート終了通知: 2025 年 9 月 15 日、 AWS は Amazon Lex V1 のサポートを終了します。 V1 2025 年 9 月 15 日以降、Amazon Lex V1 コンソールまたは Amazon Lex V1 リソースにアクセスできなくなります。Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
特定のボットのメタデータ情報を返します。ボットの名前、ボットのバージョンまたはエイリアスを指定する必要があります。
このオペレーションには、lex:GetBot アクションに対する許可が必要です。
リクエストの構文
GET /bots/name/versions/versionoralias HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
- name
-
ボットの名前。名前は、大文字と小文字が区別されます。
長さの制限: 最小長は 2 です。最大長は 50 です。
Pattern:
^([A-Za-z]_?)+$必須: はい
- versionoralias
-
ボットのバージョンまたはエイリアス。
必須: はい
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
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"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- abortStatement
-
ユーザーが会話を完了せずに終了することを選択した場合に Amazon Lex が返すメッセージ。詳細については、「PutBot」を参照してください。
型: Statement オブジェクト
- checksum
-
ボットの
$LATESTバージョンの特定のリビジョンを識別するために使用される、ボットのチェックサム。タイプ: 文字列
- childDirected
-
Amazon Lex Model·Building·Service で作成された各 Amazon Lex ボットについて、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA (Children's Online Privacy Protection Act) の対象となっているかどうかを、
childDirectedフィールドにtrueまたはfalseを指定する必要があります。childDirectedフィールドにtrueを指定することで、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しており、COPPA の対象になることに同意します。childDirectedフィールドにfalseを指定することで、Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連しておらず、COPPA の対象にならないことに同意します。Amazon Lex の全体または一部の使用が、13歳未満の児童を対象にしており、COPPAの対象となるウェブサイト、プログラム、またはその他のアプリケーションに関連するかどうかを正確に設定するために、childDirectedフィールドにデフォルト値を指定することはできません。Amazon Lex 全体または一部の使用が、13 歳未満の児童を対象とするウェブサイト、プログラム、その他のアプリケーションに関連する場合は、COPPA により必要とされる検証可能な保護者の同意が必要です。13 歳未満の児童を対象とするウェブサイト、プログラム、またはその他のアプリケーションに関連する Amazon Lex の全体または一部の使用についての詳細は、「Amazon Lex FAQ」
を参照してください。 型: ブール値
- clarificationPrompt
-
Amazon Lex がユーザーのリクエストを理解できない場合に、使用するメッセージ。詳細については、「PutBot」を参照してください。
型: Prompt オブジェクト
- createdDate
-
ボットが作成された日付。
型: タイムスタンプ
- description
-
ボットの説明。
タイプ: 文字列
長さの制約: 最小長は 0 です。最大長は 200 です。
- detectSentiment
-
ユーザーの発話を Amazon Comprehend に送信して、センチメント分析を行うかどうかを示します。
型: ブール値
- enableModelImprovements
-
ボットが精度向上を使用しているかどうかを示します。
trueはボットが精度向上を使用していることを示し、それ以外はfalseとなります。型: ブール値
- failureReason
-
statusがFAILEDの場合、Amazon Lex はボットの構築に失敗した理由を提示します。タイプ: 文字列
- idleSessionTTLInSeconds
-
Amazon Lex が会話で収集したデータを保持する最大時間 (秒) です。詳細については、「PutBot」を参照してください。
型: 整数
有効範囲: 最小値 は 60 です。最大値は 86400 です。
- intents
-
intentオブジェクトの配列。詳細については、「PutBot」を参照してください。型: Intent オブジェクトの配列
- lastUpdatedDate
-
ボットが更新された日付。リソースを作成すると、作成日と最終更新日は同じ日付になります。
型: タイムスタンプ
- locale
-
ボットのターゲットロケール。
タイプ: 文字列
有効な値:
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
-
ボットの名前。
タイプ: 文字列
長さの制限: 最小長は 2 です。最大長は 50 です。
パターン:
^([A-Za-z]_?)+$ - nluIntentConfidenceThreshold
-
Amazon Lex が PostContent または PostText レスポンスで代替インテントを返す際に、
AMAZON.FallbackIntent、AMAZON.KendraSearchIntent、またはその両方を挿入する場所を決定するスコアです。AMAZON.FallbackIntentは、すべてのインテントの信頼性スコアがこの値を下回る場合に挿入されます。AMAZON.KendraSearchIntentは、ボットに設定されている場合のみ挿入されます。型: 倍精度浮動小数点数
有効範囲: 最小値 は 0 です。最大値は 1 です。
- status
-
ボットのステータス。
ステータスが
BUILDINGの場合、Amazon Lex はテストと使用のためにボットを構築します。ボットのステータスが
READY_BASIC_TESTINGの場合、ボットのインテントで指定された正確な発話を使用してボットをテストできます。ボットが完全なテストまたは実行の準備ができたら、ステータスはREADYになります。ボットの構築に問題があった場合、ステータスは
FAILEDとなり、failureReasonのフィールドにはボットが構築できなかった理由が記載されます。ボットが保存され、まだビルドされていない場合、ステータスは
NOT_BUILTになります。タイプ: 文字列
有効な値:
BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT - version
-
ボットのバージョン。新規のボットの場合、バージョンは常に
$LATESTです。タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン:
\$LATEST|[0-9]+ - voiceId
-
Amazon Lex がユーザーとの音声対話に使用する Amazon Polly 音声 ID。詳細については、「PutBot」を参照してください。
タイプ: 文字列
エラー
- BadRequestException
-
リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。
HTTP ステータスコード: 400
- InternalFailureException
-
Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。
HTTP ステータスコード: 500
- LimitExceededException
-
リクエストが制限を超えました。リクエストを再試行してください。
HTTP ステータスコード: 429
- NotFoundException
-
リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。
HTTP ステータスコード: 404
以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
