github assistant
1.0.0
اطرح أسئلة حول مستودع GitHub بسهولة باستخدام RAG.
يتيح لك هذا المشروع التفاعل مباشرة مع مستودع GitHub والاستفادة من البحث الدلالي لفهم قاعدة الشفرة. اطرح أسئلة محددة حول رمز المستودع واستقبل ردود ذات مغزى ودرع في السياق.
تبدأ العملية من خلال استنساخ مستودع GitHub محليًا إلى دليل /tmp . ثم يتم استخدام SimpleDirectoryReader لتحميل المستودع المستنسخ للفهرسة. يتم تقسيم المستندات إلى أجزاء بناءً على نوع الملف ، واستخدام CodeSplitter لملفات التعليمات البرمجية ، إلى جانب JSON ، Markdown ، و SentenceSplitters للتنسيقات الأخرى. بعد تحليل العقد ، يتم إنشاء التضمينات باستخدام نموذج text-embedding-3-large وتخزينه في Elasticsearch. يتيح هذا الإعداد البحث الدلالي ، مما يسمح لنا بطرح أسئلة ذات معنى حول الرمز.
استنساخ المستودع :
git clone https://github.com/framsouza/github-assistant.git
cd github-assistantتثبيت المكتبات المطلوبة :
pip install -r requirements.txt إعداد متغيرات البيئة : قم بتحديث ملف .env باستخدام بيانات اعتماد Elasticsearch وتفاصيل مستودع GitHub المستهدف (على سبيل المثال ، GITHUB_TOKEN ، GITHUB_OWNER ، GITHUB_REPO ، GITHUB_BRANCH ، ELASTIC_CLOUD_ID ، ELASTIC_USER ، ELASTIC_PASSWORD ، ELASTIC_INDEX ).
python index.py سيتم إنشاء فهرس Elasticsearch ، يضم التضمينات. يمكنك بعد ذلك الاتصال بنشر ESS وتشغيل استعلام البحث مقابل الفهرس ، سترى حقلًا جديدًا يسمى embeddings .
python query.pyمثال:
python query.py
Please enter your query: Give me a detailed list of the external dependencies being used in this repository
Based on the provided context, the following is a list of third-party dependencies used in the given Elastic Cloud on K8s project:
1. dario.cat/mergo (BSD-3-Clause, v1.0.0)
2. Masterminds/sprig (MIT, v3.2.3)
3. Masterminds/semver (MIT, v4.0.0)
4. go-spew (ISC, v1.1.2-0.20180830191138-d8f796af33cc)
5. elastic/go-ucfg (Apache-2.0, v0.8.8)
6. ghodss/yaml (MIT, v1.0.0)
7. go-logr/logr (Apache-2.0, v1.4.1)
8. go-test/deep (MIT, v1.1.0)
9. gobuffalo/flect (MIT, v1.0.2)
10. google/go-cmp (BSD-3-Clause, v0.6.0)
...
This list includes both direct and indirect dependencies as identified in the context.None
أسئلة قد ترغب في طرحها:
يقوم evaluation.py Code بمعالجة المستندات ، ويقوم بإنشاء أسئلة التقييم بناءً على المحتوى ، ثم يقوم بتقييم ردود الصلة ( سواء كانت الاستجابة ذات صلة بالسؤال ) والإخلاص ( سواء كانت الاستجابة مخلصة لمحتوى المصدر ) باستخدام LLM. إليك دليل خطوة بخطوة حول كيفية استخدام الرمز:
python evaluation.py --num_documents 5 --skip_documents 2 --num_questions 3 --skip_questions 1 --process_last_questions
يمكنك تشغيل الكود دون أي معلمات ، ولكن المثال أعلاه يوضح كيفية استخدام المعلمات. إليك تفاصيل ما تفعله كل معلمة:
بعد تحميل المستندات ، سيقوم البرنامج النصي بإنشاء قائمة بالأسئلة بناءً على محتوى هذه المستندات.
Number of documents loaded: 5
All available questions generated:
0. What is the purpose of chunking monitors in the updated push command as mentioned in the changelog?
1. How does the changelog describe the improvement made to the performance of the push command?
2. What new feature is added to the synthetics project when it is created via the `init` command?
3. According to the changelog, what is the file size of the CHANGELOG.md document?
4. On what date was the CHANGELOG.md file last modified?
5. What is the significance of the example lightweight monitor yaml file mentioned in the changelog?
6. How might the changes described in the changelog impact the workflow of users creating or updating monitors?
7. What is the file path where the CHANGELOG.md document is located?
8. Can you identify the issue numbers associated with the changes mentioned in the changelog?
9. What is the creation date of the CHANGELOG.md file as per the context information?
10. What type of file is the document described in the context information?
11. On what date was the CHANGELOG.md file last modified?
12. What is the file size of the CHANGELOG.md document?
13. Identify one of the bug fixes mentioned in the CHANGELOG.md file.
14. What command is referenced in the context of creating new synthetics projects?
15. How does the CHANGELOG.md file address the issue of varying NDJSON chunked response sizes?
16. What is the significance of the number #680 in the context of the document?
17. What problem is addressed by skipping the addition of empty values for locations?
18. How many bug fixes are explicitly mentioned in the provided context?
19. What is the file path of the CHANGELOG.md document?
20. What is the file path of the document being referenced in the context information?
...
Generated questions:
1. What command is referenced in relation to the bug fix in the CHANGELOG.md?
2. On what date was the CHANGELOG.md file created?
3. What is the primary purpose of the document based on the context provided?
Total number of questions generated: 3
Processing Question 1 of 3:
Evaluation Result:
+---------------------------------------------------+-------------------------------------------------+----------------------------------------------------+----------------------+----------------------+-------------------+------------------+------------------+
| Query | Response | Source | Relevancy Response | Relevancy Feedback | Relevancy Score | Faith Response | Faith Feedback |
+===================================================+=================================================+====================================================+======================+======================+===================+==================+==================+
| What command is referenced in relation to the bug | The `init` command is referenced in relation to | Bug Fixes | Pass | YES | 1 | Pass | YES |
| fix in the CHANGELOG.md? | the bug fix in the CHANGELOG.md. | | | | | | |
| | | | | | | | |
| | | - Pick the correct loader when bundling TypeScript | | | | | |
| | | or JavaScript journey files | | | | | |
| | | | | | | | |
| | | during push command #626 | | | | | |
+---------------------------------------------------+-------------------------------------------------+----------------------------------------------------+----------------------+----------------------+-------------------+------------------+------------------+
Processing Question 2 of 3:
Evaluation Result:
+-------------------------------------------------+------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+
| Query | Response | Source | Relevancy Response | Relevancy Feedback | Relevancy Score | Faith Response | Faith Feedback |
+=================================================+================================================+==============================+======================+======================+===================+==================+==================+
| On what date was the CHANGELOG.md file created? | The date mentioned in the CHANGELOG.md file is | v1.0.0-beta-38 (20222-11-02) | Pass | YES | 1 | Pass | YES |
| | November 2, 2022. | | | | | | |
+-------------------------------------------------+------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+
Processing Question 3 of 3:
Evaluation Result:
+---------------------------------------------------+---------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+
| Query | Response | Source | Relevancy Response | Relevancy Feedback | Relevancy Score | Faith Response | Faith Feedback |
+===================================================+===================================================+==============================+======================+======================+===================+==================+==================+
| What is the primary purpose of the document based | The primary purpose of the document is to provide | v1.0.0-beta-38 (20222-11-02) | Pass | YES | 1 | Pass | YES |
| on the context provided? | a changelog detailing the features and | | | | | | |
| | improvements made in version 1.0.0-beta-38 of a | | | | | | |
| | software project. It highlights specific | | | | | | |
| | enhancements such as improved validation for | | | | | | |
| | monitor schedules and an enhanced push command | | | | | | |
| | experience. | | | | | | |
+---------------------------------------------------+---------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+
(clean_env) (base) framsouza@Frams-MacBook-Pro-2 git-assistant %
+-------------------------------------------------+------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+------+------------------+
Processing Question 3 of 3:
Evaluation Result:
+---------------------------------------------------+---------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+-----------+------------------+
| Query | Response | Source | Relevancy Response | Relevancy Feedback | Relevancy Score | Faith Response | Faith Feedback |Response | Faith Feedback |
+===================================================+===================================================+==============================+======================+======================+===================+==================+==================+===========+==================+
| What is the primary purpose of the document based | The primary purpose of the document is to provide | v1.0.0-beta-38 (20222-11-02) | Pass | YES | 1 | Pass | YES | | YES |
| on the context provided? | a changelog detailing the features and | | | | | | | | |
| | improvements made in version 1.0.0-beta-38 of a | | | | | | | | |
| | software project. It highlights specific | | | | | | | | |
| | enhancements such as improved validation for | | | | | | | | |
| | monitor schedules and an enhanced push command | | | | | | | | |
| | experience. | | | | | | | | |
+---------------------------------------------------+---------------------------------------------------+------------------------------+----------------------+----------------------+-------------------+------------------+------------------+-----------+------------------+
فيما يلي بعض الطرق التي يمكنك من خلالها استخدام هذا الرمز:
خرقة سعيدة!
