终止支持通知:2025年9月15日, AWS 我们将停止对Amazon Lex V1的支持。2025 年 9 月 15 日之后,您将无法再访问亚马逊 Lex V1 主机或 Amazon Lex V1 资源。如果您使用的是 Amazon Lex V2,请改为参阅 Amazon Lex 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
-
InputContext
对象数组,列出了 Amazon Lex 在与用户的对话中选择意图时必须处于活动状态的上下文。类型:InputContext 对象数组
数组成员:最少 0 个物品。最多 5 项。
- kendraConfiguration
-
用于将 Amazon Kendra 索引与
AMAZON.KendraSearchIntent
意图关联的配置信息(如果有)。类型: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
另请参阅
有关以特定语言之一使用此 API 的更多信息 AWS SDKs,请参阅以下内容: