[E-1] 10-Retriever / 01-VectorStoreRetriever #173

ErikaPark · 2025-01-06T12:43:47Z

01-vectorstore-retriever-rag-flow.png: 도식을 직접 제작하여 추가하였습니다 (PPT 활용). 도식화한 내용의 flow가 틀리거나 어색한 부분이 있는지 확인 부탁드립니다!
01-vectorstore-retriever-appendix-keywords.txt: 기존 한국어 텍스트 파일을 영어로 번역하여 활용하였습니다.

Author Checklist

PR Title Format: I have confirmed that the PR title follows the correct format. (e.g., [N-2] 07-Text Splitter / 07-RecursiveCharacterTextSplitter)
Committed Files: I have ensured that no unnecessary files (e.g., .bin, .gitignore, poetry.lock, pyproject.toml) are included. These files are not allowed.

…orial

jhboyo

[Review]

Review OS(Windows/Mac/Linux): Mac
Template Rule 가이드를 준수 하였는가(YES/NO): Yes
Table of Contents 의 링크가 원활하게 동작하는지 확인하였는가?(YES/NO): Yes
이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가?(YES/NO): Yes
import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가?(YES/NO): Yes
모든 코드가 동작에 오류 없이 동작하는가? (만약, warning 발생시 코멘트에 적어주세요): Yes
기타 의견:
첨부해주신 그림으로 인해 메뉴얼의 이해도를 더 높일 수 있게하는 것 같습니다.
다만, 문서의 키워드 강조표시가 일관성 있게 적용 되면 좋을 같습니다.
ex) **는 삭제하고 모든 강조는 ``로만 진행

jhboyo · 2025-01-06T23:29:29Z

@jeong-wooseok UPSTAGE API KEY와 BILLING에 카드 등록까지 진행하면 되더라구요. 다만 CREDIT은 결제 안해도 됩니다.
@ErikaPark UPSTAGE API KEY발급과 BILLING 등록 부분에 대한 안내가 필요해 보이기도 하네요.

…tting

ErikaPark · 2025-01-07T13:52:52Z

@jhboyo @jeong-wooseok
꼼꼼한 리뷰 정말 감사드립니다. 수정사항 반영하였습니다.

수정 사항:

코드 실행 오류 수정: Environment setup에 faiss-cpu를 추가하였습니다.
가독성을 위해 문서 내 불필요한 강조 표시를 줄였습니다.

추가 사항:

Windows 환경에서 발생할 수 있는 인코딩 오류를 방지하기 위해 encoding='utf-8' 옵션을 추가하였습니다.
Upstage API Key 발급 방법과 관련 이미지를 추가하였습니다.
Billing 관련 내용은 OpenAI API와 유사하여, 사용자가 친숙할 것으로 판단해 포함하지 않았습니다.

jeong-wooseok · 2025-01-07T14:30:26Z

[Review]

Review OS:Windows
Template Rule 가이드를 준수 하였는가:YES
Table of Contents 의 링크가 원활하게 동작하는지 확인하였는가?:YES
이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가?:YES
import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가?(YES/NO):YES
모든 코드가 동작에 오류 없이 동작하는가? (만약, warning 발생시 코멘트에 적어주세요):YES
꼭 필요한 파일들만 제출 되었는가? 튜토리얼 외 설정 파일이나 다른 분이 작업한 파일이 포함되었는지
Files Changed 에서 확인 부탁 드립니다.:YES
기타 의견:

정상작동하고 잘 이해되도록 작성된 것 같습니다.
UPSTAGE에서 카드등록 및 .env에 api키를 등록하는 것도 추가하면 좋을 것 같아요
.env_sample파일에 UPSTAGE_API_KEY= 가 두개가 있어서 복사해서 쓰다가 하나를 지우지 않으면 에러가 발생하네요. 인프라팀에 공유하겠습니다.

jeongkpa

Review OS: Windows
Template Rule 가이드를 준수 하였는가: YES
Table of Contents 의 링크가 원활하게 동작하는지 확인하였는가?: YES
이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가?: YES
import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가?: YES
모든 코드가 동작에 오류 없이 동작하는가? : Yes

이미 앞전에서 에러들을 모두 잘 잡으신 것 같습니다..!

출력 이쁘게 신경써주신게 굉장히 인상깊네요!

Restored the file from previous valid commit and uploaded the corrected version.

jhboyo

[Review]

Review OS(Windows/Mac/Linux): Mac
Template Rule 가이드를 준수 하였는가(YES/NO): Yes
Table of Contents 의 링크가 원활하게 동작하는지 확인하였는가?(YES/NO): Yes
이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가?(YES/NO): Yes
import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가?(YES/NO): Yes
모든 코드가 동작에 오류 없이 동작하는가? (만약, warning 발생시 코멘트에 적어주세요): Yes
기타 의견:
모든 코드가 정상적으로 작동합니다.
사용자가 해당 메뉴얼로 학습하는데 많은 도움이 될 것 같습니다.
응답에서 이머지콘은 문단을 더 분명하게하여 가독성을 높이는 효과가 있는 것 같습니다.
고생 많으셨습니다!

musangk

01-Basic/05-Using-OpenAIAPI-MultiModal.ipynb 파일이 PR에 포함된 것 같습니다.
확인 부탁드립니다.

ErikaPark · 2025-01-09T12:10:25Z

@musangk
네 이 부분은 의도된 것이었습니다!
1주차 때 리뷰 후 merge 된 파일에서 최종본이 아닌 버전으로 revert되는 버전 꼬임 문제가 발생했었습니다.

테디님과 상의 후 맞는 버전(리뷰까지 끝난 버전) 다시 올리기로 했습니다.
Pr을 두 개 동시에 생성할 수 없어서 이 pr에 포함시켰습니다!

다만 새로 올린 버전도(1-5 파일) 검수가 필요하여 @Q0211 님께서가능하다면 이 pr 확인해주실 수 있는지
여쭤봐뒀습니다.

musangk

[Review Checklist]

Review OS: Linux
- Windows / Mac / Linux (해당 OS를 기재해주세요)
Template Rule 준수 여부:
- Template Rule 가이드를 준수하였는가? (Check 표기)
Table of Contents 링크 확인:
- Table of Contents의 링크가 원활하게 동작하는지 확인하였는가? (Check 표기)
이미지 파일명 검토:
- 이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가? (Check 표기)
최신 import 방식 사용 여부:
- import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가? (Check 표기)
코드 동작 확인:
- 모든 코드가 오류 없이 동작하는가? (Check 표기)
- Warning 발생 시 코멘트에 적어주세요.
제출 파일 확인:
- 꼭 필요한 파일들만 제출되었는가?
  - 튜토리얼 외 설정 파일이나 다른 분이 작업한 파일이 포함되었는지 Files Changed에서 확인 부탁드립니다. (Check 표기)
기타 의견:
- 길고 복잡한 내용을 잘 정리해주시고, 코드도 잘 작성해주셔서 막힘 없이 잘 실행되었습니다. 💯
- 제가 디테일하게 확인하지 못하고 문의드리는 부분일 수 있지만 아래 내용 확인 부탁드립니다.
- 10-Retriever/assets/01-vectorstore-retriever-appendix-keywords.txt 파일의 경우 data/ 경로가 적절하지 않은지 확인 부탁드립니다.
  - 템플릿 가이드 라인 data/: 튜토리얼에서 사용하는 모든 데이터 파일 저장 내용을 기반으로 문의드립니다.
  - 해당 내용 확인 해주시면 바로 approve 남기겠습니다.

musangk · 2025-01-09T12:59:54Z

@musangk 네 이 부분은 의도된 것이었습니다! 1주차 때 리뷰 후 merge 된 파일에서 최종본이 아닌 버전으로 revert되는 버전 꼬임 문제가 발생했었습니다.

테디님과 상의 후 맞는 버전(리뷰까지 끝난 버전) 다시 올리기로 했습니다. Pr을 두 개 동시에 생성할 수 없어서 이 pr에 포함시켰습니다!

다만 새로 올린 버전도(1-5 파일) 검수가 필요하여 @Q0211 님께서가능하다면 이 pr 확인해주실 수 있는지 여쭤봐뒀습니다.

빠른 답변 감사합니다. 👍
추가로 도움이 될까하여 첨언합니다.

작업하는 branch를 기준으로 작성되므로, ErikaPark:main에서 작업을 하게 되면 PR에 자동으로 쌓이게 됩니다.

PR을 분리해서 작업을 원하시면 branch를 별도로 생성해서 작업하고 PR을 생성하시면 됩니다.
다만, 이 작업은 git / github에 익숙하지 않고, 지금처럼 다양한 사람이 동시에 작업하면 문제를 해결하기 쉽지 않으므로 지금은 굳이 적용하지 않는 것이 좋을 것 같습니다 😄

Create 'data' directory and move '01-vectorstore-retriever-appendix-keywords.txt' to it

musangk

리뷰를 한번에 드리지 않아서 죄송합니다.
colab환경에서 추가 테스트를 하다 보니 보이는게 있어서 추가 요청 드립니다.

10-Retriever/01-VectorStoreRetriever.ipynb

ErikaPark · 2025-01-09T13:37:15Z

빠른 답변 감사합니다. 👍 추가로 도움이 될까하여 첨언합니다.

작업하는 branch를 기준으로 작성되므로, ErikaPark:main에서 작업을 하게 되면 PR에 자동으로 쌓이게 됩니다.

PR을 분리해서 작업을 원하시면 branch를 별도로 생성해서 작업하고 PR을 생성하시면 됩니다. 다만, 이 작업은 git / github에 익숙하지 않고, 지금처럼 다양한 사람이 동시에 작업하면 문제를 해결하기 쉽지 않으므로 지금은 굳이 적용하지 않는 것이 좋을 것 같습니다 😄

아! 마침 git 공부 중이었는데, 이런 상황에서 브랜치를 활용하는군요! 🫢
다음에 비슷한 상황이 생기면, 브랜치를 생성하고 PR 작성하는 방법도 한번 도전해볼게요.
감사합니다! 😊

Co-authored-by: Musang Kim <[email protected]>

musangk · 2025-01-09T13:42:08Z

10-Retriever/01-VectorStoreRetriever.ipynb

+    "from langchain_community.document_loaders import TextLoader\n",
+    "\n",
+    "# Load the file using TextLoader\n",
+    "loader = TextLoader(\"./assets/01-vectorstore-retriever-appendix-keywords.txt\", encoding=\"utf-8\")\n",


Suggested change

"loader = TextLoader(\"./assets/01-vectorstore-retriever-appendix-keywords.txt\", encoding=\"utf-8\")\n",

"loader = TextLoader(\"./data/01-vectorstore-retriever-appendix-keywords.txt\", encoding=\"utf-8\")\n",

파일 경로가 변경되어 코드 내의 경로도 변경 부탁드립니다.
많아서 전체 표시는 하지 못하였습니다. 😢
위의 내용 참고하여 적용 부탁드립니다.

@ErikaPark 늦게 말씀드렸는데, 이거까지만 수정 부탁드립니다 👍

@musangk 수정해 커밋하였습니다. 자잘한 부분들까지 꼼꼼하게 봐주셔서 감사드립니다 🙇‍♀️

ErikaPark · 2025-01-09T13:44:12Z

제가 디테일하게 확인하지 못하고 문의드리는 부분일 수 있지만 아래 내용 확인 부탁드립니다.

10-Retriever/assets/01-vectorstore-retriever-appendix-keywords.txt 파일의 경우 data/ 경로가 적절하지 않은지 확인 부탁드립니다.

디테일하게 확인해주셔서 감사합니다 (감탄)
제가 완전히 놓친 부분이네요!! 반영하여 커밋하였습니다.

리뷰를 한번에 드리지 않아서 죄송합니다. colab환경에서 추가 테스트를 하다 보니 보이는게 있어서 추가 요청 드립니다.

수정 요청 주신 것 확인 후 전부 커밋하였습니다!

musangk

[Review Checklist]

Review OS: Linux
- Windows / Mac / Linux (해당 OS를 기재해주세요)
Template Rule 준수 여부:
- Template Rule 가이드를 준수하였는가? (Check 표기)
Table of Contents 링크 확인:
- Table of Contents의 링크가 원활하게 동작하는지 확인하였는가? (Check 표기)
이미지 파일명 검토:
- 이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가? (Check 표기)
최신 import 방식 사용 여부:
- import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가? (Check 표기)
코드 동작 확인:
- 모든 코드가 오류 없이 동작하는가? (Check 표기)
- Warning 발생 시 코멘트에 적어주세요.
제출 파일 확인:
- 꼭 필요한 파일들만 제출되었는가?
  - 튜토리얼 외 설정 파일이나 다른 분이 작업한 파일이 포함되었는지 Files Changed에서 확인 부탁드립니다. (Check 표기)
