Skip to content

epuerta9/kitchenai-labs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Here's the final, structured, and easy-to-follow version incorporating everything:


🚀 KitchenAI Bento Demo

Welcome to the KitchenAI Bento Box Demo! 🍱
This guide will help you set up and interact with a KitchenAI Bento Box through the KitchenAI Playground. By the end, you’ll be able to:

✅ Run example use cases
✅ Generate responses using your own KitchenAI app in the Playground


🛠️ Prerequisites

1️⃣ Create a Virtual Environment

In your terminal, run:

python -m venv venv

Then activate it:

  • Mac/Linux: source venv/bin/activate
  • Windows: venv\Scripts\activate

🚀 Step 1: Choose a Use Case

Go to the examples folder in the KitchenAI repository.

  • Pick a use case notebook that interests you.
  • Open it in Jupyter Notebook.
  • Run all the cells in the notebook.

🌐 Step 2: Set Up in KitchenAI Playground

1️⃣ Visit KitchenAI Playground.
2️⃣ Generate a Client ID: This ID uniquely identifies your app.
3️⃣ Copy the generated client_id.


🛠️ Step 3: Run Your KitchenAI Client

After running the use case notebook, set up your client by running the following code:

client = WhiskClient(
    nats_url="nats://nats.playground.kitchenai.dev:4222",
    client_id="your-client-id-here",  # Replace with your generated client ID
    user="playground",
    password="kitchenai_playground",
    kitchen=kitchen,
)

await client.run()
  • This connects your app to the KitchenAI Playground.
  • Once client.run() executes, your app is ready to respond to requests in the Playground UI.

🔥 Step 4: Test Your App

1️⃣ Open the KitchenAI Playground.
2️⃣ Select your app name and send a request.
3️⃣ View the response and experiment with different prompts.


🔗 Step 5: Advanced Features (Only Available with Sign-Up)

Not Available in Playground Mode

The following features are only accessible if you sign up for a KitchenAI account:

Interacting with Bento Boxes via Client Notebook (client_playground.ipynb)
Uploading & Querying Files
Retrieval-Augmented Generation (RAG) Workflows

📌 Playground users can only send requests to their KitchenAI app—just like the OpenAI SDK.


🎯 Next Steps

  • Explore more use cases from the examples folder.
  • Customize your queries and experiment with different inputs.
  • Sign up for a KitchenAI account to unlock advanced features.

For more details and video tutorials, visit the KitchenAI repository or Our website. 🚀


About

The experimentation and R&D section of kitchenai

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •