终止支持通知：2025年9月15日， AWS 我们将停止对Amazon Lex V1的支持。2025 年 9 月 15 日之后，您将无法再访问 Amazon Lex V1 控制台或 Amazon Lex V1 资源。如果您使用的是 Amazon Lex V2，请改为参阅 [Amazon Lex V2 指南](https://docs.aws.amazon.com/lexv2/latest/dg/what-is.html)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 数据类型
<a name="API_Types"></a>

Amazon Lex 模型构建服务支持以下数据类型：
+  [BotAliasMetadata](API_BotAliasMetadata.md) 
+  [BotChannelAssociation](API_BotChannelAssociation.md) 
+  [BotMetadata](API_BotMetadata.md) 
+  [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md) 
+  [BuiltinIntentSlot](API_BuiltinIntentSlot.md) 
+  [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md) 
+  [CodeHook](API_CodeHook.md) 
+  [ConversationLogsRequest](API_ConversationLogsRequest.md) 
+  [ConversationLogsResponse](API_ConversationLogsResponse.md) 
+  [EnumerationValue](API_EnumerationValue.md) 
+  [FollowUpPrompt](API_FollowUpPrompt.md) 
+  [FulfillmentActivity](API_FulfillmentActivity.md) 
+  [InputContext](API_InputContext.md) 
+  [Intent](API_Intent.md) 
+  [IntentMetadata](API_IntentMetadata.md) 
+  [KendraConfiguration](API_KendraConfiguration.md) 
+  [LogSettingsRequest](API_LogSettingsRequest.md) 
+  [LogSettingsResponse](API_LogSettingsResponse.md) 
+  [Message](API_Message.md) 
+  [MigrationAlert](API_MigrationAlert.md) 
+  [MigrationSummary](API_MigrationSummary.md) 
+  [OutputContext](API_OutputContext.md) 
+  [Prompt](API_Prompt.md) 
+  [ResourceReference](API_ResourceReference.md) 
+  [Slot](API_Slot.md) 
+  [SlotDefaultValue](API_SlotDefaultValue.md) 
+  [SlotDefaultValueSpec](API_SlotDefaultValueSpec.md) 
+  [SlotTypeConfiguration](API_SlotTypeConfiguration.md) 
+  [SlotTypeMetadata](API_SlotTypeMetadata.md) 
+  [SlotTypeRegexConfiguration](API_SlotTypeRegexConfiguration.md) 
+  [Statement](API_Statement.md) 
+  [Tag](API_Tag.md) 
+  [UtteranceData](API_UtteranceData.md) 
+  [UtteranceList](API_UtteranceList.md) 

Amazon Lex 运行时服务支持以下数据类型：
+  [ActiveContext](API_runtime_ActiveContext.md) 
+  [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) 
+  [Button](API_runtime_Button.md) 
+  [DialogAction](API_runtime_DialogAction.md) 
+  [GenericAttachment](API_runtime_GenericAttachment.md) 
+  [IntentConfidence](API_runtime_IntentConfidence.md) 
+  [IntentSummary](API_runtime_IntentSummary.md) 
+  [PredictedIntent](API_runtime_PredictedIntent.md) 
+  [ResponseCard](API_runtime_ResponseCard.md) 
+  [SentimentResponse](API_runtime_SentimentResponse.md) 

# Amazon Lex 模型构建服务
<a name="API_Types_Amazon_Lex_Model_Building_Service"></a>

Amazon Lex 模型构建服务支持以下数据类型：
+  [BotAliasMetadata](API_BotAliasMetadata.md) 
+  [BotChannelAssociation](API_BotChannelAssociation.md) 
+  [BotMetadata](API_BotMetadata.md) 
+  [BuiltinIntentMetadata](API_BuiltinIntentMetadata.md) 
+  [BuiltinIntentSlot](API_BuiltinIntentSlot.md) 
+  [BuiltinSlotTypeMetadata](API_BuiltinSlotTypeMetadata.md) 
+  [CodeHook](API_CodeHook.md) 
+  [ConversationLogsRequest](API_ConversationLogsRequest.md) 
+  [ConversationLogsResponse](API_ConversationLogsResponse.md) 
+  [EnumerationValue](API_EnumerationValue.md) 
+  [FollowUpPrompt](API_FollowUpPrompt.md) 
+  [FulfillmentActivity](API_FulfillmentActivity.md) 
+  [InputContext](API_InputContext.md) 
+  [Intent](API_Intent.md) 
+  [IntentMetadata](API_IntentMetadata.md) 
+  [KendraConfiguration](API_KendraConfiguration.md) 
+  [LogSettingsRequest](API_LogSettingsRequest.md) 
+  [LogSettingsResponse](API_LogSettingsResponse.md) 
+  [Message](API_Message.md) 
+  [MigrationAlert](API_MigrationAlert.md) 
+  [MigrationSummary](API_MigrationSummary.md) 
+  [OutputContext](API_OutputContext.md) 
+  [Prompt](API_Prompt.md) 
+  [ResourceReference](API_ResourceReference.md) 
+  [Slot](API_Slot.md) 
+  [SlotDefaultValue](API_SlotDefaultValue.md) 
+  [SlotDefaultValueSpec](API_SlotDefaultValueSpec.md) 
+  [SlotTypeConfiguration](API_SlotTypeConfiguration.md) 
+  [SlotTypeMetadata](API_SlotTypeMetadata.md) 
+  [SlotTypeRegexConfiguration](API_SlotTypeRegexConfiguration.md) 
+  [Statement](API_Statement.md) 
+  [Tag](API_Tag.md) 
+  [UtteranceData](API_UtteranceData.md) 
+  [UtteranceList](API_UtteranceList.md) 

# BotAliasMetadata
<a name="API_BotAliasMetadata"></a>

提供有关机器人别名的信息。

## 内容
<a name="API_BotAliasMetadata_Contents"></a>

 ** botName **   <a name="lex-Type-BotAliasMetadata-botName"></a>
别名指向的自动程序的名称。  
类型：字符串  
长度限制：最小长度为 2。最大长度为 50。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** botVersion **   <a name="lex-Type-BotAliasMetadata-botVersion"></a>
别名指向的 Amazon Lex 机器人的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

 ** checksum **   <a name="lex-Type-BotAliasMetadata-checksum"></a>
机器人别名的校验和。  
类型：字符串  
必需：否

 ** conversationLogs **   <a name="lex-Type-BotAliasMetadata-conversationLogs"></a>
确定 Amazon Lex 如何使用对话日志作为别名的设置。  
类型：[ConversationLogsResponse](API_ConversationLogsResponse.md) 对象  
必需：否

 ** createdDate **   <a name="lex-Type-BotAliasMetadata-createdDate"></a>
机器人别名的创建日期。  
类型：时间戳  
必需：否

 ** description **   <a name="lex-Type-BotAliasMetadata-description"></a>
机器人别名的描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 200。  
必需：否

 ** lastUpdatedDate **   <a name="lex-Type-BotAliasMetadata-lastUpdatedDate"></a>
机器人别名的更新日期。创建资源时，创建日期和上次更新日期相同。  
类型：时间戳  
必需：否

 ** name **   <a name="lex-Type-BotAliasMetadata-name"></a>
自动程序别名的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：否

## 另请参阅
<a name="API_BotAliasMetadata_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BotAliasMetadata) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BotAliasMetadata) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BotAliasMetadata) 

# BotChannelAssociation
<a name="API_BotChannelAssociation"></a>

表示 Amazon Lex 机器人与外部消息收发平台之间的关联。

## 内容
<a name="API_BotChannelAssociation_Contents"></a>

 ** botAlias **   <a name="lex-Type-BotChannelAssociation-botAlias"></a>
指向要与之建立此关联的 Amazon Lex 机器人的特定版本的别名。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** botConfiguration **   <a name="lex-Type-BotChannelAssociation-botConfiguration"></a>
提供与消息收发平台通信所需的信息。  
类型：字符串到字符串映射  
映射条目：最多 10 项。  
必需：否

 ** botName **   <a name="lex-Type-BotChannelAssociation-botName"></a>
要与之建立此关联的 Amazon Lex 机器人的名称。  
目前，Amazon Lex 支持与 Facebook、Slack 和 Twilio 的关联。
类型：字符串  
长度限制：最小长度为 2。最大长度为 50。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** createdDate **   <a name="lex-Type-BotChannelAssociation-createdDate"></a>
Amazon Lex 机器人与通道之间建立关联的日期。  
类型：时间戳  
必需：否

 ** description **   <a name="lex-Type-BotChannelAssociation-description"></a>
您正在创建的关联的文本描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 200。  
必需：否

 ** failureReason **   <a name="lex-Type-BotChannelAssociation-failureReason"></a>
如果 `status` 是 `FAILED`，则 Amazon Lex 会提供其未能创建关联的原因。  
类型：字符串  
必需：否

 ** name **   <a name="lex-Type-BotChannelAssociation-name"></a>
机器人与通道之间的关联的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** status **   <a name="lex-Type-BotChannelAssociation-status"></a>
机器人通道的状态。  
+  `CREATED` — 通道已创建，随时可用。
+  `IN_PROGRESS` — 通道正在创建。
+  `FAILED` — 创建通道时出错。有关失败原因的信息，请参阅 `failureReason` 字段。
类型：字符串  
有效值：`IN_PROGRESS | CREATED | FAILED`  
必需：否

 ** type **   <a name="lex-Type-BotChannelAssociation-type"></a>
通过指明 Amazon Lex 机器人和外部消息收发平台之间建立的通道类型，指定关联的类型。  
类型：字符串  
有效值：`Facebook | Slack | Twilio-Sms | Kik`  
必需：否

## 另请参阅
<a name="API_BotChannelAssociation_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BotChannelAssociation) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BotChannelAssociation) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BotChannelAssociation) 

# BotMetadata
<a name="API_BotMetadata"></a>

提供有关机器人的信息。

## 内容
<a name="API_BotMetadata_Contents"></a>

 ** createdDate **   <a name="lex-Type-BotMetadata-createdDate"></a>
机器人的创建日期。  
类型：时间戳  
必需：否

 ** description **   <a name="lex-Type-BotMetadata-description"></a>
机器人的描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 200。  
必需：否

 ** lastUpdatedDate **   <a name="lex-Type-BotMetadata-lastUpdatedDate"></a>
机器人的更新日期。创建机器人时，创建日期和上次更新日期相同。  
类型：时间戳  
必需：否

 ** name **   <a name="lex-Type-BotMetadata-name"></a>
机器人的名称。  
类型：字符串  
长度限制：最小长度为 2。最大长度为 50。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** status **   <a name="lex-Type-BotMetadata-status"></a>
机器人的状态。  
类型：字符串  
有效值：`BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT`  
必需：否

 ** version **   <a name="lex-Type-BotMetadata-version"></a>
自动程序的版本。对于新机器人，版本始终是 `$LATEST`。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

## 另请参阅
<a name="API_BotMetadata_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BotMetadata) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BotMetadata) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BotMetadata) 

# BuiltinIntentMetadata
<a name="API_BuiltinIntentMetadata"></a>

提供内置意图的元数据。

## 内容
<a name="API_BuiltinIntentMetadata_Contents"></a>

 ** signature **   <a name="lex-Type-BuiltinIntentMetadata-signature"></a>
内置意图的唯一标识符。要查找意图的签名，请参阅 *Alexa Skills Kit* 中的[标准内置意图](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents)。  
类型：字符串  
必需：否

 ** supportedLocales **   <a name="lex-Type-BuiltinIntentMetadata-supportedLocales"></a>
意图支持的区域设置的标识符列表。  
类型：字符串数组  
有效值：`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`  
必需：否

## 另请参阅
<a name="API_BuiltinIntentMetadata_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BuiltinIntentMetadata) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BuiltinIntentMetadata) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BuiltinIntentMetadata) 

# BuiltinIntentSlot
<a name="API_BuiltinIntentSlot"></a>

提供有关在内置意图中使用的插槽的信息。

## 内容
<a name="API_BuiltinIntentSlot_Contents"></a>

 ** name **   <a name="lex-Type-BuiltinIntentSlot-name"></a>
为意图定义的插槽列表。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_BuiltinIntentSlot_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BuiltinIntentSlot) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BuiltinIntentSlot) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BuiltinIntentSlot) 