기타 의견:
- 많은 수정 요청 사항을 번거로우실텐데도 빠르게 확인하여 처리해주셔서 감사합니다. 💯

Q0211 · 2025-01-09T16:03:37Z

1-5에 대한 검수는 approve로 해도 괜찮을 것 같습니다. 다만, 현재 issue에서 제가 approve 판정을 내려버리면 2주차에 수행하시고 있는 프로젝트에 대한 검수를 어떻게 해야할지 판단이 안서 approve를 미루고 있습니다

ErikaPark · 2025-01-09T16:14:55Z

1-5에 대한 검수는 approve로 해도 괜찮을 것 같습니다. 다만, 현재 issue에서 제가 approve 판정을 내려버리면 2주차에 수행하시고 있는 프로젝트에 대한 검수를 어떻게 해야할지 판단이 안서 approve를 미루고 있습니다

@Q0211 안녕하세요! 😊
현재 2주차 파일에 대한 PR은 1-5 파일에 문제가 없다면 approve해주셔도 괜찮을 것 같습니다.
2주차 파일의 경우, 이미 지정된 두 분께 Peer Review를 모두 받은 상황입니다.
제가 이해하기로는, Peer Review를 받은 후 한 번 메인에 Merge되고, 그 이후 Merge된 버전을 기준으로 검수가 진행되는 것으로 알고 있습니다.

jhboyo

[Review]

Review OS(Windows/Mac/Linux): Mac
Template Rule 가이드를 준수 하였는가(YES/NO): Yes
Table of Contents 의 링크가 원활하게 동작하는지 확인하였는가?(YES/NO): Yes
이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가?(YES/NO): Yes
import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가?(YES/NO): Yes
모든 코드가 동작에 오류 없이 동작하는가? (만약, warning 발생시 코멘트에 적어주세요): Yes
기타 의견: 수저해서 다시 올려주신 코드 정상 작동 합니다.

jeongkpa

Review OS(Windows/Mac/Linux): Win
Template Rule 가이드를 준수 하였는가(YES/NO): Yes
Table of Contents 의 링크가 원활하게 동작하는지 확인하였는가?(YES/NO): Yes
이미지가 포함되어 있다면, 이미지의 파일명이 가이드를 준수하였는가?(YES/NO): Yes
import 구문이 예전 legacy 방식이 아닌 최신 버전을 따르는가?(YES/NO): Yes
모든 코드가 동작에 오류 없이 동작하는가? (만약, warning 발생시 코멘트에 적어주세요): Yes

ErikaPark added 2 commits January 6, 2025 21:38

1st commit

ab19ce7

Merge branch 'main' of https://github.com/ErikaPark/LangChain-OpenTut…

30d1c94

…orial

ErikaPark requested review from jhboyo, jeongkpa and jeong-wooseok January 6, 2025 12:43

chaeyoonyunakim added the docs tutorial label Jan 6, 2025

This comment has been minimized.

Sign in to view

jhboyo previously approved these changes Jan 6, 2025

View reviewed changes

ErikaPark added 3 commits January 7, 2025 19:14

Merge branch 'LangChain-OpenTutorial:main' into main

5c8e3ed

fix(FAISS): handle encoding error while loading documents

c1820f4

fix(FAISS): handle encoding error while loading documents

5f7cf0d

ErikaPark dismissed jhboyo’s stale review via 5f7cf0d January 7, 2025 10:41

ErikaPark requested a review from HarryKane11 January 7, 2025 10:41

fix(encoding): set encoding='utf-8' when using TextLoader

a72fc4b

ErikaPark removed the request for review from HarryKane11 January 7, 2025 13:01

Add instructions for issuing Upstage API key and unify emphasis forma…

e85dee0

…tting

ErikaPark requested a review from jhboyo January 7, 2025 13:52

jeongkpa previously approved these changes Jan 8, 2025

View reviewed changes

Revert to correct version

bd613b6

Restored the file from previous valid commit and uploaded the corrected version.

ErikaPark dismissed jeongkpa’s stale review via bd613b6 January 8, 2025 12:06

ErikaPark requested a review from teddylee777 January 8, 2025 12:34

teddylee777 requested a review from musangk January 8, 2025 15:11

jhboyo previously approved these changes Jan 8, 2025

