终止支持通知：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)。本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # GetBot 返回特定机器人的元数据信息。您必须提供机器人名称和机器人版本或别名。此操作需要 `lex:GetBot` 操作的权限。 ## 请求语法 ``` GET /bots/name/versions/versionoralias HTTP/1.1 ``` ## URI 请求参数请求使用以下 URI 参数。 ** [name](#API_GetBot_RequestSyntax) ** 机器人的名称。该名称区分大小写。长度限制：最小长度为 2。最大长度为 50。模式：`^([A-Za-z]_?)+$` 是否必需：是 ** [versionoralias](#API_GetBot_RequestSyntax) ** 机器人的版本或别名。是否必需：是 ## 请求体该请求没有请求正文。 ## 响应语法 ``` 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](#API_GetBot_ResponseSyntax) ** 当用户选择在不完成对话的情况下结束对话时，Amazon Lex 返回的消息。有关更多信息，请参阅 [PutBot](API_PutBot.md)。类型：[Statement](API_Statement.md) 对象 ** [checksum](#API_GetBot_ResponseSyntax) ** 用于识别机器人 `$LATEST` 版本的特定修订版的机器人的校验和。类型：字符串 ** [childDirected](#API_GetBot_ResponseSyntax) ** 对于使用 Amazon Lex 模型构建服务创建的每个 Amazon Lex 机器人，您都必须通过在 `childDirected` 字段中指定 `true` 或 `false`，指定您对 Amazon Lex 的使用是否与全部或部分针对 13 岁以下儿童且受《儿童在线隐私保护法》(COPPA) 约束的网站、程序或其他应用程序有关。在 `childDirected` 字段中指定 `true`，即表示您确认您对 Amazon Lex 的使用**确实**与全部或部分针对 13 岁以下儿童且受 COPPA 约束的网站、计划或其他应用程序有关。在 `childDirected` 字段中指定 `false`，即表示您确认您对 Amazon Lex 的使用**不**与全部或部分针对 13 岁以下儿童且受 COPPA 约束的网站、计划或其他应用程序有关。如果在 `childDirected` 字段中指定默认值不能正确反映您确认您对 Amazon Lex 的使用不与全部或部分针对 13 岁以下儿童且受 COPPA 约束的网站、计划或其他应用程序有关，则您可以不指定。如果您对 Amazon Lex 的使用涉及全部或部分针对 13 岁以下儿童的网站、程序或其他应用程序，则必须获得 COPPA 规定的任何必需的可核实的家长同意。有关将 Amazon Lex 用于全部或部分针对 13 岁以下儿童的网站、程序或其他应用程序的信息，请参阅 [Amazon Lex 常见问题解答](https://aws.amazon.com/lex/faqs#data-security)。类型：布尔值 ** [clarificationPrompt](#API_GetBot_ResponseSyntax) ** Amazon Lex 在无法理解用户的请求时使用的消息。有关更多信息，请参阅 [PutBot](API_PutBot.md)。类型：[Prompt](API_Prompt.md) 对象 ** [createdDate](#API_GetBot_ResponseSyntax) ** 机器人的创建日期。类型：时间戳 ** [description](#API_GetBot_ResponseSyntax) ** 机器人的描述。类型：字符串长度限制：最小长度为 0。最大长度为 200。 ** [detectSentiment](#API_GetBot_ResponseSyntax) ** 表示是否应将用户言语发送到 Amazon Comprehend 以进行情绪分析。类型：布尔值 ** [enableModelImprovements](#API_GetBot_ResponseSyntax) ** 表示机器人是否使用精度改进。`true` 表示机器人正在使用改进，否则为 `false`。类型：布尔值 ** [failureReason](#API_GetBot_ResponseSyntax) ** 如果 `status` 是 `FAILED`，Amazon Lex 会解释为什么它未能构建该机器人。类型：字符串 ** [idleSessionTTLInSeconds](#API_GetBot_ResponseSyntax) ** Amazon Lex 保留对话中收集的数据的最长时间（秒）。有关更多信息，请参阅 [PutBot](API_PutBot.md)。类型：整数有效范围：最小值为 60。最大值为 86400。 ** [intents](#API_GetBot_ResponseSyntax) ** `intent` 数据元数组。有关更多信息，请参阅 [PutBot](API_PutBot.md)。类型：[Intent](API_Intent.md) 对象数组 ** [lastUpdatedDate](#API_GetBot_ResponseSyntax) ** 机器人的更新日期。创建资源时，创建日期和上次更新日期相同。类型：时间戳 ** [locale](#API_GetBot_ResponseSyntax) ** 机器人的目标区域设置。类型：字符串有效值：`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](#API_GetBot_ResponseSyntax) ** 机器人的名称。类型：字符串长度限制：最小长度为 2。最大长度为 50。模式：`^([A-Za-z]_?)+$` ** [nluIntentConfidenceThreshold](#API_GetBot_ResponseSyntax) ** 该分数决定 Amazon Lex 在或[PostText](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html)响应中返回替代意图时在何处插入`AMAZON.KendraSearchIntent`、[PostContent](https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html)或两者。`AMAZON.FallbackIntent` `AMAZON.FallbackIntent`如果实际可信度分数低于此值，则会插入。 `AMAZON.KendraSearchIntent`只有在为机器人配置时才会插入。类型：双精度有效范围：最小值为 0。最大值为 1。 ** [status](#API_GetBot_ResponseSyntax) ** 机器人的状态。当状态为 `BUILDING` 时，Amazon Lex 正在构建机器人以供测试和使用。如果机器人的状态为 `READY_BASIC_TESTING`，则可以使用机器人意图中指定的确切言语来测试机器人。当机器人准备好进行全面测试或运行时，状态为 `READY`。如果在构建机器人时出现问题，则状态为 `FAILED`，并且 `failureReason` 字段解释了为什么没有构建机器人。如果机器人已保存但未构建，则状态为 `NOT_BUILT`。类型：字符串有效值：`BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT` ** [version](#API_GetBot_ResponseSyntax) ** 自动程序的版本。对于新机器人，版本始终是 `$LATEST`。类型：字符串长度限制：最小长度为 1。长度上限为 64。模式：`\$LATEST|[0-9]+` ** [voiceId](#API_GetBot_ResponseSyntax) ** Amazon Lex 用于和用户进行语音交互的 Amazon Polly 语音 ID。有关更多信息，请参阅 [PutBot](API_PutBot.md)。类型：字符串 ## 错误 ** BadRequestException ** 请求格式不正确。例如，值无效或必填字段未填充。检查字段值，然后重试。 HTTP 状态代码：400 ** InternalFailureException ** 出现内部 Amazon Lex 错误。请再次尝试您的请求。 HTTP 状态代码：500 ** LimitExceededException ** 请求超出了限制。请再次尝试您的请求。 HTTP 状态代码：429 ** NotFoundException ** 找不到在请求中指定的资源。检查资源并重试。 HTTP 状态代码：404 ## 另请参阅有关以特定语言之一使用此 API 的更多信息 AWS SDKs，请参阅以下内容： + [AWS 命令行界面 V2](https://docs.aws.amazon.com/goto/cli2/lex-models-2017-04-19/GetBot) + [AWS 适用于.NET 的 SDK V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lex-models-2017-04-19/GetBot) + [AWS 适用于 C\$1\$1 的 SDK](https://docs.aws.amazon.com/goto/SdkForCpp/lex-models-2017-04-19/GetBot) + [AWS 适用于 Go v2 的 SDK](https://docs.aws.amazon.com/goto/SdkForGoV2/lex-models-2017-04-19/GetBot) + [AWS 适用于 Java 的 SDK V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lex-models-2017-04-19/GetBot) + [AWS JavaScript V3 版软件开发工具包](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lex-models-2017-04-19/GetBot) + [AWS 适用于 Kotlin 的 SDK](https://docs.aws.amazon.com/goto/SdkForKotlin/lex-models-2017-04-19/GetBot) + [AWS 适用于 PHP 的 SDK V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lex-models-2017-04-19/GetBot) + [AWS Python 软件开发工具包](https://docs.aws.amazon.com/goto/boto3/lex-models-2017-04-19/GetBot) + [AWS 适用于 Ruby V3 的 SDK](https://docs.aws.amazon.com/goto/SdkForRubyV3/lex-models-2017-04-19/GetBot)