Merge pull request #1 from YellowGangneng/working_with_mac

branch merge

Author: YellowGangneng

.env_sample

@@ -1,16 +1,21 @@
 OPENAI_API_KEY=sk-5K9kI4dia...
-HUGGINGFACEHUB_API_TOKEN=hf_oEHVwJ...
 LANGCHAIN_TRACING_V2=false
 LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
 LANGCHAIN_API_KEY=ls__69f274d55...
 LANGCHAIN_PROJECT=LANGCHAIN_PROJECT
-TAVILY_API_KEY=tvly-mGxBGvzbH...
-GOOGLE_API_KEY=AIzaSyCSttRIEqEf1_X...
-PINECONE_API_KEY=549b555d-c388-4d...
 ANTHROPIC_API_KEY=sk-ant-api0...
+GOOGLE_API_KEY=AIzaSyCSttRIEqEf1_X...
 UPSTAGE_API_KEY=up_oZ4HjE...
 COHERE_API_KEY=63HBVVS...
-UPSTAGE_API_KEY=up_oZ4HjE...
+TAVILY_API_KEY=tvly-mGxBGvzbH...
+HUGGINGFACEHUB_API_TOKEN=hf_oEHVwJ...
+MONGODB_ATLAS_CLUSTER_URI=mongodb+srv://...
+PINECONE_API_KEY=549b555d-c388-4d...
+NEO4J_URI=neo4j://localhost:7687...
+NEO4J_USERNAME=neo4j...
+NEO4J_PASSWORD=password...
+ES_URL=https://my-elasticsearch-projec...
+ES_API_KEY=bk9X...
 LLAMA_CLOUD_API_KEY=llx-...
 JINA_API_KEY=jina...
 DEEPL_API_KEY=deepl-api-key...

.github/.gitkeep

@@ -34,7 +34,7 @@ body:
         required: false
       - label: 🖋️ **Formatting** - Issues with Markdown formatting.
         required: false
-      - label: No issues found
+      - label: Other Issues
         required: false
 
 - type: checkboxes

.github/ISSUE_TEMPLATE/Proofread.yml

@@ -12,9 +12,9 @@
 🖥️ OS: Win/Mac/Linux   
 ✅ Checklist      
  - [ ] **Template**: Tutorials follows the required template. 
- - [ ] **Table of Contents(TOC) Links**: All Table of Contents links work. ((Yes/No)
+ - [ ] **Table of Contents(TOC) Links**: All Table of Contents links work. (Yes/No)
  - [ ] **Image**: Image filenames follow guidelines.
- - [ ] **Imports*: All import statements use the latest versions. Ensure "langchain-teddynote" is not used. 
+ - [ ] **Imports**: All import statements use the latest versions. Ensure "langchain-teddynote" is not used. 
  - [ ] **Code Execution**: Code runs without errors.
  - Comments: {Write freely, 한국어 기술 가능}     
 ```

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,8 +5,6 @@ on:
     - cron: '30 0,3,9,15 * * *'  
   pull_request:
     types: [opened, synchronize, reopened]
-  # pull_request_review:
-  #   types: [submitted]
   workflow_dispatch:
 
 permissions:
@@ -17,20 +15,20 @@ permissions:
 jobs:
   check-pr-age:
     runs-on: ubuntu-latest
+    if: github.repository == 'LangChain-OpenTutorial/LangChain-OpenTutorial' # 원본 레포에서만 실행
     steps:
       - name: Check if 24 hours have passed since PR creation
         uses: actions/github-script@v6
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
-            // check 24-hours
+            // Function to check PR age
             async function checkPrAge(pr) {
               const createdAt = new Date(pr.created_at);
               const now = new Date();
               const diffHours = (now - createdAt) / (1000 * 60 * 60);
-              
+
               if (diffHours >= 24) {
-                // success
                 console.log(`PR #${pr.number} is older than 24 hours. Merge allowed.`);
                 await github.rest.checks.create({
                   owner: context.repo.owner,
@@ -45,7 +43,6 @@ jobs:
                   },
                 });
               } else {
-                // fail
                 const hoursLeft = (24 - diffHours).toFixed(2);
                 console.log(`PR #${pr.number} is not yet older than 24 hours. Left ${hoursLeft} hours.`);
                 await github.rest.checks.create({
@@ -63,7 +60,7 @@ jobs:
               }
             }
 
-            // know whether sceduled event
+            // Check if it's a scheduled event
             const isScheduled = !context.payload.pull_request;
 
             if (isScheduled) {
@@ -72,17 +69,15 @@ jobs:
                 repo: context.repo.repo,
                 state: 'open',
                 per_page: 100,
-              });              
+              });
               for (const pr of pullRequests) {
                 await checkPrAge(pr);
               }