View reviewed changes

ErikaPark mentioned this pull request Jan 9, 2025

Proofread: <01-Basic / 05-Using-OpenAIAPI-MultiModal > #171

Closed

8 tasks

musangk reviewed Jan 9, 2025

View reviewed changes

Relocate data file into 'data' directory

6a4012f

Create 'data' directory and move '01-vectorstore-retriever-appendix-keywords.txt' to it

ErikaPark dismissed jhboyo’s stale review via 6a4012f January 9, 2025 13:31

musangk reviewed Jan 9, 2025

View reviewed changes

10-Retriever/01-VectorStoreRetriever.ipynb Outdated Show resolved Hide resolved

10-Retriever/01-VectorStoreRetriever.ipynb Outdated Show resolved Hide resolved

ErikaPark and others added 2 commits January 9, 2025 22:40

Fix potential error when uncommenting code

7befa4c

Co-authored-by: Musang Kim <[email protected]>

Confirm package removal: no issues observed

1df3339

Co-authored-by: Musang Kim <[email protected]>

musangk reviewed Jan 9, 2025

View reviewed changes

ErikaPark requested a review from musangk January 9, 2025 13:46

Fix incorrect file path

696867f

ErikaPark requested review from jeongkpa and removed request for teddylee777 January 9, 2025 14:52

ErikaPark self-assigned this Jan 9, 2025

ErikaPark requested review from teddylee777 and Q0211 and removed request for teddylee777 January 9, 2025 14:58

musangk approved these changes Jan 9, 2025

View reviewed changes

musangk mentioned this pull request Jan 10, 2025

[E-1] 10-Retriever / 08-SelfQueryRetriever #209

Closed

3 tasks

BokyungisaGod removed the request for review from Q0211 January 11, 2025 08:45

Q0211 self-requested a review January 11, 2025 08:51

jhboyo approved these changes Jan 11, 2025

View reviewed changes

jeongkpa approved these changes Jan 11, 2025

View reviewed changes

ErikaPark removed request for jeong-wooseok and Q0211 January 11, 2025 14:04

teddylee777 merged commit 7f1da41 into LangChain-OpenTutorial:main Jan 11, 2025
1 of 2 checks passed

	"loader = TextLoader(\"./assets/01-vectorstore-retriever-appendix-keywords.txt\", encoding=\"utf-8\")\n",
	"loader = TextLoader(\"./data/01-vectorstore-retriever-appendix-keywords.txt\", encoding=\"utf-8\")\n",

[E-1] 10-Retriever / 01-VectorStoreRetriever #173

[E-1] 10-Retriever / 01-VectorStoreRetriever #173

Uh oh!

Conversation

ErikaPark commented Jan 6, 2025 • edited by jhboyo Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Author Checklist

Uh oh!

This comment has been minimized.

jhboyo left a comment

Choose a reason for hiding this comment

Uh oh!

jhboyo commented Jan 6, 2025

Uh oh!

ErikaPark commented Jan 7, 2025

Uh oh!

jeong-wooseok commented Jan 7, 2025

Uh oh!

jeongkpa left a comment

Choose a reason for hiding this comment

Uh oh!

jhboyo left a comment

Choose a reason for hiding this comment

Uh oh!

musangk left a comment

Choose a reason for hiding this comment

Uh oh!

ErikaPark commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

musangk left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

[Review Checklist]

Uh oh!

musangk commented Jan 9, 2025

Uh oh!

musangk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ErikaPark commented Jan 9, 2025

Uh oh!

musangk Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

musangk Jan 9, 2025

Choose a reason for hiding this comment

Uh oh!

ErikaPark Jan 9, 2025

Choose a reason for hiding this comment

Uh oh!

ErikaPark commented Jan 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

musangk left a comment

Choose a reason for hiding this comment

[Review Checklist]

Uh oh!

Q0211 commented Jan 9, 2025

Uh oh!

ErikaPark commented Jan 9, 2025

Uh oh!

jhboyo left a comment

Choose a reason for hiding this comment

Uh oh!

jeongkpa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ErikaPark commented Jan 6, 2025 •

edited by jhboyo

Loading

ErikaPark commented Jan 9, 2025 •

edited

Loading

musangk left a comment •

edited

Loading

musangk Jan 9, 2025 •

edited

Loading

ErikaPark commented Jan 9, 2025 •

edited

Loading