feat: Add aiAgent info to AiResponse (box/box-openapi#485) (#336)

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "a839036", "specHash": "544d370", "version": "1.5.0" }
+{ "engineHash": "a839036", "specHash": "d7dfe68", "version": "1.5.0" }

Box.Sdk.Gen/Managers/Ai/AiManager.cs

@@ -73,7 +73,8 @@ public async System.Threading.Tasks.Task<AiAgentAskOrAiAgentExtractOrAiAgentExtr
 
         /// <summary>
         /// Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
-        /// Freeform metadata extraction does not require any metadata template setup before sending the request.
+        /// In this request, both the prompt and the output can be freeform.
+        /// Metadata template setup before sending the request is not required.
         /// </summary>
         /// <param name="requestBody">
         /// Request body of createAiExtract method
@@ -93,7 +94,8 @@ public async System.Threading.Tasks.Task<AiResponse> CreateAiExtractAsync(AiExtr
 
         /// <summary>
         /// Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
-        /// For this request, you need to use an already defined metadata template or a define a schema yourself.
+        /// For this request, you either need a metadata template or a list of fields you want to extract.
+        /// Input is **either** a metadata template or a list of fields to ensure the structure.
         /// To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
         /// or use the [metadata template API](g://metadata/templates/create).
         /// </summary>

Box.Sdk.Gen/Managers/Ai/IAiManager.cs

@@ -50,7 +50,8 @@ public interface IAiManager {
 
         /// <summary>
     /// Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
-    /// Freeform metadata extraction does not require any metadata template setup before sending the request.
+    /// In this request, both the prompt and the output can be freeform.
+    /// Metadata template setup before sending the request is not required.
     /// </summary>
     /// <param name="requestBody">
     /// Request body of createAiExtract method
@@ -65,7 +66,8 @@ public interface IAiManager {
 
         /// <summary>
     /// Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
-    /// For this request, you need to use an already defined metadata template or a define a schema yourself.
+    /// For this request, you either need a metadata template or a list of fields you want to extract.
+    /// Input is **either** a metadata template or a list of fields to ensure the structure.
     /// To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
     /// or use the [metadata template API](g://metadata/templates/create).
     /// </summary>

Box.Sdk.Gen/Schemas/AiAgentInfo/AiAgentInfo.cs

@@ -0,0 +1,43 @@
+using Box.Sdk.Gen;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Box.Sdk.Gen.Internal;
+using System;
+using System.Collections.ObjectModel;
+
+namespace Box.Sdk.Gen.Schemas {
+    public class AiAgentInfo : ISerializable {
+        /// <summary>
+        /// The models used for the request
+        /// </summary>
+        [JsonPropertyName("models")]
+        public IReadOnlyList<AiAgentInfoModelsField>? Models { get; init; }
+
+        /// <summary>
+        /// The processor used for the request
+        /// </summary>
+        [JsonPropertyName("processor")]
+        public string? Processor { get; init; }
+
+        public AiAgentInfo() {
+
+        }
+        internal string? RawJson { get; set; } = default;
+
+        void ISerializable.SetJson(string json) {
+            RawJson = json;
+        }
+
+        string? ISerializable.GetJson() {
+            return RawJson;
+        }
+
+        /// <summary>
+        /// Returns raw json response returned from the API.
+        /// </summary>
+        public Dictionary<string, object?>? GetRawData() {
+            return SimpleJsonSerializer.GetAllFields(this);
+        }
+
+    }
+}

Box.Sdk.Gen/Schemas/AiAgentInfo/AiAgentInfoModelsField.cs

@@ -0,0 +1,47 @@
+using Box.Sdk.Gen;
+using System.Text.Json.Serialization;
+using System.Collections.Generic;
+using Box.Sdk.Gen.Internal;
+
+namespace Box.Sdk.Gen.Schemas {
+    public class AiAgentInfoModelsField : ISerializable {
+        /// <summary>
+        /// The name of the model used for the request
+        /// </summary>
+        [JsonPropertyName("name")]
+        public string? Name { get; init; }
+
+        /// <summary>
+        /// The provider that owns the model used for the request
+        /// </summary>
+        [JsonPropertyName("provider")]
+        public string? Provider { get; init; }
+
+        /// <summary>
+        /// The supported purpose utilized by the model used for the request
+        /// </summary>
+        [JsonPropertyName("supported_purpose")]
+        public string? SupportedPurpose { get; init; }
+
+        public AiAgentInfoModelsField() {
+
+        }
+        internal string? RawJson { get; set; } = default;
+
+        void ISerializable.SetJson(string json) {
+            RawJson = json;
+        }
+
+        string? ISerializable.GetJson() {
+            return RawJson;
+        }
+
+        /// <summary>
+        /// Returns raw json response returned from the API.
+        /// </summary>
+        public Dictionary<string, object?>? GetRawData() {
+            return SimpleJsonSerializer.GetAllFields(this);
+        }
+
+    }
+}

Box.Sdk.Gen/Schemas/AiResponse/AiResponse.cs

@@ -2,6 +2,7 @@
 using System.Text.Json.Serialization;
 using System.Collections.Generic;
 using Box.Sdk.Gen.Internal;
+using Box.Sdk.Gen.Schemas;
 
 namespace Box.Sdk.Gen.Schemas {
     public class AiResponse : ISerializable {
@@ -23,6 +24,9 @@ public class AiResponse : ISerializable {
         [JsonPropertyName("completion_reason")]
         public string? CompletionReason { get; init; }
 
+        [JsonPropertyName("ai_agent_info")]
+        public AiAgentInfo? AiAgentInfo { get; init; }
+
         public AiResponse(string answer, System.DateTimeOffset createdAt) {
             Answer = answer;
             CreatedAt = createdAt;

docs/Ai.md

@@ -109,7 +109,8 @@ The response depends on the agent configuration requested in this endpoint.
 ## Extract metadata (freeform)
 
 Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs.
-Freeform metadata extraction does not require any metadata template setup before sending the request.
+In this request, both the prompt and the output can be freeform.
+Metadata template setup before sending the request is not required.
 
 This operation is performed by calling function `CreateAiExtract`.
 
@@ -141,7 +142,8 @@ A response including the answer from the LLM.
 ## Extract metadata (structured)
 
 Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.
-For this request, you need to use an already defined metadata template or a define a schema yourself.
+For this request, you either need a metadata template or a list of fields you want to extract.
+Input is **either** a metadata template or a list of fields to ensure the structure.
 To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)
 or use the [metadata template API](g://metadata/templates/create).