Skip to content

Latest commit

 

History

History

README.md

User Examples

This directory contains executable examples and the comprehensive user guide for the Augment Python SDK.

📖 User Guide

See user_guide.md for the complete documentation with detailed explanations, API reference, and usage patterns.

🚀 Quick Start Examples

  1. 01_quick_start.py - Basic agent usage
  2. 02_event_listener_builtin.py - Using the built-in logging listener
  3. 03_event_listener_custom.py - Creating a custom event listener
  4. 04_session_management.py - Using sessions for conversational context
  5. 05_type_inference.py - Automatic type inference
  6. 06_typed_returns.py - Explicit type specification with dataclasses
  7. 07_success_criteria.py - Using success criteria for verification
  8. 08_function_tools.py - Giving the agent access to custom functions

Running Examples

Run individual examples:

python 01_quick_start.py

Run all examples:

./run_all.sh