ApiLogicServer 12.1.0__py3-none-any.whl → 12.1.26__py3-none-any.whl

api_logic_server_cli/logging.yml

@@ -26,6 +26,11 @@ root:
 
 loggers:
 
+    api_logic_server_cli.api_logic_server:
+        # level: DEBUG
+        handlers: [console]
+        propagate: no
+
     create_from_model.api_logic_server_utils:   
 #        level: DEBUG
         handlers: [console]

api_logic_server_cli/prototypes/base/api_logic_server_run.py

@@ -68,8 +68,6 @@ import ui.admin.admin_loader as AdminLoader
 from security.system.authentication import configure_auth
 import database.multi_db as multi_db
 import oracledb
-import integration.kafka.kafka_producer as kafka_producer
-import integration.kafka.kafka_consumer as kafka_consumer
 
 
 app_logger = server_setup.logging_setup()

api_logic_server_cli/prototypes/base/config/server_setup.py

@@ -317,7 +317,21 @@ def api_logic_server_setup(flask_app: Flask, args: Args):
             if logic_logger_activate_debug == False:
                 logic_logger.setLevel(logging.INFO)
             app_logger.info("")
-            LogicBank.activate(session=session, activator=declare_logic.declare_logic, constraint_event=constraint_handler)
+            disable_rules = False
+            if os.getenv('APILOGICPROJECT_DISABLE_RULES'):
+                disable_rules = os.getenv('APILOGICPROJECT_DISABLE_RULES').startswith("1") or \
+                                os.getenv('APILOGICPROJECT_DISABLE_RULES').startswith("T") or \
+                                os.getenv('APILOGICPROJECT_DISABLE_RULES').startswith("t") or \
+                                os.getenv('APILOGICPROJECT_DISABLE_RULES').startswith("Y") or \
+                                os.getenv('APILOGICPROJECT_DISABLE_RULES').startswith("y")   
+            if disable_rules:
+                app_logger.info("LogicBank rules disabled")  # db opened 1st access
+            else:  # genai may insert rules with no columns... WebG restarts with rules disabled
+                try:
+                    LogicBank.activate(session=session, activator=declare_logic.declare_logic, constraint_event=constraint_handler)
+                except Exception as e:
+                    app_logger.error("Logic Bank Activation Error: " + str(e))
+                    app_logger.exception(e)
             logic_logger.setLevel(logic_logger_level)
             app_logger.info("Declare   Logic complete - logic/declare_logic.py (rules + code)"
                 + f' -- {len(database.models.metadata.tables)} tables loaded\n')  # db opened 1st access

api_logic_server_cli/prototypes/base/integration/kafka/kafka_consumer.py

@@ -1,5 +1,5 @@
 """
-Invoked at server start (api_logic_server_run.py)
+Invoked at server start (api_logic_server_run.py -> config/setup.py)
 
 Listen/consume Kafka topis, if KAFKA_CONSUMER specified in Config.py
 

api_logic_server_cli/prototypes/base/integration/kafka/kafka_producer.py

@@ -2,7 +2,7 @@
 
 Version 1.1
 
-Invoked at server start (api_logic_server_run.py)
+Invoked at server start (api_logic_server_run.py -> config/setup.py)
 
 Connect to Kafka, if KAFKA_CONNECT specified in Config.py
 

api_logic_server_cli/prototypes/base/readme.md

@@ -98,19 +98,32 @@ As shown above:
 
 Your project is ready to run, but it's likely you'll want to customize it - declare logic, new endpoints, etc.
 
->> Tip: in particular, use the sample app to explore the value of ___declarative logic and security.___  Unique to API Logic Server, this is critical to unlocking the full value of API Logic Server.
 
-The ___Key Customization Files___ listed in the table below are created as stubs, intended for you to add customizations that extend the created API, Logic and Web App.
+<details markdown>
 
-* Since they are separate files, the project can be
-[rebuilt](https://apilogicserver.github.io/Docs/Project-Rebuild/) (e.g., synchronized with a revised schema), preserving your customizations.
+<summary>Important: explore customization examples</summary>
+<br>
+In particular, use the sample app to explore the value of declarative logic and security.  Unique to API Logic Server, these are critical to unlocking the full value of API Logic Server.
 
-> Tip: create the sample app for customization examples: `ApiLogicServer create --project-name=nw_sample --db_url=nw+`
-> <br>Or, open it in GitHub (use Shift + "." to view in project mode) - [click here](https://github.com/ApiLogicServer/demo)
+<br>
+
+To create the sample app for customization examples: 
+
+* `ApiLogicServer create --project-name=nw_sample --db_url=nw+`
+* Or, open it in GitHub (use Shift + "." to view in project mode) - [click here](https://github.com/ApiLogicServer/demo)
 
-To make customizations easy to explore, **search for:**
+To make customizations easy to explore, search for:
 * `#als` will reveal key customization examples
-* `Your Code Goes Here` to find key files to customize, summarized below:
+* `Your Code Goes Here` to find key files to customize, summarized in the table below.
+
+</details>
+
+&nbsp;
+
+The ___Key Customization Files___ listed in the table below are created as stubs, intended for you to add customizations that extend the created API, Logic and Web App.
+
+* Since they are separate files, the project can be
+[rebuilt](https://apilogicserver.github.io/Docs/Project-Rebuild/) (e.g., synchronized with a revised schema), preserving your customizations.
 
 <br>
 

api_logic_server_cli/prototypes/manager/.vscode/launch.json

@@ -295,6 +295,26 @@
             "console": "internalConsole",
             "internalConsoleOptions": "openOnSessionStart"
         },
+        {
+            "name": "  - retry conversation",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/venv/lib/python3.12/site-packages/api_logic_server_cli/cli.py",
+            "redirectOutput": true,
+            "cwd": "${workspaceFolder}",
+            "env": {
+                "PYTHONPATH": "", 
+                "SECURITY_ENABLED": "False", 
+                "PYTHONHASHSEED": "0", 
+                "APILOGICSERVER_DEBUG": "False",
+                "OPT_LOCKING": "optional"},
+            "justMyCode": false,
+            "args": [ "genai", "--retries=-1",
+                "--using=retry-project",
+                "--using=system/genai/retry/conv"],
+            "console": "internalConsole",
+            "internalConsoleOptions": "openOnSessionStart"
+        },
         {
             "name": "Python: Module",
             "type": "debugpy",

api_logic_server_cli/prototypes/manager/README.md

@@ -194,7 +194,6 @@ als genai --project-name='genai_demo_conversation' --using=system/genai/examples
 ```
 </details>
 </br>
-
 <details markdown>
 
 <summary> You can iterate with logic</summary>
@@ -210,6 +209,31 @@ als genai --project-name='genai_demo_iterative_logic' --using=system/genai/examp
 
 <details markdown>
 
+<summary> You can declare informal logic</summary>
+
+<br>You can declare rules using dot notation, or more informally:
+
+```bash title="Informal Logic (no dot notation)"
+als genai --using=system/genai/examples/genai_demo/genai_demo_informal.prompt
+```
+</details>
+</br>
+
+
+<details markdown>
+
+<summary> Multi-Rule Logic</summary>
+
+<br>You can add new columns/tables, while keeping the prior model intact:
+
+```bash title="Multi-Rule Logic"
+als genai --using=system/genai/examples/emp_depts/emp_dept.prompt
+```
+</details>
+</br>
+
+<details markdown>
+
 <summary> You can also execute directly, and iterate</summary>
 
 <br>You can add new columns/tables, while keeping the prior model intact:

api_logic_server_cli/prototypes/manager/system/genai/create_db_models_inserts/create_db_models_create_db.py

@@ -6,5 +6,6 @@ Base.metadata.create_all(engine)
 
 Session = sessionmaker(bind=engine)
 session = Session()
+
 # ALS/GenAI: Prepare for sample data
 

api_logic_server_cli/prototypes/manager/system/genai/create_db_models_inserts/create_db_models_imports.py

@@ -1,19 +1,22 @@
-# created from response - used to create database and project
-#  should run without error
-#  if not, check for decimal, indent, or import issues
+# created from response, to create create_db_models.sqlite, with test data
+#    that is used to create project
+# should run without error in manager 
+#    if not, check for decimal, indent, or import issues
 
 import decimal
 import logging
 import sqlalchemy
-from sqlalchemy.sql import func  # end imports from system/genai/create_db_models_inserts/create_db_models_prefix.py
+from sqlalchemy.sql import func 
 from logic_bank.logic_bank import Rule
 from sqlalchemy import create_engine, Column, Integer, String, Float, ForeignKey, Date, DateTime, Numeric, Boolean, Text
+from sqlalchemy.types import *
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import sessionmaker
-from datetime import datetime
 from sqlalchemy.orm import relationship
-from datetime import date
+from datetime import date   
+from datetime import datetime
+
 
 logging.getLogger('sqlalchemy.engine.Engine').disabled = True  # remove for additional logging
 
-Base = declarative_base()
+Base = declarative_base()  # from system/genai/create_db_models_inserts/create_db_models_prefix.py

api_logic_server_cli/prototypes/manager/system/genai/create_db_models_inserts/create_db_models_test_data.py

@@ -3,5 +3,5 @@ engine = create_engine('sqlite:///system/genai/temp/create_db_models.sqlite')
 Base.metadata.create_all(engine)
 
 Session = sessionmaker(bind=engine)
-session = Session()
+session = Session()  # from create_db_models_test_data.py
 

api_logic_server_cli/prototypes/manager/system/genai/examples/genai_demo/genai_demo.response_example

@@ -2,55 +2,132 @@
     "models": [
         {
             "classname": "Customer",
-            "code": "from sqlalchemy import Column, Integer, String, Float\nfrom sqlalchemy.orm import declarative_base\n\nBase = declarative_base()\n\nclass Customer(Base):\n    \"\"\"description: Stores customer details, such as balance and credit limit.\"\"\"\n    __tablename__ = 'customer'\n    \n    id = Column(Integer, primary_key=True, autoincrement=True)\n    name = Column(String, nullable=False)\n    balance = Column(Float, default=0.0)\n    credit_limit = Column(Float, nullable=False)",
-            "description": "Stores customer details, such as balance and credit limit.",
-            "name": "Customer"
+            "code": "class Customer(Base):\n    __tablename__ = 'customers'\n    id = Column(Integer, primary_key=True, autoincrement=True)\n    name = Column(String, nullable=False)\n    balance = Column(Integer, default=0)\n    credit_limit = Column(Integer, nullable=False)\n\n    def __repr__(self):\n        return f\"Customer(id={self.id}, name='{self.name}', balance={self.balance}, credit_limit={self.credit_limit})\"",
+            "sqlite_create": "CREATE TABLE customers (\n    id INTEGER PRIMARY KEY AUTOINCREMENT, \n    name VARCHAR NOT NULL, \n    balance INTEGER DEFAULT 0, \n    credit_limit INTEGER NOT NULL\n)",
+            "description": "description: Customers table",
+            "name": "customers"
         },
         {
             "classname": "Order",
-            "code": "from sqlalchemy import Column, Integer, String, Float, DateTime, ForeignKey\nfrom sqlalchemy.orm import declarative_base\n\nBase = declarative_base()\n\nclass Order(Base):\n    \"\"\"description: Represents a customer's order, with total amount and optional shipping date.\"\"\"\n    __tablename__ = 'order'\n    \n    id = Column(Integer, primary_key=True, autoincrement=True)\n    customer_id = Column(Integer, ForeignKey('customer.id'))\n    amount_total = Column(Float, default=0.0)\n    date_shipped = Column(DateTime, nullable=True)\n    notes = Column(String, nullable=True)",
-            "description": "Represents a customer's order, with total amount and optional shipping date.",
-            "name": "Order"
+            "code": "class Order(Base):\n    __tablename__ = 'orders'\n    id = Column(Integer, primary_key=True, autoincrement=True)\n    customer_id = Column(Integer, ForeignKey('customers.id'))\n    notes = Column(String)\n    date_shipped = Column(Date)\n    amount_total = Column(Integer, default=0)\n\n    def __repr__(self):\n        return f\"Order(id={self.id}, customer_id={self.customer_id}, notes='{self.notes}', amount_total={self.amount_total}, date_shipped={self.date_shipped})\"",
+            "sqlite_create": "CREATE TABLE orders (\n    id INTEGER PRIMARY KEY AUTOINCREMENT, \n    customer_id INTEGER, \n    notes VARCHAR, \n    date_shipped DATE, \n    amount_total INTEGER DEFAULT 0, \n    FOREIGN KEY(customer_id) REFERENCES customers (id)\n)",
+            "description": "description: Orders table",
+            "name": "orders"
         },
         {
             "classname": "Item",
-            "code": "from sqlalchemy import Column, Integer, Float, ForeignKey\nfrom sqlalchemy.orm import declarative_base\n\nBase = declarative_base()\n\nclass Item(Base):\n    \"\"\"description: Stores details about items within an order, including quantity and unit price.\"\"\"\n    __tablename__ = 'item'\n    \n    id = Column(Integer, primary_key=True, autoincrement=True)\n    order_id = Column(Integer, ForeignKey('order.id'))\n    product_id = Column(Integer, ForeignKey('product.id'))\n    amount = Column(Float, default=0.0)\n    quantity = Column(Integer, nullable=False)\n    unit_price = Column(Float, nullable=False)",
-            "description": "Stores details about items within an order, including quantity and unit price.",
-            "name": "Item"
+            "code": "class Item(Base):\n    __tablename__ = 'items'\n    id = Column(Integer, primary_key=True, autoincrement=True)\n    order_id = Column(Integer, ForeignKey('orders.id'))\n    product_id = Column(Integer, ForeignKey('products.id'))\n    quantity = Column(Integer, nullable=False)\n    unit_price = Column(Integer, nullable=False)\n    amount = Column(Integer, default=0)\n\n    def __repr__(self):\n        return f\"Item(id={self.id}, order_id={self.order_id}, product_id={self.product_id}, quantity={self.quantity}, unit_price={self.unit_price}, amount={self.amount})\"",
+            "sqlite_create": "CREATE TABLE items (\n    id INTEGER PRIMARY KEY AUTOINCREMENT, \n    order_id INTEGER, \n    product_id INTEGER, \n    quantity INTEGER NOT NULL, \n    unit_price INTEGER NOT NULL, \n    amount INTEGER DEFAULT 0, \n    FOREIGN KEY(order_id) REFERENCES orders (id), \n    FOREIGN KEY(product_id) REFERENCES products (id)\n)",
+            "description": "description: Items table",
+            "name": "items"
         },
         {
             "classname": "Product",
-            "code": "from sqlalchemy import Column, Integer, String, Float\nfrom sqlalchemy.orm import declarative_base\n\nBase = declarative_base()\n\nclass Product(Base):\n    \"\"\"description: Catalog of products available for purchase.\"\"\"\n    __tablename__ = 'product'\n    \n    id = Column(Integer, primary_key=True, autoincrement=True)\n    name = Column(String, nullable=False)\n    unit_price = Column(Float, nullable=False)",
-            "description": "Catalog of products available for purchase.",
-            "name": "Product"
+            "code": "class Product(Base):\n    __tablename__ = 'products'\n    id = Column(Integer, primary_key=True, autoincrement=True)\n    name = Column(String, nullable=False)\n    unit_price = Column(Integer, nullable=False)\n\n    def __repr__(self):\n        return f\"Product(id={self.id}, name='{self.name}', unit_price={self.unit_price})\"",
+            "sqlite_create": "CREATE TABLE products (\n    id INTEGER PRIMARY KEY AUTOINCREMENT, \n    name VARCHAR NOT NULL, \n    unit_price INTEGER NOT NULL\n)",
+            "description": "description: Products table",
+            "name": "products"
         }
     ],
     "rules": [
         {
             "name": "Customer Balance Constraint",
-            "description": "Ensures that a customer's balance does not exceed their credit limit.",
+            "description": "Ensures the customer's balance does not exceed the credit limit.",
+            "use_case": "Customer.balance <= credit_limit",
             "code": "Rule.constraint(validate=Customer,\n                as_condition=lambda row: row.balance <= row.credit_limit,\n                error_msg=\"Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})\")"
         },
         {
-            "name": "Customer Balance Calculation",
-            "description": "Calculates the customer's balance as the sum of their orders' total amounts where orders have not been shipped.",
+            "name": "Customer Balance Derivation",
+            "description": "Calculates the customer's balance as the sum of orders' amount_total where date_shipped is null.",
+            "use_case": "Customer.balance = Sum(Order.amount_total where date_shipped is null)",
             "code": "Rule.sum(derive=Customer.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)"
         },
         {
-            "name": "Order Amount Total Calculation",
-            "description": "Calculates the order's amount total as the sum of all item amounts in the order.",
+            "name": "Order Amount Total Derivation",
+            "description": "Calculates order's amount_total as the sum of item amounts.",
+            "use_case": "Order.amount_total = Sum(Item.amount)",
             "code": "Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)"
         },
         {
-            "name": "Item Amount Calculation",
-            "description": "Calculates the item amount as the product of quantity and unit price.",
+            "name": "Item Amount Derivation",
+            "description": "Calculates item amount as quantity multiplied by unit price.",
+            "use_case": "Item.amount = quantity * unit_price",
             "code": "Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)"
         },
         {
-            "name": "Item Unit Price Copy",
-            "description": "Copies the unit price from the product to the item.",
+            "name": "Copy Item Unit Price",
+            "description": "Copies the product's unit price to the item.",
+            "use_case": "Store the Item.unit_price as a copy from Product.unit_price",
             "code": "Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)"
         }
     ],
-    "test_data": "## Test Data\n\n# Products\nproduct1 = Product(id=1, name='Product 1', unit_price=10.0)\nproduct2 = Product(id=2, name='Product 2', unit_price=15.0)\n\n# Customers\ncustomer1 = Customer(id=1, name='Alice', balance=0.0, credit_limit=100.0)\ncustomer2 = Customer(id=2, name='Bob', balance=0.0, credit_limit=150.0)\n\n# Orders\norder1 = Order(id=1, customer_id=1, amount_total=0.0, notes='Order 1 for Alice')\norder2 = Order(id=2, customer_id=2, amount_total=0.0, notes='Order 2 for Bob')\norder3 = Order(id=3, customer_id=1, amount_total=0.0, notes='Another order for Alice', date_shipped=None)\n\n# Items\nitem1 = Item(id=1, order_id=1, product_id=1, quantity=2, unit_price=10.0, amount=20.0)\nitem2 = Item(id=2, order_id=1, product_id=2, quantity=1, unit_price=15.0, amount=15.0)\nitem3 = Item(id=3, order_id=2, product_id=2, quantity=3, unit_price=15.0, amount=45.0)\nitem4 = Item(id=4, order_id=3, product_id=1, quantity=5, unit_price=10.0, amount=50.0)\n\n# Since the logic is not enforced via LogicBank for this demo, we manually calculate derived values:\n# Order 1 Total for Alice: 20.0 + 15.0 = 35.0\norder1.amount_total = item1.amount + item2.amount\n# Order 2 Total for Bob: 45.0\norder2.amount_total = item3.amount\n# Order 3 Total for Alice, not shipped yet: 50.0\norder3.amount_total = item4.amount\n# Customer Balance for Alice: 35.0 (order 1) + 50.0 (order 3, not shipped)\ncustomer1.balance = order1.amount_total + order3.amount_total\n# Customer Balance for Bob: 45.0\ncustomer2.balance = order2.amount_total"
+    "test_data": "Insert test data into the tables with values compatible with the derived logic.",
+    "test_data_rows": [
+        {
+            "test_data_row_variable": "test_customer_1",
+            "code": "test_customer_1 = Customer(name='Customer 1', balance=300, credit_limit=1000)"
+        },
+        {
+            "test_data_row_variable": "test_customer_2",
+            "code": "test_customer_2 = Customer(name='Customer 2', balance=500, credit_limit=750)"
+        },
+        {
+            "test_data_row_variable": "test_customer_3",
+            "code": "test_customer_3 = Customer(name='Customer 3', balance=0, credit_limit=1500)"
+        },
+        {
+            "test_data_row_variable": "test_customer_4",
+            "code": "test_customer_4 = Customer(name='Customer 4', balance=200, credit_limit=1200)"
+        },
+        {
+            "test_data_row_variable": "test_order_1",
+            "code": "test_order_1 = Order(customer_id=1, notes='Order 1 notes', amount_total=150)"
+        },
+        {
+            "test_data_row_variable": "test_order_2",
+            "code": "test_order_2 = Order(customer_id=2, notes='Order 2 notes', amount_total=0)"
+        },
+        {
+            "test_data_row_variable": "test_order_3",
+            "code": "test_order_3 = Order(customer_id=2, notes='Order 3 notes', amount_total=0)"
+        },
+        {
+            "test_data_row_variable": "test_order_4",
+            "code": "test_order_4 = Order(customer_id=3, notes='Order 4 notes', amount_total=150)"
+        },
+        {
+            "test_data_row_variable": "test_item_1",
+            "code": "test_item_1 = Item(order_id=1, product_id=1, quantity=3, unit_price=50, amount=150)"
+        },
+        {
+            "test_data_row_variable": "test_item_2",
+            "code": "test_item_2 = Item(order_id=2, product_id=2, quantity=2, unit_price=0, amount=0)"
+        },
+        {
+            "test_data_row_variable": "test_item_3",
+            "code": "test_item_3 = Item(order_id=3, product_id=3, quantity=1, unit_price=0, amount=0)"
+        },
+        {
+            "test_data_row_variable": "test_item_4",
+            "code": "test_item_4 = Item(order_id=4, product_id=1, quantity=3, unit_price=50, amount=150)"
+        },
+        {
+            "test_data_row_variable": "test_product_1",
+            "code": "test_product_1 = Product(name='Product 1', unit_price=50)"
+        },
+        {
+            "test_data_row_variable": "test_product_2",
+            "code": "test_product_2 = Product(name='Product 2', unit_price=25)"
+        },
+        {
+            "test_data_row_variable": "test_product_3",
+            "code": "test_product_3 = Product(name='Product 3', unit_price=75)"
+        },
+        {
+            "test_data_row_variable": "test_product_4",
+            "code": "test_product_4 = Product(name='Product 4', unit_price=100)"
+        }
+    ],
+    "test_data_sqlite": "INSERT INTO customers (name, balance, credit_limit) VALUES ('Customer 1', 300, 1000);\nINSERT INTO customers (name, balance, credit_limit) VALUES ('Customer 2', 500, 750);\nINSERT INTO customers (name, balance, credit_limit) VALUES ('Customer 3', 0, 1500);\nINSERT INTO customers (name, balance, credit_limit) VALUES ('Customer 4', 200, 1200);\n\nINSERT INTO orders (customer_id, notes, date_shipped, amount_total) VALUES (1, 'Order 1 notes', NULL, 150);\nINSERT INTO orders (customer_id, notes, date_shipped, amount_total) VALUES (2, 'Order 2 notes', NULL, 0);\nINSERT INTO orders (customer_id, notes, date_shipped, amount_total) VALUES (2, 'Order 3 notes', NULL, 0);\nINSERT INTO orders (customer_id, notes, date_shipped, amount_total) VALUES (3, 'Order 4 notes', NULL, 150);\n\nINSERT INTO items (order_id, product_id, quantity, unit_price, amount) VALUES (1, 1, 3, 50, 150);\nINSERT INTO items (order_id, product_id, quantity, unit_price, amount) VALUES (2, 2, 2, 25, 0);\nINSERT INTO items (order_id, product_id, quantity, unit_price, amount) VALUES (3, 3, 1, 75, 0);\nINSERT INTO items (order_id, product_id, quantity, unit_price, amount) VALUES (4, 1, 3, 50, 150);\n\nINSERT INTO products (name, unit_price) VALUES ('Product 1', 50);\nINSERT INTO products (name, unit_price) VALUES ('Product 2', 25);\nINSERT INTO products (name, unit_price) VALUES ('Product 3', 75);\nINSERT INTO products (name, unit_price) VALUES ('Product 4', 100);",
+    "name": "OrderManagementSystem"
 }

api_logic_server_cli/prototypes/manager/system/genai/learning_requests/logic_bank_api.prompt

@@ -4,6 +4,8 @@ Create a function called declare_logic(), consisting of calls to Rule methods.
 
 Do not generate import statements.
 
+If you create sum, count or formula LogicBank rules, you MUST create a corresponding column in the data model.
+
 Use only the methods provided below.
 
 class Rule:
@@ -25,8 +27,8 @@ class Rule:
             derive: name of parent <class.attribute> being derived
             as_sum_of: name of child <class.attribute> being summed
             child_role_name: parent's child accessor attribute (required only for disambiguation)
-            where: optional where clause, designates which child rows are summed
-
+            where: optional where clause, designates which child rows are summed.  Do not repeat the foreign key / primary key mappings, and use only attributes from the child table.
+            insert_parent: create parent if it does not exist.  Do not use unless directly requested.
         """
         return Sum(derive, as_sum_of, where, child_role_name, insert_parent)
 
