GetBot - Amazon Lex V1
Request SyntaxURI 요청 파라미터Request BodyResponse Syntax응답 요소Errors참고

Amazon Lex V2를 사용하는 경우 Amazon Lex V2 가이드를 대신 참조하십시오.

 

Amazon Lex V1을 사용하는 경우 봇을 Amazon Lex V2로 업그레이드하는하는 것이 좋습니다. 더 이상 V1에 새로운 기능을 추가하지 않으므로 모든 새 봇에 V2를 사용할 것을 강력히 권장합니다.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

GetBot

특정 봇에 대한 메타데이터를 반환합니다. 봇 이름 및 봇 버전 또는 별칭도 제공해야 합니다.

이 작업에는 lex:GetBot 액션에 대한 권한이 필요합니다.

Request Syntax

GET /bots/name/versions/versionoralias HTTP/1.1

URI 요청 파라미터

요청은 다음 URI 파라미터를 사용합니다.

name

봇의 이름. 이름은 대/소문자를 구분합니다.

길이 제한: 최소 길이는 2. 최대 길이는 50.

패턴: ^([A-Za-z]_?)+$

필수 사항 여부: Yes

versionoralias

봇의 버전 또는 별칭입니다.

필수 사항 여부: Yes

Request Body

해당 요청에는 본문이 없습니다.

Response Syntax

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

사용자가 대화를 완료하지 않고 종료하기로 선택할 때 Amazon Lex가 반환하는 메시지입니다. 자세한 내용은 PutBot을 참조하세요.

유형: Statement 객체

checksum

봇의 $LATEST 버전의 특정 버전을 식별하는 데 사용되는 봇의 체크섬입니다.

타입: 문자열

childDirected

Amazon Lex Model Building Service로 만든 각 Amazon Lex 봇에 대해, Amazon Lex 사용이, 전체 또는 일부가, 13세 미만 어린이를 대상으로 하거나 대상으로 하는 웹 사이트, 프로그램 또는 기타 애플리케이션과 관련이 있는지 여부 및 어린이 온라인 개인정보 보호 법률(COPPA)을 준수하는지를 childDirected 필드의 true 또는 false를 지정하여 지정해야 합니다. childDirected 필드에 true을 지정함으로써 사용자는 Amazon Lex 사용이 13세 미만 및 COPPA 적용 대상 아동 전체 또는 일부를 대상으로 하는 웹 사이트, 프로그램 또는 기타 애플리케이션과 관련이 있음을 확인합니다. childDirected 필드에 false을 지정함으로써 사용자는 Amazon Lex 사용이 13세 미만 및 COPPA 적용 대상 아동 전체 또는 일부를 대상으로 하는 웹 사이트, 프로그램 또는 기타 애플리케이션과 관련이 없음을 확인합니다. 사용자는 Amazon Lex 사용이 13세 미만 및 COPPA 적용 대상 아동 전체 또는 일부를 대상으로 하는 웹 사이트, 프로그램 또는 기타 애플리케이션과 관련이 있는지 여부를 정확하게 반영하지 않는 childDirected 필드에 대한 기본값을 지정할 수 없습니다.

Amazon Lex의 사용이 전체 또는 부분적으로 13세 미만 어린이를 대상으로 하는 웹 사이트, 프로그램 또는 기타 애플리케이션과 관련된 경우 COPPA에 따라 검증 가능한 필수 부모 동의를 얻어야 합니다. 전체 또는 일부를 13세 미만 어린이를 대상으로 하거나 대상으로 하는 웹 사이트, 프로그램 또는 기타 애플리케이션과 관련된 Amazon Lex 사용에 관한 정보는 Amazon Lex FAQ를 참조하십시오.

타입: 부울

clarificationPrompt

Amazon Lex가 사용자의 요청을 이해하지 못할 때 사용하는 메시지입니다. 자세한 정보는 PutBot을 참조하세요.

유형: Prompt 객체

createdDate

봇이 생성된 날짜.

유형: 타임스탬프

description

봇에 대한 설명입니다.

타입: 문자열

길이 제한: 최소 길이는 0. 최대 길이는 200.

detectSentiment

감정 분석을 위해 사용자가 입력한 표현을 Amazon Comprehend로 전송해야 하는지 여부를 나타냅니다.

타입: 부울

enableModelImprovements

봇이 정확도 개선을 사용하는지 여부를 나타냅니다. true은 봇이 개선 사항을 사용하고 있음을 나타내며, 그렇지 않으면, false입니다.

타입: 부울

failureReason

status이 FAILED인 경우, Amazon Lex가 봇 구축에 실패한 이유를 설명합니다.

타입: 문자열

idleSessionTTLInSeconds

Amazon Lex가 대화에서 수집된 데이터를 유지하는 최대 시간(초) 입니다. 자세한 내용은 PutBot을 참조하세요.

유형: 정수

유효한 범위: 최소값은 60. 최대값은 86,400.

intents

intent 객체 어레이. 자세한 내용은 PutBot을 참조하세요.

유형: Intent 객체 배열

lastUpdatedDate

봇이 업데이트된 날짜. 리소스를 생성할 때 생성 날짜 및 최종 업데이트 날짜가 동일합니다.

유형: 타임스탬프

locale

봇의 타겟 로캘입니다.

타입: 문자열

유효 값: 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

봇의 이름.

타입: 문자열

길이 제한: 최소 길이는 2. 최대 길이는 50.

패턴: ^([A-Za-z]_?)+$

nluIntentConfidenceThreshold

또는 PostText응답에서 대체 인텐트를 반환할 때 Amazon Lex가 AMAZON.FallbackIntentAMAZON.KendraSearchIntent, 또는 둘 다를 삽입하는 PostContent위치를 결정하는 점수입니다. AMAZON.FallbackIntent모든 인텐트에 대한 신뢰도 점수가 이 값보다 낮은 경우 삽입됩니다. AMAZON.KendraSearchIntent봇용으로 구성된 경우에만 삽입됩니다.

유형: Double

유효한 범위: 최소값 0. 최댓값은 1.

status

봇의 상태.

상태가 BUILDING인 경우 Amazon Lex는 테스트 및 사용을 위해 봇을 구축하고 있습니다.

봇 상태가 READY_BASIC_TESTING인 경우 봇의 의도에 지정된 정확한 표현을 사용하여 봇을 테스트할 수 있습니다. 봇을 완전히 테스트하거나 실행할 준비가 되면 상태는 READY입니다.

봇을 구축하는 데 문제가 있는 경우 상태는 FAILED이며 failureReason 필드에는 봇이 빌드되지 않은 이유가 설명되어 있습니다.

봇이 저장되었지만 빌드되지 않은 경우 상태는 NOT_BUILT입니다.

타입: 문자열

유효 값: BUILDING | READY | READY_BASIC_TESTING | FAILED | NOT_BUILT

version

봇의 버전. 새 봇의 경우 버전은 항상 $LATEST입니다.

유형: 문자열

길이 제한: 최소 길이는 1. 최대 길이는 64.

패턴: \$LATEST|[0-9]+

voiceId

Amazon Lex가 사용자와의 음성 상호 작용에 사용하는 Amazon Polly 음성 ID입니다. 자세한 정보는 PutBot을 참조하세요.

타입: 문자열

Errors

BadRequestException

요청이 제대로 구성되지 않았습니다. 예를 들어, 값이 유효하지 않거나 필수 필드가 누락된 경우입니다. 필드 값을 확인한 후 다시 시도하세요.

HTTP 상태 코드: 400

InternalFailureException

내부 Amazon Lex 오류가 발생했습니다. 요청을 다시 시도하세요.

HTTP 상태 코드: 500

LimitExceededException

요청이 한도를 초과했습니다. 다시 요청해 보세요.

HTTP 상태 코드: 429

NotFoundException

요청에 지정된 리소스를 찾을 수 없습니다. 리소스를 확인한 후 다시 시도하세요.

HTTP 상태 코드: 404

참고

언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.