com.openai.unity 8.6.4 (#356)

- Fixed Assistant Reasoning Model request serialization when using thread.CreateRunAsync

Author: StephenHodgson

Runtime/Threads/ThreadExtensions.cs

@@ -167,8 +167,9 @@ public static async Task<RunResponse> CreateRunAsync(this ThreadResponse thread,
                 model: assistant.Model,
                 instructions: assistant.Instructions,
                 tools: assistant.Tools,
-                temperature: assistant.Temperature,
-                topP: assistant.TopP,
+                temperature: assistant.ReasoningEffort > 0 ? null : assistant.Temperature,
+                topP: assistant.ReasoningEffort > 0 ? null : assistant.TopP,
+                reasoningEffort: assistant.ReasoningEffort ?? 0,
                 responseFormat: assistant.ResponseFormat);
             return await thread.Client.ThreadsEndpoint.CreateRunAsync(thread, request, streamEventHandler, cancellationToken);
         }

Tests/TestFixture_03_Threads.cs

@@ -848,6 +848,105 @@ public async Task Test_06_01_CreateThreadAndRun_Reasoning()
                     Debug.Log($"{response.Role}: {response.PrintContent()}");
                 }
             }
+            catch (Exception e)
+            {
+                Debug.LogException(e);
+                throw;
+            }
+            finally
+            {
+                await assistant.DeleteAsync(deleteToolResources: thread == null);
+
+                if (thread != null)
+                {
+                    var isDeleted = await thread.DeleteAsync(deleteToolResources: true);
+                    Assert.IsTrue(isDeleted);
+                }
+            }
+        }
+
+        [Test]
+        public async Task Test_06_02_CreateRun_Reasoning_Streaming()
+        {
+            const string POLICY = "policy = \"\n# TechStore Policy: Customer Service Guidelines\n\n## 1. Introduction\n\nWelcome to our Customer Service Guidelines for TechStore. This policy aims to provide comprehensive guidance to resolve common customer concerns, covering multiple scenarios, including product damage, incorrect orders, refunds, and replacements. The guidelines include decision trees to help agents make informed decisions and offer a consistent customer experience.\n\n## 2. Product Damage Policy\n\nOur product damage policy covers a range of potential issues, from delivery damage to manufacturing defects. The following decision tree helps guide customer service representatives through different scenarios related to damaged products.\n\n### Decision Tree: Damaged Product Resolution\n\n- **Step 1: Damage Reported**\n\n  - **If there is visible damage** (e.g., cracked screen, broken case):\n    Proceed to **Step 2**.\n\n  - **If there is no visible damage**:\n    Proceed to **Step 3c**.\n\n- **Step 2:** Was the damage reported within 7 days of delivery?\n\n  - **Yes:** Proceed to **Step 3a**.\n  - **No:** Proceed to **Step 3b**.\n\n- **Step 3: Eligibility for Replacement/Refund**\n\n  - **a. Visible Damage Reported Within 7 Days:**\n    - **Option 1:** Full replacement if stock is available.\n    - **Option 2:** Refund (customer's choice).\n    - **Agent Action:** Confirm customer's preferred resolution and provide prepaid shipping label for return (if needed).\n  - **b. Visible Damage Reported After 7 Days but Within 30 Days:**\n    - Assess if the damage could be due to customer mishandling.\n      - **Not Customer Fault (e.g. internal screen issue, phone burst):** Offer repair service or replacement (partial fees may apply based on damage).\n      - **Customer Mishandling (e.g. cracked screen, visible damage):** Offer paid repair or replacement, but customer is not eligible for a refund\n  - **c. No visible damage: Assess damage type**\n    - **If battery issue**: Offer discount for new phone or paid replacement of battery\n    - **If software issue**: Offer troubleshooting tips (see troubleshooting section)\n    - **If phone turns off**: Proceed to **Step 4**.\n\n- **Step 4:** Check Product Purchase Date:\n  - **Less than 1 Year:** Eligible for replacement or return with similar product up to 120% value.\n  - **Less than 1 Month:** Eligible for replacement or return with similar product up to 130% value.\n  - **Between 1 and 2 Years:** Eligible for replacement with similar product up to 110% value.\n  - **More than 2 Years:** No refund or replacement possible.\n\n## 3. Incorrect Order Policy\n\n### Decision Tree: Incorrect Order Handling\n\n- **Step 1: Wrong Product Received**\n\n  - **Customer Receives Wrong Item:**\n    - Ask for photo proof of the item received.\n    - Confirm if the product matches anything available in our inventory (to check if it was a mix-up).\n      - **Match Found:** Proceed to **Step 2**.\n      - **No Match Found:** Escalate to the inventory team to verify any logistical errors.\n\n- **Step 2: Replacement and Retrieval**\n\n  - Confirm that the wrong item is in unused condition and eligible for return.\n  - Offer prepaid shipping label for return of incorrect item.\n  - **Stock Availability for Correct Item:**\n    - **In Stock:** Dispatch correct item immediately.\n    - **Out of Stock:** Offer the following options to the customer:\n      - **Option 1:** Full refund.\n      - **Option 2:** Store credit with 10% bonus as goodwill.\n      - **Option 3:** Waitlist for restock.\n\n## 4. Refund Policy\n\nRefunds may be processed depending on specific scenarios and customer preferences. Use the decision tree below to guide customers.\n\n### Decision Tree: Refund Processing\n\n- **Step 1: Reason for Refund Request**\n\n  - **Product Damaged:** Follow guidelines under **Product Damage Policy**.\n  - **Customer Unsatisfied with Product:**\n    - **Step 2:** Is the request made within 30 days of purchase?\n      - **Yes:** Offer refund (excluding return shipping fee) or store credit.\n      - **No:** Advise customer of the 30-day return limit, suggest troubleshooting, or discuss potential product upgrade.\n  - **Wrong Product Delivered:** See **Incorrect Order Policy** for replacement and refund eligibility.\n\n- **Step 3: Condition of Returned Product**\n\n  - **Unused, Original Packaging:** Full refund processed within 5-7 business days.\n  - **Used, but Fault-Free:** Charge restocking fee (15%) and process the remainder of the refund.\n  - **Damaged Due to Customer Handling:** Notify customer of deduction in refund to cover repair/restocking fee.\n\n## 5. Warranty Claims\n\nAll wearable hardware products come with a limited one-year warranty covering manufacturer defects. Warranty claims are subject to the following decision tree.\n\n### **Decision Tree: Warranty Claim Evaluation**\n\n- **Step 1: Warranty Validity**\n\n  - **Product Purchase Date Verified:**\n    - Within 1 year?\n      - **Yes:** Proceed to **Step 2**.\n      - **No:** Offer paid repair options.\n\n- **Step 2: Nature of Defect**\n\n  - **Manufacturing Defect Confirmed:**\n    - Offer free replacement or repair.\n  - **Wear and Tear or Customer Neglect:**\n    - Inform customer that warranty does not cover general wear and tear.\n    - Offer discounted repair.\n\n## 6. Customer Courtesy Compensation\n\nIn certain cases, customers may be eligible for courtesy compensation in the form of store credit or discounts.\n\n### Decision Tree: Eligibility for Courtesy Compensation\n\n- **Step 1: Assess Severity of Issue**\n  - **Major Inconvenience Due to Our Error:** (e.g., repeated delivery issues, incorrect items sent multiple times)\n    - Offer store credit equivalent to 15% of the product value or a discount coupon for future purchases.\n  - **Minor Issue:** (e.g., delayed delivery due to courier but product received in good condition)\n    - Offer free accessory or a 5% discount code.\n\n## 7. Summary of Escalation Paths\n\nFor cases that cannot be resolved using the above decision trees, escalate to:\n\n- **Tier 2 Support:** Issues requiring deeper technical knowledge (e.g., rare hardware malfunctions, software issues that persist after troubleshooting).\n- **Logistics Team:** Situations involving repeated wrong item deliveries, significant delays, or lost packages.\n- **Customer Success Manager:** High-value customers, chronic dissatisfaction, or VIP escalations requiring a tailored solution.\n\n## 8. Record-Keeping and Follow-Ups\n\n- Ensure all interactions are logged in the CRM system.\n- Follow up on any pending replacements, warranty claims, or courtesy compensation within 48 hours.\n- Provide customers with tracking numbers and regular updates on their cases.\n\n## 9. Final Notes\n\nThese guidelines are intended to ensure our customers are supported in every scenario with fair, efficient, and courteous service. Always strive for the best customer experience, listen attentively, and seek the best solution that aligns with both customer needs and company policy.\n";
+            const string REQUEST_SUMMARY = "Phone keeps turning off, it has no visible damage";
+            const string ORDER_CONTEXT = "Samsung Galaxy S23 bought on January 28th, 2024.";
+
+            var assistant = await OpenAIClient.AssistantsEndpoint.CreateAssistantAsync(
+                new CreateAssistantRequest(
+                    name: "Customer Service Policy",
+                    instructions: $"This is our customer service policy:\n{POLICY}\n\nYou will be provided with context on a user order.\nYour task is to reply with what the user is eligible for.\nRespond in one sentence.",
+                    model: Model.O3Mini));
+            Assert.NotNull(assistant);
+            ThreadResponse thread = null;
+
+            try
+            {
+                thread = await OpenAIClient.ThreadsEndpoint.CreateThreadAsync();
+                Assert.NotNull(thread);
+                var message = await thread.CreateMessageAsync($"Here is context on the order:\nToday is {DateTime.UtcNow}.\nRequest Summary: {REQUEST_SUMMARY}\nOrder Context: {ORDER_CONTEXT}");
+                Assert.NotNull(message);
+
+                var run = await thread.CreateRunAsync(assistant, async streamEvent =>
+                {
+                    Debug.Log(streamEvent.ToJsonString());
+
+                    switch (streamEvent)
+                    {
+                        case RunResponse runEvent:
+                            Assert.NotNull(runEvent);
+                            break;
+                        case RunStepResponse runStepEvent:
+                            Assert.NotNull(runStepEvent);
+                            switch (runStepEvent.Object)
+                            {
+                                case "thread.run.step.delta":
+                                    Assert.NotNull(runStepEvent.Delta);
+                                    break;
+                                default:
+                                    Assert.IsNull(runStepEvent.Delta);
+                                    break;
+                            }
+                            break;
+                        case ThreadResponse threadEvent:
+                            Assert.NotNull(threadEvent);
+                            break;
+                        case MessageResponse messageEvent:
+                            Assert.NotNull(messageEvent);
+                            switch (messageEvent.Object)
+                            {
+                                case "thread.message.delta":
+                                    Assert.NotNull(messageEvent.Delta);
+                                    Debug.Log($"{messageEvent.Object}: \"{messageEvent.Delta.PrintContent()}\"");
+                                    break;
+                                default:
+                                    Debug.Log($"{messageEvent.Object}: \"{messageEvent.PrintContent()}\"");
+                                    Assert.IsNull(messageEvent.Delta);
+                                    break;
+                            }
+                            break;
+                        case Error errorEvent:
+                            Assert.NotNull(errorEvent);
+                            break;
+                    }
+
+                    await Task.CompletedTask;
+                });
+
+                Assert.IsNotNull(run);
+                Assert.IsTrue(run.Status == RunStatus.Completed);
+                var messages = await thread.ListMessagesAsync();
+
+                foreach (var response in messages.Items.Reverse())
+                {
+                    Debug.Log($"{response.Role}: {response.PrintContent()}");
+                }
+            }
+            catch (Exception e)
+            {
+                Debug.LogException(e);
+                throw;
+            }
             finally
             {
                 await assistant.DeleteAsync(deleteToolResources: thread == null);

package.json

@@ -3,7 +3,7 @@
   "displayName": "OpenAI",
   "description": "A OpenAI package for the Unity Game Engine to use GPT-4, GPT-3.5, GPT-3 and Dall-E though their RESTful API (currently in beta).\n\nIndependently developed, this is not an official library and I am not affiliated with OpenAI.\n\nAn OpenAI API account is required.",
   "keywords": [],
-  "version": "8.6.3",
+  "version": "8.6.4",
   "unity": "2021.3",
   "documentationUrl": "https://github.com/RageAgainstThePixel/com.openai.unity#documentation",
   "changelogUrl": "https://github.com/RageAgainstThePixel/com.openai.unity/releases",