GetIntent - Amazon Lex V1

如果您使用的是 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 參數。

name

意圖的名稱。名稱區分大小寫。

長度限制:長度下限為 1。長度上限為 100。

模式:^([A-Za-z]_?)+$

必要:是

version

意圖的版本。

長度限制:長度下限為 1。長度上限為 64。

模式:\$LATEST|[0-9]+

必要:是

請求主體

請求沒有請求主體。

回應語法

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

建立意圖的日期。

類型:Timestamp

description

意圖的描述。

類型:字串

長度限制:長度下限為 0。長度上限為 200。

dialogCodeHook

如果在機器人中定義,Amazon Amazon Lex 會針對每個使用者輸入叫用此 Lambda 函數。如需詳細資訊,請參閱 PutIntent

類型:CodeHook 物件

followUpPrompt

如果在機器人中定義,Amazon Lex 會在完成意圖後使用此提示來請求其他使用者活動。如需詳細資訊,請參閱 PutIntent

類型:FollowUpPrompt 物件

fulfillmentActivity

描述如何實現意圖。如需詳細資訊,請參閱 PutIntent

類型:FulfillmentActivity 物件

inputContexts

InputContext物件陣列,列出 Amazon Lex 必須處於作用中狀態的內容,才能在與使用者交談中選擇意圖。

類型:InputContext 物件陣列

陣列成員:項目數下限為 0。項目數上限為 5。

kendraConfiguration

設定資訊 (如果有的話),以便依據AMAZON.KendraSearchIntent意圖連接到 Amazon Kendra 索引。

類型:KendraConfiguration 物件

lastUpdatedDate

更新意圖的日期。建立資源時,建立日期和上次更新日期相同。

類型:Timestamp

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 的詳細資訊,請參閱下列內容: