Skip to content

Commit

Permalink
Add E-commerce Order Processing Workflow Cookbook (#650)
Browse files Browse the repository at this point in the history
**Overview:**
This pull request introduces a new cookbook titled
`01-E-commerce_Order_Processing_Workflow.ipynb`. It provides a
comprehensive guide for automating the order processing system, which
includes handling order placements, inventory checks, payment
processing, and shipment tracking.

**Key Features:**
- **Introduction:** An overview explaining the purpose of the cookbook.
- **Installation Section:** Instructions for installing the Julep client
to facilitate the order processing workflow.
- **Structured Sections:** 
- **Creating an Agent:** Steps to create a Julep agent for handling user
interactions.
- **Defining a Task:** Guidance on how to define tasks for order
placement and inventory management.
- **Creating Executions:** Detailed instructions on how to create and
manage executions for order processing.
- **Code Quality:** 
- The code is well-commented, follows PEP 8 style guidelines, and uses
meaningful variable names.
- Error handling is implemented gracefully to ensure a robust execution
flow.
  
**Documentation:**
- Each step is explained clearly, assuming the reader is new to Julep. 
- Links to relevant Julep documentation are included for further
reference.

**Testing:**
- The notebook has been thoroughly tested in Google Colab to ensure it
runs without errors.
- Sample outputs are included to demonstrate the functionality of the
order processing workflow.
<!-- ELLIPSIS_HIDDEN -->

----

> [!IMPORTANT]
> Adds a Jupyter notebook for automating e-commerce order processing
with tasks for order placement, inventory checking, payment processing,
and shipment tracking.
> 
>   - **New Feature**:
> - Adds `01-E-commerce_Order_Processing_Workflow.ipynb` for automating
e-commerce order processing.
> - Includes tasks for order placement, inventory checking, payment
processing, and shipment tracking.
>   - **Code Structure**:
>     - Uses `uuid` for task and agent identification.
>     - Implements tasks using `yaml.safe_load` for task definitions.
> - Functions `place_order`, `check_inventory`, `process_payment`, and
`track_shipment` handle respective tasks.
>   - **Testing and Documentation**:
>     - Tested in Google Colab with sample outputs.
>     - Well-commented code with PEP 8 compliance.
> 
> <sup>This description was created by </sup>[<img alt="Ellipsis"
src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=julep-ai%2Fjulep&utm_source=github&utm_medium=referral)<sup>
for c067fde. It will automatically
update as commits are pushed.</sup>

<!-- ELLIPSIS_HIDDEN -->

---------

Co-authored-by: Diwank Singh Tomer <[email protected]>
Co-authored-by: creatorrr <[email protected]>
  • Loading branch information
3 people authored Oct 15, 2024
1 parent c48f03e commit 4bab852
Show file tree
Hide file tree
Showing 3 changed files with 623 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,8 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓
<summary><h3>📖 Table of Contents</h3></summary>

- [Introduction](#introduction)
- [Quick Example](#quick-example)
- [Key Features](#key-features)
- [Why Julep vs. LangChain?](#why-julep-vs-langchain)
- [Different Use Cases](#different-use-cases)
- [Different Form Factor](#different-form-factor)
- [In Summary](#in-summary)
- [Quick Example](#quick-example)
- [Installation](#installation)
- [Python Quick Start 🐍](#python-quick-start-)
- [Step 1: Create an Agent](#step-1-create-an-agent)
Expand All @@ -89,10 +85,10 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓
- [Understanding Tasks](#understanding-tasks)
- [Types of Workflow Steps](#types-of-workflow-steps)
- [Tool Types](#tool-types)
- [User-defined `function`s](#user-defined-functions)
- [User-defined `functions`](#user-defined-functions)
- [`system` tools](#system-tools)
- [Built-in `integration`s](#built-in-integrations)
- [Direct `api_call`s](#direct-api_calls)
- [Built-in `integrations`](#built-in-integrations)
- [Direct `api_calls`](#direct-api_calls)
- [Integrations](#integrations)
- [Other Features](#other-features)
- [Adding Tools to Agents](#adding-tools-to-agents)
Expand Down
Loading

0 comments on commit 4bab852

Please sign in to comment.