Add project idea generation and update certification processing

madebygps · madebygps · commit e4ea494fff28 · 2024-08-31T21:34:13.000-04:00
Introduce new dependencies and functionality to generate project ideas based on Azure certification skills and services. Update `GenerateProject` to use `ContentGenerationService` for generating project ideas. Modify `ProcessCertDataFile` to use certification code vectors. Extend `ContentGenerationService` with a method for generating project ideas using `ChatClient`. Add new model `CloudProjectIdea` to represent project ideas.
diff --git a/azure-project-generator/GenerateProject.cs b/azure-project-generator/GenerateProject.cs
@@ -1,29 +1,34 @@
+using Azure;
 using azure_project_generator.models;
+using azure_project_generator.services;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Azure.Cosmos;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Azure.Functions.Worker.Http;
 using Microsoft.Extensions.Logging;
-using OpenAI.Embeddings;
-using System.ComponentModel;
+using Newtonsoft.Json;
+using System.Net;
 
 namespace azure_project_generator
 {
     public class GenerateProject
     {
         private readonly ILogger<GenerateProject> _logger;
+        private readonly ContentGenerationService _contentGenerationService;
 
-        public GenerateProject(ILogger<GenerateProject> logger)
+        public GenerateProject(ILogger<GenerateProject> logger, ContentGenerationService contentGenerationService)
         {
             _logger = logger;
+            _contentGenerationService = contentGenerationService;
         }
 
         [Function("GenerateProject")]
-        public IActionResult Run([HttpTrigger(AuthorizationLevel.Function, "get")] HttpRequest req, string certificationCode,
+        public async Task<HttpResponseData> Run([HttpTrigger(AuthorizationLevel.Function, "get")] HttpRequestData req, string certificationCode,
 
              [CosmosDBInput(Connection = "CosmosDBConnection")] CosmosClient client)
         {
+            var response = req.CreateResponse(HttpStatusCode.OK);
             _logger.LogInformation("C# HTTP trigger function processed a request.");
 
             var query = new QueryDefinition("SELECT * FROM c WHERE c.certificationCode = @certificationCode")
@@ -36,25 +41,35 @@ public IActionResult Run([HttpTrigger(AuthorizationLevel.Function, "get")] HttpR
             CertificationProjectPromptDocument certificationProjectPromptDocument = iterator.ReadNextAsync().Result.FirstOrDefault();
 
             float[] projectPromptVector = certificationProjectPromptDocument.ProjectPromptVector;
- 
 
+            var queryDef = new QueryDefinition
+                (query: $"SELECT c.serviceName, c.skillName, c.topicName, VectorDistance(c.contextVector,@embedding) " +
+                $"AS SimilarityScore FROM c ORDER BY VectorDistance(c.contextVector,@embedding)"
+                ).WithParameter("@embedding", projectPromptVector);
 
-            var queryDef = new QueryDefinition(
-      query: $"SELECT c.serviceName, VectorDistance(c.contextVector,@embedding) AS SimilarityScore FROM c ORDER BY VectorDistance(c.contextVector,@embedding)"
-      ).WithParameter("@embedding", projectPromptVector);
+            using FeedIterator<CertificationService> resultSetIterator =
+                 client.GetContainer("AzureCertDB", "certvectors").GetItemQueryIterator<CertificationService>(queryDef);
+
+            string projectServices = "";
+            string projectSkills = "";
 
-            using FeedIterator<CertificationServiceDocument> resultSetIterator = client.GetContainer("AzureCertDB", "certvectors").GetItemQueryIterator<CertificationServiceDocument>(queryDef);
-            
             while (resultSetIterator.HasMoreResults)
             {
-                FeedResponse<CertificationServiceDocument> response = resultSetIterator.ReadNextAsync().Result;
-                foreach (var item in response)
+                FeedResponse<CertificationService> feedResponse = resultSetIterator.ReadNextAsync().Result;
+                foreach (var item in feedResponse)
                 {
-                    _logger.LogInformation(item.ServiceName);
+                    projectServices += item.ServiceName + " ";
+                    projectSkills += item.SkillName + " ";
+
                 }
             }
 
-            return new OkObjectResult("Welcome to Azure Functions!");
+            string cloudProjectIdea = await _contentGenerationService.GenerateProjectIdeaAsync(projectSkills, projectServices);
+
+            response.Headers.Add("Content-Type", "application/json");
+            await response.WriteStringAsync(cloudProjectIdea);
+
+            return response;
         }
     }
 }
diff --git a/azure-project-generator/ProcessCertDataFile.cs b/azure-project-generator/ProcessCertDataFile.cs
@@ -79,10 +79,9 @@ public async Task<CertificationProjectPromptOutput> Run([BlobTrigger("certdata/{
                
 
 
-            string contextSentence = _contentGenerationService.GenerateCertDataContextSentence(certification);
-            float[] contentVector = await _contentGenerationService.GenerateEmbeddingsAsync(contextSentence);
+            float[] cerificationCodeVector = await _contentGenerationService.GenerateEmbeddingsAsync(certification.CertificationCode);
 
-            var certificationDocument = CreateCertificationProjectPromptDocument(certification, contextSentence, contentVector);
+            var certificationDocument = CreateCertificationProjectPromptDocument(certification, cerificationCodeVector);
 
             _logger.LogInformation("Document created successfully.");
             _logger.LogInformation($"Archiving blob: {name}");
@@ -95,13 +94,12 @@ public async Task<CertificationProjectPromptOutput> Run([BlobTrigger("certdata/{
             };
         }
 
-        private CertificationProjectPromptDocument CreateCertificationProjectPromptDocument(Certification data, string contextSentence, float[] contentVector) =>
+        private CertificationProjectPromptDocument CreateCertificationProjectPromptDocument(Certification data, float[] contentVector) =>
            new CertificationProjectPromptDocument
            {
                Id = Guid.NewGuid().ToString(),
                CertificationCode = data.CertificationCode,
                CertificationName = data.CertificationName,
-               ProjectPrompt = contextSentence,
                ProjectPromptVector = contentVector
            };
     }
diff --git a/azure-project-generator/Program.cs b/azure-project-generator/Program.cs
@@ -21,6 +21,7 @@
         string endpointFromEnvironment = config["AZURE_OPENAI_API_ENDPOINT"];
         string embeddingsDeployment = config["EMBEDDINGS_DEPLOYMENT"];
         string azureWebJobsStorage = config["AzureWebJobsStorage"];
+        string completionsDeployment = config["COMPLETIONS_DEPLOYMENT"];
 
         if (string.IsNullOrEmpty(keyFromEnvironment) || string.IsNullOrEmpty(endpointFromEnvironment) || string.IsNullOrEmpty(embeddingsDeployment))
         {
@@ -37,6 +38,9 @@
         // Register EmbeddingClient as a singleton
         services.AddSingleton(azureClient.GetEmbeddingClient(embeddingsDeployment));
 
+        // Register ChatClient as a singleton
+        services.AddSingleton(azureClient.GetChatClient(completionsDeployment));
+
         // Register JsonValidationService
         services.AddSingleton<JsonValidationService>();
 
diff --git a/azure-project-generator/models/CertificationProjectPromptDocument.cs b/azure-project-generator/models/CertificationProjectPromptDocument.cs
@@ -15,9 +15,7 @@ public class CertificationProjectPromptDocument
         public string CertificationCode { get; set; }
         [JsonPropertyName("certificationName")]
         public string CertificationName { get; set; }
-        [JsonPropertyName("skillName")]
-        public string ProjectPrompt { get; set; }
-        [JsonPropertyName("projectPrompt")]
+        [JsonPropertyName("projectPromptVector")]
         public float[] ProjectPromptVector { get; set; }
     }
 }
diff --git a/azure-project-generator/models/CloudProjectIdea.cs b/azure-project-generator/models/CloudProjectIdea.cs
@@ -0,0 +1,17 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace azure_project_generator.models
+{
+    public class CloudProjectIdea
+    {
+       
+            public string Title { get; set; }
+            public string Description { get; set; }
+            public List<string> Steps { get; set; }
+        
+    }
+}
diff --git a/azure-project-generator/services/ContentGenerationService.cs b/azure-project-generator/services/ContentGenerationService.cs
@@ -2,43 +2,30 @@
 using azure_project_generator.models;
 using Microsoft.Extensions.Logging;
 using OpenAI.Embeddings;
+using OpenAI.Chat;
+using System.Text.Json;
+using Microsoft.AspNetCore.Mvc;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 
 namespace azure_project_generator.services
 {
     public class ContentGenerationService
     {
         private readonly ILogger<ContentGenerationService> _logger;
         private readonly EmbeddingClient _embeddingClient;
-
-        public ContentGenerationService(ILogger<ContentGenerationService> logger, EmbeddingClient embeddingClient)
+        private readonly ChatClient _completionsClient;
+        public ContentGenerationService(ILogger<ContentGenerationService> logger, EmbeddingClient embeddingClient, ChatClient completionsClient)
         {
             _logger = logger ?? throw new ArgumentNullException(nameof(logger));
             _embeddingClient = embeddingClient ?? throw new ArgumentNullException(nameof(embeddingClient));
+            _completionsClient = completionsClient ?? throw new ArgumentNullException(nameof(completionsClient));
+
         }
 
         public string GenerateCertServiceContextSentence(CertificationService data) =>
             $"The {data.CertificationCode} {data.CertificationName} certification includes the skill of {data.SkillName}. Within this skill, there is a focus on the topic of {data.TopicName}, particularly through the use of the service {data.ServiceName}.";
 
-        public string GenerateCertDataContextSentence(Certification certificationDocument)
-        {
-            var certificationName = certificationDocument.CertificationName;
-            var certificationCode = certificationDocument.CertificationCode;
-
-            var skills = certificationDocument.SkillsMeasured.Select(s => s.Name).ToList();
-            var topicsWithServices = certificationDocument.SkillsMeasured
-                .SelectMany(s => s.Topics)
-                .Select(t => $"{t.TopicName} (using {string.Join(", ", t.Services)})").ToList();
-
-            string skillNames = string.Join(", ", skills);
-            string topicDetails = string.Join("; ", topicsWithServices);
-
-            string prompt = $"Generate a project idea that aligns with the {certificationCode} certification, " +
-                            $"which covers skills such as {skillNames}. The project should focus on topics like {topicDetails}, " +
-                            $"addressing real-world scenarios related to {certificationName}.";
-
-            return prompt;
-
-        }
 
         public async Task<float[]> GenerateEmbeddingsAsync(string content)
         {
@@ -60,5 +47,83 @@ public async Task<float[]> GenerateEmbeddingsAsync(string content)
                 throw;
             }
         }
+
+        public async Task<string> GenerateProjectIdeaAsync(string skills, string services)
+        {
+            string userPrompt = $@"You are an expert cloud architect. 
+Please generate a detailed project idea for a beginner-friendly weekend cloud solution 
+based on the following Azure certification skills: {skills}. 
+The project should utilize the following services: {services}.
+The project should be small in scale, achievable over a weekend, and have a fun, creative name. Suitable for beginners. Cheap to run.
+The response must be formatted as valid JSON and include only the following fields:
+{{
+    ""projectName"": ""A fun and creative project name"",
+    ""description"": ""A brief, engaging description of the project, highlighting its purpose and main features."",
+    ""learningGoals"": [""Goal 1"", ""Goal 2"", ""Goal 3""],
+    ""steps"": [
+        ""Step 1: Description of the first step"",
+        ""Step 2: Description of the second step"",
+        ""Step 3: Description of the third step"",
+        ""Step 4: Description of the fourth step"",
+        ""Step 5: Description of the fifth step""
+    ]
+}}
+Ensure that the project idea is practical, aligned with beginner-level skills, and leverages best practices in Azure architecture.";
+
+            try
+            {
+                _logger.LogInformation("Generating project idea...");
+                ChatCompletion completion = await _completionsClient.CompleteChatAsync(new ChatMessage[]
+                {
+                new SystemChatMessage("You are a technical assistant specialized in generating beginner-friendly cloud project ideas. Provide the response in JSON format only, without any additional text."),
+                new UserChatMessage(userPrompt)
+                });
+
+                string projectIdeaContent = completion.Content[0].Text;
+
+                if (string.IsNullOrWhiteSpace(projectIdeaContent))
+                {
+                    _logger.LogWarning("The response from the AI model was empty or null.");
+                    throw new Exception("Failed to generate project idea.");
+                }
+
+                string cleanedJsonContent = projectIdeaContent
+                    .Replace("```json", string.Empty)
+                    .Replace("```", string.Empty)
+                    .Replace("json\n", string.Empty)
+                    .Trim();
+
+                JObject jsonObject = JObject.Parse(cleanedJsonContent);
+
+                // Validate that all required fields are present
+                string[] requiredFields = { "projectName", "description", "learningGoals", "steps"};
+                foreach (var field in requiredFields)
+                {
+                    if (!jsonObject.ContainsKey(field))
+                    {
+                        _logger.LogWarning($"Generated JSON is missing required field: {field}");
+                        throw new System.Text.Json.JsonException($"Generated project idea is missing required field: {field}");
+
+                    }
+                }
+
+                return jsonObject.ToString();
+            }
+            catch (System.Text.Json.JsonException ex)
+            {
+                _logger.LogError(ex, "Error parsing JSON response");
+                throw;
+            }
+            catch (RequestFailedException ex)
+            {
+                _logger.LogError(ex, "Azure OpenAI API request failed");
+                throw;
+            }
+            catch (Exception ex)
+            {
+                _logger.LogError(ex, "Error generating project idea");
+                throw;
+            }
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,7 @@ public class CertificationProjectPromptDocument`
`15`	`15`	`public string CertificationCode { get; set; }`
`16`	`16`	`[JsonPropertyName("certificationName")]`
`17`	`17`	`public string CertificationName { get; set; }`
`18`		`- [JsonPropertyName("skillName")]`
`19`		`- public string ProjectPrompt { get; set; }`
`20`		`- [JsonPropertyName("projectPrompt")]`
	`18`	`+ [JsonPropertyName("projectPromptVector")]`
`21`	`19`	`public float[] ProjectPromptVector { get; set; }`
`22`	`20`	`}`
`23`	`21`	`}`