보름달 🌝 #3.2 Development - NUGU PlayBuilder (ENG)

1. Role Distribution

Name	Role
Kim Jeongin	Application Backend, NUGU backend proxy
Kim Jina	Application Frontend, NUGU playbuilder
Jung Sihyun	Application Backend, NUGU backend proxy
Theophile	Application Backend - Machine Learning

2. Structure

    NUGU Play Builder is a development tool that can easily create AI services which can be used in SKT NUGU devices and applications with simple code definition and example sentence input.    The picture above is NUGU play structure of 보름달.

3. Function

1) Emotional Converstaion

2) Health Tip

3) Analgesic Recommendation

4) Woman Health Self-check

# case 1

# case 2

5) Ask Mean Period

6) Ask Real Menstruation

7) Input Real Menstruation

8) Ask Predicted Menstruation

4. NUGU Playbuilder

1) Emotional Converstaion

• Intent : ask.Mood

  주체	발화 예시	힘들어
  사용자	Entity	MOOD

• Action : ask.Mood

  주체	발화 예시	가끔은 털어놓는 게 도움이 될 수도 있어요 ...
  NUGU	-	-

2) Health Tip

• Intet : ask.Tip

  주체	발화 예시	배가 아파
  사용자	Entity	TIP

• Action : ask.Tip

  주체	발화 예시	저를 따라 심호흡을 해보세요 ...
  NUGU	-	-

3) Woman Health Self-check

• Intent : ask.selfTest

  주체	발화 예시	자가진단할래
  사용자	-	-

• Action : answer.selfTest

  주체	발화 예시	어떤 자가진단을 원하세요? 생리혈 상태 자가진단은 1번, 생리혈 색깔 자가진단은 2번이라고 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	1번
  사용자	Entity	NUMBER

  • check.bleedState : NUMBER === 1번

    주체	발화 예시	생리혈 상태 자가진단을 시작할게요. 생리대 양으로 따져보면, 하루에 생리대 5개 정도를 사용하는 것이 정상적인 생리의 양이라고 볼 수 있습니다. 생리량이 갑자기 많아졌으면 1번, 생리량이 너무 적으면 2번, 생리할 때 핏덩어리가 나오면 3번이라고 말씀해주세요.
    NUGU	-	-

    
    

    주체	발화 예시	1번
    사용자	Entity	NUMBER

    • check.bleedState_large : NUMBER === 1번

      주체	발화 예시	생리량이 갑자기 늘었을 경우, "스트레스가 평소보다 과했군." 하고 넘어가서는 안됩니다! 생리량이 급격하게 많이 늘었다면, 자궁근종을 의심해볼 수 있습니다. 그냥 넘겼다가 병을 키울 수도 있으니, 꼭 산부인과에 방문하여 검사를 받아보시는 것이 좋습니다!
      NUGU	-	-

    • check.bleedState_small : NUMBER === 2번

      주체	발화 예시	배란기가 지나면 자궁내막의 두께는 8mm 이상으로 두꺼워져야 하는데 그렇지 않은 경우에는 생리량이 적어지게 됩니다. 자궁내막이 8mm 이상으로 성장하지 않으면 수정 후 착상에 지장을 줄 수 있기 때문에 임신에 안 좋은 영향을 끼칠 수 있으니 꼭 기억해 주세요!
      NUGU	-	-

    • check.bleedState_mass : NUMBER === 3번

      주체	발화 예시	생리할 때 나오는 피의 덩어리를 한방에서는 어혈이라고 불러요. 심한 스트레스 등으로, 혈액과 기 순환이 잘 되지 않아서생기는 것으로 핏덩이가 많이 나오는 분들은 하복냉증이나 생리통이 심할 가능성이 커요. 몸을 따뜻하게 해주고 혈액순환이 잘 되도록 스트레칭이나 가벼운 산책 등 규칙적으로 운동하는 것이 자궁건강과 내 몸 건강에 좋아요!
      NUGU	-	-

  • check.bleedColor : NUMBER === 2번

    주체	발화 예시	생리혈 색깔 자가진단을 시작할게요. 생리혈 색깔이 선명한 분홍색이면 1번, 밝은 빨간색이면 2번, 어두운 자주색이면 3번, 주황빛이면 4번, 진한 갈색이면 5번, 검은색이면 6번이라고 말씀해주세요.
    NUGU	-	-

    
    

    주체	발화 예시	1번
    사용자	Entity	NUMBER

    • check.bleedColor_PINK

      주체	발화 예시	생리 초기에는 생리혈이 선분홍색을 띌 수 있지만, 생리 기간 중 핑크빛을 보인다면 내부손상, 성병 또는 호르몬 변화 등 건강 상의 문제가 있을 수 있으므로 산부인과 진단이 필요해요. 또한, 생리 기간 외에 이러한 출혈이 있다면 자궁염증 혹은 임신 가능성이 있으므로 정확한 검사를 위해 병원을 꼭 방문해주세요!
      NUGU	-	-

    • check.bleedColor_RED

      주체	발화 예시	흔한 생리혈 색깔로, 호르몬 수치가 적당하며 혈액순환이 원활할 경우 밝은 빨간색의 생리혈이 나타나요. 그러나 지나치게 밝은 분홍빛을 띈다면 에스트로겐 수치의 문제일수도 있어요. 다이어트, 또한 과도한 알코올 섭취로도 나타날 수 있어요.
      NUGU	-	-

    • check.bleedColor_PURPLE

      주체	발화 예시	생리량이 많을 경우 어두운 자주색의 덩어리 혈이 보일 수 있어요. 그러나, 타인과 비교했을 때, 자주 생리대를 교체해야 할 정도로 생리혈이 배출된다면 자궁근종, 자궁선근증 등 여성 질환의 신호일 수 있으므로 주의해주세요!
      NUGU	-	-

    • check.bleedColor_ORANGE

      주체	발화 예시	질염에 감염되었을 가능성이 높다고 볼 수 있어요. 질염은 흔한 질병이지만, 방치하게 되면 더 큰 질병 또는 다른 질병을 야기하고 확대시킬 수 있답니다! 질염이 심각하지 않다고 가볍게 생각하지 말고 초기에 병원을 찾는 것이 좋아요.
      NUGU	-	-

    • check.bleedColor_BROWN

      주체	발화 예시	오래된 생리혈이 나오는 것일 수 있으므로 생리 첫날 또는 끝자락 즈음이라면, 걱정하지 않아도 돼요! 그러나 생리 기간 중 진한 갈색의 생리혈이 나온다면, 이는 부정 출혈로 자궁근종 또는 자궁내막증 일 수 있어요!
      NUGU	-	-

    • check.bleedColor_BLACK

      주체	발화 예시	생리 끝 무렵, 또는 생리양이 많은 삼일에서 사일 경에, 검은색을 띄는 생리혈이 나올 수 있어요. 그러나 이 상태가 오래 지속된다면 자궁근종을 의심해 볼 수 있어요.
      NUGU	-	-

4) Analgesic Recommendation

• Intent : ask.pill

  주체	발화 예시	약	추천해줘
  사용자	Entity	PILL	-

• Action : check.userID2

  주체	발화 예시	보름달 어플의 메인 페이지에있는 누구 스피커아이디를 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	1
  사용자	Entity	user_ID

  • answer.pill

    주체	발화 예시	1	님의 정보를 알려드릴게요.
    NUGU	Entity	user_ID	-

    
    

    주체	발화 예시	그래
    사용자	Entity	YON

    
    

    주체	발화 예시	약을 추천해드릴게요. 게보린과 펜잘큐를 복용하세요.
    NUGU	Backend Parameter	pillPredict

    * answer.noPill : No symptoms exist in the database

    주체	발화 예시	입력된 증상이 없어서 추천해드릴 수 없어요. 보름달 어플에서 증상을 입력해주세요.
    NUGU	-	-

    * answer.wrongID3 : No id exists in the database

    주체	발화 예시	존재하는 아이디가 없어요. 보름달 어플 메인 페이지에서 누구 스피커 아이디를 확인해주세요.
    NUGU	-	-

    * answer.WRONG3 : YON is not '예'

    주체	발화 예시	보름달을 종료할게요.
    NUGU	-	-

    
    

