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

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

@@ -0,0 +1,122 @@
+Certainly! Let's incorporate the business logic using LogicBank, ensuring we add any necessary derived attributes to our model and adjust the test data accordingly. We'll also include the function `declare_logic` which utilizes LogicBank rules.
+
+```python
+from sqlalchemy import create_engine, Column, Integer, String, Float, ForeignKey, Date
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+from datetime import datetime
+
+Base = declarative_base()
+
+
+class Customer(Base):
+    """
+    description: Table for storing customer information.
+    """
+    __tablename__ = 'customers'
+    
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    name = Column(String, nullable=True)
+    credit_limit = Column(Float, nullable=True)
+    balance = Column(Float, default=0.0)  # Added for logic rule
+
+
+class Order(Base):
+    """
+    description: Table for orders linked to customers.
+    """
+    __tablename__ = 'orders'
+    
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    customer_id = Column(Integer, ForeignKey('customers.id'), nullable=True)
+    date_shipped = Column(Date, nullable=True)
+    notes = Column(String, nullable=True)
+    amount_total = Column(Float, default=0.0)  # Added for logic rule
+
+
+class Product(Base):
+    """
+    description: Table for products.
+    """
+    __tablename__ = 'products'
+    
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    name = Column(String, nullable=True)
+    unit_price = Column(Float, nullable=True)
+
+
+class Item(Base):
+    """
+    description: Table for items linked to orders and products.
+    """
+    __tablename__ = 'items'
+    
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    order_id = Column(Integer, ForeignKey('orders.id'), nullable=True)
+    product_id = Column(Integer, ForeignKey('products.id'), nullable=True)
+    quantity = Column(Integer, nullable=True)
+    unit_price = Column(Float, nullable=True)  # Added for logic rule
+    amount = Column(Float, default=0.0)  # Added for logic rule
+
+
+# Create an SQLite database
+engine = create_engine('sqlite:///system/genai/temp/create_db_models.sqlite')
+Base.metadata.create_all(engine)
+
+Session = sessionmaker(bind=engine)
+session = Session()
+
+# Creating test data for tables
+customer1 = Customer(name="John Doe", credit_limit=5000.0, balance=0.0)
+customer2 = Customer(name="Jane Smith", credit_limit=10000.0, balance=0.0)
+session.add_all([customer1, customer2])
+session.commit()
+
+order1 = Order(customer_id=customer1.id, date_shipped=None, notes="Express delivery", amount_total=0.0)
+order2 = Order(customer_id=customer2.id, date_shipped=datetime.now().date(), notes="Standard delivery", amount_total=0.0)
+session.add_all([order1, order2])
+session.commit()
+
+product1 = Product(name="Laptop", unit_price=1000.0)
+product2 = Product(name="Smartphone", unit_price=500.0)
+session.add_all([product1, product2])
+session.commit()
+
+item1 = Item(order_id=order1.id, product_id=product1.id, quantity=2, unit_price=1000.0, amount=2000.0)
+item2 = Item(order_id=order1.id, product_id=product2.id, quantity=3, unit_price=500.0, amount=1500.0)
+item3 = Item(order_id=order2.id, product_id=product2.id, quantity=1, unit_price=500.0, amount=500.0)
+session.add_all([item1, item2, item3])
+session.commit()
+
+
+def declare_logic():
+    Rule.sum(derive=Customer.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
+    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
+    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
+    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
+    Rule.constraint(validate=Customer,
+                    as_condition=lambda row: row.balance <= row.credit_limit,
+                    error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
+
+```
+
+### Explanation of Changes and Additions:
+
+- **Data Model Updates**:
+  - Added `balance` to `Customer` to support business rules.
+  - Added `amount_total` to `Order` for summation logic.
+  - Added `unit_price` and `amount` to `Item` for business logic involving calculations and copying.
+
+- **Test Data Updates**:
+  - Initialized `balance` and `amount_total` manually since we're relying on LogicBank for automatic updates.
+  - Set `unit_price` and `amount` for each item directly based on test data consistency with products and orders.
+
+- **Business Logic (LogicBank)**:
+  - Implemented `declare_logic` function using LogicBank to define rules:
+    - Calculate `Customer.balance` as the sum of pending `Order.amount_total`.
+    - Sum `Order.amount_total` from `Item.amount`.
+    - Calculate `Item.amount` using `quantity * unit_price`.
+    - Copy `Product.unit_price` to `Item.unit_price`.
+    - Constraint to ensure `Customer.balance` does not exceed `credit_limit`.
+
+By following these guidelines, the data model is prepared with a skeleton for logical integrity checks and value derivations, mirroring the application requirements without executing the logic directly in the database.

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)
 