-
             } else {
               const pr = await github.rest.pulls.get({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 pull_number: context.payload.pull_request.number,
               });
-              
               await checkPrAge(pr.data);
             }

.github/workflows/pr-age.yml

@@ -8,8 +8,7 @@
         "# Getting Started on Windows\n",
         "\n",
         "- Author: [Wooseok-Jeong](https://github.com/jeong-wooseok)\n",
-        "- Design: [Teddy](https://github.com/teddylee777)\n",
-        "- Peer Review: [Yun Eun](https://github.com/yuneun92), [r14minji](https://github.com/r14minji)\n",
+        "- Peer Review: [Yun Eun](https://github.com/yuneun92), [MinJi Kang](https://www.linkedin.com/in/minji-kang-995b32230/)\n",
         "- This is a part of [LangChain Open Tutorial](https://github.com/LangChain-OpenTutorial/LangChain-OpenTutorial)\n",
         "\n",
         "[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/LangChain-OpenTutorial/LangChain-OpenTutorial/blob/main/01-Basic/01-Getting-Started-Windows.ipynb) [![Open in GitHub](https://img.shields.io/badge/Open%20in%20GitHub-181717?style=flat-square&logo=github&logoColor=white)](https://github.com/LangChain-OpenTutorial/LangChain-OpenTutorial/blob/main/01-Basic/01-Getting-Started-Windows.ipynb)\n",
@@ -53,6 +52,7 @@
       "metadata": {},
       "source": [
         "Confirm options during installation and proceed\n",
+        "\n",
         "![](./assets/01-follow-the-installation-video-windows-02.png)"
       ]
     },
@@ -62,6 +62,7 @@
       "metadata": {},
       "source": [
         "Click the Next button for all the rest to proceed with the installation.\n",
+        "\n",
         "![](./assets/01-follow-the-installation-video-windows-03.png)"
       ]
     },
@@ -76,6 +77,7 @@
         "```Powershell\n",
         "git\n",
         "```\n",
+        "\n",
         "![](./assets/01-follow-the-installation-video-windows-04.png)\n"
       ]
     },
@@ -86,7 +88,7 @@
       "source": [
         "- Apply PowerShell Policy \n",
         "\n",
-        "First, **run **Windows PowerShell** as an \"administrator.\"</p> <p><br>\n",
+        "First, run **Windows PowerShell** as an \"administrator.\"</p> <p><br>\n",
         "\n",
         "Enter the following command to apply the policy\n",
         "```Powershell\n",
@@ -133,7 +135,8 @@
         "```powershell\n",
         "pyenv\n",
         "```\n",
-        "![](./assets/01-follow-the-installation-video-windows-05.png)\n"
+        " \n",
+        "![](./assets/01-follow-the-installation-video-windows-05.png )\n"
       ]
     },
     {
@@ -226,6 +229,7 @@
         "Install the downloaded Visual Studio Code (copy it to the Applications folder)\n",
         "\n",
         "Click 'install' of Jupyter on left Menu of extensions \n",
+        "\n",
         "![](./assets/01-follow-the-installation-video-windows-06.png)"
       ]
     },
@@ -236,9 +240,11 @@
       "source": [
         "## Install Jupyter Extension\n",
         "Search for \"python\" and install\n",
+        "\n",
         "![](./assets/01-follow-the-installation-video-windows-07.png)\n",
         "\n",
         "Search for \"jupyter\" and install\n",
+        "\n",
         "![](./assets/01-follow-the-installation-video-windows-08.png)\n",
         "\n",
         "Turn off and restart Visual Studio Code\n",
@@ -247,12 +253,6 @@
         "\n",
         "Click python environment - if you don't see the virtual environment you installed, turn off Visual Studio Code and restart it"
       ]