5) Ask Mean Period

• Intent : ask.meanCycle

  주체	발화 예시	주기	알려줘
  사용자	Entity	MEANCYCLE	-

• Action : check.userID1

  주체	발화 예시	보름달 어플의 메인 페이지에있는 누구 스피커아이디를 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	1
  사용자	Entity	user_ID

  
  

  • answer.meanCycle

    주체	발화 예시	1	님의 정보를 알려드릴게요.
    NUGU	Entity	user_ID	-

    
    

    주체	발화 예시	그래
    사용자	Entity	YON

    
    

    주체	발화 예시	회원님의 주기는	30	일 입니다.
    NUGU	Backend Parameter	-	meanCycle	-

    
    

    *  answer.noMeanCycle : No meanPeriod exists in the database, not enough data to calculate meanPeriod 

    주체	발화 예시	입력된 충분한 주기가 없네요. 어플에서 주기를 입력해주세요.
    NUGU	-	-

    
    

    * answer.wrongID3 : No id exists in the database.

    주체	발화 예시	존재하는 아이디가 없어요. 보름달 어플 메인 페이지에서 누구 스피커 아이디를 확인해주세요.
    NUGU	-	-

    * answer.WRONG3 : YON is not '예'

    주체	발화 예시	보름달을 종료할게요.
    NUGU	-	-

    
    

6) 실제 생리 주기 조회

• Intent : ask.cycle

  주체	발화 예시	이번 생리	언제 끝나?
  사용자	Entity	CYCLE_STATE	-

• Action : check.userID3

  주체	발화 예시	보름달 어플의 메인 페이지에있는 누구 스피커아이디를 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	1
  사용자	Entity	user_ID

  • answer.cycle

    주체	발화 예시	1	님의 정보를 알려드릴게요.
    NUGU	Entity	user_ID	-

    
    

    주체	발화 예시	그래
    사용자	Entity	YON

    
    

    주체	발화 예시	회원님의 이번 생리 시작일은	2020-12-3	이고, 종료일은	2020-12-9	입니다.
    NUGU	Backend Parameter	-	cycleStart	-	cycleEnd	-

    * answer.noCycle : No real cycle exists in the database

    주체	발화 예시	입력된 주기가 없네요. 어플에서 주기를 입력해주세요.
    NUGU	-	-

    * answer.wrongID1 : NO id exists in the database

    주체	발화 예시	존재하는 아이디가 없어요. 보름달 어플 메인 페이지에서 누구 스피커 아이디를 확인해주세요.
    NUGU	-	-

    * answer.WRONG1 : YON is no '예'

    주체	발화 예시	보름달을 종료할게요.
    NUGU	-	-

    
    

7) Input Real Menstruation

1 - relative date

• Intent : input.cycle

  주체	발화 예시	나	오늘	생리	시작	했어
  사용자	Entity	-	DATE	-	CYCLE	-

