기록 파일을 사용하여 봇 디버그Debug your bot using transcript files

적용 대상: SDK v4APPLIES TO: SDK v4

봇을 성공적으로 테스트 및 디버깅하기 위한 요소 중 하나는 봇을 실행하는 동안 발생하는 조건 집합을 기록하고 검사하는 기능입니다.One of the keys to successful testing and debugging a bot is your ability to record and examine the set of conditions that occur when running your bot. 이 문서에서는 봇 기록 파일을 만들어서 테스트 및 디버깅을 위한 구체적인 사용자 상호 작용 및 봇 응답 집합을 제공하는 방법을 설명합니다.This article discusses the creation and use of a bot transcript file to provide a detailed set of user interactions and bot responses for testing and debugging.

봇 기록 파일The bot transcript file

봇 기록 파일은 사용자와 봇 간의 상호 작용을 유지하는 특수 JSON 파일입니다.A bot transcript file is a specialized JSON file that preserves the interactions between a user and your bot. 기록 파일은 메시지의 콘텐츠뿐만 아니라 사용자 id, 채널 id, 채널 형식, 채널 기능, 상호 작용 시간 등의 상호 작용 세부 정보를 유지합니다. 이 모든 정보는 봇을 테스트 또는 디버깅할 때 문제를 찾아서 해결하는 데 사용할 수 있습니다.A transcript file preserves not only the contents of a message, but also interaction details such as the user id, channel id, channel type, channel capabilities, time of the interaction, etc. All of this information can then be used to help find and resolve issues when testing or debugging your bot.

봇 기록 파일 만들기/저장Creating/Storing a bot transcript file

이 문서에서는 Microsoft의 Bot Framework Emulator를 사용하여 봇 기록 파일을 만드는 방법을 보여줍니다.This article shows how to create bot transcript files using Microsoft's Bot Framework Emulator. 또한 기록 파일을 프로그래밍 방식으로 만들 수 있습니다. 이 방법에 대 한 자세한 내용은 Blob 성적 증명서 저장소 를 참조 하세요.Transcript files may also be created programmatically; see Blob transcript storage to read more concerning that approach. 이 문서에서는 사용자의 교통 수단, 이름 및 연령을 요청하는 Multi Turn Prompt Bot에 Bot Framework 샘플 코드를 사용하지만 Microsoft의 Bot Framework Emulator로 액세스할 수 있는 모든 코드를 통해 대본 파일을 만들 수 있습니다.In this article we will use the Bot Framework sample code for Multi Turn Prompt Bot that requests a user's mode of transportation, name and age, but any code that can be accessed using Microsoft's Bot Framework Emulator may be used to create a transcript file.

이 프로세스를 시작하려면 테스트하려는 봇 코드가 개발 환경 내에서 실행되고 있는지 확인해야 합니다.To begin this process ensure that the bot code you want to test is running within your development environment. Bot framework 에뮬레이터를 시작 하 고 Open bot 단추를 선택한 다음 아래 이미지에 표시 된 것 처럼 브라우저에 표시 되는 localhost: 포트 의 주소를 입력 합니다.Start the bot framework Emulator, select the Open Bot button, then enter the address of localhost:port shown in your browser followed by "/api/messages" as shown in the image below. 이제 연결 단추를 클릭 하 여 사용자의 봇에 에뮬레이터를 연결 합니다.Now click the Connect button to connect the Emulator to your bot.

에뮬레이터를 코드에 연결 합니다.

에뮬레이터를 실행 중인 코드에 연결한 후에는 시뮬레이션 된 사용자 상호 작용을 bot 전송 하 여 코드를 테스트 합니다.After connecting the Emulator to your running code, test your code by sending simulated user interactions to the bot. 이 예제에서는 사용자의 교통 수단, 이름, 연령을 전달했습니다.For this example we have passed in the user's mode of transportation, name and age. 유지 하려는 모든 사용자 상호 작용을 입력 한 후에는 bot framework 에뮬레이터를 사용 하 여이 대화를 포함 하는 기록 파일을 만들고 저장 합니다.After you have entered all of the user interactions you want to preserve, use the bot framework Emulator to create and save a transcript file containing this conversation.

아래처럼 실시간 채팅 탭 내에서 기록 저장 단추를 선택합니다.Within the Live Chat tab (shown below), select the Save transcript button.

기록 저장 선택

기록 파일의 위치와 이름을 선택한 다음, [저장] 단추를 선택합니다.Choose a location and name for your transcript file and then select the save button.

기록을 ursula로 저장

이제 에뮬레이터를 사용 하 여 코드를 테스트 하기 위해 입력 한 모든 사용자 상호 작용 및 봇 응답이 나중에 다시 로드 하 여 사용자와 봇 간의 상호 작용을 디버그 하는 데 도움이 되는 기록 파일에 저장 되었습니다.All of the user interactions and bot responses that you entered to test your code with the Emulator have now been saved into a transcript file that you can later reload to help debug interactions between your user and your bot.

봇 기록 파일 검색Retrieving a bot transcript file

Bot Framework 에뮬레이터를 사용 하 여 bot 성적 증명서 파일을 검색 하려면 아래와 같이 에뮬레이터의 왼쪽 위 모퉁이에서 파일 을 선택 하 고 기록 ...을 엽니다 .To retrieve a bot transcript file using the Bot Framework Emulator, select the File then Open Transcript... in the upper left corner of the Emulator, as shown below. 다음으로, 검색하려는 기록 파일을 선택합니다.Next, select the transcript file that you want to retrieve. (이 경우에는 에뮬레이터의 리소스 섹션에 있는 성적 증명서 목록 컨트롤 내에서 기록을 액세스할 수도 있습니다.)(Transcripts may also be accessed from within the TRANSCRIPTS list control in the RESOURCES section of the Emulator)

이 예제에서는 "ursula_user.transcript"라는 대본 파일을 검색합니다.In this example we are retrieving the transcript file named "ursula_user.transcript". 성적 증명서 파일을 선택 하면 유지 되는 전체 대화가 새 탭에 자동으로 기록 됩니다.Selecting a transcript file will automatically load the entire preserved conversation into a new Tab titled Transcript.

저장된 기록 검색

기록 파일을 사용하여 디버그Debug using transcript file

기록 파일이 로드되었으니, 사용자와 봇 간에 캡처한 상호 작용을 디버그할 준비가 완료되었습니다.With your transcript file loaded, you are now ready to debug interactions that you captured between a user and your bot. 이렇게 하려면 에뮬레이터의 오른쪽 아래 영역에 표시 된 로그 섹션에 기록 된 이벤트 또는 작업을 클릭 하면 됩니다.To do this, simply click on any event or activity recorded in the LOG section shown in the lower right area of the Emulator. 아래 예에서는 사용자가 "Hello" 메시지를 보낼 때의 첫 번째 상호 작용을 선택했습니다.In the example shown below, we selected the user's first interaction when they sent the message "Hello". 이 작업을 수행 하면이 특정 상호 작용에 관한 성적 증명서 파일의 모든 정보가 JSON 형식의 에뮬레이터 검사기 창에 표시 됩니다.When we do this, all of the information in your transcript file concerning this specific interaction is displayed in the Emulator's INSPECTOR window in JSON format. 아래에서 위쪽 방향으로 이러한 값 중 일부를 살펴보면, 다음과 같은 정보가 보입니다.Looking at some of these values from the bottom upward, we see the:

  • 상호 작용 유형은 message 였습니다.Interaction type was message.
  • 메시지가 전송된 시간.Time the message was sent.
  • 일반 텍스트로 전송되었으며 "Yes"가 포함되었습니다.Plain text sent contained "Yes".
  • 메시지가 봇으로 전송되었습니다.Message was sent to our bot.
  • 사용자 id 및 정보.User id and information.
  • 채널 id, 기능 및 정보.Channel id, capabilities and information.

기록을 사용하여 디버깅

이 자세한 정보를 통해 사용자 입력과 봇 응답 간의 단계별 상호 작용을 추적할 수 있으며, 봇이 예상 방식대로 응답하지 않거나 사용자에게 전혀 응답하지 않는 상황을 디버깅하는 데 도움이 됩니다.This detailed level of information allows you to follow the step-by-step interactions between the user's input and your bot's response, which is useful for debugging situations where your bot either did not respond back in the manner that you anticipated or did not respond back to the user at all. 이러한 값과 실패한 상호 작용까지 이어지는 단계별 레코드를 모두 이용하여 코드를 살펴보고, 봇이 예상대로 응답하지 않는 위치를 찾고, 문제를 해결할 수 있습니다.Having both these values and a record of the steps leading up to the failed interaction allows you to step through your code, find the location where your bot does not respond as anticipated, and resolve those issues.

Bot Framework Emulator와 함께 기록 파일을 사용하는 것은 봇의 코드 및 사용자 상호 작용을 테스트하고 디버그하는 데 사용할 수 있는 여러 도구 중 하나일 뿐입니다.Using transcript files together with the Bot Framework Emulator is just one of the many tools you can use to help you test and debug your bot's code and user interactions. 봇을 테스트 및 디버그하는 방법을 더 보려면 아래에 나열된 추가 리소스를 참조하세요.To find more ways to test and debug your bot, see the additional resources listed below.

추가 정보Additional information

테스트 및 디버깅에 대한 추가 정보는 다음 항목을 참조하세요.For additional testing and debugging information see: