Readme

Author: martinibach

community/gemini/README.md

@@ -1,4 +1,39 @@
-# Restack AI SDK - Gemini Generate Content Example
+# Restack AI - Gemini Example
+
+This example demonstrates how to build reliable and scalable AI applications using Google's Gemini API with Restack. It shows how to handle rate limits, concurrent API calls, and workflow orchestration effectively.
+
+We build four example workflows: a basic content generation workflow, a function calling workflow, a multi-function calling workflow, and a swarm workflow that demonstrates parallel execution.
+
+
+## Motivation
+
+When building AI applications with Gemini, you need to handle various production challenges:
+
+1. **API Rate Limits**: Gemini API has concurrent request limits (e.g., 3 concurrent calls)([1](https://googleapis.github.io/python-genai)) that need to be managed across multiple workflows.
+
+2. **Reliability**: AI workflows need retry mechanisms and graceful failure handling for production use.
+
+3. **Scalability**: As your application grows to handle thousands of concurrent agents or requests, you need robust queue management and execution control.
+
+### How Restack Helps
+
+Restack provides built-in solutions for these challenges:
+
+1. **Automated Rate Limiting**: Define rate limits in service options and let Restack handle the queuing:
+```python
+client.start_service(
+    task_queue="gemini",
+    functions=[generate_content, function_call],
+    options=ServiceOptions(
+        rate_limit=3,  # Match Gemini's concurrent call limit
+        max_concurrent_function_runs=3
+    )
+)
+```
+
+2. **Built-in Retries**: Restack automatically handles retries and failure scenarios.
+
+3. **Queue Management**: Efficiently manages thousands of concurrent workflows while respecting API limits.
 
 ## Prerequisites
 
@@ -25,8 +60,7 @@
 
    ```bash
    git clone https://github.com/restackio/examples-python
-   cd examples-python/examples/gemini_generate_content
-   ```
+   cd examples-python/community/gemini
 
 4. Install dependencies using Poetry:
 
@@ -52,25 +86,15 @@
    export GEMINI_API_KEY=<your-api-key>
    ```
 
-6. Run the services:
+6. Run the services in dev:
 
    ```bash
-   poetry run services
+   poetry run dev
    ```
 
    This will start the Restack service with the defined workflows and functions.
 
-7. In a new terminal, schedule the workflow:
-
-   ```bash
-   poetry shell
-   ```
-
-   ```bash
-   poetry run schedule
-   ```
-
-   This will schedule the `GeminiGenerateOppositeWorkflow` and print the result.
+8. Schedule workflows via the UI 
 
 ## Project Structure