Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

教育資料のフィードバックの機能の実装 #51

Merged
merged 28 commits into from
Mar 19, 2024

Conversation

Z00One
Copy link
Member

@Z00One Z00One commented Mar 19, 2024

🔍 このPRで解決したい問題は何ですか?

実装した機能や解決した課題、PRを開くきっかけや目的をReviewerが理解しやすいように書いてください。
バックログのリンク、ダイアグラム、Figmaなどの関連ドキュメントを添付するとより良いです。

  • 検索拡張生成(RAG)に利用された教育資料に対するフィードバックを受けるようにしたかった。

✨ このPRで主に変わったことは何ですか?

問題を解決しながら、主な変更点を書いてください。

  • S3で教育資料のファイルをロードするFileモジュール構成
  • フィードバックに必要な参照データを加工及びそのデータを利用してLLMを使い、フィードバック受ける機能の実装(Materialfeedbackモジュール、Langchainモジュール)

🔖 主な変更点以外に追加で変更された部分はありますか?

ない場合は「なし」と記載してください。

  • referモジュールのディレクトリの経路変更
  • materialモジュールで資料の削除のメソッドの名前変更(delete -> remove

🙏🏻 Reviewerに特に見ていただきたい部分はありますか?

開発過程で他の方の意見が気になったり、クロスチェックが必要だと感じたコードがあれば教えてください。

  • なし

🩺 このPRでテストや検証が必要な部分はありますか?

テストが必要な項目やテストコードが追加されたら一緒に書いてください。

  • 教育資料に対するフィードバックに関するコントローラーに対するテスト

📚 関連するIssueやTrello、ドキュメント

このPRが解決しようとしている問題に関連するIssueやドキュメント、Trelloがあればリンクを記載してください。Trelloの場合タイトルの形で添付してください。

🖥 作動する様子

スクリーンショットや録画したビデオ、またはgifを追加して、Reviewerが変更点を理解するのに役立ててください。

📌 PRを行う際の注意点

  • Reviewerはコードレビュー時に良いコードの方向性を示しますが、コード修正を強制することはありません。
  • Reviewerは良いコードを見つけた場合、賞賛と励ましを惜しみません。
  • レビューは特別なケースでない限り、Reviewerに指定された時点から3日以内に行ってください。
  • コメント作成時にPrefixにP1、P2、P3を書いていただくと、Assigneeがより明確にコメントに対して対応することができます。
    • P1 : 必ず反映してください (Request Changes) - 問題が発生したり、脆弱性が発見されたケースなど。
    • P2 : 反映を積極的に検討していただければと思います (コメント)。
    • P3 : こんな方法もあるんじゃないかな~などの些細な意見です (Chore)。

Z00One added 28 commits March 10, 2024 21:24
Removed the Feedback model from the schema.prisma file to align with the updated data structure.
Removed unnecessary error message in catch block.
- changed the metadata decorator from ApiAuthMetadata to ApiDefaultMetadata

- change method's name from delete to remove
- Added new constants NO_IDEA and NO_IDEA_MESSAGE for handling unknown answers
- Updated answer logic to display NO_IDEA_MESSAGE when answer is unknown
- Improved referInfo formatting in the answer
- Updated comments for better clarity
Prevents potential errors when referInfo is empty
@Z00One Z00One added ✨ Feature 기능 개발 ✅ Test test 관련(storybook, jest...) labels Mar 19, 2024
@Z00One Z00One added 🔨 Refactor 코드 리팩토링 📬 API 서버 API 통신 ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) 🆗 safe CI workflow 동작 관련 labels Mar 19, 2024
package.json Show resolved Hide resolved
prisma/schema.prisma Show resolved Hide resolved
Copy link
Member

@yuminn-k yuminn-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

고생하셨습니다~ :)
P3: 한 개의 PR에 업데이트되는 로직의 양이 많아서 조금씩 나눠서 PR해도 괜찮을 것 같습니다. 👍🏻

@Z00One Z00One removed the 🆗 safe CI workflow 동작 관련 label Mar 19, 2024
@Z00One Z00One merged commit 7b2b926 into YJU-OKURA:main Mar 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📬 API 서버 API 통신 ✨ Feature 기능 개발 ⏰ P1 반드시 해결해야 하는 중요한 이슈나 문제 (예: 버그, 취약점 등) 🔨 Refactor 코드 리팩토링 ✅ Test test 관련(storybook, jest...)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants