pygeai 0.1.6__py3-none-any.whl → 0.6.0b15__py3-none-any.whl

pygeai/tests/snippets/evaluation/plan/complete_workflow_example.py

@@ -0,0 +1,136 @@
+"""
+Complete Evaluation Plan API Workflow Example
+
+This example demonstrates a full workflow using the Evaluation Plan API:
+1. Query available system metrics
+2. Create an evaluation plan
+3. Add system metrics
+4. Update the plan
+5. Execute the plan
+6. Cleanup
+"""
+
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+
+def main():
+    # Initialize client
+    client = EvaluationPlanClient()
+    
+    print("="*60)
+    print("Evaluation Plan API Complete Workflow Example")
+    print("="*60)
+    
+    # Step 1: List available system metrics
+    print("\n[1/7] Listing available system metrics...")
+    metrics = client.list_system_metrics()
+    print(f"✓ Available metrics: {metrics}")
+    
+    # Get details of a specific metric
+    if metrics and 'systemMetrics' in metrics and len(metrics['systemMetrics']) > 0:
+        first_metric_id = metrics['systemMetrics'][0].get('systemMetricId')
+        metric_details = client.get_system_metric(system_metric_id=first_metric_id)
+        print(f"✓ Sample metric details: {metric_details}")
+    
+    # Step 2: Create an evaluation plan
+    print("\n[2/7] Creating evaluation plan...")
+    plan = client.create_evaluation_plan(
+        name="AI Assistant Performance Test",
+        type="TextPromptAssistant",
+        assistant_id="your-assistant-id",
+        assistant_name="Test Assistant",
+        assistant_revision="1.0",
+        dataset_id="your-dataset-id",
+        system_metrics=[
+            {
+                "systemMetricId": "accuracy",
+                "systemMetricWeight": 0.6
+            },
+            {
+                "systemMetricId": "fluency",
+                "systemMetricWeight": 0.4
+            }
+        ]
+    )
+    plan_id = plan.get('evaluationPlanId')
+    print(f"✓ Created evaluation plan: {plan_id}")
+    
+    # Step 3: Get the plan details
+    print("\n[3/7] Retrieving plan details...")
+    plan_details = client.get_evaluation_plan(evaluation_plan_id=plan_id)
+    print(f"✓ Plan name: {plan_details.get('evaluationPlanName')}")
+    print(f"✓ Plan type: {plan_details.get('evaluationPlanType')}")
+    print(f"✓ Number of metrics: {len(plan_details.get('systemMetrics', []))}")
+    
+    # Step 4: List plan's system metrics
+    print("\n[4/7] Listing plan's system metrics...")
+    plan_metrics = client.list_evaluation_plan_system_metrics(evaluation_plan_id=plan_id)
+    print(f"✓ Plan metrics: {plan_metrics}")
+    
+    # Step 5: Add a new metric to the plan
+    print("\n[5/7] Adding new system metric to plan...")
+    new_metric = client.add_evaluation_plan_system_metric(
+        evaluation_plan_id=plan_id,
+        system_metric_id="relevance",
+        system_metric_weight=0.5
+    )
+    print(f"✓ Added metric: {new_metric}")
+    
+    # Step 6: Update a metric's weight
+    print("\n[6/7] Updating metric weight...")
+    updated_metric = client.update_evaluation_plan_system_metric(
+        evaluation_plan_id=plan_id,
+        system_metric_id="accuracy",
+        system_metric_weight=0.8
+    )
+    print(f"✓ Updated metric weight")
+    
+    # Get specific metric details
+    metric_detail = client.get_evaluation_plan_system_metric(
+        evaluation_plan_id=plan_id,
+        system_metric_id="accuracy"
+    )
+    print(f"✓ Metric details: {metric_detail}")
+    
+    # Step 7: Update the plan itself
+    print("\n[7/7] Updating evaluation plan...")
+    updated_plan = client.update_evaluation_plan(
+        evaluation_plan_id=plan_id,
+        name="Updated Performance Test",
+        assistant_revision="2.0"
+    )
+    print(f"✓ Updated plan")
+    
+    # Execute the evaluation plan
+    print("\n[EXECUTE] Running evaluation plan...")
+    execution = client.execute_evaluation_plan(evaluation_plan_id=plan_id)
+    print(f"✓ Execution started")
+    print(f"  Execution ID: {execution.get('executionId')}")
+    print(f"  Status: {execution.get('status')}")
+    
+    # Cleanup
+    print("\n[CLEANUP] Cleaning up...")
+    
+    # Delete metrics
+    client.delete_evaluation_plan_system_metric(
+        evaluation_plan_id=plan_id,
+        system_metric_id="relevance"
+    )
+    print(f"✓ Deleted added metric")
+    
+    # Delete the plan
+    client.delete_evaluation_plan(evaluation_plan_id=plan_id)
+    print(f"✓ Deleted evaluation plan")
+    
+    print("\n" + "="*60)
+    print("Workflow completed successfully!")
+    print("="*60)
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as e:
+        print(f"\n❌ Error occurred: {e}")
+        import traceback
+        traceback.print_exc()

pygeai/tests/snippets/evaluation/plan/create_evaluation_plan.py

@@ -0,0 +1,24 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+response = client.create_evaluation_plan(
+    name="My Evaluation Plan",
+    type="TextPromptAssistant",
+    assistant_id="your-assistant-id",
+    assistant_name="My Assistant",
+    assistant_revision="1.0",
+    dataset_id="your-dataset-id",
+    system_metrics=[
+        {
+            "systemMetricId": "metric-1",
+            "systemMetricWeight": 0.6
+        },
+        {
+            "systemMetricId": "metric-2",
+            "systemMetricWeight": 0.4
+        }
+    ]
+)
+
+print(f"Created evaluation plan: {response}")

pygeai/tests/snippets/evaluation/plan/create_rag_evaluation_plan.py

@@ -0,0 +1,22 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+response = client.create_evaluation_plan(
+    name="RAG Assistant Evaluation",
+    type="RAG Assistant",
+    profile_name="My RAG Profile",
+    dataset_id="your-dataset-id",
+    system_metrics=[
+        {
+            "systemMetricId": "accuracy",
+            "systemMetricWeight": 0.7
+        },
+        {
+            "systemMetricId": "fluency",
+            "systemMetricWeight": 0.3
+        }
+    ]
+)
+
+print(f"Created RAG evaluation plan: {response}")

pygeai/tests/snippets/evaluation/plan/delete_evaluation_plan.py

@@ -0,0 +1,9 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+
+response = client.delete_evaluation_plan(evaluation_plan_id=evaluation_plan_id)
+
+print(f"Deleted evaluation plan: {response}")

pygeai/tests/snippets/evaluation/plan/delete_plan_system_metric.py

@@ -0,0 +1,13 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+system_metric_id = "your-metric-id"
+
+response = client.delete_evaluation_plan_system_metric(
+    evaluation_plan_id=evaluation_plan_id,
+    system_metric_id=system_metric_id
+)
+
+print(f"Deleted system metric: {response}")

pygeai/tests/snippets/evaluation/plan/execute_evaluation_plan.py

@@ -0,0 +1,11 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+
+response = client.execute_evaluation_plan(evaluation_plan_id=evaluation_plan_id)
+
+print(f"Execution started: {response}")
+print(f"Execution ID: {response.get('executionId')}")
+print(f"Status: {response.get('status')}")

pygeai/tests/snippets/evaluation/plan/get_evaluation_plan.py

@@ -0,0 +1,9 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+
+response = client.get_evaluation_plan(evaluation_plan_id=evaluation_plan_id)
+
+print(f"Evaluation plan: {response}")

pygeai/tests/snippets/evaluation/plan/get_plan_system_metric.py

@@ -0,0 +1,13 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+system_metric_id = "your-metric-id"
+
+response = client.get_evaluation_plan_system_metric(
+    evaluation_plan_id=evaluation_plan_id,
+    system_metric_id=system_metric_id
+)
+
+print(f"Plan system metric: {response}")

pygeai/tests/snippets/evaluation/plan/get_system_metric.py

@@ -0,0 +1,9 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+system_metric_id = "your-metric-id"
+
+response = client.get_system_metric(system_metric_id=system_metric_id)
+
+print(f"System metric: {response}")

pygeai/tests/snippets/evaluation/plan/list_evaluation_plans.py

@@ -0,0 +1,7 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+response = client.list_evaluation_plans()
+
+print(f"Evaluation plans: {response}")

pygeai/tests/snippets/evaluation/plan/list_plan_system_metrics.py

@@ -0,0 +1,9 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+
+response = client.list_evaluation_plan_system_metrics(evaluation_plan_id=evaluation_plan_id)
+
+print(f"Plan system metrics: {response}")

pygeai/tests/snippets/evaluation/plan/list_system_metrics.py

@@ -0,0 +1,7 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+response = client.list_system_metrics()
+
+print(f"Available system metrics: {response}")

pygeai/tests/snippets/evaluation/plan/update_evaluation_plan.py

@@ -0,0 +1,22 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+
+response = client.update_evaluation_plan(
+    evaluation_plan_id=evaluation_plan_id,
+    name="Updated Plan Name",
+    system_metrics=[
+        {
+            "systemMetricId": "metric-1",
+            "systemMetricWeight": 0.8
+        },
+        {
+            "systemMetricId": "metric-2",
+            "systemMetricWeight": 0.2
+        }
+    ]
+)
+
+print(f"Updated evaluation plan: {response}")

pygeai/tests/snippets/evaluation/plan/update_plan_system_metric.py

@@ -0,0 +1,14 @@
+from pygeai.evaluation.plan.clients import EvaluationPlanClient
+
+client = EvaluationPlanClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+system_metric_id = "your-metric-id"
+
+response = client.update_evaluation_plan_system_metric(
+    evaluation_plan_id=evaluation_plan_id,
+    system_metric_id=system_metric_id,
+    system_metric_weight=0.9
+)
+
+print(f"Updated system metric: {response}")

pygeai/tests/snippets/evaluation/result/complete_workflow_example.py

@@ -0,0 +1,150 @@
+"""
+Complete Evaluation Result API Workflow Example
+
+This example demonstrates how to retrieve and analyze evaluation results:
+1. List all results for a plan
+2. Get detailed results for each
+3. Analyze performance metrics
+4. Extract insights
+
+Note: This is a read-only API. Results are created by executing evaluation plans.
+"""
+
+from pygeai.evaluation.result.clients import EvaluationResultClient
+
+
+def main():
+    # Initialize client
+    client = EvaluationResultClient()
+    
+    print("="*70)
+    print("Evaluation Result API Complete Workflow Example")
+    print("="*70)
+    
+    # Step 1: List all results for an evaluation plan
+    print("\n[1/4] Listing evaluation results for a plan...")
+    evaluation_plan_id = "your-evaluation-plan-id"
+    
+    results = client.list_evaluation_results(evaluation_plan_id=evaluation_plan_id)
+    
+    if isinstance(results, list):
+        print(f"✓ Found {len(results)} evaluation results")
+    else:
+        print(f"✓ Results: {results}")
+        results = []
+    
+    # Step 2: Display summary of all results
+    print("\n[2/4] Summary of all results:")
+    print("-" * 70)
+    
+    total_cost = 0
+    total_duration = 0
+    status_counts = {}
+    
+    for i, result in enumerate(results, 1):
+        result_id = result.get('evaluationResultId', 'Unknown')
+        status = result.get('evaluationResultStatus', 'Unknown')
+        cost = result.get('evaluationResultCost', 0)
+        duration = result.get('evaluationResultDuration', 0)
+        
+        print(f"\n{i}. Result ID: {result_id}")
+        print(f"   Status: {status}")
+        print(f"   Cost: ${cost}")
+        print(f"   Duration: {duration}ms")
+        print(f"   Model: {result.get('evaluationResultModelName', 'N/A')}")
+        print(f"   Provider: {result.get('evaluationResultProviderName', 'N/A')}")
+        
+        # Aggregate metrics
+        total_cost += cost
+        total_duration += duration
+        status_counts[status] = status_counts.get(status, 0) + 1
+    
+    # Step 3: Get detailed results for the first result
+    if results:
+        print("\n[3/4] Getting detailed results for first evaluation...")
+        first_result_id = results[0].get('evaluationResultId')
+        
+        detailed_result = client.get_evaluation_result(
+            evaluation_result_id=first_result_id
+        )
+        
+        print(f"✓ Retrieved detailed result: {detailed_result.get('evaluationResultId')}")
+        
+        # Display row-level details
+        rows = detailed_result.get('rows', [])
+        print(f"\n  Row-level results: {len(rows)} rows")
+        
+        successful_rows = 0
+        failed_rows = 0
+        row_costs = []
+        
+        for row in rows:
+            row_status = row.get('evaluationResultRowStatus', 'Unknown')
+            row_cost = row.get('evaluationResultRowCost', 0)
+            
+            if row_status == 'completed' or row_status == 'success':
+                successful_rows += 1
+            else:
+                failed_rows += 1
+            
+            row_costs.append(row_cost)
+        
+        print(f"  Successful rows: {successful_rows}")
+        print(f"  Failed rows: {failed_rows}")
+        
+        if row_costs:
+            avg_row_cost = sum(row_costs) / len(row_costs)
+            print(f"  Average row cost: ${avg_row_cost:.4f}")
+        
+        # Show sample row
+        if rows:
+            print(f"\n  Sample Row:")
+            sample_row = rows[0]
+            print(f"    Dataset Row ID: {sample_row.get('dataSetRowId')}")
+            print(f"    Status: {sample_row.get('evaluationResultRowStatus')}")
+            print(f"    Cost: ${sample_row.get('evaluationResultRowCost')}")
+            print(f"    Start: {sample_row.get('evaluationResultRowStartDate')}")
+            print(f"    End: {sample_row.get('evaluationResultRowEndDate')}")
+            
+            output = sample_row.get('evaluationResultRowOutput', '')
+            if output:
+                print(f"    Output (first 200 chars):")
+                print(f"      {output[:200]}...")
+    
+    # Step 4: Display aggregated analytics
+    print("\n[4/4] Aggregated Analytics:")
+    print("-" * 70)
+    print(f"Total Evaluations: {len(results)}")
+    print(f"Total Cost: ${total_cost:.2f}")
+    print(f"Total Duration: {total_duration}ms ({total_duration/1000:.2f}s)")
+    
+    if results:
+        print(f"Average Cost per Evaluation: ${total_cost/len(results):.4f}")
+        print(f"Average Duration per Evaluation: {total_duration/len(results):.0f}ms")
+    
+    print(f"\nStatus Distribution:")
+    for status, count in status_counts.items():
+        percentage = (count / len(results) * 100) if results else 0
+        print(f"  {status}: {count} ({percentage:.1f}%)")
+    
+    print("\n" + "="*70)
+    print("Workflow completed successfully!")
+    print("="*70)
+    
+    # Important note about field names
+    print("\n⚠️  IMPORTANT NOTE:")
+    print("The API responses contain typos in some field names:")
+    print("  - evaluationResultAssitantRevision (missing 's' in Assistant)")
+    print("  - evaluationResultChunckCount (should be Chunk)")
+    print("  - evaluationResultChunckSize (should be Chunk)")
+    print("  - evaluationResultaMaxTokens (lowercase 'a')")
+    print("\nThese are API-level typos, not errors in our code.")
+
+
+if __name__ == "__main__":
+    try:
+        main()
+    except Exception as e:
+        print(f"\n❌ Error occurred: {e}")
+        import traceback
+        traceback.print_exc()

