diff --git a/README-CN.md b/README-CN.md index 22bd8cb81..8dca6dcbb 100644 --- a/README-CN.md +++ b/README-CN.md @@ -26,6 +26,30 @@ GitHub 许可证

+***** + +## 🌟 诚邀贡献者！ + +我们很高兴欢迎新的贡献者加入 Julep 项目！我们创建了几个"适合新手的问题"来帮助您入门。以下是您可以贡献的方式： + +1. 查看我们的 [CONTRIBUTING.md](CONTRIBUTING.md) 文件，了解如何贡献的指南。 +2. 浏览我们的[适合新手的问题](https://github.com/julep-ai/julep/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)，找到一个您感兴趣的任务。 +3. 如果您有任何问题或需要帮助，请随时在我们的 [Discord](https://discord.com/invite/JTSBGRZrzj) 频道上联系我们。 + +您的贡献，无论大小，对我们都很宝贵。让我们一起创造令人惊叹的东西吧！🚀 + +### 🎉 DevFest.AI 2024年10月 + +激动人心的消息！我们将在整个2024年10月参与 DevFest.AI 活动！🗓️ + +- 在此活动期间为 Julep 做出贡献，有机会赢得超棒的 Julep 周边和礼品！🎁 +- 加入来自世界各地的开发者，为 AI 仓库做出贡献并参与精彩的活动。 +- 非常感谢 DevFest.AI 组织这个fantastic的活动！ + +> [!TIP] +> 准备好加入这场盛会了吗？**[发推文开始参与](https://twitter.com/intent/tweet?text=Pumped%20to%20be%20participating%20in%20%40devfestai%20with%20%40julep_ai%20building%20%23ai%20%23agents%20%23workflows%20Let's%20gooo!%20https%3A%2F%2Fgit.new%2Fjulep)**，让我们开始编码吧！🖥️ + +![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif) ***** @@ -50,6 +74,9 @@ 请继续关注我们即将发布的稳定版本的更多更新！📢 + +***** + ## 简介 Julep 是一个开源平台，用于创建具有可定制工作流的持久 AI 代理。它提供了开发、管理和部署 AI 驱动应用程序的工具，注重灵活性和易用性。 @@ -634,4 +661,4 @@ results = client.documents.search( ## 致谢 -我们要感谢所有贡献者和开源社区为他们宝贵的资源和贡献。 +我们要感谢所有贡献者和开源社区为他们宝贵的资源和贡献。 \ No newline at end of file diff --git a/README.md b/README.md index 37a3651be..af87426b1 100644 --- a/README.md +++ b/README.md @@ -7,104 +7,6 @@ The **Quick Start Guide Focused README** is the most promising for optimizing the time to first workflow. It allows developers to get hands-on experience quickly, which is essential for engagement and understanding. -* * * - -**Outline for the README:** - -1. **Title and Badges** - * Julep Logo or Title - * Build status, npm version, license badges -2. **Introduction** - * _Briefly explain what Julep is and its purpose._ - * Emphasize how it simplifies building persistent AI agents with workflows. -3. **Features** - * _Highlight key features with a focus on "tasks" (AI workflows)._ - * Mention support for persistent sessions, tool integration, and document management. -4. **Installation** - * _Provide npm installation command:_ - - bash - - Copy code - - `npm install julep` - -5. **Quick Start Guide** - * **Step 1: Import Julep** - * _Show how to import Julep into a project._ - - javascript - - Copy code - - `const Julep = require('julep');` - - * **Step 2: Initialize the Agent** - * _Guide on creating a new agent with basic settings._ - - javascript - - Copy code - - `const agent = new Julep.Agent({  name: 'MyAgent',  model: 'gpt-4-turbo', });` - - * **Step 3: Chat with the Agent** - * _Provide a simple example of a chat with the agent._ - - javascript - - Copy code - - `const response = await client.sessions.chat({  session_id: session.id,  message: 'Hello, how are you?' });` - - * **Step 4: Define a Task (Workflow)** - * _Provide a simple example of a task definition._ - - javascript - - Copy code - - `const task = {  name: 'GreetingTask',  main: [    {      prompt: 'Say hello to the user.',    },  ], }; agent.addTask(task);` - - * **Step 5: Execute the Task** - * _Show how to run the task and handle the output._ - - javascript - - Copy code - - `agent.executeTask('GreetingTask').then((output) => {  console.log(output); });` - -6. **Understanding Tasks** - * _Explain what tasks are and how they function within Julep._ - * Describe different types of workflow steps. - * Prompt, Tool Call, Evaluate, etc. - * _Note:_ Link to detailed documentation for each step type. -7. **Advanced Features** - * _Briefly mention other capabilities:_ - * Adding tools to agents. - * Managing sessions and users. - * Document integration and search. -8. **API Reference** - * _Link to full API documentation._ - * Mention key endpoints for agents, tasks, and executions. -9. **Examples and Tutorials** - * _Provide links to example projects or further tutorials._ - * Encourage users to explore and build upon provided examples. -10. **Contributing** - * _Instructions for contributing to the project._ - * Link to contribution guidelines and code of conduct. -11. **Support and Community** - * _Information on how to get help._ - * Links to community forums, chat groups, or issue trackers. -12. **License** - * _State the project's license._ - * Provide a link to the LICENSE file. -13. **Acknowledgements** - * _Credit to contributors and used resources._ - -* * * - **Notes:** * **Code Examples:** Ensure all code snippets are easy to understand and copy-paste ready. @@ -144,6 +46,31 @@ The **Quick Start Guide Focused README** is the most promising for optimizing th ***** +## 🌟 Call for Contributors! + +We're excited to welcome new contributors to the Julep project! We've created several "good first issues" to help you get started. Here's how you can contribute: + +1. Check out our [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines on how to contribute. +2. Browse our [good first issues](https://github.com/julep-ai/julep/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to find a task that interests you. +3. If you have any questions or need help, don't hesitate to reach out on our [Discord](https://discord.com/invite/JTSBGRZrzj) channel. + +Your contributions, big or small, are valuable to us. Let's build something amazing together! 🚀 + +### 🎉 DevFest.AI October 2024 + +Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓️ + +- Contribute to Julep during this event and get a chance to win awesome Julep merch and swag! 🎁 +- Join developers from around the world in contributing to AI repositories and participating in amazing events. +- A big thank you to DevFest.AI for organizing this fantastic initiative! + +> [!TIP] +> Ready to join the fun? **[Tweet to start participating](https://twitter.com/intent/tweet?text=Pumped%20to%20be%20participating%20in%20%40devfestai%20with%20%40julep_ai%20building%20%23ai%20%23agents%20%23workflows%20Let's%20gooo!%20https%3A%2F%2Fgit.new%2Fjulep)** and let's get coding! 🖥️ + +![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif) + +***** + ## 🎉🚀 **Exciting News: Julep 1.0 Alpha Release!** 🚀🎉 We're thrilled to announce the **alpha** release of Julep 1.0! 🥳 @@ -165,6 +92,7 @@ We're thrilled to announce the **alpha** release of Julep 1.0! 🥳 Stay tuned for more updates as we approach our stable release! 📢 +***** ## Introduction diff --git a/cookbooks/01-Website_Crawler_using_Spider.ipynb b/cookbooks/01-Website_Crawler_using_Spider.ipynb index 251e699f4..36a77d525 100644 --- a/cookbooks/01-Website_Crawler_using_Spider.ipynb +++ b/cookbooks/01-Website_Crawler_using_Spider.ipynb @@ -30,11 +30,11 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "### Implementation\n", + "## Implementation\n", "\n", "To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb b/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb index 618d95df9..fded810a1 100644 --- a/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb +++ b/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb @@ -60,7 +60,7 @@ "\n", "To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/cookbooks/03-SmartResearcher_With_WebSearch.ipynb b/cookbooks/03-SmartResearcher_With_WebSearch.ipynb index b32d0f95b..c01b54652 100644 --- a/cookbooks/03-SmartResearcher_With_WebSearch.ipynb +++ b/cookbooks/03-SmartResearcher_With_WebSearch.ipynb @@ -73,7 +73,7 @@ "\n", "To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb b/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb index cfc95f3c2..d7fc39840 100644 --- a/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb +++ b/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb @@ -80,7 +80,7 @@ "\n", "To recreate the notebook and see the code implementation for this task, you can access the Google Colab notebook using the link below:\n", "\n", - "\n", + "\n", " \"Open\n", "\n", "\n", diff --git a/cookbooks/README.md b/cookbooks/README.md new file mode 100644 index 000000000..e7a6bfa89 --- /dev/null +++ b/cookbooks/README.md @@ -0,0 +1,157 @@ +
+ julep +
+ +# Julep AI - Notebook Overview + +Welcome to the **Julep AI Notebook Collection**! This directory contains a set of Jupyter notebooks designed to showcase various AI and automation tasks using Julep's features. + +Each notebook explores a unique use case, demonstrating different aspects of Julep's capabilities. Below is a quick overview of the notebooks, their purpose, and a link to run each of them on Google Colab. + +| **Notebook Name** | **Colab Link** | **Description** | **Implemented** | +|------------------------------------------------- |---------------------------------------------------------------------------- |--------------------------------------------------------------------|-----------------| +| `01-Website_Crawler_using_Spider.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/01-Website_Crawler_using_Spider.ipynb) | Implements a web crawler using a spider to extract website content. | Yes | +| `02-Sarcastic_News_Headline_Generator.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/02-Sarcastic_News_Headline_Generator.ipynb) | Generates sarcastic news headlines using a Brave Search Tool. | Yes | +| `03-SmartResearcher_With_WebSearch.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/03-SmartResearcher_With_WebSearch.ipynb) | Searches and aggregates web information for research purposes using Brave Search. | Yes | +| `04-TripPlanner_With_Weather_And_WikiInfo.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/04-TripPlanner_With_Weather_And_WikiInfo.ipynb) | Plans trips using weather data and Wikipedia information. | Yes | +| `05-Basic_Agent_Creation_and_Interaction.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/05-Basic_Agent_Creation_and_Interaction.ipynb) | Demonstrates how to create a basic agent and interact with it. | No | +| `06-Designing_Multi-Step_Tasks.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/06-Designing_Multi-Step_Tasks.ipynb) | Explores creating tasks with various step types. | No | +| `07-Integrating_External_Tools_and_APIs.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/07-Integrating_External_Tools_and_APIs.ipynb) | Shows how to integrate and use external tools and APIs. | No | +| `08-Managing_Persistent_Sessions.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/08-Managing_Persistent_Sessions.ipynb) | Covers creating and managing persistent sessions with context. | No | +| `09-User_Management_and_Personalization.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/09-User_Management_and_Personalization.ipynb) | Demonstrates user management and personalized interactions. | No | +| `10-Document_Management_and_Search.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/10-Document_Management_and_Search.ipynb) | Explores document upload, management, and search capabilities. | No | +| `11-Advanced_Chat_Interactions.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/11-Advanced_Chat_Interactions.ipynb) | Covers advanced chat features and context handling. | No | +| `12-Monitoring_Task_Executions.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/12-Monitoring_Task_Executions.ipynb) | Shows how to monitor and manage task executions. | No | +| `13-Error_Handling_and_Recovery.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/13-Error_Handling_and_Recovery.ipynb) | Demonstrates implementing error handling and recovery in tasks. | No | +| `14-API_Versioning_and_Configurations.ipynb` | [Colab Link](https://colab.research.google.com/github/julep-ai/julep/blob/dev/cookbooks/14-API_Versioning_and_Configurations.ipynb) | Explores API versioning and server configuration options. | No | + +## Potential Cookbooks for Contributors + +We welcome contributions to expand our cookbook collection. Here are some ideas for new cookbooks that showcase various Julep features and use cases: + +| **Potential Cookbook Name** | **Description** | **Key Features** | +|---------------------------- |----------------- |------------------| +| Automated Research Assistant | Conducts research on given topics using web search and summarization | Web search, Tool integration, Multi-step tasks | +| Customer Support Chatbot | Interacts with users, analyzes sentiment, and routes complex issues | Chat functionality, Sentiment analysis, Conditional logic | +| Daily News Aggregator | Collects and summarizes news articles, emails summaries to subscribers | Scheduled tasks, Email integration, Content summarization | +| Social Media Monitoring System | Monitors social platforms for keywords and sends alerts | API integration, Real-time monitoring, Alert system | +| Weather-Based Notification Service | Checks weather forecasts and notifies users of severe conditions | Weather API integration, Conditional alerts, Scheduling | +| Automated Financial Report Generator | Gathers financial data and generates reports for stakeholders | Data aggregation, Report generation, Scheduling | +| Task Management and Reminder System | Manages user tasks, sets reminders, and sends notifications | User management, Scheduling, Notifications | +| Interactive Story Generator | Creates stories based on user input with corresponding images | Natural language processing, Image generation, User interaction | +| Automated Meeting Scheduler | Finds optimal meeting times and manages calendar entries | Calendar integration, Conflict resolution, Invitations | +| Email Categorization and Response | Categorizes incoming emails and sends automated responses | Email processing, Content categorization, Automated responses | +| E-commerce Order Processing | Handles order placements, inventory, and shipment tracking | Workflow automation, Inventory management, Notifications | +| Content Moderation System | Reviews and classifies user-generated content | Content analysis, Classification, Moderation actions | +| Personalized Learning Assistant | Provides tailored learning materials and tracks progress | Personalization, Progress tracking, Content recommendation | +| Automated Backup and Recovery | Regularly backs up data and initiates recovery procedures | Scheduled tasks, Error handling, Data management | +| Smart Home Automation Workflow | Manages smart home devices based on user commands and conditions | IoT integration, Conditional logic, User interaction | +| Inventory Management System | Tracks inventory levels and automates reordering | Stock management, Predictive analysis, Automated ordering | +| Event-Driven Notification System | Triggers notifications based on specific events or thresholds | Event monitoring, Conditional alerts, Multi-channel notifications | +| Data Cleaning and Transformation | Cleans and transforms raw data for analysis | Data processing, ETL operations, Quality assurance | +| Project Management Assistant | Breaks down projects into tasks and tracks progress | Task decomposition, Progress monitoring, Reporting | +| Parallel Data Processing Pipeline | Processes large datasets in parallel and aggregates results | Parallel execution, Data aggregation, Scalable processing | +| Dynamic Content Recommendation | Analyzes user behavior and recommends personalized content | User profiling, Content analysis, Personalized recommendations | +| Compliance Monitoring System | Monitors activities for regulatory compliance and generates reports | Rule-based monitoring, Violation detection, Compliance reporting | +| Intelligent Resume Screening | Evaluates resumes based on criteria and forwards qualified candidates | Document analysis, Candidate scoring, Automated screening | +| Automated Code Review Pipeline | Reviews code commits, runs tests, and manages deployments | Code analysis, Automated testing, Deployment management | +| Personal Finance Tracker | Tracks expenses, analyzes patterns, and provides financial advice | Financial data analysis, Pattern recognition, Personalized advice | +| Automated Content Publishing | Schedules and publishes content across various platforms | Content management, Multi-platform publishing, Scheduling | +| AI-Powered Personal Assistant | Manages personal tasks, schedules, and provides information | Task management, Scheduling, Information retrieval | +| Bug Tracking and Reporting | Monitors repositories, categorizes issues, and assigns to developers | Issue tracking, Categorization, Automated assignment | +| Multi-Stage Data Validation | Validates data through multiple stages with different rules | Data validation, Multi-step processing, Error handling | +| Document Summarization and Archiving | Summarizes documents and archives them for easy retrieval | Text summarization, Document classification, Archiving | +| Real-Time Stock Market Analyzer | Analyzes market data and alerts users about significant changes | Real-time data processing, Financial analysis, Alert system | +| Webinar Management System | Schedules webinars, manages participants, and handles follow-ups | Event scheduling, Participant management, Automated follow-ups | +| Smart Content Filtering | Filters and recommends content based on user preferences | Content analysis, User profiling, Recommendation system | +| Automated Translation Workflow | Translates content into multiple languages and localizes it | Language translation, Localization, Content management | +| AI-Driven Survey Analysis | Analyzes survey responses and generates insight reports | Survey processing, Sentiment analysis, Report generation | +| Compliance Documentation Generator | Creates compliance documents based on regulatory standards | Document generation, Compliance checking, Template management | +| Task Prioritization and Allocation | Prioritizes tasks and allocates them to team members | Task analysis, Resource allocation, Team management | +| Webinar Feedback Analyzer | Collects and analyzes feedback from webinar participants | Feedback collection, Sentiment analysis, Improvement suggestions | +| Health and Fitness Tracker | Tracks health metrics and provides personalized fitness recommendations | Health data analysis, Personalized recommendations, Progress tracking | +| Incident Response System | Detects incidents, initiates response workflows, and notifies personnel | Incident detection, Workflow automation, Alert system | +| Content Optimization Workflow | Analyzes content performance and optimizes for better engagement | Performance analysis, Content optimization, A/B testing | +| Legal Document Processor | Extracts key information from legal documents and ensures compliance | Document analysis, Information extraction, Compliance checking | +| Job Application Tracker | Tracks job applications and provides application improvement suggestions | Application tracking, Status updates, Improvement recommendations | +| Content Rescheduling System | Monitors content performance and reschedules for better visibility | Performance monitoring, Content scheduling, Optimization | +| AI-Powered Investment Advisor | Analyzes financial data and suggests investment opportunities | Financial analysis, Risk assessment, Investment recommendations | +| Intelligent Document Version Control | Manages document versions and notifies users about updates | Version control, Change tracking, Notification system | +| Marketing Campaign Manager | Creates, schedules, and optimizes marketing campaigns | Campaign planning, Performance tracking, Optimization strategies | +| Competitive Analysis Workflow | Gathers data on competitors and generates analysis reports | Data collection, Comparative analysis, Report generation | +| Health Monitoring and Alerting | Monitors health metrics and alerts users and healthcare providers | Health data analysis, Anomaly detection, Alert system | +| Travel Itinerary Planner | Plans travel itineraries based on preferences and conditions | Trip planning, Preference matching, Dynamic scheduling | +| AI-Powered Personal Diary | Helps maintain a diary and provides insights into emotions and growth | Natural language processing, Sentiment analysis, Personal growth tracking | +| Language Learning Tutor | Provides exercises and personalized feedback for language learners | Language processing, Progress tracking, Personalized lessons | +| Knowledge Base Maintenance | Updates and maintains a knowledge base with new information | Information extraction, Knowledge management, Consistency checking | +| Feedback Loop for Improvement | Collects user feedback, analyzes it, and implements improvements | Feedback analysis, Improvement tracking, Stakeholder notifications | +| Grant Application Processor | Reviews grant applications, evaluates eligibility, and notifies applicants | Application processing, Eligibility checking, Automated notifications | +| AI-Powered Resume Builder | Assists in building resumes and provides improvement suggestions | Resume analysis, Content generation, Personalized recommendations | +| Vendor Management System | Manages vendor information, monitors performance, and handles communications | Vendor tracking, Performance monitoring, Communication automation | +| Meeting Minutes Recorder | Records meetings, transcribes audio, and distributes summaries | Audio transcription, Summary generation, Automated distribution | +| Personal Shopping Assistant | Finds products based on preferences and notifies about deals | Product matching, Price comparison, Deal notifications | +| Environmental Monitoring Reporter | Monitors environmental data and generates reports for stakeholders | Data monitoring, Anomaly detection, Report generation | +| Data Sync and Integration Workflow | Syncs data between platforms and handles conflicts | Data synchronization, Conflict resolution, Integration management | +| Competitive Pricing Strategy | Analyzes competitor pricing and adjusts prices dynamically | Price analysis, Dynamic pricing, Market monitoring | +| User Onboarding Workflow | Manages the user onboarding process and sets up accounts | User registration, Account setup, Welcome communications | +| Content Curation and Distribution | Curates content based on interests and tracks engagement | Content curation, Distribution scheduling, Engagement tracking | + +We encourage contributors to choose from these ideas or propose their own to showcase Julep's capabilities in solving real-world problems. + +## Julep Features Demonstrated + +These notebooks showcase various features of Julep. Here's an overview of the key features you can explore: + +1. **Agent Management** + - Creating and updating agents + - Configuring agent settings (name, model, about) + +2. **Task Definition and Execution** + - Creating multi-step tasks + - Executing tasks with specific inputs + - Various step types (Prompt, Tool Call, Evaluate, Conditional Logic, Loops, etc.) + +3. **Tool Integration** + - Adding custom tools to agents + - Integrating external APIs (e.g., web search, image generation) + +4. **Session Management** + - Creating and managing persistent sessions + - Handling context overflow + +5. **User Management** + - Creating and managing users + - Associating users with sessions + +6. **Document Management** + - Uploading and managing documents + - Document search functionality + +7. **Chat Functionality** + - Interacting with agents through chat sessions + +8. **Execution Monitoring** + - Streaming execution progress + - Monitoring task lifecycle + +9. **API Versioning** + - Support for different API versions + +10. **Authentication** + - API Key authentication + +11. **Server Configuration** + - Configurable server environments + +We encourage contributors to create new notebooks that demonstrate these features in various combinations and use cases. + +### Additional Information + +For more details about the tasks or if you have any questions, please don't hesitate to contact the author: + +**Author:** Julep AI +**Contact:** [hey@julep.ai](mailto:hey@julep.ai) or Discord + +--- + +If you have feedback or would like to contribute to the notebooks, feel free to open an issue(s) in the [repository](https://github.com/julep-ai/julep). \ No newline at end of file