Merge pull request #85 from mikebudzynski/sk-agents-cu

Semantic Kernel agents: Content Understanding and SOP Forge

Author: mwhalin

samples/agent-catalog/msft-agent-samples/semantic-kernel-sdk/contract-analysis-agent/README.md

@@ -1,26 +1,67 @@
-# Contract Analysis Agent
+# Contract Analysis Agent Using Azure AI Agent Service And Semantic Kernel
 
-## Overview
+## Overview 
 
-The Contract Analysis agent code sample enables creating agents that compare contract versions by evaluating changes between them. It assists in reviewing multiple versions of a contract by evaluating the changes between them. extracts key fields and clauses from the contracts, highlights differences, and generates a detailed report that highlights the differences. The report is formatted in markdown to clearly identify these differences and mirrors the structure of the contracts to ensure readability, making it easy for the reviewer to understand all changes.
+The Contract Analysis agent, implemented with Azure AI Agent Service and Semantic Kernel, reviews multiple versions of a contract and generates a detailed and structured report that highlights the differences. The Markdown report mirrors the structure of the contracts to ensure readability and makes it easy for the reviewer to understand the differences.
 
-The agent performs the following:
+The agent's capabilities include: 
 
-- **Contract Comparison**: Compare two versions of a contract to identify changes in key fields and clauses. Use specialized tools and techniques to extract relevant information.
-- **Report Generation**: Generate a detailed report on the differences between the two versions of the contract. Format reports using markdown to ensure clarity and readability. Organize content with headings, subheadings, bullet points, and numbered lists.
-- **Communication**: Communicate findings to the reviewer in a clear and concise manner. Identify the next actions for the reviewer.
+* **Contract Comparison**: Compares two versions of a contract to identify changes in key fields and clauses. Uses specialized tools and techniques to extract relevant information from them. 
+* **Report Generation**: Generates a detailed report on the differences between the two versions of a contract. Formats reports using Markdown to ensure clarity and readability. Organizes content with headings, subheadings, bullet points, and numbered lists. 
+* **Communication**: Communicates findings to the reviewer in a clear and concise manner.
 
-The agent uses the following tools:
+This Azure AI Agent Service agent uses the Azure AI Content Understanding for transcription of PDF contacts to markdown, contract analysis, and content extraction.
 
-- **Azure Content Understanding**: Contract analysis, content extraction, field extraction.
-- **File Search**: Pull user-provided additional documents or brand guides.
+## Sample Data
 
-## Getting Started
+Example of the Standard Operating Procedure generated by the agent is located in the [assets folder](assets/output/sample_output.md). This response was generated from sample contracts located in [the input folder](assets/input).
 
-TBD
+## Getting Started
 
 ### Prerequisites
 
+* [Python](https://www.python.org/downloads/)
+
 ### Instructions
 
-### Sample Data
+#### Step 1: Create Azure AI Content Understanding Resource
+
+[Follow the official documentation](https://learn.microsoft.com/azure/ai-services/content-understanding/how-to/create-multi-service-resource) to create an Azure AI Services resource that supports Content Understanding.
+
+#### Step 2: Create Deployment Model
+
+[Follow the official documentation](https://learn.microsoft.com/azure/ai-foundry/quickstarts/get-started-playground#deploy-a-chat-model) to create an Azure AI Foundry model deployment.
+
+#### (Optional) Step 3: Create Azure AI Agent Service Agent
+
+*This step is optional. If you don't create an Azure AI Agent, the program will create one for you automatically.*
+
+1. Follow the official [Azure AI Agent Service documentation](https://learn.microsoft.com/azure/ai-services/agents/quickstart?pivots=ai-foundry-portal) to create the claims analysis agent (a chat completion agent). 
+2. In the **Instructions** box, paste the contents of [AgentInstructions.md file](assets/input/AgentInstructions.md).
+
+#### Step 4: Configure `.env` File
+
+Duplicate the `src/.env.example` file as `src/.env` and provide the required configuration.
+
+#### Step 5: Install Required Modules
+
+Run the following command to install modules used by the application:
+
+```sh
+pip install -r requirements.txt
+```
+
+#### Step 6: Run Agent
+
+Launch the application:
+
+```sh
+python src/template.py
+```
+
+## Resources
+
+- Semantic Kernel [documentation](https://learn.microsoft.com/semantic-kernel/overview/) and [GitHub repo with source code](https://github.com/microsoft/semantic-kernel)
+- [Azure AI Agent Service documentation](https://learn.microsoft.com/azure/ai-services/agents/)
+- [Azure AI Content Understanding documentation](https://learn.microsoft.com/azure/ai-services/content-understanding/)
+- [Azure AI Foundry documentation](https://learn.microsoft.com/azure/ai-foundry/)

samples/agent-catalog/msft-agent-samples/semantic-kernel-sdk/contract-analysis-agent/assets/input/123LogisticsContract.pdf

@@ -0,0 +1 @@
+You are responsible for comparing different versions of a contract, extracting key fields and clauses, and generating detailed reports on the changes. This role requires a keen eye for detail, strong analytical skills, and the ability to communicate findings clearly and concisely. Make sure to analyze the contracts thoroughly. The contracts are formatted in markdown in a user's prompt. Generate the response with differences in a markdown format.

samples/agent-catalog/msft-agent-samples/semantic-kernel-sdk/contract-analysis-agent/assets/input/ABCContract.pdf

@@ -0,0 +1,42 @@
+{
+	"scenario": "document",
+	"fieldSchema": {
+		"fields": {
+			"Summary": {
+				"type": "string",
+				"method": "generate",
+				"description": "Generate the summary of this contract with names of the parties, dates and any contract values"
+			},
+			"Article": {
+				"type": "array",
+				"items": {
+					"type": "object",
+					"properties": {
+						"ArticleName": {
+							"type": "string",
+							"method": "extract",
+							"description": "Name of the article listed as Article4:Contracting Out, and so on"
+						}
+					},
+					"method": "extract"
+				},
+				"method": "generate",
+				"description": "List of all the articles in the document"
+			},
+			"Sections": {
+				"type": "string",
+				"method": "classify",
+				"description": "Sections of the Contract",
+				"enum": [
+					"Preamble",
+					"Article"
+				],
+				"enumDescriptions": {
+					"Preamble": "Preamble",
+					"Article": "Article"
+				}
+			}
+		},
+		"definitions": {}
+	}
+}

samples/agent-catalog/msft-agent-samples/semantic-kernel-sdk/contract-analysis-agent/assets/input/AgentInstructions.md

@@ -0,0 +1,123 @@
+## Comparative Analysis Report: 123 Logistics Contract vs. ABC Transit Contract
+
+This detailed comparative report outlines key differences between the two collective bargaining agreements (CBAs) provided. Each section identifies distinctions in key fields and clauses.
+
+---
+
+### **1. Preamble**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Acknowledges mutual commitments to efficient operations and emphasizes collaboration between labor and management. | Emphasis on fostering cooperation between labor and management without detailed mutual commitments to operational efficiency. | Greater emphasis on efficiency in the 123 Logistics Contract compared to ABC. |
+
+---
+
+### **2. Recognition**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Covers Maintenance Technicians, Vehicle Repair Technicians, Facilities Maintenance Staff. | Covers Mechanics, Equipment Body Repair, Fuelers, Washer/Cleaners, Equipment Service Workers, Facilities Maintenance Workers, and Facilities Support Specialists. | Broader scope in ABC Transit, including more job classifications. |
+| Bargaining unit is defined as employees working 20+ hours/week. | Bargaining unit includes employees working less than 24 hours/week. | ABC Transit defines part-time as <24 hours, while 123 Logistics uses a 20-hour threshold. |  
+| Management personnel may temporarily perform bargaining unit work (provided it’s incidental or unavoidable). | Management personnel retain the right to perform bargaining unit work, including during emergencies. | Broader management rights outlined in ABC Transit CBA. |
+
+---
+
+### **3. Management Rights**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Includes detailed rights to alter and enforce operational policies and emergency actions. Emergency definition is detailed. | Similar provisions but with less specificity regarding emergency definitions and decision-making processes. | 123 Logistics provides more structured definitions and processes for emergencies. |
+| Requires notification for changes to personnel rules/policies through written, electronic, or posted means. | Changes may be communicated orally or in writing. | 123 Logistics has stricter communication methods. |
+
+---
+
+### **4. Union Membership**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Employees must join the Union or submit a written declination within 30 days of hire. | Union membership allowed within 45 days of hire. | ABC Transit offers a longer timeframe for Union membership. |
+| Deduction of Union dues is revocable and voluntary. | Deduction of Union dues requires a written request but is not noted as revocable. | Logistics explicitly acknowledges dues revocation. |
+
+---
+
+### **5. Contracting Out**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Prohibits contracting out if it results in permanent layoffs or reduced hours. Exceptions include historical precedent and specialization requirements. | Prohibits contracting out if layoffs occur but explicitly allows historical contracting out without conditions. | ABC Transit provides less conditional protection for bargaining unit work. |
+| Requires Union consultation for subcontracting impacts. | Provides Union an opportunity to participate in discussions but retains sole decision authority. | 123 Logistics consults with unions in good faith, while ABC limits Union influence. |
+
+---
+
+### **6. Non-Discrimination**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Includes protections for gender identity, sexual orientation, veteran status, genetic information. | Protects based on race, creed, color, sex, religion, age, marital status, physical handicap. | 123 Logistics provides broader protections for diverse categories. |
+
+---
+
+### **7. Probationary Employees**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Probationary period lasts 1,000 working hours. | Probationary period lasts 900 working hours. | 123 Logistics has a longer probationary period. |
+| Provides notification within 5 business days of successful completion of probation. | Provides notification upon completion but with no timeline mentioned. | Clearer probation completion communication in 123 Logistics with stricter timelines. |
+
+---
+
+### **8. Hours of Work/Overtime**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Overtime is offered by seniority on a rotating basis with a formal weekly sign-up sheet. | Overtime is distributed by seniority but uses a Monday sign-up process without specific posting times. | 123 Logistics offers more structured overtime processes. |
+| Employees need a minimum 12-hour rest period (unless waived). | Employees need an 8-hour rest period (cannot waive). | Longer mandatory rest periods in 123 Logistics, with added flexibility. |
+| Call-back pay is set at a minimum of 4 hours. | Call-back pay is set at a minimum of 3 hours. | Higher compensation for call-back in 123 Logistics. |
+| Shift differentials: Swing Shift = $0.95/hour; Graveyard = $1.30/hour. | Shift differentials: Swing Shift = $0.60/hour; Graveyard = $1.25/hour. | 123 Logistics has higher shift differential rates. |
+
+---
+
+### **9. Continuity of Service**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Service adjustments for unpaid leave exceeding 45 days or medical leave over 26 weeks. | Same as 123 Logistics. | Identical provisions in both agreements. |
+
+---
+
+### **10. Seniority/Layoff/Recall**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Provides 14 days’ layoff notice, bumping rights, 12-month recall rights, and certified recall notices. | Provides 2 weeks’ layoff notice, bumping rights, 12-month recall rights, and certified recall notices. | Both agreements are largely similar, but 123 Logistics explicitly mentions more detailed processes for posting notices. |
+
+---
+
+### **11. Job Openings and Training**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Shift bidding occurs annually, with specific deadlines (February). | Shift bidding occurs twice a year (February and August). | ABC allows semi-annual bidding, offering more frequent opportunities. |
+| Training committee convenes monthly. | Training committee meets twice a month. | ABC provides more rapid meetings initially for training development. |
+
+---
+
+### **12. Wages**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Includes wage schedules attached as Appendix A (not provided explicitly). | Includes wage schedules attached as Appendix A (not provided explicitly). | No differences identified due to missing appendix content. |
+
+---
+
+### **13. Benefits**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Comprehensive medical contribution allowance system with caps for premium increases (7.5%). | No specific benefit details provided. | Detailed and structured benefits framework in 123 Logistics compared to ABC's omission. |      
+
+---
+
+### **14. Holidays**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Lists standard national holidays with work and pay provisions. | No holiday provisions mentioned. | ABC Transit lacks holiday provisions. |
+
+---
+
+### **15. General Leave**
+| **123 Logistics Contract** | **ABC Transit Contract** | **Key Difference** |
+|-----------------------------|--------------------------|--------------------|
+| Includes detailed accrual rates based on years of service. | No general leave details mentioned. | ABC lacks structured leave accrual provisions. |
+
+---
+
+### **Summary**
+The 123 Logistics CBA provides stricter timelines, broader protections, and more structured processes across many sections. ABC Transit offers expanded access to shift bidding and shorter probationary requirements while omitting several detailed benefits and leave provisions present in 123 Logistics Contract. The differences highlight varying priorities, with ABC focused on flexibility and Logistics emphasizing procedural clarity and equity.