@@ -152,11 +155,11 @@ Expanded example:
 Prompt:
 
     Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):
-    1. Customer.balance <= credit_limit
-    2. Customer.balance = Sum(Order.amount_total where date_shipped is null)
-    3. Order.amount_total = Sum(Item.amount)
-    4. Item.amount = quantity * unit_price
-    5. Store the Item.unit_price as a copy from Product.unit_price
+        1. Customer.balance <= credit_limit
+        2. Customer.balance = Sum(Order.amount_total where date_shipped is null)
+        3. Order.amount_total = Sum(Item.amount)
+        4. Item.amount = quantity * unit_price
+        5. Store the Item.unit_price as a copy from Product.unit_price
 
 Response:
 
@@ -169,3 +172,150 @@ def declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank
     Rule.constraint(validate=CustomerAccount,
                     as_condition=lambda row: row.balance <= row.credit_limit,
                     error_msg="Customer balance ({row.balance}) exceeds credit limit ({row.credit_limit})")
+
+
+Equivalent expanded example using informal syntax:
+
+Prompt:
+
+    Use Logic Bank to enforce the Check Credit requirement (do not generate check constraints):
+        1. The Customer's balance is less than the credit limit
+        2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
+        3. The Order's amount_total is the sum of the Item amount
+        4. The Item amount is the quantity * unit_price
+        5. The Item unit_price is copied from the Product unit_price
+
+Response is the same:
+
+def declare_logic():  # created by Web/GenAI for ApiLogicServer, LogicBank
+    
+    Rule.sum(derive=CustomerAccount.balance, as_sum_of=Order.amount_total, where=lambda row: row.date_shipped is None)
+    Rule.sum(derive=Order.amount_total, as_sum_of=Item.amount)
+    Rule.formula(derive=Item.amount, as_expression=lambda row: row.quantity * row.unit_price)
+    Rule.copy(derive=Item.unit_price, from_parent=Product.unit_price)
+    Rule.constraint(validate=CustomerAccount,
+                    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:
+    The sum of the child value cannot exceed the parent limit
+
+Response is to create 2 rules - a derivation and a constraint, as follows:
+    First Rule to Create:
+        Rule.sum(derive=Parent.value_total, as_sum_of=Child.value)
+    And, be sure to create the second Rule:
+        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/logic_inserts.prompt

@@ -0,0 +1 @@
+Use LogicBank to create declare_logic() to enforce these requirements (do not generate check constraints); be sure to update the data model and *all* test data with any attributes used in the logic:

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

@@ -0,0 +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 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.
+
+</responseFormat>

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

@@ -4,12 +4,27 @@ Use SQLAlchemy to create a sqlite database named system/genai/temp/create_db_mod
 
 Hints: use autonum keys (for all tables - including for link/join/junction/intersection tables), allow nulls, foreign keys, no check constraints.
 
+Be sure to create classes, never tables.
+
+If you create sum, count or formula Logic Bank rules, then you MUST create a corresponding column in the data model.
+
 Remember that SQLite DateTime type only accepts Python datetime and date objects as input, 
 this means you can not enter string attributes where a date or datetime object is expected.
 
 Don't install additional packages.
 Don't use the faker pip package.
 
-Create some test data, use foreign key columns instead of relationship names for the data.  Do not print the test data.  Be sure to initialize derived attributes, but do not rely on LogicBank.
+When creating SQLAlchemy data model classes, follow these guidelines carefully:
+* Use foreign key columns instead of relationship names for the data.  
+* Do not specify nullable unless otherwise specified.
+* For each data model class, create a docstring describing the table, prefixed with 'description: '. 
+* Do not use Float unless otherwise specified.
 
-For each data model class, create a docstring describing the table, prefixed with 'description: '. 
+Create multiple rows of test data for each table, and follow these guidelines carefully:
+* Create separate objects for each test data row, not in arrays. 
+* Be sure to initialize derived attributes for test data rows - including all sums and counts, but do not rely on Logic Bank,
+and do not generate db.execute statements.
+* Do not create arrays of test data.
+* Do not create a function to load test data.  
+* Do not print the test data. 
+* For test data, format dates as date(year, month, day).

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

@@ -0,0 +1,28 @@
+
+{{prompt}}
+
+Update the prior response - be sure not to lose classes and test data already created.
+
+Hints: use autonum keys (for all tables - including for link/join/junction/intersection tables), allow nulls, foreign keys, no check constraints.
+
+Be sure to create classes, never tables.
+
+If you create sum, count or formula Logic Bank rules, then you MUST create a corresponding column in the data model.
+
+Remember that SQLite DateTime type only accepts Python datetime and date objects as input, 
+this means you can not enter string attributes where a date or datetime object is expected.
+
+Don't install additional packages.
+Don't use the faker pip package.
+
+Create multiple rows of test data for each table, and follow these guidelines carefully:
+* Use foreign key columns instead of relationship names for the data.  
+* Create separate objects for each test data row, not in arrays. 
+* Be sure to initialize derived attributes for test data rows - including all sums and counts, but do not rely on Logic Bank,
+and do not generate db.execute statements.
+* Do not create arrays of test data.
+* Do not create a function to load test data.  
+* Do not print the test data.
+* For test data, format dates as date(year, month, day).
+
+For each data model class, create a docstring describing the table, prefixed with 'description: '. 

api_logic_server_cli/prototypes/manager/system/genai/retry/conv/create_db_models.py

@@ -0,0 +1,96 @@
+# 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 
+from logic_bank.logic_bank import Rule
+from sqlalchemy import create_engine, Column, Integer, String, Float, ForeignKey, Date, DateTime, Numeric, Boolean, Text
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import sessionmaker
+from sqlalchemy.orm import relationship
+from datetime import date   
+from datetime import datetime
+
+logging.getLogger('sqlalchemy.engine.Engine').disabled = True  # remove for additional logging
+
+Base = declarative_base()  # from system/genai/create_db_models_inserts/create_db_models_prefix.py
+
+
+class Customer(Base):
+    """description: Table representing customers in the system."""
+
+    __tablename__ = 'customers'
+
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    name = Column(String, nullable=False)
+    balance = Column(Float, default=0.0)  # Derived as sum of Order.amount_total where shipped_date is null
+    credit_limit = Column(Float, nullable=False)
+
+
+class Order(Base):
+    """description: Table representing customer orders with associated notes."""
+
+    __tablename__ = 'orders'
+
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    customer_id = Column(Integer, ForeignKey('customers.id'))
+    notes = Column(Text)
+    amount_total = Column(Float, default=0.0)  # Derived as sum of Item.amount
+    date_shipped = Column(DateTime)
+
+
+class Item(Base):
+    """description: Table representing items associated with orders."""
+
+    __tablename__ = 'items'
+
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    order_id = Column(Integer, ForeignKey('orders.id'))
+    product_id = Column(Integer, ForeignKey('products.id'))
+    quantity = Column(Integer, nullable=False)
+    amount = Column(Float, default=0.0)  # Derived as quantity * unit_price
+    unit_price = Column(Float)  # Copied from Product.unit_price
+
+
+class Product(Base):
+    """description: Table representing products available for sale."""
+
+    __tablename__ = 'products'
+
+    id = Column(Integer, primary_key=True, autoincrement=True)
+    name = Column(String, nullable=False)
+    unit_price = Column(Float, nullable=False)
+
+
+# ALS/GenAI: Create an SQLite database
+engine = create_engine('sqlite:///system/genai/temp/create_db_models.sqlite')
+Base.metadata.create_all(engine)
+
+Session = sessionmaker(bind=engine)
+session = Session()
+
+# ALS/GenAI: Prepare for sample data
+
+# Test Data Loading
+from datetime import date, datetime
+
+test_product1 = Product(id=1, name="Laptop", unit_price=1000.00)
+test_product2 = Product(id=2, name="Phone", unit_price=600.00)
+
+test_customer1 = Customer(id=1, name="Alice Smith", credit_limit=5000.00, balance=3800.00)
+test_customer2 = Customer(id=2, name="Bob Johnson", credit_limit=3000.00, balance=0.0)
+
+test_order1 = Order(id=1, customer_id=1, notes="Urgent delivery", amount_total=3800.00, date_shipped=None)
+test_order2 = Order(id=2, customer_id=2, notes="Gift wrap", amount_total=1000.00, date_shipped=datetime(2023, 5, 10))
+
+test_item1 = Item(id=1, order_id=1, product_id=1, quantity=2, amount=2000.00, unit_price=1000.00)
+test_item2 = Item(id=2, order_id=1, product_id=2, quantity=3, amount=1800.00, unit_price=600.00)
+test_item3 = Item(id=3, order_id=2, product_id=1, quantity=1, amount=1000.00, unit_price=1000.00)
+
+
+session.add_all([test_product1, test_product2, test_customer1, test_customer2, test_order1, test_order2, test_item1, test_item2, test_item3])
+session.commit()

api_logic_server_cli/prototypes/manager/system/genai/retry/conv/inf-1_iter_1_1_000.response

@@ -0,0 +1 @@
+You are a data modelling expert and python software architect who expands on user input ideas. You create data models with at least 4 tables