Framework Docs AI

프레임 워크 문서 AI

Framework Docs AI는 다양한 프레임 워크에 대한 문서 관리에 혁명을 일으키는 강력한 SaaS 솔루션입니다. 프레임 워크 문서를 원활하게 긁어 내고 포괄적 인 지식 기반을 생성하며 고급 언어 모델을 사용하여 사용자 쿼리에 대한 정확한 검색 기반 응답을 제공합니다.

특징

• 자동 문서 스크래핑 : 인기있는 프레임 워크에서 문서를 쉽게 수집합니다.
• 지능형 지식 기반 : 효율적인 검색을 위해 스크랩 된 데이터를 저장하고 구성합니다.
• AI 기반 응답 : 정확한 답변을 위해 최첨단 언어 모델을 활용합니다.
• 사용자 정의 가능한 프레임 워크 지원 : 자신의 프레임 워크를 추가하거나 기존 프레임 워크를 사용하십시오.
• 사용자 친화적 인 인터페이스 : 원활한 사용자 경험을 위해 간소로 구축되었습니다.

사용 된 기술

• UI : 간소
• 벡터 데이터베이스 : Chroma DB
• 기능 호출 : PHI 데이터
• 언어 모델 : GPT-4O-MINI

지원되는 프레임 워크

1. 랭케인
2. 다음 .js
3. vue.js
4. Pytorch
5. 체인 리트
6. MDN 웹 문서

시작하기

전제 조건

• 파이썬 3.7+
• 씨

설치

1. 저장소 복제 :

    git clone https://github.com/yourusername/framework-docs-ai.git
   cd framework-docs-ai
   

2. 필요한 종속성 설치 :

    pip install -r requirements.txt
   

3. OpenAI API 키 설정 :

   • 루트 디렉토리에서 .env 파일을 만듭니다
   • OpenAI API 키 추가 :

      OPENAI_API_KEY=your_api_key_here
     

용법

1. 응용 프로그램 실행 :

    python app.py
   

2. 웹 브라우저를 열고 제공된 로컬 URL (일반적으로 http://localhost:8501 )으로 이동하십시오.

3. 프레임 워크 문서를 탐색하고 질문을 시작하십시오!

? 사용자 정의 프레임 워크 추가

프레임 워크 문서 AI에 자신의 사용자 정의 프레임 워크를 추가 할 수 있습니다. 다음 단계를 따르십시오.

1. URL을 크롤링합니다 (Crawler.py) :

   • crawler.py 파일은 DomainCrawler 클래스를 사용하여 웹 사이트를 크롤링하고 URL을 수집합니다.
   • 수정할 주요 구성 요소 :

      CONFIGS = [
         {
             "start_url" : "https://your-framework-docs-url.com" ,
             "docs_path" : "/" ,
             "avoid_keywords" : [ "blog" , "about" , "community" ]
         },
         # You can add multiple configurations for different sections of your documentation
     ]
     
     OUTPUT_PATH = "data/Crawled_url/"
     FILE_NAME = "YOUR_FRAMEWORK_crawled.json"

   • CONFIGS 목록 사용자 정의 :
     • start_url : 프레임 워크 문서의 기본 URL.
     • docs_path : 문서가 시작되는 특정 경로.
     • avoid_keywords : URL에서 피할 키워드 목록 (예 : 블로그 게시물, 커뮤니티 페이지).
   • 필요에 따라 OUTPUT_PATH 및 FILE_NAME 업데이트하십시오.
   • Crawler는 사용 가능한 경우 sitemap.xml을 사용하려고 시도한 다음 지정된 docs_path 에서 크롤링으로 돌아갑니다.
   • 다중 스레딩을 사용하여 여러 구성을 동시에 크롤링합니다.
   • crawler.py 실행하여 지정된 출력 파일에 크롤링 된 URL을 저장하십시오.

2. 내용을 긁어냅니다 .

   • scrape.py 사용하여 크롤링 된 URL에서 콘텐츠를 추출하십시오.
   • 새 프레임 워크와 일치하도록 scrape.py 의 파일 경로를 수정하십시오.

      if __name__ == "__main__" :
         Scrape ( "data/Crawled_url/YOUR_FRAMEWORK_crawled.json" , "data/Scraped_data/YOUR_FRAMEWORK_scraped.json" )

   • scrape.py 실행하여 data/Scraped_data 디렉토리에 스크랩 된 컨텐츠를 저장하십시오.

3. Langchain 문서 형식으로 변환 :

   • save.py 사용하여 스크랩 된 JSON을 Langchain의 문서 스키마와 호환되는 피클 파일로 변환하십시오.
   • save.py 에서 파일 경로를 업데이트하십시오.

      if __name__ == "__main__" :
         convert_json_to_pkl ( 'data/Scraped_data/YOUR_FRAMEWORK_scraped.json' , 'data/Scraped_data/YOUR_FRAMEWORK_scraped.pkl' )

   • save.py 실행하여 피클 파일을 만듭니다.

4. app.py 업데이트 :

   • 새로운 프레임 워크의 지식 기반을 초기화하십시오.

      kb_manager_your_framework = initialize_kb ( "Your Framework Name" , "./Vector_DB/YOUR_FRAMEWORK" , "data/Scraped_data/YOUR_FRAMEWORK_scraped.pkl" )

   • 프레임 워크에 대한 조수를 만듭니다.

      assistant_your_framework = create_assistant ( "Your Framework Name" , api_key , kb_manager_your_framework ) if kb_manager_your_framework else None

   • 사이드 바 옵션에 프레임 워크 추가 :

      options = [ "Langchain Python" , "Next.js" , "Vue.js" , "MDN_WEB" , "Pytorch" , "Chainlit" , "Your Framework Name" ],

   • 프레임 워크 선택을 처리하십시오.

      elif selected == "Your Framework Name" and assistant_your_framework :
         display_framework ( assistant_your_framework , "Your Framework Name" )

5. 응용 프로그램을 다시 시작하십시오 .

   • app.py 다시 실행하여 새로운 프레임 워크가 실제로 작동합니다.

"Your_framework"및 "귀하의 프레임 워크 이름"을 사용자 정의 프레임 워크에 적합한 이름으로 바꾸는 것을 잊지 마십시오.

? 기여

우리는 기여를 환영합니다! 자세한 내용은 기고 안내서를 참조하십시오.

? 특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다. 자세한 내용은 라이센스 파일을 참조하십시오.

감사의 말

• 직관적 인 UI 프레임 워크를 간소화하십시오
• 이를 가능하게 한 모든 오픈 소스 프로젝트

---