-    },
-    {
-      "cell_type": "markdown",
-      "id": "e9c62cb7",
-      "metadata": {},
-      "source": []
     }
   ],
   "metadata": {

.github/workflows/restrict-commits.yml

@@ -15,17 +15,17 @@
         "\n",
         "## Overview\n",
         "\n",
-        "This tutorial covers how to set up and use LangSmith, a powerful platform for developing, monitoring, and testing LLM applications. \n",
-        "LangSmith provides comprehensive tracking capabilities that are essential for understanding and optimizing your LLM applications.\n",
+        "This tutorial covers how to set up and use `LangSmith`, a powerful platform for developing, monitoring, and testing LLM applications. \n",
+        "`LangSmith` provides comprehensive tracking capabilities that are essential for understanding and optimizing your LLM applications.\n",
         "\n",
-        "LangSmith tracking helps you monitor:\n",
+        "`LangSmith` tracking helps you monitor:\n",
         "\n",
-        "Token usage and associated costs\n",
+        "- Token usage and associated costs\n",
         "- Execution time and performance metrics\n",
         "- Error rates and unexpected behaviors\n",
         "- Agent interactions and chain operations\n",
         "\n",
-        "In this tutorial, we'll walk through the process of setting up LangSmith tracking and integrating it with your LangChain applications.\n",
+        "In this tutorial, we'll walk through the process of setting up `LangSmith` tracking and integrating it with your `LangChain` applications.\n",
         "\n",
         "### Table of Contents\n",
         "\n",
@@ -48,8 +48,8 @@
       "source": [
         "## Setting up a LangSmith trace\n",
         "\n",
-        "LangSmith is a platform for developing, monitoring, and testing LLM applications. \n",
-        "If you're starting a project or learning LangChain, LangSmith is a must-have to get set up and running."
+        "`LangSmith` is a platform for developing, monitoring, and testing LLM applications. \n",
+        "If you're starting a project or learning `LangChain`, `LangSmith` is a must-have to get set up and running."
       ]
     },
     {
@@ -100,7 +100,7 @@
         "\n",
         "1. Go to https://smith.langchain.com/ and sign up.\n",
         "2. After signing up, you will need to verify your email.\n",
-        "3. Click the left cog (Setting) - centre \"Personal\" - \"Create API Key\" to get an API key.\n",
+        "3. Click the left cog (Setting) - center \"Personal\" - \"Create API Key\" to get an API key.\n",
         "\n",
         "![get-api-key](./assets/03-langsmith-tracking-setup-04.png)\n",
         "\n"
@@ -110,7 +110,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "set environment variables is in `.env`.\n",
+        "Set environment variables is in the `.env` file.\n",
         "\n",
         "Copy the contents of `.env_sample` and load it into your `.env` with the key you set.\n"
       ]
@@ -140,7 +140,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "In Description, enter a description that makes sense to you and click the Create API Key button to create it.\n",
+        "In Description, enter a description that makes sense to you and click the Create API Key button.\n",
         "\n",
         "![create-api-key](./assets/03-langsmith-tracking-setup-05.png\n",
         ")\n"
@@ -167,10 +167,10 @@
         "\n",
         "First, enter the key you received from LangSmith and your project information in the .env file.\n",
         "\n",
-        "- LANGCHAIN_TRACING_V2: Set to \"true\" to start tracking.\n",
-        "- LANGCHAIN_ENDPOINT: https://api.smith.langchain.com Do not change.\n",
-        "- LANGCHAIN_API_KEY: Enter the key issued in the previous step.\n",
-        "- LANGCHAIN_PROJECT: If you enter a project name, all runs will be traced to that project group.\n",
+        "- `LANGCHAIN_TRACING_V2`: Set to \"true\" to start tracking.\n",
+        "- `LANGCHAIN_ENDPOINT`: https://api.smith.langchain.com (Do not modify this value).\n",
+        "- `LANGCHAIN_API_KEY`: Enter the key you received in the previous step.\n",
+        "- `LANGCHAIN_PROJECT`: Specify a project name to group and trace all runs under that project group.\n",
         "\n",
         "![setting-api-key](./assets/03-langsmith-tracking-setup-07.png)\n",
         "\n"
@@ -184,7 +184,7 @@
         "\n",
         "Enabling tracking is very simple. All you need to do is set an environment variable.\n",
         "\n",
-        "Copy the contents of .env_sample and load it into your .env with the key you set for Bonnie."
+        "Copy the contents of `.env_sample` and load it into your `.env` with the key you set"
       ]
     },
     {
@@ -223,7 +223,7 @@
       "cell_type": "markdown",
       "metadata": {},
       "source": [
-        "As long as your traces are enabled and your API key and project name are set correctly, this should be sufficient.\n",
+        "As long as your traces are enabled and your API key and project name are set correctly, tracking will work properly.\n",
         "\n",
         "However, if you want to change the project name or change the tracking, you can do so with the code below."
       ]
@@ -238,7 +238,7 @@
         "\n",
         "os.environ[\"LANGCHAIN_TRACING_V2\"] = \"true\"\n",
         "os.environ[\"LANGCHAIN_ENDPOINT\"] = \"https://api.smith.langchain.com\"\n",
-        "os.environ[\"LANGCHAIN_PROJECT\"] = \"<LangChain Peoject Name>\"\n",
+        "os.environ[\"LANGCHAIN_PROJECT\"] = \"<LangChain Project Name>\"\n",
         "os.environ[\"LANGCHAIN_API_KEY\"] = \"<LangChain API KEY>\""
       ]
     }
@@ -264,4 +264,4 @@
   },
   "nbformat": 4,
   "nbformat_minor": 2
-}
+}