Skip to content

Latest commit

 

History

History
156 lines (121 loc) · 5.5 KB

README.md

File metadata and controls

156 lines (121 loc) · 5.5 KB
Raw

robot image

COMandA Examples

This directory contains various examples demonstrating different capabilities of COMandA. The examples are organized into categories based on their primary functionality.

Categories

Server Examples (server-examples/)

Examples demonstrating server functionality and STDIN input:

  • stdin-example.yaml - Shows STDIN input usage with server POST requests

    # Can be processed via HTTP POST with input string
analyze_text:
  input: STDIN  # Makes YAML eligible for POST requests
  model: gpt-4o
  action: "Analyze the following text and provide key insights:"
  output: STDOUT

    Process via server:

    # Using query parameter
curl -X POST "http://localhost:8080/process?filename=server-examples/stdin-example.yaml&input=your text here"

# Using JSON body
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"input":"your text here"}' \
  "http://localhost:8080/process?filename=server-examples/stdin-example.yaml"

This server example also demonstrates how comanda can be used as part of a comand line data pipe:

cat text.txt|comanda process stdin-example.yaml

Database Connections (database-connections/)

Examples demonstrating database integration:

  • db-example.yaml - Database read/write operations
  • simpledb.sql - Sample database schema and data
  • Supporting files: Dockerfile for test environment

To start up the docker container for testing the database examples, run the following commands (after installing Docker)

cd examples/database-connections/postgres
docker build -t comanda-postgres .
docker run -d -p 5432:5432 comanda-postgres

Model Examples (model-examples/)

Examples demonstrating integration with different AI models:

  • openai-example.yaml - Basic OpenAI integration example
  • ollama-example.yaml - Using local Ollama models
  • anthropic-pdf-example.yaml - Using Anthropic's Claude model with PDF processing
  • google-example.yaml - Integration with Google's AI models
  • xai-example.yaml - X.AI model integration example

File Processing (file-processing/)

Examples of file manipulation and processing:

  • analyze-csv.yaml - Processing CSV data
  • consolidate-example.yaml - Combining multiple files
  • multi-file-example.yaml - Working with multiple files
  • Supporting files: harvey1.txt, harvey2.txt, consolidated.txt, test.csv

Web Scraping (web-scraping/)

Examples of web interaction and scraping:

  • scrape-example.yaml - Web scraping functionality
  • url-example.yaml - Working with URLs
  • screenshot-example.yaml - Taking screenshots of web pages
  • scrape-file-example.yaml - File-based scraping configuration

Document Processing (document-processing/)

Examples of working with various document formats:

  • xml-example.yaml - XML file handling
  • google-xml-example.yaml - Google model XML processing
  • markdown-action-example.yaml - Markdown file processing
  • test-action.md - Example markdown action file
  • Supporting files: input.xml, output.xml, sample.pdf

Image Processing (image-processing/)

Examples of image-related operations:

  • image-example.yaml - Basic image processing capabilities
  • Supporting files: image.jpeg

Running Examples

You can run any example using:

comanda process examples/[category]/[example-file].yaml

For instance:

comanda process examples/model-examples/openai-example.yaml

Each example includes comments explaining its functionality and any specific requirements (like API keys or local model setup).

Example Types

  1. Basic Examples: Start with these to understand core functionality

    • model-examples/openai-example.yaml
    • model-examples/ollama-example.yaml
    • server-examples/stdin-example.yaml (server POST integration)

  2. Advanced Examples: Demonstrate more complex features

    • file-processing/consolidate-example.yaml (multi-file processing)
    • web-scraping/screenshot-example.yaml (browser interaction)
    • document-processing/markdown-action-example.yaml (external action files)
    • database-connections/db-example.yaml (database operations)

  3. Integration Examples: Show provider-specific features

    • model-examples/anthropic-pdf-example.yaml (PDF processing)
    • model-examples/google-example.yaml (Google AI integration)
    • model-examples/xai-example.yaml (X.AI integration)

  4. Data Examples: Demonstrate data processing capabilities

    • 'database-connections/postgres/db-example.yaml' (database operations)

  5. Server Examples: Show HTTP server functionality

    • server-examples/stdin-example.yaml (POST request with string input)
    # Check if YAML supports POST
curl "http://localhost:8080/list"

# Process with POST if supported
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"input":"analyze this text"}' \
  "http://localhost:8080/process?filename=server-examples/stdin-example.yaml"

Test Environment

A Docker environment is provided for testing database operations:

cd examples/database-connections/postgres
docker build -t comanda-postgres .
docker run -d -p 5432:5432 comanda-postgres

This creates a PostgreSQL database with sample customer and order data.

Contributing

Feel free to add new examples! When contributing:

  1. Place your example in the appropriate category directory
  2. Include clear comments in your YAML file
  3. Update this README with a description of your example
  4. Include any necessary supporting files