# BuiltinSlotTypeMetadata
<a name="API_BuiltinSlotTypeMetadata"></a>

提供有关内置插槽类型的信息。

## 内容
<a name="API_BuiltinSlotTypeMetadata_Contents"></a>

 ** signature **   <a name="lex-Type-BuiltinSlotTypeMetadata-signature"></a>
内置插槽类型的唯一标识符。要查找插槽类型的签名，请参阅 *Alexa Skills Kit* 中的[插槽类型参考](https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference)。  
类型：字符串  
必需：否

 ** supportedLocales **   <a name="lex-Type-BuiltinSlotTypeMetadata-supportedLocales"></a>
插槽的目标区域设置列表。  
类型：字符串数组  
有效值：`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`  
必需：否

## 另请参阅
<a name="API_BuiltinSlotTypeMetadata_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/BuiltinSlotTypeMetadata) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/BuiltinSlotTypeMetadata) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/BuiltinSlotTypeMetadata) 

# CodeHook
<a name="API_CodeHook"></a>

指定 Lambda 函数，其用于验证对机器人的请求，或履行用户向机器人发出的请求。

## 内容
<a name="API_CodeHook_Contents"></a>

 ** messageVersion **   <a name="lex-Type-CodeHook-messageVersion"></a>
您想要 Amazon Lex 用来调用您的 Lambda 函数的请求-响应版本。有关更多信息，请参阅 [使用 Lambda 函数](using-lambda.md)。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 5。  
必需：是

 ** uri **   <a name="lex-Type-CodeHook-uri"></a>
Lambda 函数的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:aws[a-zA-Z-]*:lambda:[a-z]+-[a-z]+(-[a-z]+)*-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?`  
必需：是

## 另请参阅
<a name="API_CodeHook_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/CodeHook) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/CodeHook) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/CodeHook) 

# ConversationLogsRequest
<a name="API_ConversationLogsRequest"></a>

提供对话日志所需的设置。

## 内容
<a name="API_ConversationLogsRequest_Contents"></a>

 ** iamRoleArn **   <a name="lex-Type-ConversationLogsRequest-iamRoleArn"></a>
一个 IAM 角色的 Amazon 资源名称 (ARN)，该角色有权写入您的 CloudWatch 日志以获取文本日志，并有权写入您的 S3 存储桶（用于存放音频日志）。如果启用了音频加密，则此角色还提供针对用于加密音频日志的 AWS KMS 密钥的访问权限。有关更多信息，请参阅[为对话日志创建 IAM 角色和策略](https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`^arn:[\w\-]+:iam::[\d]{12}:role/.+$`  
必需：是

 ** logSettings **   <a name="lex-Type-ConversationLogsRequest-logSettings"></a>
对话日志的设置。您可以记录对话文本和/或对话音频。  
类型：[LogSettingsRequest](API_LogSettingsRequest.md) 对象数组  
必需：是

## 另请参阅
<a name="API_ConversationLogsRequest_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ConversationLogsRequest) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ConversationLogsRequest) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ConversationLogsRequest) 

# ConversationLogsResponse
<a name="API_ConversationLogsResponse"></a>

包含有关对话日志设置的信息。

## 内容
<a name="API_ConversationLogsResponse_Contents"></a>

 ** iamRoleArn **   <a name="lex-Type-ConversationLogsResponse-iamRoleArn"></a>
用于将日志写入 CloudWatch 日志或 S3 存储桶的 IAM 角色的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`^arn:[\w\-]+:iam::[\d]{12}:role/.+$`  
必需：否

 ** logSettings **   <a name="lex-Type-ConversationLogsResponse-logSettings"></a>
对话日志的设置。您可以记录文本和/或音频。  
类型：[LogSettingsResponse](API_LogSettingsResponse.md) 对象数组  
必需：否

## 另请参阅
<a name="API_ConversationLogsResponse_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ConversationLogsResponse) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ConversationLogsResponse) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ConversationLogsResponse) 

# EnumerationValue
<a name="API_EnumerationValue"></a>

每种槽类型可以有一组值。每个枚举值表示插槽类型可采用的值。

例如，订购披萨机器人可能有一个插槽类型，用于指定披萨应有的饼皮类型。插槽类型可以包含值 
+ 厚
+ thin
+ 装馅

## 内容
<a name="API_EnumerationValue_Contents"></a>

 ** value **   <a name="lex-Type-EnumerationValue-value"></a>
插槽类型的值。  
类型：字符串  
长度限制：最小长度为 1。长度上限为 140。  
必需：是

 ** synonyms **   <a name="lex-Type-EnumerationValue-synonyms"></a>
与插槽类型值相关的额外值。  
类型：字符串数组  
长度限制：最小长度为 1。长度上限为 140。  
必需：否

## 另请参阅
<a name="API_EnumerationValue_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/EnumerationValue) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/EnumerationValue) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/EnumerationValue) 

# FollowUpPrompt
<a name="API_FollowUpPrompt"></a>

履行意图后提示是否要进行其他活动。例如，在履行 `OrderPizza` 意图后，您可以提示用户以了解用户是否想要订购饮品。

## 内容
<a name="API_FollowUpPrompt_Contents"></a>

 ** prompt **   <a name="lex-Type-FollowUpPrompt-prompt"></a>
提示用户提供信息。  
类型：[Prompt](API_Prompt.md) 对象  
必需：是

 ** rejectionStatement **   <a name="lex-Type-FollowUpPrompt-rejectionStatement"></a>
当用户对 `prompt` 字段中定义的问题回答“否”时，Amazon Lex 将使用此语句进行响应，以确认意图已被取消。  
类型：[Statement](API_Statement.md) 对象  
必需：是

## 另请参阅
<a name="API_FollowUpPrompt_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/FollowUpPrompt) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/FollowUpPrompt) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/FollowUpPrompt) 

# FulfillmentActivity
<a name="API_FulfillmentActivity"></a>

 描述用户提供意图所需的所有信息后如何履行意图。您可以提供 Lambda 函数来处理意图，也可以将意图信息返回给客户端应用程序。我们建议您使用 Lambda 函数，以便相关逻辑存在于云中，并将客户端代码主要限于演示。如果您需要更新逻辑，则只需更新 Lambda 函数；无需升级您的客户端应用程序。

考虑以下示例：
+ 在订购披萨应用程序中，在用户提供所有下单信息后，您可以使用 Lambda 函数向披萨店下订单。
+ 在游戏应用程序中，当用户说“捡起石头”时，这些信息必须返回到客户端应用程序，这样它才能执行操作并更新图形。在这种情况下，您希望 Amazon Lex 将意图数据返回给客户。

## 内容
<a name="API_FulfillmentActivity_Contents"></a>

 ** type **   <a name="lex-Type-FulfillmentActivity-type"></a>
 应如何通过运行 Lambda 函数或将插槽数据返回到客户端应用程序来履行意图。  
类型：字符串  
有效值：`ReturnIntent | CodeHook`  
必需：是

 ** codeHook **   <a name="lex-Type-FulfillmentActivity-codeHook"></a>
 对为履行意图而运行的 Lambda 函数的描述。  
类型：[CodeHook](API_CodeHook.md) 对象  
必需：否

## 另请参阅
<a name="API_FulfillmentActivity_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/FulfillmentActivity) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/FulfillmentActivity) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/FulfillmentActivity) 

# InputContext
<a name="API_InputContext"></a>

上下文的名称，该上下文必须对 Amazon Lex 选择的意图保持活动状态。

## 内容
<a name="API_InputContext_Contents"></a>

 ** name **   <a name="lex-Type-InputContext-name"></a>
上下文的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：是

## 另请参阅
<a name="API_InputContext_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/InputContext) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/InputContext) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/InputContext) 

# Intent
<a name="API_Intent"></a>

标识意图的特定版本。

## 内容
<a name="API_Intent_Contents"></a>

 ** intentName **   <a name="lex-Type-Intent-intentName"></a>
意图的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：是

 ** intentVersion **   <a name="lex-Type-Intent-intentVersion"></a>
意图的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：是

## 另请参阅
<a name="API_Intent_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Intent) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Intent) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Intent) 

# IntentMetadata
<a name="API_IntentMetadata"></a>

提供有关意图的信息。

## 内容
<a name="API_IntentMetadata_Contents"></a>

 ** createdDate **   <a name="lex-Type-IntentMetadata-createdDate"></a>
意图的创建日期。  
类型：时间戳  
必需：否

 ** description **   <a name="lex-Type-IntentMetadata-description"></a>
目的的描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 200。  
必需：否

 ** lastUpdatedDate **   <a name="lex-Type-IntentMetadata-lastUpdatedDate"></a>
意图的更新日期。创建意图时，创建日期和上次更新日期相同。  
类型：时间戳  
必需：否

 ** name **   <a name="lex-Type-IntentMetadata-name"></a>
意图的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** version **   <a name="lex-Type-IntentMetadata-version"></a>
意图的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

## 另请参阅
<a name="API_IntentMetadata_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/IntentMetadata) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/IntentMetadata) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/IntentMetadata) 

# KendraConfiguration
<a name="API_KendraConfiguration"></a>

提供亚马逊的配置信息。 KendraSearchIntent意图。当您使用此意图时，Amazon Lex 会搜索特定的 Amazon Kendra 索引，并从与用户表达匹配的索引返回文档。有关更多信息，请参阅[亚马逊。 KendraSearchIntent](https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html)。

## 内容
<a name="API_KendraConfiguration_Contents"></a>

 ** kendraIndex **   <a name="lex-Type-KendraConfiguration-kendraIndex"></a>
你想要亚马逊的亚马逊 Kendra 索引的亚马逊资源名称 (ARN)。 KendraSearchIntent 打算搜寻。索引必须与 Amazon Lex 机器人位于相同的账户和区域中。如果 Amazon Kendra 索引不存在，则在调用 `PutIntent` 操作时会出现异常。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:aws:kendra:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:index\/[a-zA-Z0-9][a-zA-Z0-9_-]*`  
必需：是

 ** role **   <a name="lex-Type-KendraConfiguration-role"></a>
具有搜索 Amazon Kendra 索引权限的 IAM 角色的 Amazon 资源名称 (ARN)。该角色必须与 Amazon Lex 机器人位于相同的账户和区域中。如果角色不存在，则在调用 `PutIntent` 操作时会出现异常。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`arn:aws:iam::[0-9]{12}:role/.*`  
必需：是

 ** queryFilterString **   <a name="lex-Type-KendraConfiguration-queryFilterString"></a>