• Action : check.userID5

  주체	발화 예시	보름달 어플의 메인 페이지에있는 누구 스피커아이디를 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	1
  사용자	Entity	user_ID

  • output.cycleStart

    주체	발화 예시	1	님의 정보에 입력합니다.
    NUGU	Entity	user_ID	-

    
    

    주체	발화 예시	그래
    사용자	Entity	YON

    
    

    주체	발화 예시	생리 시작일을 입력했습니다.
    NUGU	-	-

    * answer.wrongID5_1 : No id exists in the database

    주체	발화 예시	존재하는 아이디가 없어요. 보름달 어플 메인 페이지에서 누구 스피커 아이디를 확인해주세요.
    NUGU	-	-

    * answer.WRONG5_1 : YON is not 예'

    주체	발화 예시	보름달을 종료할게요.
    NUGU	-	-

  • output.cycleEnd

    주체	발화 예시	1	님의 정보에 입력합니다.
    NUGU	Entity	user_ID	-

    
    

    주체	발화 예시	그래
    사용자	Entity	YON

    
    

    주체	발화 예시	생리 종료일을 입력했습니다.
    NUGU	-	-

    - answer.wrongID5_2 : No id eixstis in the database

    주체	발화 예시	존재하는 아이디가 없어요. 보름달 어플 메인 페이지에서 누구 스피커 아이디를 확인해주세요.
    NUGU	-	-

    - answer.WRONG5_2 : YON is not '예'

    주체	발화 예시	보름달을 종료할게요.
    NUGU	-	-

2 - absolute date

• Intent : input.pastCycleStart

  주체	발화 예시	2020년	12월	9일	에	생리 시작	했어
  사용자	Entity	START_YEAR	START_MONTH	START_DATE	-	PAST_CYCLE_START	-

• Action : add.pastPeriod

  주체	발화 예시	생리 시작을 입력하셨습니다. 생리를 며칠 동안 하셨는지 알려주세요. 이틀 동안 하셨다면, 2일이라고 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	2	일
  사용자	Entity	PAST_PERIOD	-

  • check.userID6

    주체	발화 예시	보름달 어플의 메인 페이지에있는 누구 스피커아이디를 말씀해주세요.
    NUGU	-	-

    
    

    주체	발화 예시	1
    사용자	Entity	user_ID

    • output.pastCycle

      주체	발화 예시	1	님의 정보에 입력합니다.
      NUGU	Entity	user_ID	-

      
      

      주체	발화 예시	그래
      사용자	Entity	YON

      
      

      주체	발화 예시	생리 종료일을 입력했습니다.
      NUGU	-	-

      - answer.wrongID6 : No id exists in the database
- answer.WRONG6 : YON is not '예'

8) Input Predicted Menstruation

• Intent : ask.predictCycle

  주체	발화 예시	생리 예정일	알려줘
  사용자	Entity	CYCLE_STATE	-

• Action : check.userID4

  주체	발화 예시	보름달 어플의 메인 페이지에있는 누구 스피커아이디를 말씀해주세요.
  NUGU	-	-

  
  

  주체	발화 예시	1
  사용자	Entity	user_ID

  • answer.predictBleed

    주체	발화 예시	1	님의 정보를 알려드릴게요.
    NUGU	Entity	user_ID	-

    
    

    주체	발화 예시	그래
    사용자	Entity	YON

    
    

    주체	발화 예시	회원님의 다음 생리는	2020-1-3	에 시작해서	2020-1-9	에 끝날 예정입니다.
    NUGU	Backend Parameter	-	predictStart	-	predictEnd	-

    * answer.NoPredictBleed : No previous cycle data exists, canno predict future cycle

    주체	발화 예시	입력된 주기가 없네요. 어플에서 주기를 입력해주세요.
    NUGU	-	-

    * answer.wrongID4 : No id exists in the database

    주체	발화 예시	존재하는 아이디가 없어요. 보름달 어플 메인 페이지에서 누구 스피커 아이디를 확인해주세요.
    NUGU	-	-

    * answer.WRONG4 : YON is not '예'

    주체	발화 예시	보름달을 종료할게요.
    NUGU	-	-]

5. Backend Proxy

    Backend proxy is server used when NUGU playbuilder external data to answer a question.
    Accorind to the NUGU developers guide, version, resultCode, output are mandatory. We made responseController moudle in accordance with sample format.

const resSample = function () {
  let resSample = {
    version: "2.0",
    resultCode: "OK",
    output: {},
  };
  return resSample;
};

module.exports = { resSample };

    To differentiate application backend and backend proxy, we did routing at teh proxyIndex file, and made functions at teh proxyControllers directory.
   Each contoller makes function and returns in accordance with responseController format.