Generate ListInputItems for Responses (#604)

Author: christothes

api/OpenAI.net8.0.cs

@@ -1463,7 +1463,7 @@ public class ChatClient {
         [Experimental("OPENAI001")]
         public virtual Task<ClientResult<ChatCompletion>> GetChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
         [Experimental("OPENAI001")]
-        public virtual CollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessages(string completionId, ChatCompletionCollectionOptions options = null, CancellationToken cancellationToken = default);
+        public virtual CollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessages(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
         [Experimental("OPENAI001")]
         public virtual CollectionResult GetChatCompletionMessages(string completionId, string after, int? limit, string order, RequestOptions options);
         [Experimental("OPENAI001")]
@@ -4748,6 +4748,10 @@ public class OpenAIResponseClient {
         public virtual ClientResult<ResponseDeletionResult> DeleteResponse(string responseId, CancellationToken cancellationToken = default);
         public virtual Task<ClientResult> DeleteResponseAsync(string responseId, RequestOptions options);
         public virtual Task<ClientResult<ResponseDeletionResult>> DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default);
+        public virtual CollectionResult<ResponseItem> GetInputItems(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
+        public virtual CollectionResult GetInputItems(string responseId, int? limit, string order, string after, string before, RequestOptions options);
+        public virtual AsyncCollectionResult<ResponseItem> GetInputItemsAsync(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
+        public virtual AsyncCollectionResult GetInputItemsAsync(string responseId, int? limit, string order, string after, string before, RequestOptions options);
         public virtual ClientResult GetResponse(string responseId, bool? stream, int? startingAfter, RequestOptions options);
         public virtual ClientResult<OpenAIResponse> GetResponse(string responseId, CancellationToken cancellationToken = default);
         public virtual Task<ClientResult> GetResponseAsync(string responseId, bool? stream, int? startingAfter, RequestOptions options);
@@ -4998,11 +5002,15 @@ public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<Response
         protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
     }
     [Experimental("OPENAI001")]
-    public class ResponseItemCollectionOptions {
+    public class ResponseItemCollectionOptions : IJsonModel<ResponseItemCollectionOptions>, IPersistableModel<ResponseItemCollectionOptions> {
         public string AfterId { get; set; }
         public string BeforeId { get; set; }
         public ResponseItemCollectionOrder? Order { get; set; }
         public int? PageSizeLimit { get; set; }
+        protected virtual ResponseItemCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
+        protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
+        protected virtual ResponseItemCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
+        protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
     }
     [Experimental("OPENAI001")]
     public readonly partial struct ResponseItemCollectionOrder : IEquatable<ResponseItemCollectionOrder> {

api/OpenAI.netstandard2.0.cs

@@ -1310,7 +1310,7 @@ public class ChatClient {
         public virtual ClientResult<ChatCompletion> GetChatCompletion(string completionId, CancellationToken cancellationToken = default);
         public virtual Task<ClientResult> GetChatCompletionAsync(string completionId, RequestOptions options);
         public virtual Task<ClientResult<ChatCompletion>> GetChatCompletionAsync(string completionId, CancellationToken cancellationToken = default);
-        public virtual CollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessages(string completionId, ChatCompletionCollectionOptions options = null, CancellationToken cancellationToken = default);
+        public virtual CollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessages(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
         public virtual CollectionResult GetChatCompletionMessages(string completionId, string after, int? limit, string order, RequestOptions options);
         public virtual AsyncCollectionResult<ChatCompletionMessageListDatum> GetChatCompletionMessagesAsync(string completionId, ChatCompletionMessageCollectionOptions options = null, CancellationToken cancellationToken = default);
         public virtual AsyncCollectionResult GetChatCompletionMessagesAsync(string completionId, string after, int? limit, string order, RequestOptions options);
@@ -4193,6 +4193,10 @@ public class OpenAIResponseClient {
         public virtual ClientResult<ResponseDeletionResult> DeleteResponse(string responseId, CancellationToken cancellationToken = default);
         public virtual Task<ClientResult> DeleteResponseAsync(string responseId, RequestOptions options);
         public virtual Task<ClientResult<ResponseDeletionResult>> DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default);
+        public virtual CollectionResult<ResponseItem> GetInputItems(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
+        public virtual CollectionResult GetInputItems(string responseId, int? limit, string order, string after, string before, RequestOptions options);
+        public virtual AsyncCollectionResult<ResponseItem> GetInputItemsAsync(string responseId, ResponseItemCollectionOptions options = null, CancellationToken cancellationToken = default);
+        public virtual AsyncCollectionResult GetInputItemsAsync(string responseId, int? limit, string order, string after, string before, RequestOptions options);
         public virtual ClientResult GetResponse(string responseId, bool? stream, int? startingAfter, RequestOptions options);
         public virtual ClientResult<OpenAIResponse> GetResponse(string responseId, CancellationToken cancellationToken = default);
         public virtual Task<ClientResult> GetResponseAsync(string responseId, bool? stream, int? startingAfter, RequestOptions options);
@@ -4421,11 +4425,15 @@ public class ResponseItem : IJsonModel<ResponseItem>, IPersistableModel<Response
         protected virtual ResponseItem PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
         protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
     }
-    public class ResponseItemCollectionOptions {
+    public class ResponseItemCollectionOptions : IJsonModel<ResponseItemCollectionOptions>, IPersistableModel<ResponseItemCollectionOptions> {
         public string AfterId { get; set; }
         public string BeforeId { get; set; }
         public ResponseItemCollectionOrder? Order { get; set; }
         public int? PageSizeLimit { get; set; }
+        protected virtual ResponseItemCollectionOptions JsonModelCreateCore(ref Utf8JsonReader reader, ModelReaderWriterOptions options);
+        protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options);
+        protected virtual ResponseItemCollectionOptions PersistableModelCreateCore(BinaryData data, ModelReaderWriterOptions options);
+        protected virtual BinaryData PersistableModelWriteCore(ModelReaderWriterOptions options);
     }
     public readonly partial struct ResponseItemCollectionOrder : IEquatable<ResponseItemCollectionOrder> {
         public ResponseItemCollectionOrder(string value);

codegen/generator/src/Visitors/PaginationVisitor.cs

@@ -22,7 +22,7 @@ public class PaginationVisitor : ScmLibraryVisitor
     private static readonly Dictionary<string, string> _paramReplacementMap = new()
     {
         { "after", "AfterId" },
-        { "before", "LastId" },
+        { "before", "BeforeId" },
         { "limit", "PageSizeLimit" },
         { "order", "Order" },
         { "model", "Model" },
@@ -40,11 +40,19 @@ public class PaginationVisitor : ScmLibraryVisitor
         },
         {
             "GetChatCompletionMessages",
-            ("ChatCompletionMessageListDatum", "ChatCompletionCollectionOptions", _chatParamsToReplace)
+            ("ChatCompletionMessageListDatum", "ChatCompletionMessageCollectionOptions", _chatParamsToReplace)
         },
         {
             "GetChatCompletionMessagesAsync",
             ("ChatCompletionMessageListDatum", "ChatCompletionMessageCollectionOptions", _chatParamsToReplace)
+        },
+        {
+            "GetInputItems",
+            ("ResponseItem", "ResponseItemCollectionOptions", _chatParamsToReplace)
+        },
+        {
+            "GetInputItemsAsync",
+            ("ResponseItem", "ResponseItemCollectionOptions", _chatParamsToReplace)
         }
     };
 

specification/base/typespec/responses/models.tsp

@@ -1272,7 +1272,7 @@ model ResponseItemList {
   object: "list";
 
   /** A list of items used to generate this response. */
-  data: ItemResource[];
+  @pageItems data: ItemResource[];
 
   /** Whether there are more items available. */
   has_more: boolean;
@@ -1281,7 +1281,7 @@ model ResponseItemList {
   first_id: string;
 
   /** The ID of the last item in the list. */
-  last_id: string;
+  @continuationToken last_id: string;
 }
 
 // Tool customization: Establish discriminated type base

specification/base/typespec/responses/operations.tsp

@@ -82,6 +82,7 @@ interface Responses {
   @operationId("listInputItems")
   @get
   @route("{response_id}/input_items")
+  @list
   listInputItems(
     @path
     @example("resp_677efb5139a88190b512bc3fef8e535d")

specification/client/models/common.models.tsp

@@ -144,4 +144,13 @@ alias CollectionAfterQueryParameter = {
    * subsequent call can include after=obj_foo in order to fetch the next page of the list.
    */
   @query @continuationToken afterId?: string;
+};
+
+alias CollectionBeforeQueryParameter = {
+  /**
+   * A cursor for use in pagination. `before` is an object ID that defines your place in the list.
+   * For instance, if you make a list request and receive 100 objects, starting with obj_foo, your
+   * subsequent call can include before=obj_foo in order to fetch the previous page of the list.
+   */
+  @query beforeId?: string;
 };

specification/client/models/responses.models.tsp

@@ -2,6 +2,7 @@ import "../../base/typespec/responses/main.tsp";
 import "@azure-tools/typespec-client-generator-core";
 
 using Azure.ClientGenerator.Core;
+using TypeSpec.Http;
 
 namespace OpenAI;
 
@@ -25,3 +26,26 @@ model DotNetItemReferenceItemResource extends ItemResource {
   type: ItemType.item_reference;
   ...ItemReferenceItemBase;
 }
+
+alias ResponseItemCollectionOrderQueryParameter = {
+  /**
+   * Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`
+   * for descending order.
+   */
+  @query order?: ResponseItemCollectionOrder;
+};
+
+union ResponseItemCollectionOrder {
+  string,
+  Ascending: "asc",
+  Descending: "desc",
+}
+
+@access(Access.public)
+@usage(Usage.input)
+model ResponseItemCollectionOptions {
+  ...CollectionAfterQueryParameter,
+  ...CollectionBeforeQueryParameter,
+  ...CollectionLimitQueryParameter,
+  ...ResponseItemCollectionOrderQueryParameter,
+}

src/Custom/Responses/OpenAIResponseClient.Protocol.cs

@@ -8,8 +8,6 @@ namespace OpenAI.Responses;
 
 [CodeGenSuppress("GetResponse", typeof(string), typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(RequestOptions))]
 [CodeGenSuppress("GetResponseAsync", typeof(string), typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(RequestOptions))]
-[CodeGenSuppress("GetInputItems", typeof(string), typeof(int?), typeof(string), typeof(string), typeof(string), typeof(RequestOptions))]
-[CodeGenSuppress("GetInputItemsAsync", typeof(string), typeof(int?), typeof(string), typeof(string), typeof(string), typeof(RequestOptions))]
 [CodeGenSuppress("CancelResponse", typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(RequestOptions))]
 [CodeGenSuppress("CancelResponseAsync", typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(RequestOptions))]
 [CodeGenSuppress("GetResponse", typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(RequestOptions))]

src/Custom/Responses/OpenAIResponseClient.cs

@@ -16,8 +16,6 @@ namespace OpenAI.Responses;
 [CodeGenSuppress("CreateResponse", typeof(ResponseCreationOptions), typeof(CancellationToken))]
 [CodeGenSuppress("GetResponse", typeof(string), typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(CancellationToken))]
 [CodeGenSuppress("GetResponseAsync", typeof(string), typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(CancellationToken))]
-[CodeGenSuppress("GetInputItems", typeof(string), typeof(int?), typeof(OpenAI.VectorStores.VectorStoreCollectionOrder?), typeof(string), typeof(string), typeof(CancellationToken))]
-[CodeGenSuppress("GetInputItemsAsync", typeof(string), typeof(int?), typeof(OpenAI.VectorStores.VectorStoreCollectionOrder?), typeof(string), typeof(string), typeof(CancellationToken))]
 [CodeGenSuppress("DeleteResponse", typeof(string), typeof(string), typeof(CancellationToken))]
 [CodeGenSuppress("DeleteResponseAsync", typeof(string), typeof(string), typeof(CancellationToken))]
 [CodeGenSuppress("CancelResponse", typeof(string), typeof(IEnumerable<InternalIncludable>), typeof(bool?), typeof(int?), typeof(CancellationToken))]

src/Custom/Responses/Pagination/ResponseItemCollectionOptions.cs

@@ -1,34 +1,4 @@
-using System.Diagnostics.CodeAnalysis;
-
 namespace OpenAI.Responses;
 
-/// <summary> The options to configure how <see cref="ResponseItem"/> objects are retrieved and paginated. </summary>
-[Experimental("OPENAI001")]
-public class ResponseItemCollectionOptions
-{
-    /// <summary> Initializes a new instance of <see cref="ResponseItemCollectionOptions"/>. </summary>
-    public ResponseItemCollectionOptions() { }
-
-    /// <summary> 
-    ///     A limit on the number of <see cref="Response"/> objects to be returned per page.
-    /// </summary>
-    public int? PageSizeLimit { get; set; }
-
-    /// <summary>
-    ///     The order in which to retrieve <see cref="Response"/> objects when sorted by their
-    ///     <see cref="Response.CreatedAt"/> timestamp.
-    /// </summary>
-    public ResponseItemCollectionOrder? Order { get; set; }
-
-    /// <summary>
-    ///     The <see cref="Response.Id"/> used to retrieve the page of <see cref="Response"/> objects that come
-    ///     after this one.
-    /// </summary>
-    public string AfterId { get; set; }
-
-    /// <summary>
-    ///     The <see cref="Response.Id"/> used to retrieve the page of <see cref="Response"/> objects that come
-    ///     before this one.
-    /// </summary>
-    public string BeforeId { get; set; }
-}
+// CUSTOM: Make public and use the correct namespace. 
+[CodeGenType("ResponseItemCollectionOptions")] public partial class ResponseItemCollectionOptions { }