Amazon Lex 发送给 Amazon Kendra 以筛选查询响应的查询筛选条件。筛选条件采用 Amazon Kendra 定义的格式。有关更多信息，请参阅[筛选查询](https://docs.aws.amazon.com/kendra/latest/dg/filtering.html)。  
您可以在运行时用新的筛选字符串覆盖此筛选器字符串。  
类型：字符串  
长度约束：最小长度为 0。  
必需：否

## 另请参阅
<a name="API_KendraConfiguration_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/KendraConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/KendraConfiguration) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/KendraConfiguration) 

# LogSettingsRequest
<a name="API_LogSettingsRequest"></a>

用于配置对话日志的传送模式和目标的设置。

## 内容
<a name="API_LogSettingsRequest_Contents"></a>

 ** destination **   <a name="lex-Type-LogSettingsRequest-destination"></a>
将日志传送到哪里。文本日志被传送到 CloudWatch 日志日志组。音频日志将传输到 S3 存储桶  
类型：字符串  
有效值：`CLOUDWATCH_LOGS | S3`  
必需：是

 ** logType **   <a name="lex-Type-LogSettingsRequest-logType"></a>
要启用的日志类型。文本日志被传送到 CloudWatch日志日志组。音频日志将传输到 S3 存储桶  
类型：字符串  
有效值：`AUDIO | TEXT`  
必需：是

 ** resourceArn **   <a name="lex-Type-LogSettingsRequest-resourceArn"></a>
应将日志传送到的 CloudWatch 日志组或 S3 存储桶的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
模式：`^arn:[\w\-]+:(?:logs:[\w\-]+:[\d]{12}:log-group:[\.\-_/#A-Za-z0-9]{1,512}(?::\*)?|s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9])$`  
必需：是

 ** kmsKeyArn **   <a name="lex-Type-LogSettingsRequest-kmsKeyArn"></a>
AWS KMS 客户托管式密钥的 Amazon 资源名称 (ARN)，用于对传输到 S3 存储桶中的音频日志进行加密的 Amazon 资源名称 (ARN)。该密钥不适用于 CloudWatch 日志，对于 S3 存储桶是可选的。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`  
必需：否

## 另请参阅
<a name="API_LogSettingsRequest_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/LogSettingsRequest) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/LogSettingsRequest) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/LogSettingsRequest) 

# LogSettingsResponse
<a name="API_LogSettingsResponse"></a>

对话日志的设置。

## 内容
<a name="API_LogSettingsResponse_Contents"></a>

 ** destination **   <a name="lex-Type-LogSettingsResponse-destination"></a>
日志的传送目的地。  
类型：字符串  
有效值：`CLOUDWATCH_LOGS | S3`  
必需：否

 ** kmsKeyArn **   <a name="lex-Type-LogSettingsResponse-kmsKeyArn"></a>
用于对存储在 S3 存储桶中的音频日志进行加密的密钥的 Amazon 资源名称（ARN）。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`^arn:[\w\-]+:kms:[\w\-]+:[\d]{12}:(?:key\/[\w\-]+|alias\/[a-zA-Z0-9:\/_\-]{1,256})$`  
必需：否

 ** logType **   <a name="lex-Type-LogSettingsResponse-logType"></a>
启用的日志记录类型。  
类型：字符串  
有效值：`AUDIO | TEXT`  
必需：否

 ** resourceArn **   <a name="lex-Type-LogSettingsResponse-resourceArn"></a>
发送日志的 CloudWatch 日志组或 S3 存储桶的 Amazon 资源名称 (ARN)。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
模式：`^arn:[\w\-]+:(?:logs:[\w\-]+:[\d]{12}:log-group:[\.\-_/#A-Za-z0-9]{1,512}(?::\*)?|s3:::[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9])$`  
必需：否

 ** resourcePrefix **   <a name="lex-Type-LogSettingsResponse-resourcePrefix"></a>
资源前缀是您指定用于包含音频日志的 S3 存储桶中的 S3 对象键的第一部分。对于 CloudWatch 日志，它是您指定的日志组中日志流名称的前缀。  
类型：字符串  
长度限制：最大长度为 1024。  
必需：否

## 另请参阅
<a name="API_LogSettingsResponse_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/LogSettingsResponse) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/LogSettingsResponse) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/LogSettingsResponse) 

# Message
<a name="API_Message"></a>

提供消息文本及其类型的消息对象。

## 内容
<a name="API_Message_Contents"></a>

 ** content **   <a name="lex-Type-Message-content"></a>
消息的文本。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 1000。  
必需：是

 ** contentType **   <a name="lex-Type-Message-contentType"></a>
消息字符串的内容类型。  
类型：字符串  
有效值：`PlainText | SSML | CustomPayload`  
必需：是

 ** groupNumber **   <a name="lex-Type-Message-groupNumber"></a>
标识消息所属的消息组。将群组分配给消息后，Amazon Lex 会在响应中返回来自每个群组的一条消息。  
类型：整数  
有效范围：最小值为 1。最大值为 5。  
必需：否

## 另请参阅
<a name="API_Message_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Message) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Message) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Message) 

# MigrationAlert
<a name="API_MigrationAlert"></a>

提供有关 Amazon Lex 在迁移期间发送的警报和警告的信息。这些警报包含有关如何解决该问题的信息。

## 内容
<a name="API_MigrationAlert_Contents"></a>

 ** details **   <a name="lex-Type-MigrationAlert-details"></a>
有关该警报的其他详细信息。  
类型：字符串数组  
必需：否

 ** message **   <a name="lex-Type-MigrationAlert-message"></a>
描述发出警报的原因的消息。  
类型：字符串  
必需：否

 ** referenceURLs **   <a name="lex-Type-MigrationAlert-referenceURLs"></a>
指向描述如何解决警报的 Amazon Lex 文档的链接。  
类型：字符串数组  
必需：否

 ** type **   <a name="lex-Type-MigrationAlert-type"></a>
错误的类型。有两种警报：  
+  `ERROR` — 迁移存在无法解决的问题。迁移将会停止。
+  `WARN` — 迁移存在问题，需要手动更改新的 Amazon Lex V2 机器人。迁移仍在继续。
类型：字符串  
有效值：`ERROR | WARN`  
必需：否

## 另请参阅
<a name="API_MigrationAlert_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/MigrationAlert) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/MigrationAlert) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/MigrationAlert) 

# MigrationSummary
<a name="API_MigrationSummary"></a>

提供有关将机器人从 Amazon Lex V1 迁移到 Amazon Lex V2 的信息。

## 内容
<a name="API_MigrationSummary_Contents"></a>

 ** migrationId **   <a name="lex-Type-MigrationSummary-migrationId"></a>
Amazon Lex 为迁移分配的唯一标识符。  
类型：字符串  
长度限制：固定长度为 10。  
模式：`^[0-9a-zA-Z]+$`  
必需：否

 ** migrationStatus **   <a name="lex-Type-MigrationSummary-migrationStatus"></a>
操作的状态。当状态为 `COMPLETE` 时，机器人在 Amazon Lex V2 中可用。可能需要解决警报和警告才能完成迁移。  
类型：字符串  
有效值：`IN_PROGRESS | COMPLETED | FAILED`  
必需：否

 ** migrationStrategy **   <a name="lex-Type-MigrationSummary-migrationStrategy"></a>
用于进行迁移的策略。  
类型：字符串  
有效值：`CREATE_NEW | UPDATE_EXISTING`  
必需：否

 ** migrationTimestamp **   <a name="lex-Type-MigrationSummary-migrationTimestamp"></a>
启动迁移的日期和时间。  
类型：时间戳  
必需：否

 ** v1BotLocale **   <a name="lex-Type-MigrationSummary-v1BotLocale"></a>
作为迁移来源的 Amazon Lex V1 机器人的区域设置。  
类型：字符串  
有效值：`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`  
必需：否

 ** v1BotName **   <a name="lex-Type-MigrationSummary-v1BotName"></a>
作为迁移来源的 Amazon Lex V1 机器人的名称。  
类型：字符串  
长度限制：最小长度为 2。最大长度为 50。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** v1BotVersion **   <a name="lex-Type-MigrationSummary-v1BotVersion"></a>
作为迁移来源的 Amazon Lex V1 机器人的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

 ** v2BotId **   <a name="lex-Type-MigrationSummary-v2BotId"></a>
作为迁移目标的 Amazon Lex V2 的唯一标识符。  
类型：字符串  
长度限制：固定长度为 10。  
模式：`^[0-9a-zA-Z]+$`  
必需：否

 ** v2BotRole **   <a name="lex-Type-MigrationSummary-v2BotRole"></a>
Amazon Lex 用来运行 Amazon Lex V2 机器人的 IAM 角色。  
类型：字符串  
长度约束：最小长度为 20。最大长度为 2048。  
模式：`^arn:[\w\-]+:iam::[\d]{12}:role/.+$`  
必需：否

## 另请参阅
<a name="API_MigrationSummary_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/MigrationSummary) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/MigrationSummary) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/MigrationSummary) 

# OutputContext
<a name="API_OutputContext"></a>

当履行意图时设置的输出上下文的规范。

## 内容
<a name="API_OutputContext_Contents"></a>

 ** name **   <a name="lex-Type-OutputContext-name"></a>
上下文的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：是

 ** timeToLiveInSeconds **   <a name="lex-Type-OutputContext-timeToLiveInSeconds"></a>
在 `PostContent` 或 `PostText` 响应中首次发送上下文后，上下文应处于活动状态的秒数。您可以设置 5 到 86,400 秒（24 小时）之间的值。  
类型：整数  
有效范围：最小值为 5。最大值为 86400。  
必需：是

 ** turnsToLive **   <a name="lex-Type-OutputContext-turnsToLive"></a>
上下文应处于活动状态的对话回合次数。对话回合是指一个 `PostContent` 或 `PostText` 请求以及来自 Amazon Lex 的相应响应。  
类型：整数  
有效范围：最小值为 1。最大值为 20。  
必需：是

## 另请参阅
<a name="API_OutputContext_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/OutputContext) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/OutputContext) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/OutputContext) 

# Prompt
<a name="API_Prompt"></a>

从用户那里获取信息。要定义提示，请提供一条或多条消息，并指定尝试从用户那里获取信息的次数。如果您提供多条消息，Amazon Lex 会选择其中一条消息来提示用户。有关更多信息，请参阅 [Amazon Lex：工作原理](how-it-works.md)。

## 内容
<a name="API_Prompt_Contents"></a>

 ** maxAttempts **   <a name="lex-Type-Prompt-maxAttempts"></a>
提示用户输入信息的次数。  
类型：整数  
有效范围：最小值为 1。最大值为 5。  
必需：是

 ** messages **   <a name="lex-Type-Prompt-messages"></a>
对象的数组，每个对象均提供消息字符串及其类型。可以采用纯文本或语音合成标记语言 (SSML) 指定消息字符串。  
类型：[Message](API_Message.md) 对象数组  
数组成员：最少 1 个物品。最多 15 项。  
必需：是

 ** responseCard **   <a name="lex-Type-Prompt-responseCard"></a>
响应卡。在运行时，Amazon Lex 在 `PostText` API 响应中使用此提示。它使用会话属性和插槽值替换响应卡中的占位符。有关更多信息，请参阅 [使用响应卡](ex-resp-card.md)。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 50000。  
必需：否

## 另请参阅
<a name="API_Prompt_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Prompt) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Prompt) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Prompt) 

# ResourceReference
<a name="API_ResourceReference"></a>

描述的资源引用您正在尝试删除的资源。此对象作为 `ResourceInUseException` 异常的一部分返回。

## 内容
<a name="API_ResourceReference_Contents"></a>

 ** name **   <a name="lex-Type-ResourceReference-name"></a>
资源的名称，该资源正在使用您正在尝试删除的资源。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`[a-zA-Z_]+`  
必需：否

 ** version **   <a name="lex-Type-ResourceReference-version"></a>
资源的版本，该资源正在使用您正在尝试删除的资源。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

## 另请参阅
<a name="API_ResourceReference_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/ResourceReference) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/ResourceReference) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/ResourceReference) 

# Slot
<a name="API_Slot"></a>

标识特定插槽的版本。

## 内容
<a name="API_Slot_Contents"></a>

 ** name **   <a name="lex-Type-Slot-name"></a>
槽的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z](-|_|.)?)+$`  
必需：是

 ** slotConstraint **   <a name="lex-Type-Slot-slotConstraint"></a>
指定槽是必需的还是可选的。  
类型：字符串  
有效值：`Required | Optional`  
必需：是

 ** defaultValueSpec **   <a name="lex-Type-Slot-defaultValueSpec"></a>
插槽的默认值的列表。当 Amazon Lex 未决定插槽值时，将使用默认值。您可以从上下文变量、会话属性和定义的值指定默认值。  
类型：[SlotDefaultValueSpec](API_SlotDefaultValueSpec.md) 对象  
必需：否

 ** description **   <a name="lex-Type-Slot-description"></a>
插槽的描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 200。  
必需：否

 ** obfuscationSetting **   <a name="lex-Type-Slot-obfuscationSetting"></a>
确定对话日志和存储的言语中是否对插槽进行了混淆处理。对插槽进行混淆处理时，该值将替换为大括号 (\$1\$1) 中的插槽名称。例如，如果插槽名称为“full\$1name”，则混淆处理后的值将替换为“\$1full\$1name\$1”。有关更多信息，请参阅[插槽混淆处理](https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html)。  
类型：字符串  
有效值：`NONE | DEFAULT_OBFUSCATION`  
必需：否

 ** priority **   <a name="lex-Type-Slot-priority"></a>
 指示 Amazon Lex 从用户引发插槽值的顺序。例如，如果意图有两个优先级分别为 1 和 2 的插槽，则 AWS Amazon Lex 会首先为优先级为 1 的插槽引发一个值。  
如果多个插槽优先级相同，则 Amazon Lex 引发值的顺序是任意的。  
类型：整数  
有效范围：最小值为 0。最大值为 100。  
必需：否

 ** responseCard **   <a name="lex-Type-Slot-responseCard"></a>
 基于文本的客户端使用的插槽类型的一组可能的响应。用户从响应卡中选择一个选项，而不是使用文字进行回复。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 50000。  
必需：否

 ** sampleUtterances **   <a name="lex-Type-Slot-sampleUtterances"></a>
 如果您知道用户可能用于响应 Amazon Lex 插槽值请求的特定模式，则可以提供这些言语来提高准确性。该项为可选项。在大多数情况下，Amazon Lex 能够理解用户的言语。  
类型：字符串数组  
数组成员：最少 0 项。最多 10 项。  
长度限制：长度下限为 1。最大长度为 200。  
必需：否

 ** slotType **   <a name="lex-Type-Slot-slotType"></a>
插槽的类型，可以是您定义的自定义插槽类型，也可以是内置插槽类型之一。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^((AMAZON\.)_?|[A-Za-z]_?)+`  
必需：否

 ** slotTypeVersion **   <a name="lex-Type-Slot-slotTypeVersion"></a>
插槽类型的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

 ** valueElicitationPrompt **   <a name="lex-Type-Slot-valueElicitationPrompt"></a>
Amazon Lex 用来从用户引发插槽值的提示。  
类型：[Prompt](API_Prompt.md) 对象  
必需：否

## 另请参阅
<a name="API_Slot_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Slot) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Slot) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Slot) 

# SlotDefaultValue
<a name="API_SlotDefaultValue"></a>

插槽的默认值。

## 内容
<a name="API_SlotDefaultValue_Contents"></a>

 ** defaultValue **   <a name="lex-Type-SlotDefaultValue-defaultValue"></a>
插槽的默认值。您可以指定以下几项之一：  
+  `#context-name.slot-name` — 上下文“context-name”中的插槽值“slot-name”。
+  `{attribute}` — 会话属性“attribute”的插槽值。
+  `'value'` — 离散值“value”。
类型：字符串  
长度限制：长度下限为 1。最大长度为 202。  
必需：是

## 另请参阅
<a name="API_SlotDefaultValue_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotDefaultValue) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotDefaultValue) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotDefaultValue) 

# SlotDefaultValueSpec
<a name="API_SlotDefaultValueSpec"></a>

包含插槽的默认值。当 Amazon Lex 未决定插槽值时，将使用默认值。

## 内容
<a name="API_SlotDefaultValueSpec_Contents"></a>

 ** defaultValueList **   <a name="lex-Type-SlotDefaultValueSpec-defaultValueList"></a>
插槽的默认值。您可以指定多个默认值。例如，您可以从匹配的上下文变量、会话属性或固定值中指定要使用的默认值。  
所选的默认值是根据您在列表中指定的顺序选择的。例如，如果您按顺序指定上下文变量和固定值，Amazon Lex 将使用上下文变量（如果可用），否则它将使用固定值。  
类型：[SlotDefaultValue](API_SlotDefaultValue.md) 对象数组  
数组成员：最少 0 个物品。最多 10 个物品。  
必需：是

## 另请参阅
<a name="API_SlotDefaultValueSpec_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotDefaultValueSpec) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotDefaultValueSpec) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotDefaultValueSpec) 

# SlotTypeConfiguration
<a name="API_SlotTypeConfiguration"></a>

提供插槽类型的配置信息。

## 内容
<a name="API_SlotTypeConfiguration_Contents"></a>

 ** regexConfiguration **   <a name="lex-Type-SlotTypeConfiguration-regexConfiguration"></a>
用于验证槽值的正则表达式。  
类型：[SlotTypeRegexConfiguration](API_SlotTypeRegexConfiguration.md) 对象  
必需：否

## 另请参阅
<a name="API_SlotTypeConfiguration_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotTypeConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotTypeConfiguration) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotTypeConfiguration) 

# SlotTypeMetadata
<a name="API_SlotTypeMetadata"></a>

提供有关插槽类型的信息。

## 内容
<a name="API_SlotTypeMetadata_Contents"></a>

 ** createdDate **   <a name="lex-Type-SlotTypeMetadata-createdDate"></a>
插槽类型的创建日期。  
类型：时间戳  
必需：否

 ** description **   <a name="lex-Type-SlotTypeMetadata-description"></a>
槽类型的描述。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 200。  
必需：否

 ** lastUpdatedDate **   <a name="lex-Type-SlotTypeMetadata-lastUpdatedDate"></a>
插槽类型的更新日期。创建资源时，创建日期和上次更新日期相同。  
类型：时间戳  
必需：否

 ** name **   <a name="lex-Type-SlotTypeMetadata-name"></a>
槽类型的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：否

 ** version **   <a name="lex-Type-SlotTypeMetadata-version"></a>
插槽类型的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

## 另请参阅
<a name="API_SlotTypeMetadata_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotTypeMetadata) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotTypeMetadata) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotTypeMetadata) 

# SlotTypeRegexConfiguration
<a name="API_SlotTypeRegexConfiguration"></a>

提供用于验证槽值的正则表达式。

## 内容
<a name="API_SlotTypeRegexConfiguration_Contents"></a>

 ** pattern **   <a name="lex-Type-SlotTypeRegexConfiguration-pattern"></a>
用于验证槽值的正则表达式。  
使用标准正则表达式。Amazon Lex 支持在正则表达式中使用以下字符：  
+ A-Z, a-z
+ 0-9
+ Unicode 字符（“\$1 u<Unicode>”）
使用四位数表示 Unicode 字符，如“\$1u0041”或“\$1u005A”。  
不支持以下正则表达式运算符：  
+ 无限重复符：\$1、\$1 或 \$1x,\$1，无上限。
+ 通配符（.）
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
必需：是

## 另请参阅
<a name="API_SlotTypeRegexConfiguration_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/SlotTypeRegexConfiguration) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/SlotTypeRegexConfiguration) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/SlotTypeRegexConfiguration) 

# Statement
<a name="API_Statement"></a>

向用户传达信息的消息集合。在运行时，Amazon Lex 会选择要传达的消息。

## 内容
<a name="API_Statement_Contents"></a>

 ** messages **   <a name="lex-Type-Statement-messages"></a>
消息对象的集合。  
类型：[Message](API_Message.md) 对象数组  
数组成员：最少 1 个物品。最多 15 项。  
必需：是

 ** responseCard **   <a name="lex-Type-Statement-responseCard"></a>
 在运行时，如果客户端正在使用 [PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html)API，Amazon Lex 会在响应中包含响应卡。它使用所有会话属性和插槽值替换响应卡中的占位符。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 50000。  
必需：否

## 另请参阅
<a name="API_Statement_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Statement) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Statement) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Statement) 

# Tag
<a name="API_Tag"></a>

标识机器人、机器人别名或机器人通道的键/值对列表。标签键和值可以包含 Unicode 字母、数字、空格及以下符号：\$1 . : / = \$1 - @。

## 内容
<a name="API_Tag_Contents"></a>

 ** key **   <a name="lex-Type-Tag-key"></a>
用于标签的键。键不区分大小写，并且必须是唯一的。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 128。  
必需：是

 ** value **   <a name="lex-Type-Tag-value"></a>
与键关联的值。该值可以是空字符串，但不能为 null。  
类型：字符串  
长度约束：最小长度为 0。最大长度为 256。  
必需：是

## 另请参阅
<a name="API_Tag_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/Tag) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/Tag) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/Tag) 

# UtteranceData
<a name="API_UtteranceData"></a>

提供有关向您的机器人发出的单句言语的信息。

## 内容
<a name="API_UtteranceData_Contents"></a>

 ** count **   <a name="lex-Type-UtteranceData-count"></a>
言语受到处理的次数。  
类型：整数  
必需：否

 ** distinctUsers **   <a name="lex-Type-UtteranceData-distinctUsers"></a>
使用该言语的个人总数。  
类型：整数  
必需：否

 ** firstUtteredDate **   <a name="lex-Type-UtteranceData-firstUtteredDate"></a>
首次录制言语的日期。  
类型：时间戳  
必需：否

 ** lastUtteredDate **   <a name="lex-Type-UtteranceData-lastUtteredDate"></a>
末次录制言语的日期。  
类型：时间戳  
必需：否

 ** utteranceString **   <a name="lex-Type-UtteranceData-utteranceString"></a>
用户输入的文本或音频片段的文本表示形式。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 2000。  
必需：否

## 另请参阅
<a name="API_UtteranceData_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/UtteranceData) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/UtteranceData) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/UtteranceData) 

# UtteranceList
<a name="API_UtteranceList"></a>

提供针对特定版本的机器人所说的言语列表。该列表最多包含 100 句言语。

## 内容
<a name="API_UtteranceList_Contents"></a>

 ** botVersion **   <a name="lex-Type-UtteranceList-botVersion"></a>
用于处理列表的机器人的版本。  
类型：字符串  
长度限制：长度下限为 1。长度上限为 64。  
模式：`\$LATEST|[0-9]+`  
必需：否

 ** utterances **   <a name="lex-Type-UtteranceList-utterances"></a>
一个或多个 [UtteranceData](API_UtteranceData.md) 对象，其中包含有关已向机器人发出的言语的信息。每个对象的最大数目为 100。  
类型：[UtteranceData](API_UtteranceData.md) 对象数组  
必需：否

## 另请参阅
<a name="API_UtteranceList_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/UtteranceList) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/UtteranceList) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/UtteranceList) 

# Amazon Lex 运行时服务
<a name="API_Types_Amazon_Lex_Runtime_Service"></a>

Amazon Lex 运行时服务支持以下数据类型：
+  [ActiveContext](API_runtime_ActiveContext.md) 
+  [ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) 
+  [Button](API_runtime_Button.md) 
+  [DialogAction](API_runtime_DialogAction.md) 
+  [GenericAttachment](API_runtime_GenericAttachment.md) 
+  [IntentConfidence](API_runtime_IntentConfidence.md) 
+  [IntentSummary](API_runtime_IntentSummary.md) 
+  [PredictedIntent](API_runtime_PredictedIntent.md) 
+  [ResponseCard](API_runtime_ResponseCard.md) 
+  [SentimentResponse](API_runtime_SentimentResponse.md) 

# ActiveContext
<a name="API_runtime_ActiveContext"></a>

上下文是一个变量，它包含有关用户与 Amazon Lex 之间对话的当前状态的信息。上下文可以在履行意图时由 Amazon Lex 自动设置，也可以在运行时使用 `PutContent`、`PutText` 或 `PutSession` 操作进行设置。

## 内容
<a name="API_runtime_ActiveContext_Contents"></a>

 ** name **   <a name="lex-Type-runtime_ActiveContext-name"></a>
上下文的名称。  
类型：字符串  
长度约束：最小长度为 1。最大长度为 100。  
模式：`^([A-Za-z]_?)+$`  
必需：是

 ** parameters **   <a name="lex-Type-runtime_ActiveContext-parameters"></a>
当前上下文的状态变量。在后续事件中，您可以使用这些值作为插槽的默认值。  
类型：字符串到字符串映射  
映射条目：最低 0 项。最多 10 个物品。  
密钥长度限制：最小长度为 1。最大长度为 100。  
值长度限制：最小长度为 1。最大长度为 1024。  
必需：是

 ** timeToLive **   <a name="lex-Type-runtime_ActiveContext-timeToLive"></a>
上下文保持活动状态的时间长度或回合数。  
类型：[ActiveContextTimeToLive](API_runtime_ActiveContextTimeToLive.md) 对象  
必需：是

## 另请参阅
<a name="API_runtime_ActiveContext_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/ActiveContext) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/ActiveContext) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/ActiveContext) 

# ActiveContextTimeToLive
<a name="API_runtime_ActiveContextTimeToLive"></a>

上下文保持活动状态的时间长度或回合数。

## 内容
<a name="API_runtime_ActiveContextTimeToLive_Contents"></a>

 ** timeToLiveInSeconds **   <a name="lex-Type-runtime_ActiveContextTimeToLive-timeToLiveInSeconds"></a>
在 `PostContent` 或 `PostText` 响应中首次发送上下文后，上下文应处于活动状态的秒数。您可以设置 5 到 86,400 秒（24 小时）之间的值。  
类型：整数  
有效范围：最小值为 5。最大值为 86400。  
必需：否

 ** turnsToLive **   <a name="lex-Type-runtime_ActiveContextTimeToLive-turnsToLive"></a>
上下文应处于活动状态的对话回合次数。对话回合是指一个 `PostContent` 或 `PostText` 请求以及来自 Amazon Lex 的相应响应。  
类型：整数  
有效范围：最小值为 1。最大值为 20。  
必需：否

## 另请参阅
<a name="API_runtime_ActiveContextTimeToLive_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/ActiveContextTimeToLive) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/ActiveContextTimeToLive) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/ActiveContextTimeToLive) 

# Button
<a name="API_runtime_Button"></a>

表示要在客户端平台（Facebook、Slack 等）上显示的选项

## 内容
<a name="API_runtime_Button_Contents"></a>

 ** text **   <a name="lex-Type-runtime_Button-text"></a>
用户可以在按钮上看到的文本。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 15。  
必需：是

 ** value **   <a name="lex-Type-runtime_Button-value"></a>
当用户选择按钮时发送给 Amazon Lex 的值。例如，考虑按钮文本“NYC”。当用户选择该按钮时，发送的值可以是“纽约市”。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 1000。  
必需：是

## 另请参阅
<a name="API_runtime_Button_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/Button) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/Button) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/Button) 

# DialogAction
<a name="API_runtime_DialogAction"></a>

描述机器人与用户互动时应采取的下一个操作，并提供有关该操作发生的上下文的信息。使用 `DialogAction` 数据类型将交互设置为特定状态，或让交互返回到先前的状态。

## 内容
<a name="API_runtime_DialogAction_Contents"></a>

 ** type **   <a name="lex-Type-runtime_DialogAction-type"></a>
机器人与用户交互时应采取的下一个操作。可能的值包括：  
+  `ConfirmIntent` — 下一个操作是询问用户意图是否已完成并准备好履行。这是一个回答“是”或“否”的问题，例如“是否下订单？”
+  `Close` — 表示用户不会做出响应。例如，“您的披萨已下单”不需要响应。
+  `Delegate` — 下一个操作由 Amazon Lex 决定。
+  `ElicitIntent` — 下一个操作是确定用户想要履行的意图。
+  `ElicitSlot` — 下一个操作是从用户引发插槽值。
类型：字符串  
有效值：`ElicitIntent | ConfirmIntent | ElicitSlot | Close | Delegate`  
必需：是

 ** fulfillmentState **   <a name="lex-Type-runtime_DialogAction-fulfillmentState"></a>
意图的履行状态。可能的值包括：  
+  `Failed` — 与意图关联的 Lambda 函数未能履行意图。
+  `Fulfilled` — 与意图关联的 Lambda 函数已履行意图。
+  `ReadyForFulfillment` — 存在意图所需的所有信息，并且客户端应用程序已准备好履行意图。
类型：字符串  
有效值：`Fulfilled | Failed | ReadyForFulfillment`  
必需：否

 ** intentName **   <a name="lex-Type-runtime_DialogAction-intentName"></a>
意图的名称。  
类型：字符串  
必需：否

 ** message **   <a name="lex-Type-runtime_DialogAction-message"></a>
应显示给用户的消息。如果您不指定消息，Amazon Lex 将使用为意图配置的消息。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 1024。  
必需：否

 ** messageFormat **   <a name="lex-Type-runtime_DialogAction-messageFormat"></a>
+  `PlainText` — 消息包含 UTF-8 纯文本。
+  `CustomPayload` — 消息是客户端的自定义格式。
+  `SSML` — 消息包含为语音输出设置格式的文本。
+  `Composite` — 消息包含一个转义的 JSON 对象，其中包含一条或多条消息。有关更多信息，请参阅[消息组](https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html)。
类型：字符串  
有效值：`PlainText | CustomPayload | SSML | Composite`  
必需：否

 ** slots **   <a name="lex-Type-runtime_DialogAction-slots"></a>
已收集到的插槽及其值的映射。  
类型：字符串到字符串映射  
必需：否

 ** slotToElicit **   <a name="lex-Type-runtime_DialogAction-slotToElicit"></a>
应从用户引发的插槽的名称。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_runtime_DialogAction_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/DialogAction) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/DialogAction) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/DialogAction) 

# GenericAttachment
<a name="API_runtime_GenericAttachment"></a>

表示显示提示时向用户呈现的选项。它可以是图像、按钮、链接或文本。

## 内容
<a name="API_runtime_GenericAttachment_Contents"></a>

 ** attachmentLinkUrl **   <a name="lex-Type-runtime_GenericAttachment-attachmentLinkUrl"></a>
响应卡上附件的 URL。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** buttons **   <a name="lex-Type-runtime_GenericAttachment-buttons"></a>
要向用户显示的选项列表。  
类型：[Button](API_runtime_Button.md) 对象数组  
数组成员：最少 0 个物品。最多 5 项。  
必需：否

 ** imageUrl **   <a name="lex-Type-runtime_GenericAttachment-imageUrl"></a>
向用户显示的图像的 URL。  
类型：字符串  
长度限制：最小长度为 0。最大长度为 2048。  
必需：否

 ** subTitle **   <a name="lex-Type-runtime_GenericAttachment-subTitle"></a>
标题下方显示的副标题。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 80。  
必需：否

 ** title **   <a name="lex-Type-runtime_GenericAttachment-title"></a>
选项的标题。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 80。  
必需：否

## 另请参阅
<a name="API_runtime_GenericAttachment_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/GenericAttachment) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/GenericAttachment) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/GenericAttachment) 

# IntentConfidence
<a name="API_runtime_IntentConfidence"></a>

提供一个分数，表示 Amazon Lex 对意图可满足用户的意图的置信度。

## 内容
<a name="API_runtime_IntentConfidence_Contents"></a>

 ** score **   <a name="lex-Type-runtime_IntentConfidence-score"></a>
该分数表示 Amazon Lex 对意图可满足用户的意图的置信度。范围介于 0.00 和 1.00 之间。分数越高，置信度越高。  
类型：双精度  
必需：否

## 另请参阅
<a name="API_runtime_IntentConfidence_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/IntentConfidence) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/IntentConfidence) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/IntentConfidence) 

# IntentSummary
<a name="API_runtime_IntentSummary"></a>

提供有关意图状态的信息。您可以使用此信息来获取意图的当前状态，以便可以处理意图，也可以将意图恢复到其先前的状态。

## 内容
<a name="API_runtime_IntentSummary_Contents"></a>

 ** dialogActionType **   <a name="lex-Type-runtime_IntentSummary-dialogActionType"></a>
机器人与用户交互时应采取的下一个操作。可能的值包括：  
+  `ConfirmIntent` — 下一个操作是询问用户意图是否已完成并准备好履行。这是一个回答“是”或“否”的问题，例如“是否下订单？”
+  `Close` — 表示用户不会做出响应。例如，“您的披萨已下单”不需要响应。
+  `ElicitIntent` — 下一个操作是确定用户想要履行的意图。
+  `ElicitSlot` — 下一个操作是从用户引发插槽值。
类型：字符串  
有效值：`ElicitIntent | ConfirmIntent | ElicitSlot | Close | Delegate`  
必需：是

 ** checkpointLabel **   <a name="lex-Type-runtime_IntentSummary-checkpointLabel"></a>
