Framework Docs AI

Marco documentos ai

Framework Docs AI es una poderosa solución SaaS que revoluciona la gestión de la documentación para varios marcos. Representa sin problemas la documentación del marco, crea una base de conocimiento integral y utiliza modelos de lenguaje avanzados para proporcionar respuestas precisas basadas en la recuperación a las consultas de los usuarios.

Características

• Rastreo de documentación automática : recopile sin esfuerzo la documentación de los marcos populares.
• Base de conocimiento inteligente : almacene y organice datos raspados para una recuperación eficiente.
• Respuestas con IA : aprovechar los modelos de lenguaje de última generación para respuestas precisas.
• Soporte de marco personalizable : agregue sus propios marcos o use los existentes.
• Interfaz fácil de usar : construida con Strewlit para una experiencia de usuario suave.

Tecnologías utilizadas

• UI : strewlit
• Base de datos vectorial : Chroma DB
• Llamadas de funciones : datos PHI
• Modelo de idioma : GPT-4O-Mini

Marcos compatibles

1. Langchain
2. Next.js
3. Vue.js
4. Pytorch
5. Luminoso
6. Docios web de MDN

Empezando

Requisitos previos

• Python 3.7+
• pepita

Instalación

1. Clon el repositorio:

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

2. Instalar dependencias requeridas:

    pip install -r requirements.txt
   

3. Configure su tecla API de OpenAI:

   • Cree un archivo .env en el directorio raíz
   • Agregue su tecla API de OpenAI:

      OPENAI_API_KEY=your_api_key_here
     

Uso

1. Ejecute la aplicación:

    python app.py
   

2. Abra su navegador web y navegue a la URL local proporcionada (generalmente http://localhost:8501 ).

3. ¡Comience a explorar la documentación del marco y hacer preguntas!

? Agregar marcos personalizados

Puede agregar sus propios marcos personalizados al marco Docs AI. Sigue estos pasos:

1. Ratea las URL (Crawler.py) :

   • El archivo crawler.py utiliza una clase DomainCrawler para rastrear sitios web y recopilar URL.
   • Componentes clave para modificar:

      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"

   • Personalice la lista de CONFIGS :
     • start_url : la URL base de la documentación de su marco.
     • docs_path : la ruta específica donde comienza la documentación.
     • avoid_keywords : Lista de palabras clave para evitar en URL (por ejemplo, publicaciones de blog, páginas de la comunidad).
   • Actualice OUTPUT_PATH y FILE_NAME según sea necesario.
   • El Crawler intenta usar un Sitemap.xml si está disponible, luego se vuelve a gatear del docs_path especificado.
   • Utiliza múltiples subprocesos para rastrear múltiples configuraciones simultáneamente.
   • Ejecute crawler.py para guardar las URL rastreadas en el archivo de salida especificado.

2. Raspe el contenido :

   • Use scrape.py para extraer contenido de las URL rastreadas.
   • Modifique las rutas de archivo en scrape.py para que coincida con su nuevo marco:

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

   • Ejecute scrape.py para guardar el contenido raspado en el directorio data/Scraped_data .

3. Convertir al formato de documento LangChain :

   • Use save.py para convertir el JSON raspado en un archivo de pickle compatible con el esquema de documentos de Langchain.
   • Actualice las rutas de archivo en save.py :

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

   • Ejecute save.py para crear el archivo de pickle.

4. Actualizar app.py :

   • Inicializar la base de conocimiento para su nuevo marco:

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

   • Crea un asistente para tu marco:

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

   • Agregue su marco a las opciones de la barra lateral:

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

   • Manejar la selección de su marco:

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

5. Reinicie la aplicación :

   • Ejecute app.py nuevamente para ver su nuevo marco en acción.

Recuerde reemplazar "Your_Framework" y "su nombre de marco" con los nombres apropiados para su marco personalizado.

? Que contribuye

¡Agradecemos las contribuciones! Consulte nuestra guía de contribución para obtener más detalles.

? Licencia

Este proyecto tiene licencia bajo la licencia MIT; consulte el archivo de licencia para obtener más detalles.

Expresiones de gratitud

• Aprecio para el marco de interfaz de usuario intuitivo
• Todos los proyectos de código abierto que hicieron esto posible

---