Skip to content
/ mid2_django_drf Public

[drf]ChatGPT를 이용한 챗봇 애플리케이션

0 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

jmp7911/mid2_django_drf

BranchesTags

Repository files navigation

ChatGPT를 이용한 챗봇 애플리케이션

드라마 스토브리그의 명대사를 찾아 봅시다. OpenAI ChatGPT API

목차

  1. 요구사항
  2. 프로젝트 구조
  3. 데이터베이스 구조
  4. 배포
  5. 기능명세서
  6. 화면설계
  7. 관련 이슈
  8. 회고

요구사항 명세

  • 프로젝트 일정: 11월 21일(화) ~ 11월 30일(목)
  • DRF(Django Rest Framework)를 이용하여 서버를 구현합니다.
  • 로그인/회원가입을 구현합니다.
  • ChatGPT로 요청을 보내주는 API를 Django내에 구현합니다.
    • (기존JS를 이용한방식) 프론트엔드에서 OpenAI API로 요청을 보냄
      • 프론트엔드 → OpenAI api 로 요청 → 응답값 프론트엔드에 반영
    • (변경해야 할 사항) 프론트엔드에서 Django서버를 통해 요청을 보내줍니다.
      • 프론트엔드 → Django서버 → Django서버에서 OpenAI api 로 요청 → Django서버에서 응답 받고 프론트엔드로 전달 → 응답값 프론트엔드에 반영
  • 챗봇 API는 로그인을 한 유저만 사용가능합니다.
  • 채팅을 데이터베이스에 저장합니다.
  • 저장된 채팅 내역을 조회 할 수 있도록 구현합니다.
  • 저장된 채팅 내역은 로그인한 본인만 볼 수 있습니다.
  • 백엔드 배포, front 따로 배포
gantt
    dateFormat  YYYY-MM-DD
    title       챗봇 어플리케이션
    excludes    weekends
    %% (`excludes` accepts specific dates in YYYY-MM-DD format, days of the week ("sunday") or "weekends", but not the word "weekdays".)

    section  전체
    요구사항 분석            :    des1, 2023-11-21, 0d
    데이터베이스 설계         :  des, 2023-11-21, 0d
    기능명세서 작성         :  des2, 2023-11-21, 2d
    서버환경 생성         :  des3, 2023-11-21, 1d
    개발                   : des4, after des3, 5d
    프레젠테이션             :des5, after des4, 2d

    section  개발
    FE            :    dev1, after des3, 1d
    회원가입 / 로그인 구현 :   dev2, after dev1, 1d
    chat with GPT 구현 :   dev3, after dev2, 1d
    prompt 요청/관리 구현 :   dev4, after dev3, 1d 
    요청 게시판 구현 :   dev5, after dev4, 1d
Loading

개발환경 및 기술

프로젝트 구조

  • BE
chatAPI
 ┣ .config
 ┃ ┗ uwsgi
 ┃ ┃ ┗ chatAPI.ini
 ┣ chat
 ┃ ┣ migrations
 ┃ ┃ ┣ 0001_initial.py
 ┃ ┃ ┣ 0002_alter_chat_chat_reply.py
 ┃ ┃ ┣ 0003_chat_description_chat_quote.py
 ┃ ┃ ┣ 0004_remove_chat_chat_reply_remove_chat_description_and_more.py
 ┃ ┃ ┣ 0005_rename_parent_chatreply_chat_and_more.py
 ┃ ┃ ┣ 0006_remove_chatreply_chat_chat_chat_reply.py
 ┃ ┃ ┣ 0007_remove_chat_chat_reply.py
 ┃ ┃ ┣ 0008_chat_chat_reply.py
 ┃ ┃ ┗ __init__.py
 ┃ ┣ __init__.py
 ┃ ┣ admin.py
 ┃ ┣ apps.py
 ┃ ┣ models.py
 ┃ ┣ paginator.py
 ┃ ┣ permissions.py
 ┃ ┣ serializers.py
 ┃ ┣ tests.py
 ┃ ┣ urls.py
 ┃ ┗ views.py
 ┣ chatAPI
 ┃ ┣ __init__.py
 ┃ ┣ asgi.py
 ┃ ┣ settings.py
 ┃ ┣ urls.py
 ┃ ┗ wsgi.py
 ┣ quote
 ┃ ┣ migrations
 ┃ ┃ ┣ 0001_initial.py
 ┃ ┃ ┗ __init__.py
 ┃ ┣ __init__.py
 ┃ ┣ admin.py
 ┃ ┣ apps.py
 ┃ ┣ models.py
 ┃ ┣ paginator.py
 ┃ ┣ permissions.py
 ┃ ┣ serializers.py
 ┃ ┣ tests.py
 ┃ ┣ urls.py
 ┃ ┗ views.py
 ┣ .env
 ┣ db.sqlite3
 ┣ manage.py
 ┣ quote.txt
 ┗ requirements.txt
  • FE
js
 ┣ app.js
 ┣ board.js
 ┗ controller.js
css
 ┣ chat.css
 ┣ common.css
 ┣ layout.css
 ┣ list.css
 ┣ login-join.css
 ┣ table.css
 ┣ view.css
 ┗ write.css
img
 ┣ first.png
 ┣ icon-search.png
 ┣ icon-x.png
 ┣ last.png
 ┣ next.png
 ┗ prev.png
chat.html
index.html
join.html
login.html
quote.html
view.html
write.html

데이터베이스 구조

erDiagram
    user ||--o{ chat : has
    user {
      integer id PK
      varchar email
      varchar nickname
      varchar password
      datetime created_at
      varchar ip_address
      datetime last_login
    }
    chat {
      integer id PK
      integer user FK
      text content
      datetime created_at
      datetime updated_at
      chatReply chat_reply FK
    }
    chatReply {
      integer id PK
      integer user FK
      text content
      boolean is_apply
      datetime created_at
      datetime updated_at
      
    }
    chat ||--|| chatReply : has
    user ||--o{ quote : has
    quote {
      integer id PK
      integer user FK
      text content
      boolean is_apply
      datetime created_at
      datetime updated_at
      datetime applied_at
    }
Loading

배포

AWS Lightsail 에서 배포하였습니다.

테스트계정 : jmp7911@gmail.com / 12345678!

uwsgi nginx

기능명세서

  • 기본url : 52.78.247.51
  • Content-Type : application/json
  • 인증이 필요한 공통 Header
{
  Authorization : bearer TOKEN
}
URL GET POST PUT DELETE Description
/rest-auth/login O O --- --- 로그인
/rest-auth/logout O --- --- --- 로그인
/rest-auth/join O O --- --- 회원 가입
/rest-auth/profile O --- O O 회원 정보 수정 / 탈퇴
/chat/model O O --- O 채팅
/quote O O --- --- 명대사 요청 게시판
/chat/api --- O --- --- 챗봇 연동
/chat/delete --- O --- --- 채팅 내역 삭제

/chat/api

  • POST
    • Request
    {
  "input": "text"
}
    • Resonse
    HTTP/1.1 200 OK
{
    "scene" : 1,
    "quote" : "text",
    "description" : "text"
}

/chat/delete

  • POST
    • Response 
      HTTP/1.1 204 NO_CONTENT
{
    
}

/chat/model

  • GET

    • queryString
    Key Value Default Description
    page 1 1 paging offset ( > 0)
    per-page 10 5 paging limit ( >= 5)
    • Response
    HTTP/1.1 200 OK
[
    "count": 11,
    "next": http://52.78.247.51/chat/model?page=2&per-page=5,
    "previous": null,
    "results": [
        {
          "id": 1,
          "user": "useremail",
          "content":"text",
          "created_at":"datetime",
          "chat_reply": {
            "id": 2,
            "user": "useremail",
            "quote":"text",
            "description":"text",
            "scene":"text",
            "created_at":"datetime",
          }
        },
        {2, ...},
        ...
        {5,...},
    ]
    "_links": [
      {
          "desc": "Self",
          "href": "http://52.78.247.51/chat/model/",
          "method": "GET"
      },
      {
          "desc": "New Chat",
          "href": "http://52.78.247.51/chat/model/",
          "method": "POST"
      }
  ]
]
    • POST
      • Request
      {
  "content": "흐리멍텅",
  "user": 1,
  "chat_reply": {
    "scene": 3,
    "quote": "윤성복: 임동규도 그렇고, 단장님은 가장 단단히 박힌 돌만 건드리네요. 저같은 사람 자르는 게 쉬웠을 텐데요.\n백승수: 박힌 돌에 이끼가 더 많을 겁니다.",
    "description": "3회에서 윤성복과 백승수 사이의 대화 중 윤성복이 백승수를 향해 한 말",
    "user": 1
  }
}
      • Response
      HTTP/1.1 201 Created
{
  "id": 1,
  "content": "흐리멍텅",
  "user": 1,
  "created_at": "2018-07-04 14:00:00",
  "chat_reply": {
        "id": 15,
        "quote": "윤성복: 임동규도 그렇고, 단장님은 가장 단단히 박힌 돌만 건드리네요. 저같은 사람 자르는 게 쉬웠을 텐데요.\n백승수: 박힌 돌에 이끼가 더 많을 겁니다.",
        "description": "3회에서 윤성복과 백승수 사이의 대화 중 윤성복이 백승수를 향해 한 말",
        "scene": "3",
        "created_at": "2023-11-30T15:24:13.833422+09:00",
        "user": 1
    },
  "_links": [
      {
        "desc": "Detail of chat",
        "href": "http://52.78.247.51/chat/model/1/",
        "method": "GET"
      }
  ]
}

/quote

  • GET

    • queryString
    Key Value Default Description
    page 1 1 paging offset ( > 0)
    per_page 10 5 paging limit ( >= 5)
    • Response
    HTTP/1.1 200 OK
[
    {
      "count": 1,
      "next": http://52.78.247.51/quote?page=2&per-page=5,
      "previous": null,
      "id": 1,
      "user": "useremail",
      "title":"text",
      "content":"text",
      "description":"text",
      "is_apply":True,
      "created_at":"datetime",
      "updated_at":"datetime",
      "applied_at":"datetime",
    },
    {2, ...},
    ...
    {5,...},
    "_links": [
      {
          "desc": "Self",
          "href": "http://52.78.247.51/quote/",
          "method": "GET"
      },
      {
          "desc": "New Quote",
          "href": "http://52.78.247.51/quote/",
          "method": "POST"
      }
  ]
]

  • POST

    • Response
    HTTP/1.1 201 Created
{
  "id": 1,
  "content": "text",
  "user": 1,
  "title": "text",
  "description": "text",
  "created_at": "2018-07-04 14:00:00",
  "applied_at": "2018-07-04 14:00:00",
  "updated_at": "2018-07-04 14:00:00"
  "_links": [
      {
          "desc": "Self",
          "href": "http://52.78.247.51/quote/1",
          "method": "GET"
      },
      {
          "desc": "Update self",
          "href": "http://52.78.247.51/quote/1",
          "method": "PUT"
      },
      {
          "desc": "Delete self",
          "href": "http://52.78.247.51/quote/1",
          "method": "DELETE"
      }
  ]
}

화면설계

로그인 챗봇
login chatbot
채팅 내역 삭제 게시판
list delete write

관련 이슈

  • HATEOAS(Hypermedia as the Engine of Application State)

    • REST API 는 요청-응답 이라는 단순한 구조로 되어있어, 응답만으론 리소스의 상태가 전이되기엔 정보가 부족합니다
    • 이 문제를 해결하기 위해 응답 객체에 해당 리소스의 상태가 전이될 수 있는 link를 제공하는 것이 HATEOAS 입니다

  • cors

    • HOST 와 다른 IP에서 요청을 할 경우 접근이 막힙니다.
    • BE, FE 가 다른 REST API를 요청하는 방식에서 발생합니다.
    • corsheaders 를 설치하고 CORS_ALLOWED_ORIGINS에 IP를 명시하면 해당 IP에서 요청은 허용합니다.

  • registration

    • 첫 번째 회원 가입 이후 회원가입은 서버에서 error가 발생하였습니다.
    • 문제가 해결이 되면 여기에 작성하겠습니다.

회고

  • 잘한점/인상깊은 점
    • 먼저 기능명세서를 만들어서 테스트코드로 구현해본 뒤 프론트에 작업을 진행했습니다. 기능명세서를 만들 때 필요한 기능들을 개발 할 수 있는 시간계획이 어느정도 들어 맞았던 것 같습니다.
    • DRF를 사용하여 REST API를 설계하고 CRUD 시간 내에 구현을 했다는 것이 좋았습니다.
  • 아쉬운 점
    • 부딪힌 많은 문제 중에 중요한 것들은 그 당시에 정리를 해두면 다음 프로젝트 때 시간을 아낄 수 있을 것 같습니다.

About

[drf]ChatGPT를 이용한 챗봇 애플리케이션

Topics

rest-api django-rest-framework hateos

Resources

Readme
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages