DescribeIntent - Amazon Lex

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

DescribeIntent

의도를 위한 메타데이터를 반환합니다.

요청 구문

GET /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/ HTTP/1.1

URI 요청 파라미터

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

botId

인텐트와 연결된 봇의 식별자입니다.

길이 제약 조건: 고정 길이 10입니다.

Pattern: ^[0-9a-zA-Z]+$

: 필수 예

botVersion

인텐트와 연결된 봇 버전입니다.

길이 제약 조건: 최소 길이는 1이고, 최대 길이는 5이고,

Pattern: ^(DRAFT|[0-9]+)$

: 필수 예

intentId

설명할 인텐트의 식별자입니다.

길이 제약 조건: 고정 길이 10입니다.

Pattern: ^[0-9a-zA-Z]+$

: 필수 예

localeId

설명할 인텐트의 언어 및 로케일의 식별자입니다. 문자열은 지원되는 로케일 중 하나와 일치해야 합니다. 자세한 내용은 단원을 참조하십시오.지원되는 언어.

: 필수 예

요청 본문

요청에 요청 본문이 없습니다.

응답 구문

HTTP/1.1 200 Content-type: application/json { "botId": "string", "botVersion": "string", "creationDateTime": number, "description": "string", "dialogCodeHook": { "enabled": boolean }, "fulfillmentCodeHook": { "enabled": boolean, "fulfillmentUpdatesSpecification": { "active": boolean, "startResponse": { "allowInterrupt": boolean, "delayInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutInSeconds": number, "updateResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } }, "postFulfillmentStatusSpecification": { "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "successResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "inputContexts": [ { "name": "string" } ], "intentClosingSetting": { "active": boolean, "closingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } }, "intentConfirmationSetting": { "active": boolean, "declinationResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } }, "intentId": "string", "intentName": "string", "kendraConfiguration": { "kendraIndex": "string", "queryFilterString": "string", "queryFilterStringEnabled": boolean }, "lastUpdatedDateTime": number, "localeId": "string", "outputContexts": [ { "name": "string", "timeToLiveInSeconds": number, "turnsToLive": number } ], "parentIntentSignature": "string", "sampleUtterances": [ { "utterance": "string" } ], "slotPriorities": [ { "priority": number, "slotId": "string" } ] }

응답 요소

작업이 성공하면 서비스가 HTTP 200 응답을 다시 전송합니다.

다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.

botId

인텐트와 연결된 봇의 식별자입니다.

Type: 문자열

길이 제약 조건: 고정 길이 10입니다.

Pattern: ^[0-9a-zA-Z]+$

botVersion

인텐트와 연결된 봇 버전입니다.

Type: 문자열

길이 제약 조건: 고정 길이 5입니다.

Pattern: ^DRAFT$

creationDateTime

의도를 생성한 날짜와 시간의 타임스탬프입니다.

Type: 타임스탬프

description

의도의 설명입니다.

Type: 문자열

길이 제약 조건: 최소 길이는 0입니다. 최대 길이는 200입니다.

dialogCodeHook

인텐트와 대화할 때마다 호출되는 Lambda 함수입니다.

유형: DialogCodeHookSettings 객체

fulfillmentCodeHook

인텐트가 완료되어 이행 준비가 되었을 때 호출되는 Lambda 함수입니다.

유형: FulfillmentCodeHookSettings 객체

inputContexts

사용자에게 보내기 위해 인텐트를 고려하기 위해 활성화되어야 하는 컨텍스트 목록입니다.

Type: 배열InputContext사물

배열 멤버: 최소 항목 수 0개. 최대 항목 수는 5개입니다.

intentClosingSetting

인텐트가 닫힐 때 Amazon Lex가 보내는 응답입니다.

유형: IntentClosingSetting 객체

intentConfirmationSetting

인텐트 완료를 확인하기 위해 Amazon Lex가 사용자에게 전송하라는 메시지를 표시합니다.

유형: IntentConfirmationSetting 객체

intentId

의도 생성 시 할당한 고유 식별자입니다.

Type: 문자열

길이 제약 조건: 고정 길이 10입니다.

Pattern: ^[0-9a-zA-Z]+$

intentName

의도를 위해 지정된 이름

Type: 문자열

길이 제약 조건: 최소 길이는 1이고, 최대 길이는 100입니다.

Pattern: ^([0-9a-zA-Z][_-]?)+$

kendraConfiguration

를 사용하는 데 필요한 구성 정보AMAZON.KendraSearchIntent의도.

유형: KendraConfiguration 객체

lastUpdatedDateTime

의도를 마지막으로 업데이트한 날짜와 시간의 타임스탬프입니다.

Type: 타임스탬프

localeId

인텐트에 지정된 언어와 로캘입니다.

Type: 문자열

outputContexts

인텐트가 이행될 때 활성화되는 컨텍스트 목록입니다.

Type: 배열OutputContext사물

배열 멤버: 최소 항목 수 0개. 최대 항목 수는 10개입니다.

parentIntentSignature

이 인텐트가 파생된 내장 인텐트의 식별자 (있는 경우) 입니다.

Type: 문자열

sampleUtterances

이 인텐트를 트리거하는 사용자 말입니다.

Type: 배열SampleUtterance사물

slotPriorities

사용자로부터 슬롯을 추출해야 하는 우선 순위를 결정하는 목록입니다.

Type: 배열SlotPriority사물

오류

모든 작업에 공통적인 오류에 대한 자세한 내용은 단원을 참조하십시오.일반적인 오류.

InternalServerException

서비스에 예상치 못한 조건이 발생했습니다. 요청을 다시 시도하십시오.

HTTP 상태 코드: 500

ResourceNotFoundException

사용자가 존재하지 않는 리소스를 설명하도록 요청했습니다. 요청하는 리소스를 확인하고 다시 시도하십시오.

HTTP 상태 코드: 404

ServiceQuotaExceededException

봇에 대한 할당량에 도달했습니다.

HTTP 상태 코드: 402

ThrottlingException

요청량이 너무 높습니다. 요청 횟수를 줄입니다.

HTTP 상태 코드: 429

ValidationException

요청의 입력 매개 변수 중 하나가 잘못되었습니다. 파라미터를 확인하고 요청을 다시 시도하십시오.

HTTP 상태 코드: 400

참고 항목

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