julep-ai / julep

Build AI agents and workflows with a simple API. Supabase for AI agents
https://julep.ai
Apache License 2.0
883 stars 67 forks source link

[Good First Issue]: Replicate Existing Cookbooks and Create New Examples - Batch 6 #562

Open ijindal1 opened 12 hours ago

ijindal1 commented 12 hours ago

For context, see: CONTRIBUTING.md and cookbooks/README.md

Overview

We're looking for contributors to help expand our collection of Jupyter notebooks (cookbooks) that demonstrate various AI and automation tasks using Julep's features. This is a great opportunity for newcomers to get familiar with Julep and contribute to the project!

Objectives

  1. Replicate existing cookbooks to ensure they're up-to-date and functioning correctly.
  2. Create new cookbooks based on the ideas listed in the cookbooks/README.md file.

Tasks

1. Replicating Existing Cookbooks

2. Creating New Cookbooks

Guidelines for Creating New Cookbooks

  1. Naming Convention: Name your notebook following the pattern XX-Descriptive_Name.ipynb, where XX is the next available number in the sequence.

  2. Structure:

    • Start with an introduction explaining the purpose of the cookbook.
    • Include a cell for installing the Julep client.
    • Create sections for each major step (e.g., Creating an Agent, Defining a Task, Creating an Execution).
    • Add markdown cells to explain concepts and code.
  3. Code Quality:

    • Ensure your code is well-commented and follows PEP 8 style guidelines.
    • Use meaningful variable names.
    • Handle potential errors gracefully.
  4. Documentation:

    • Explain each step clearly, assuming the reader is new to Julep.
    • Include links to relevant Julep documentation where appropriate.
  5. Testing:

    • Test your notebook thoroughly in Google Colab to ensure it runs without errors.
    • Include sample outputs where relevant.
  6. Update README.md:

    • Add your new cookbook to the table in cookbooks/README.md.
    • Include a brief description and mark it as implemented.

How to Contribute

  1. Fork the repository.
  2. Create a new branch for your cookbook (e.g., cookbook/weather-notification-service).
  3. Develop your cookbook following the guidelines above.
  4. Test your notebook thoroughly.
  5. Commit your changes and push to your fork.
  6. Open a pull request with a clear description of your contribution.

Resources

Need Help?

If you have any questions or need assistance, please don't hesitate to ask in the comments of this issue or reach out on our Discord channel.

We're excited to see your contributions and help grow the Julep cookbook collection!


Long-ass list of ideas

  1. Intelligent Content Optimization Workflow Description: Analyzes content performance, optimizes it for better engagement, and republishes optimized content. Features: Tools: web_search, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Optimize Content (Prompt), Publish Content, Log
  2. Automated Legal Document Processing Description: Processes legal documents by extracting key information, checking for compliance, and storing them securely. Features: Tools: wikipedia, api_call Step Types: Tool Call, Evaluate, Conditional Logic, Extract Information (Prompt), Store Document (Set), Log
  3. Intelligent Job Application Tracker Description: Tracks job applications, analyzes responses, and provides recommendations for improving applications. Features: Tools: sendgrid, slack, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Send Recommendations, Log
  4. Automated Content Rescheduling System Description: Monitors content performance and reschedules underperforming content for better visibility. Features: Tools: api_call, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Reschedule Content (Set), Send Notifications, Log
  5. AI-Powered Personal Finance Advisor Description: Analyzes user financial data, provides budgeting advice, and suggests investment opportunities. Features: Tools: finance, sendgrid, huggingface Step Types: Tool Call, Evaluate, Conditional Logic, Generate Advice (Prompt), Send Recommendations, Log
  6. Automated Code Deployment and Testing Description: Deploys code changes, runs automated tests, and rolls back if tests fail. Features: Tools: api_call, slack, sendgrid Step Types: Tool Call, Evaluate, Conditional Logic, Run Tests (Tool Call), Deploy Code, Send Notifications, Log
  7. Intelligent Document Version Control Description: Manages document versions, tracks changes, and notifies users about updates. Features: Tools: wikipedia, slack Step Types: Tool Call, Evaluate, Conditional Logic, Update Version (Set), Send Notifications, Log
  8. Automated Marketing Campaign Manager Description: Creates, schedules, and manages marketing campaigns, tracks performance, and optimizes strategies. Features: Tools: sendgrid, slack, finance Step Types: Tool Call, Evaluate, Conditional Logic, Schedule Campaign (Set), Track Performance, Log
PRIYANKjakharia commented 12 hours ago

i can work on this