用于标识特定意图的用户定义标签。您可以使用此标签返回到之前的意图。  
使用 `GetSessionRequest` 操作的 `checkpointLabelFilter` 参数筛选操作返回的意图，以仅显示带有指定标签的意图。  
类型：字符串  
长度限制：长度下限为 1。最大长度为 255。  
模式：`[a-zA-Z0-9-]+`  
必需：否

 ** confirmationStatus **   <a name="lex-Type-runtime_IntentSummary-confirmationStatus"></a>
用户响应确认提示后意图的状态。如果用户确认意图，则 Amazon Lex 会将此字段设置为 `Confirmed`。如果用户拒绝意图，则 Amazon Lex 会将此值设置为 `Denied`。可能的值包括：  
+  `Confirmed` — 用户已对确认提示响应“是”，从而确认意图已完成且已准备好履行。
+  `Denied` — 用户已对确认提示响应“否”。
+  `None` — 永不提示用户进行确认；或者，系统已提示用户，但用户未确认也未拒绝提示。
类型：字符串  
有效值：`None | Confirmed | Denied`  
必需：否

 ** fulfillmentState **   <a name="lex-Type-runtime_IntentSummary-fulfillmentState"></a>
意图的履行状态。可能的值包括：  
+  `Failed` — 与意图关联的 Lambda 函数未能履行意图。
+  `Fulfilled` — 与意图关联的 Lambda 函数已履行意图。
+  `ReadyForFulfillment` — 存在意图所需的所有信息，并且客户端应用程序已准备好履行意图。
类型：字符串  
有效值：`Fulfilled | Failed | ReadyForFulfillment`  
必需：否

 ** intentName **   <a name="lex-Type-runtime_IntentSummary-intentName"></a>