pygeai/tests/snippets/evaluation/result/get_evaluation_result.py

@@ -0,0 +1,26 @@
+from pygeai.evaluation.result.clients import EvaluationResultClient
+
+client = EvaluationResultClient()
+
+evaluation_result_id = "your-evaluation-result-id"
+
+result = client.get_evaluation_result(evaluation_result_id=evaluation_result_id)
+
+print(f"Evaluation Result: {result.get('evaluationResultId')}")
+print(f"Status: {result.get('evaluationResultStatus')}")
+print(f"Plan ID: {result.get('evaluationPlanId')}")
+print(f"Dataset ID: {result.get('dataSetId')}")
+print(f"Cost: ${result.get('evaluationResultCost')}")
+print(f"Duration: {result.get('evaluationResultDuration')}ms")
+print(f"Model: {result.get('evaluationResultModelName')}")
+print(f"Provider: {result.get('evaluationResultProviderName')}")
+
+# Row-level details
+rows = result.get('rows', [])
+print(f"\nRow-level results: {len(rows)} rows")
+
+for row in rows:
+    print(f"\n  Row ID: {row.get('dataSetRowId')}")
+    print(f"    Status: {row.get('evaluationResultRowStatus')}")
+    print(f"    Cost: ${row.get('evaluationResultRowCost')}")
+    print(f"    Output: {row.get('evaluationResultRowOutput')[:100]}...")

pygeai/tests/snippets/evaluation/result/list_evaluation_results.py

@@ -0,0 +1,17 @@
+from pygeai.evaluation.result.clients import EvaluationResultClient
+
+client = EvaluationResultClient()
+
+evaluation_plan_id = "your-evaluation-plan-id"
+
+results = client.list_evaluation_results(evaluation_plan_id=evaluation_plan_id)
+
+print(f"Found {len(results) if isinstance(results, list) else 'N/A'} evaluation results")
+
+for result in results if isinstance(results, list) else []:
+    print(f"\nResult ID: {result.get('evaluationResultId')}")
+    print(f"  Status: {result.get('evaluationResultStatus')}")
+    print(f"  Cost: ${result.get('evaluationResultCost')}")
+    print(f"  Duration: {result.get('evaluationResultDuration')}ms")
+    print(f"  Start: {result.get('evaluationResultStartDate')}")
+    print(f"  End: {result.get('evaluationResultEndDate')}")

pygeai/tests/snippets/files/delete_file.py

@@ -0,0 +1,9 @@
+from pygeai.core.files.managers import FileManager
+from pygeai.core.files.models import File
+
+file = File(id="7fe2393d-8f86-4020-a51f-bc14ab957e1e")
+
+file_manager = FileManager()
+
+response = file_manager.delete_file(file_id=file.id)
+print(response)

pygeai/tests/snippets/files/get_file_content.py

@@ -0,0 +1,10 @@
+from pygeai.core.files.managers import FileManager
+from pygeai.core.files.models import File
+
+
+file = File(id="7fe2393d-8f86-4020-a51f-bc14ab957e1e")
+
+file_manager = FileManager()
+
+response = file_manager.get_file_content(file_id=file.id)
+print(response)

pygeai/tests/snippets/files/get_file_data.py

@@ -0,0 +1,9 @@
+from pygeai.core.files.managers import FileManager
+from pygeai.core.files.models import File
+
+file = File(id="9984b837-fe88-4014-ad14-91e1596c8ead")
+
+file_manager = FileManager()
+
+response = file_manager.get_file_data(file_id=file.id)
+print(response)

pygeai/tests/snippets/files/get_file_list.py

@@ -0,0 +1,6 @@
+from pygeai.core.files.managers import FileManager
+
+file_manager = FileManager()
+
+response = file_manager.get_file_list()
+print(response)

pygeai/tests/snippets/files/upload_file.py

@@ -0,0 +1,13 @@
+from pygeai.core.files.managers import FileManager
+from pygeai.core.files.models import UploadFile
+
+file = UploadFile(
+    path="test.txt",
+    name="TestyFile",
+    folder="TestyTestTemp"
+)
+
+file_manager = FileManager()
+
+response = file_manager.upload_file(file)
+print(response)

pygeai/tests/snippets/gam/gam_access_token.py

@@ -0,0 +1,87 @@
+"""
+Sample script demonstrating the usage of GAMClient to interact with GAM OAuth 2.0 endpoints.
+
+This script shows how to:
+1. Obtain an access token using username and password.
+2. Fetch user information using the access token.
+3. Refresh an access token using a refresh token.
+"""
+
+import argparse
+import getpass
+from pygeai.gam.clients import GAMClient
+
+
+def main():
+    """
+    Main function to demonstrate the usage of GAMClient for GAM OAuth 2.0 authentication.
+    """
+    parser = argparse.ArgumentParser(description="GAM OAuth 2.0 Authentication Script")
+    parser.add_argument("--username", "-u", required=True, help="Username for authentication")
+    parser.add_argument("--client-id", "--cid", required=True, help="Client ID for the application")
+    parser.add_argument("--client-secret", "--cs", required=True, help="Client secret for the application")
+    args = parser.parse_args()
+
+    password = getpass.getpass("Enter password for {}: ".format(args.username))
+
+    try:
+        gam_client = GAMClient()
+    except Exception as e:
+        print(f"Error initializing GAMClient: {e}")
+        return
+
+    # Step 1: Get Access Token
+    print("=== Step 1: Obtaining Access Token ===")
+    try:
+        access_token_response = gam_client.get_access_token(
+            client_id=args.client_id,
+            client_secret=args.client_secret,
+            username=args.username,
+            password=password,
+            scope="gam_user_data+gam_user_roles",
+            authentication_type_name="local",
+            initial_properties={"Id": "Company", "Value": "GeneXus"},
+            repository="",
+            request_token_type="OAuth"
+        )
+        print("Access Token Response:")
+        print(access_token_response)
+
+        access_token = access_token_response.get("access_token", "")
+        refresh_token = access_token_response.get("refresh_token", "")
+        if not access_token:
+            print("Error: No access token received.")
+            return
+    except Exception as e:
+        print(f"Error obtaining access token: {e}")
+        return
+
+    # Step 2: Get User Information
+    print("\n=== Step 2: Fetching User Information ===")
+    try:
+        user_info_response = gam_client.get_user_info(access_token=access_token)
+        print("User Info Response:")
+        print(user_info_response)
+    except Exception as e:
+        print(f"Error fetching user information: {e}")
+        return
+
+    # Step 3: Refresh Access Token (if refresh_token is available)
+    if refresh_token:
+        print("\n=== Step 3: Refreshing Access Token ===")
+        try:
+            refresh_token_response = gam_client.refresh_access_token(
+                client_id=args.client_id,
+                client_secret=args.client_secret,
+                refresh_token=refresh_token
+            )
+            print("Refresh Token Response:")
+            print(refresh_token_response)
+        except Exception as e:
+            print(f"Error refreshing access token: {e}")
+    else:
+        print("\n=== Step 3: Skipping Refresh Token (No refresh token available) ===")
+
+
+if __name__ == "__main__":
+    main()