Amazon Lex V2 を使用している場合は、代わりに Amazon Lex V2 ガイドを参照してください。
Amazon Lex V1 を使用している場合は、ボットを Amazon Lex V2 にアップグレードすることをお勧めします。V1 には新機能を追加されませんので、すべての新しいボットには V2 を使用することを強くお勧めします。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
GetIntent
インテントに関する情報を返します。インテント名に加えて、インテントバージョンを指定する必要があります。
このオペレーションには lex:GetIntent
アクションを実行するアクセス許可が必要です。
リクエストの構文
GET /intents/name
/versions/version
HTTP/1.1
URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
リクエストボディ
リクエストにリクエスト本文がありません。
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"checksum": "string",
"conclusionStatement": {
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
},
"confirmationPrompt": {
"maxAttempts": number,
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
},
"createdDate": number,
"description": "string",
"dialogCodeHook": {
"messageVersion": "string",
"uri": "string"
},
"followUpPrompt": {
"prompt": {
"maxAttempts": number,
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
},
"rejectionStatement": {
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
}
},
"fulfillmentActivity": {
"codeHook": {
"messageVersion": "string",
"uri": "string"
},
"type": "string"
},
"inputContexts": [
{
"name": "string"
}
],
"kendraConfiguration": {
"kendraIndex": "string",
"queryFilterString": "string",
"role": "string"
},
"lastUpdatedDate": number,
"name": "string",
"outputContexts": [
{
"name": "string",
"timeToLiveInSeconds": number,
"turnsToLive": number
}
],
"parentIntentSignature": "string",
"rejectionStatement": {
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
},
"sampleUtterances": [ "string" ],
"slots": [
{
"defaultValueSpec": {
"defaultValueList": [
{
"defaultValue": "string"
}
]
},
"description": "string",
"name": "string",
"obfuscationSetting": "string",
"priority": number,
"responseCard": "string",
"sampleUtterances": [ "string" ],
"slotConstraint": "string",
"slotType": "string",
"slotTypeVersion": "string",
"valueElicitationPrompt": {
"maxAttempts": number,
"messages": [
{
"content": "string",
"contentType": "string",
"groupNumber": number
}
],
"responseCard": "string"
}
}
],
"version": "string"
}
レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- checksum
-
インテントのチェックサム。
型: 文字列
- conclusionStatement
-
fulfillmentActivity
要素で指定された Lambda 関数がインテントを達成すると、Amazon Lex はこのステートメントをユーザーに伝えます。型: Statement オブジェクト
- confirmationPrompt
-
これがボットに定義されている場合、Amazon Lex がユーザーのインテントを達成する前の確認に使用するプロンプトです。詳細については、「PutIntent」を参照してください。
型: Prompt オブジェクト
- createdDate
-
インテントが作成された日付。
型: タイムスタンプ
- description
-
インテントの説明。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 200 です。
- dialogCodeHook
-
これがボットに定義されている場合、Amazon Lex は各ユーザー入力に対してこの Lambda 関数を呼び出します。詳細については、「PutIntent」を参照してください。
型: CodeHook オブジェクト
- followUpPrompt
-
これが定義されている場合、Amazon Lex はこのプロンプトを使用して、インテントが達成された後に追加のユーザーアクティビティを要求します。詳細については、「PutIntent」を参照してください。
型: FollowUpPrompt オブジェクト
- fulfillmentActivity
-
インテントがどのように達成されるのかを説明します。詳細については、「PutIntent」を参照してください。
型: FulfillmentActivity オブジェクト
- inputContexts
-
Amazon Lex がユーザーとの会話の中でインテントを選択するためのアクティブなコンテキストをリストアップした
InputContext
オブジェクトの配列です。型: InputContext オブジェクトの配列
配列メンバー:最小数は 0 項目です。最大数は 5 項目です。
- kendraConfiguration
-
AMAZON.KendraSearchIntent
インテントで Amazon Kendra インデックスに接続するための設定情報 (項目がある場合)。型: KendraConfiguration オブジェクト
- lastUpdatedDate
-
インテントが更新された日付。リソースを作成する場合、作成日と最終更新日は同じ日付になります。
型: タイムスタンプ
- name
-
インテントの名前。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 100 です。
パターン:
^([A-Za-z]_?)+$
- outputContexts
-
OutputContext
オブジェクトの配列で、インテントが達成されたときにアクティブになるコンテキストを列挙します。型: OutputContext オブジェクトの配列
の配列メンバー: 最小数は 0 項目です。最大数は 10 項目です。
- parentIntentSignature
-
組み込みインテントの一意の識別子。
型: 文字列
- rejectionStatement
-
ユーザーが
confirmationPrompt
で定義された質問に「いいえ」と答えた場合、Amazon Lex はインテントがキャンセルされたことを確認するためにこのステートメントを返します。型: Statement オブジェクト
- sampleUtterances
-
インテント用に構成されたサンプル発話の配列。
型: 文字列の配列
配列メンバー:最小数は 0 項目です。最大数は 1500 項目です。
長さの制限:最小長は 1 です。最大長は 200 です。
- slots
-
インテント用に設定されたインテントスロットの配列。
型: Slot オブジェクトの配列
配列メンバー: 最小数は 0 項目です。最大数は 100 項目です。
- version
-
インテントのバージョン。
型: 文字列
長さの制限:最小長は 1 です。最大長は 64 文字です。
パターン:
\$LATEST|[0-9]+
エラー
- BadRequestException
-
リクエストが適切にフォーマットされていません。例えば、値が無効であったり、必須項目が設定されていない場合です。フィールドの値を確認して、再度お試しください。
HTTP ステータスコード:400
- InternalFailureException
-
Amazon Lex 内部エラーが発生しました。リクエストを再試行してください。
HTTP ステータスコード:500
- LimitExceededException
-
リクエストが制限を超えました。リクエストを再試行してください。
HTTP ステータスコード: 429
- NotFoundException
-
リクエストで指定されたリソースは見つかりませんでした。リソースを確認して、もう一度お試しください。
HTTP ステータスコード: 404
その他の参照資料
言語固有の AWS SDK でこの API を使用する方法の詳細については、以下を参照してください。