意图的名称。  
类型：字符串  
必需：否

 ** slots **   <a name="lex-Type-runtime_IntentSummary-slots"></a>
已收集到的插槽及其值的映射。  
类型：字符串到字符串映射  
必需：否

 ** slotToElicit **   <a name="lex-Type-runtime_IntentSummary-slotToElicit"></a>
要从用户引发的下一个插槽。如果没有插槽可以引发，则该字段为空。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_runtime_IntentSummary_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/IntentSummary) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/IntentSummary) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/IntentSummary) 

# PredictedIntent
<a name="API_runtime_PredictedIntent"></a>

Amazon Lex 提出的意图可以满足用户的意图。包括意图名称、Amazon Lex 对用户意图得到满足的置信度，以及为意图定义的插槽。

## 内容
<a name="API_runtime_PredictedIntent_Contents"></a>

 ** intentName **   <a name="lex-Type-runtime_PredictedIntent-intentName"></a>
Amazon Lex 提出可以满足用户的意图的意图名称。  
类型：字符串  
必需：否

 ** nluIntentConfidence **   <a name="lex-Type-runtime_PredictedIntent-nluIntentConfidence"></a>
表示 Amazon Lex 对意图是满足用户的意图的置信度。  
类型：[IntentConfidence](API_runtime_IntentConfidence.md) 对象  
必需：否

 ** slots **   <a name="lex-Type-runtime_PredictedIntent-slots"></a>
与预测意图关联的插槽和插槽值。  
类型：字符串到字符串映射  
必需：否

## 另请参阅
<a name="API_runtime_PredictedIntent_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/PredictedIntent) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/PredictedIntent) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/PredictedIntent) 

# ResponseCard
<a name="API_runtime_ResponseCard"></a>

如果您在创建机器人时配置了响应卡，Amazon Lex 会替换可用的会话属性和插槽值，然后将其返回。响应卡也可以来自 Lambda 函数（意图上的 `dialogCodeHook` 和 `fulfillmentActivity`）。

## 内容
<a name="API_runtime_ResponseCard_Contents"></a>

 ** contentType **   <a name="lex-Type-runtime_ResponseCard-contentType"></a>
响应的内容类型。  
类型：字符串  
有效值：`application/vnd.amazonaws.card.generic`  
必需：否

 ** genericAttachments **   <a name="lex-Type-runtime_ResponseCard-genericAttachments"></a>
代表选项的附件对象数组。  
类型：[GenericAttachment](API_runtime_GenericAttachment.md) 对象数组  
数组成员：最少 0 个物品。最多 10 个物品。  
必需：否

 ** version **   <a name="lex-Type-runtime_ResponseCard-version"></a>
响应卡格式的版本。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_runtime_ResponseCard_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/ResponseCard) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/ResponseCard) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/ResponseCard) 

# SentimentResponse
<a name="API_runtime_SentimentResponse"></a>

用言语表达的情绪。

当机器人配置为向 Amazon Comprehend 发送言语以进行情绪分析时，此字段结构将包含分析结果。

## 内容
<a name="API_runtime_SentimentResponse_Contents"></a>

 ** sentimentLabel **   <a name="lex-Type-runtime_SentimentResponse-sentimentLabel"></a>
Amazon Comprehend 置信度最高的情绪推断。  
类型：字符串  
必需：否

 ** sentimentScore **   <a name="lex-Type-runtime_SentimentResponse-sentimentScore"></a>
情绪推断正确的可能性。  
类型：字符串  
必需：否

## 另请参阅
<a name="API_runtime_SentimentResponse_SeeAlso"></a>

有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容：
+  [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/runtime.lex-2016-11-28/SentimentResponse) 
+  [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/runtime.lex-2016-11-28/SentimentResponse) 
+  [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/runtime.lex-2016-11-28/SentimentResponse)