기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeBotRecommendation
봇 권장 사항에 메타데이터를 제공합니다. 이 정보를 통해 요청 입력에 대한 설명을 얻고, 처리가 완료된 후 관련 기록을 다운로드하고, 봇 추천에 의해 생성된 인텐트 및 슬롯 유형을 다운로드할 수 있습니다.
요청 구문
GET /bots/botId
/botversions/botVersion
/botlocales/localeId
/botrecommendations/botRecommendationId
/ HTTP/1.1
URI 요청 파라미터
요청은 다음의 URI 파라미터를 사용합니다.
- botId
-
봇 추천과 연결된 봇의 고유 식별자입니다.
길이 제약 조건: 고정 길이 10입니다.
Pattern:
^[0-9a-zA-Z]+$
: 필수 예
- botRecommendationId
-
설명할 봇 추천의 식별자입니다.
길이 제약 조건: 고정 길이 10입니다.
Pattern:
^[0-9a-zA-Z]+$
: 필수 예
- botVersion
-
봇 권장 사항과 연결된 봇의 버전입니다.
길이 제약 조건: 고정 길이 5입니다.
Pattern:
^DRAFT$
: 필수 예
- localeId
-
설명할 봇 권장 사항의 언어 및 로케일의 식별자입니다. 문자열은 지원되는 로케일 중 하나와 일치해야 합니다. 자세한 내용은 단원을 참조하십시오.지원되는 언어.
: 필수 예
요청 본문
요청에 요청 본문이 없습니다.
응답 구문
HTTP/1.1 200
Content-type: application/json
{
"botId": "string",
"botRecommendationId": "string",
"botRecommendationResults": {
"associatedTranscriptsUrl": "string",
"botLocaleExportUrl": "string",
"statistics": {
"intents": {
"discoveredIntentCount": number
},
"slotTypes": {
"discoveredSlotTypeCount": number
}
}
},
"botRecommendationStatus": "string",
"botVersion": "string",
"creationDateTime": number,
"encryptionSetting": {
"associatedTranscriptsPassword": "string",
"botLocaleExportPassword": "string",
"kmsKeyArn": "string"
},
"failureReasons": [ "string" ],
"lastUpdatedDateTime": number,
"localeId": "string",
"transcriptSourceSetting": {
"s3BucketTranscriptSource": {
"kmsKeyArn": "string",
"pathFormat": {
"objectPrefixes": [ "string" ]
},
"s3BucketName": "string",
"transcriptFilter": {
"lexTranscriptFilter": {
"dateRangeFilter": {
"endDateTime": number,
"startDateTime": number
}
}
},
"transcriptFormat": "string"
}
}
}
응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 다시 전송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- botId
-
봇 추천과 연결된 봇의 식별자입니다.
Type: 문자열
길이 제약 조건: 고정 길이 10입니다.
Pattern:
^[0-9a-zA-Z]+$
- botRecommendationId
-
설명되는 봇 권장 사항의 식별자입니다.
Type: 문자열
길이 제약 조건: 고정 길이 10입니다.
Pattern:
^[0-9a-zA-Z]+$
- botRecommendationResults
-
봇 정의의 URL, 연관된 성적 기록의 URL 및 봇 추천 결과의 통계 요약을 나타내는 객체입니다.
유형: BotRecommendationResults 객체
- botRecommendationStatus
-
봇 권장 사항의 상태입니다. 상태가 실패인 경우 실패 이유가 실패이유 필드에 나열됩니다.
Type: 문자열
유효한 값:
Processing | Deleting | Deleted | Downloading | Updating | Available | Failed
- botVersion
-
봇 권장 사항과 연결된 봇의 버전입니다.
Type: 문자열
길이 제약 조건: 고정 길이 5입니다.
Pattern:
^DRAFT$
- creationDateTime
-
봇 권장 사항이 생성된 날짜와 시간입니다.
Type: 타임스탬프
- encryptionSetting
-
봇 추천 결과와 관련된 데이터를 암호화하는 데 사용된 암호를 나타내는 객체와 연관된 메타데이터를 암호화하는 데 사용된 KMS 키 ARN을 나타냅니다.
유형: EncryptionSetting 객체
- failureReasons
-
보트리뷰 상태가 실패인 경우 Amazon Lex에서 그 이유를 설명합니다.
Type: 문자열 배열
- lastUpdatedDateTime
-
봇 권장 사항이 마지막으로 업데이트된 날짜 및 시간입니다.
Type: 타임스탬프
- localeId
-
설명할 봇 권장 사항의 언어 및 로케일의 식별자입니다.
Type: 문자열
- transcriptSourceSetting
-
관련 메타데이터뿐만 아니라 해당 기록을 포함하는 Amazon S3 버킷을 나타내는 객체입니다.
유형: TranscriptSourceSetting 객체
오류
모든 작업에 공통적인 오류에 대한 자세한 내용은 단원을 참조하십시오.일반적인 오류.
- InternalServerException
-
서비스에 예상치 못한 조건이 발생했습니다. 요청을 다시 시도하십시오.
HTTP 상태 코드: 500
- ResourceNotFoundException
-
사용자가 존재하지 않는 리소스를 설명하도록 요청했습니다. 요청하는 리소스를 확인하고 다시 시도하십시오.
HTTP 상태 코드: 404
- ThrottlingException
-
요청량이 너무 높습니다. 요청 횟수를 줄입니다.
HTTP 상태 코드: 429
- ValidationException
-
요청의 입력 매개 변수 중 하나가 잘못되었습니다. 파라미터를 확인하고 요청을 다시 시도하십시오.
HTTP 상태 코드: 400
참고 항목
이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.