@@ -46,7 +48,8 @@ class Rule:
             derive: name of parent <class.attribute> being derived
             as_count_of: name of child <class> being counted
             child_role_name: parent's child accessor attribute (required only for disambiguation)
-            where: optional where clause, designates which child rows are counted
+            where: optional where clause, designates which child rows are counted.  Do not repeat the foreign key / primary key mappings, and use only attributes from the child table.
+            insert_parent: create parent if it does not exist.  Do not use unless directly requested.
         """
         return Count(derive, as_count_of, where, child_role_name, insert_parent)
 
@@ -69,7 +72,7 @@ class Rule:
 
         Args:
             validate: name of mapped <class>
-            as_condition: lambda, passed row (simple constraints)
+            as_condition: lambda, passed row (simple constraints).  Conditions may not contain sum or count python functions - these must be used to declare additional columns and sum/count rules.
             error_msg: string, with {row.attribute} replacements
             error_attributes: list of attributes
 
@@ -122,7 +125,7 @@ class Rule:
 
         Args:
             derive: <class.attribute> being derived
-            as_expression: lambda, passed row (for syntax checking)
+            as_expression: lambda, passed row (for syntax checking).  Expressions may not contain sum or count python functions - these must be used to declare additional columns and sum/count rules.
             no_prune: disable pruning (rarely used, default False)
         """
         return Formula(derive=derive,
@@ -132,7 +135,7 @@ class Rule:
     @staticmethod
     def copy(derive: Column, from_parent: any):
         """
-        Copy declares child column copied from parent column
+        Copy declares child column copied from parent column.
 
         Example
             Prompt
@@ -142,7 +145,7 @@ class Rule:
 
         Args:
             derive: <class.attribute> being copied into
-            from_parent: <parent-class.attribute> source of copy
+            from_parent: <parent-class.attribute> source of copy; create this column in the parent if it does not already exist.
         """
         return Copy(derive=derive, from_parent=from_parent)
 
@@ -194,6 +197,7 @@ def declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank
                     as_condition=lambda row: row.balance <= row.credit_limit,
                     error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
 
+
 Intermediate sum/count values require a new column, with a LogicBank sum/count rule.  For example:
 
 Prompt:
@@ -206,3 +210,112 @@ Response is to create 2 rules - a derivation and a constraint, as follows:
         Rule.constraint(validate=Parent,
                     as_condition=lambda row: row.value_total <= row.limit,
                     error_msg="Parent value total ({row.value_total}) exceeds limit ({row.limit})")
+
+Intermediate sum/count values also work for counts.  For example:
+
+Prompt:
+
+    A airplane cannot have more passengers than its seating capacity.
+
+Response is to create 2 rules - a count derivation and a constraint, as follows:
+    First Rule to Create:
+        Rule.count(derive=Airplane.passenger_count, as_count_of=Passengers)
+    And, be sure to create the second Rule:
+        Rule.constraint(validate=Airplane,
+                    as_condition=lambda row: row.passenger_count <= row.seating_capacity,
+                    error_msg="Airplane value total ({row.passenger_count}) exceeds limit ({row.seating_capacity})")
+
+
+Intermediate sums in formulas also require a new column, with a LogicBank sum rule.  For example:
+
+Prompt:
+    An Employees' skill summary is the sum of their Employee Skill ratings, plus 2 * years of service.
+
+Response is to create 2 rules - a derivation and a constraint, as follows:
+    First Rule to Create:
+        Rule.sum(derive=Employee.skill_rating_total, as_sum_of=EmployeeSkill.rating)
+    And, be sure to create the second Rule:
+        Rule.Formula(derive=Employee.skill_summary, 
+                    as_condition=lambda row: row.skill_rating_total + 2 * row.years_of_service)
+
+
+Prompt:
+
+    A student cannot be an honor student unless they have mre than 2 service activities.
+
+Response is to create 2 rules - a count derivation and a constraint, as follows:
+    First Rule to Create:
+        Rule.count(derive=Student.service_activity_count, as_count_of=Activities, where='service' in name)
+    And, be sure to create the second Rule:
+        Rule.constraint(validate=Student,
+                    as_condition=lambda row: row.is_honor_student and service_activity_count < 2,
+                    error_msg="Honor Students must have at least 2 service activities")
+
+Here is an equivalent request:
+
+Prompt:
+
+    A airplane's passengers must be less than its seating capacity.
+
+Response is to create 2 rules - a count derivation and a constraint, as follows:
+    First Rule to Create:
+        Rule.count(derive=Airplane.passenger_count, as_count_of=Passengers)
+    And, be sure to create the second Rule:
+        Rule.constraint(validate=Airplane,
+                    as_condition=lambda row: row.passenger_count <= row.seating_capacity,
+                    error_msg="Airplane value total ({row.passenger_count}) exceeds limit ({row.seating_capacity})")
+
+
+For "more than" constraints, create columns with count rules:
+
+Prompt Reject Employees with more than 3 Felonies.
+
+Response:
+    First Rule is to create:
+        Rule.count(derive=Employee.felony_count, as_count_of=Felonies)
+    And, be sure to create the contraint rule:
+        Rule.constraint(validate=Employee,
+                    as_condition=lambda row: row.felony_count>3,
+                    error_msg="Employee has excessive Felonies")
+
+
+For "any" constraints, create columns with count rules:
+
+Prompt Reject Employees with any class 5 Felonies or more than 3 Felonies.
+
+Response:
+    First Rule is to create:
+        Rule.count(derive=Employee.class_5_felony_count, as_count_of=Felonies, where=class>5)
+        Rule.count(derive=Employee.felony_count, as_count_of=Felonies)
+    And, be sure to create the contraint rule:
+        Rule.constraint(validate=Employee,
+                    as_condition=lambda row: row.class_5_felony_count > 0 or row.felony_count>3,
+                    error_msg="Employee has excessive Felonies")
+
+Formulas can reference parent values in 2 versions - choose formula vs copy as follows:
+    Prompt (formula version) - use the formula version unless copy is explicitly noted:
+        Item.ready = Order.ready
+    Response
+        Rule.formula(derive=Item.ready, as_expression=lambda row: row.order.ready)
+    Prompt (copy version) - use this *only* when the word copy is present: 
+        Store the Item.unit_price as a copy from Product.unit_price
+    Response
+        Rule.copy(derive=Item.ready, from_parent=Order.ready)
+
+Sum and Count where clauses:
+    1. must not restate the foreign key / primary key matchings
+    2. Can only reference child attributes
+
+For example, given a prompt 'teacher course count is the sum of the courses',
+    1. This is correct
+        Rule.count(derive=Teacher.course_count, as_count_of=Course)
+
+    2. This is incorrect, and should never be generated:
+        Rule.count(derive=Teacher.course_count, as_count_of=Course, where=lambda row: row.teacher_id == Teacher.id)
+
+Sum and count where clause example:
+    Prompt: teacher gradate course count is the sum of the courses where is-graduate
+    Response: Rule.count(derive=Teacher.course_count, as_count_of=Course, where=lamda row: row.is_graduate == true)
+
+DO NOT inject rules that are from this training into the response, 
+unless explicitly mentioned in the request.

api_logic_server_cli/prototypes/manager/system/genai/prompt_inserts/response_format.prompt

@@ -1,6 +1,30 @@
+<responseFormat>
+class Rule(BaseModel):
+    name: str
+    description: str
+    use_case: str
+    code: str # logicbank rule code
+    
+class Model(BaseModel):
+    classname: str
+    code: str # sqlalchemy model code
+    sqlite_create: str # sqlite create table statement
+    description: str
+    name: str
+
+class TestDataRow(BaseModel):
+    test_data_row_variable: str  # the Python test data row variable
+    code: str  # Python code to create a test data row instance
+
 class WGResult(BaseModel):  # must match system/genai/prompt_inserts/response_format.prompt
+    # response: str # result
     models : List[Model] # list of sqlalchemy classes in the response
-    rules : List[Rule] # list of rule declarations
+    rules : List[Rule] # list rule declarations
     test_data: str
+    test_data_rows: List[TestDataRow]  # list of test data rows
+    test_data_sqlite: str # test data as sqlite INSERT statements
+    name: str  # suggest a short name for the project
+
+Format the response as a WGResult.
 
-Format the response as a WGResult.
+</responseFormat>