tsp, openai-assistants, refactor BodyParameter (#29749)

Azure · Jul 17, 2024 · 6041852 · 6041852
1 parent 34cb052
commit 6041852
Show file tree

Hide file tree

Showing 11 changed files with 115 additions and 48 deletions.
diff --git a/specification/ai/OpenAI.Assistants/assistants/routes.tsp b/specification/ai/OpenAI.Assistants/assistants/routes.tsp
@@ -20,7 +20,13 @@ namespace Azure.AI.OpenAI.Assistants;
 @post
 @added(ServiceApiVersions.v2024_02_15_preview)
 @route("/assistants")
-op createAssistant(...BodyParameter<AssistantCreationOptions>): Assistant;
+op createAssistant(
+  /**
+   * The request details to use when creating a new assistant.
+   */
+  @bodyRoot
+  body: AssistantCreationOptions,
+): Assistant;
 
 /**
  * Gets a list of assistants that were previously created.
@@ -63,7 +69,13 @@ op getAssistant(@path assistantId: string): Assistant;
 @post
 @route("/assistants/{assistantId}")
 @added(ServiceApiVersions.v2024_02_15_preview)
-op updateAssistant(...BodyParameter<UpdateAssistantOptions>): Assistant;
+op updateAssistant(
+  /**
+   * The request details to use when modifying an existing assistant.
+   */
+  @bodyRoot
+  body: UpdateAssistantOptions,
+): Assistant;
 
 /**
  * Deletes an assistant.

diff --git a/specification/ai/OpenAI.Assistants/client.tsp b/specification/ai/OpenAI.Assistants/client.tsp
@@ -230,4 +230,35 @@ namespace Azure.AI.OpenAI.Assistants {
   // From https://platform.openai.com/docs/assistants/how-it-works
   // "Note that deleting an AssistantFile doesn’t delete the original File object, it simply deletes the association
   // between that File and the Assistant."
+
+  @@clientName(createAssistant::parameters.body,
+    "assistantCreationOptions",
+    "java"
+  );
+  @@clientName(updateAssistant::parameters.body,
+    "updateAssistantOptions",
+    "java"
+  );
+  @@clientName(createThreadAndRun::parameters.body,
+    "createAndRunThreadOptions",
+    "java"
+  );
+  @@clientName(createThread::parameters.body,
+    "assistantThreadCreationOptions",
+    "java"
+  );
+  @@clientName(updateThread::parameters.body,
+    "updateAssistantThreadOptions",
+    "java"
+  );
+  @@clientName(createVectorStore::parameters.body,
+    "vectorStoreOptions",
+    "java"
+  );
+  @@clientName(modifyVectorStore::parameters.body,
+    "vectorStoreUpdateOptions",
+    "java"
+  );
+  @@clientName(createRun::parameters.body, "createRunOptions", "java");
+  @@clientName(createMessage::parameters.body, "threadMessageOptions", "java");
 }
diff --git a/specification/ai/OpenAI.Assistants/common/models.tsp b/specification/ai/OpenAI.Assistants/common/models.tsp
@@ -148,14 +148,3 @@ union ApiResponseFormat {
   /** Using `json_object` format will limit the usage of ToolCall to only functions. */
   jsonObject: "json_object",
 }
-
-alias BodyParameter<
-  T,
-  TName extends valueof string = "body",
-  TDoc extends valueof string = "Body parameter."
-> = {
-  @doc(TDoc)
-  @friendlyName(TName)
-  @bodyRoot
-  body: T;
-};
diff --git a/specification/ai/OpenAI.Assistants/messages/routes.tsp b/specification/ai/OpenAI.Assistants/messages/routes.tsp
@@ -32,7 +32,7 @@ op createMessage(
   @path threadId: string,
 
   /** A single message within an assistant thread, as provided during that thread's creation for its initial state. */
-  ...BodyParameter<ThreadMessageOptions>,
+  @bodyRoot body: ThreadMessageOptions,
 ): ThreadMessage;
 
 /**

diff --git a/specification/ai/OpenAI.Assistants/runs/routes.tsp b/specification/ai/OpenAI.Assistants/runs/routes.tsp
@@ -28,7 +28,14 @@ namespace Azure.AI.OpenAI.Assistants;
 @route("/threads/{threadId}/runs")
 @doc("Creates a new run for an assistant thread.")
 @added(ServiceApiVersions.v2024_02_15_preview)
-op createRun(@path threadId: string, ...CreateRunOptions): ThreadRun;
+op createRun(
+  @path threadId: string,
+
+  /**
+   * The details used when creating a new run of an assistant thread.
+   */
+  @bodyRoot body: CreateRunOptions,
+): ThreadRun;
 
 /**
  * Gets a list of runs for a specified thread.
@@ -136,4 +143,10 @@ op cancelRun(@path threadId: string, @path runId: string): ThreadRun;
 @route("/threads/runs")
 @doc("Creates a new assistant thread and immediately starts a run using that new thread.")
 @added(ServiceApiVersions.v2024_02_15_preview)
-op createThreadAndRun(...BodyParameter<CreateAndRunThreadOptions>): ThreadRun;
+op createThreadAndRun(
+  /**
+   * The details used when creating and immediately running a new assistant thread.
+   */
+  @bodyRoot
+  body: CreateAndRunThreadOptions,
+): ThreadRun;
diff --git a/specification/ai/OpenAI.Assistants/threads/routes.tsp b/specification/ai/OpenAI.Assistants/threads/routes.tsp
@@ -21,7 +21,11 @@ namespace Azure.AI.OpenAI.Assistants;
 @added(ServiceApiVersions.v2024_02_15_preview)
 @route("/threads")
 op createThread(
-  ...BodyParameter<AssistantThreadCreationOptions>,
+  /**
+   * The details used to create a new assistant thread.
+   */
+  @bodyRoot
+  body: AssistantThreadCreationOptions,
 ): AssistantThread;
 
 // list threads?
@@ -55,7 +59,11 @@ op getThread(@path threadId: string): AssistantThread;
 @route("/threads/{threadId}")
 @added(ServiceApiVersions.v2024_02_15_preview)
 op updateThread(
-  ...BodyParameter<UpdateAssistantThreadOptions>,
+  /**
+   * The details used to update an existing assistant thread.
+   */
+  @bodyRoot
+  body: UpdateAssistantThreadOptions,
 ): AssistantThread;
 
 /**

diff --git a/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp b/specification/ai/OpenAI.Assistants/vector_stores/routes.tsp
@@ -34,7 +34,13 @@ op listVectorStores(
 @post
 @route("/vector_stores")
 @added(ServiceApiVersions.v2024_05_01_preview)
-op createVectorStore(...BodyParameter<VectorStoreOptions>): VectorStore;
+op createVectorStore(
+  /**
+   * Request object for creating a vector store.
+   */
+  @bodyRoot
+  body: VectorStoreOptions,
+): VectorStore;
 
 /**
  * Returns the vector store object matching the specified ID.
@@ -63,7 +69,11 @@ op modifyVectorStore(
   /** The ID of the vector store to modify. */
   @path vectorStoreId: string,
 
-  ...BodyParameter<VectorStoreUpdateOptions>,
+  /**
+   * Request object for updating a vector store.
+   */
+  @bodyRoot
+  body: VectorStoreUpdateOptions,
 ): VectorStore;
 
 /**

diff --git a/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json b/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-02-15-preview/assistants_generated.json
@@ -179,7 +179,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The request details to use when creating a new assistant.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantCreationOptions"
@@ -242,7 +242,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The request details to use when modifying an existing assistant.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantOptions"
@@ -516,7 +516,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The details used to create a new assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantThreadCreationOptions"
@@ -579,7 +579,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The details used to update an existing assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantThreadOptions"
@@ -761,7 +761,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/ThreadMessageOptions"
@@ -1003,6 +1003,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "The details used when creating a new run of an assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateRunOptions"
@@ -1385,7 +1386,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The details used when creating and immediately running a new assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateAndRunThreadOptions"

diff --git a/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json b/...ta-plane/OpenAI.Assistants/OpenApiV2/preview/2024-05-01-preview/assistants_generated.json
@@ -179,7 +179,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The request details to use when creating a new assistant.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantCreationOptions"
@@ -242,7 +242,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The request details to use when modifying an existing assistant.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantOptions"
@@ -552,7 +552,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The details used to create a new assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/AssistantThreadCreationOptions"
@@ -615,7 +615,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The details used to update an existing assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/UpdateAssistantThreadOptions"
@@ -804,7 +804,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "A single message within an assistant thread, as provided during that thread's creation for its initial state.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/ThreadMessageOptions"
@@ -1046,6 +1046,7 @@
           {
             "name": "body",
             "in": "body",
+            "description": "The details used when creating a new run of an assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateRunOptions"
@@ -1428,7 +1429,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "The details used when creating and immediately running a new assistant thread.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/CreateAndRunThreadOptions"
@@ -1570,7 +1571,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "Request object for creating a vector store.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/VectorStoreOptions"
@@ -1633,7 +1634,7 @@
           {
             "name": "body",
             "in": "body",
-            "description": "Body parameter.",
+            "description": "Request object for updating a vector store.",
             "required": true,
             "schema": {
               "$ref": "#/definitions/VectorStoreUpdateOptions"

diff --git a/...on/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml b/...on/ai/data-plane/OpenAI.Assistants/OpenApiV3/2024-02-15-preview/assistants_generated.yaml
@@ -18,7 +18,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Assistant'
       requestBody:
-        description: Body parameter.
+        description: The request details to use when creating a new assistant.
         required: true
         content:
           application/json:
@@ -125,7 +125,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Assistant'
       requestBody:
-        description: Body parameter.
+        description: The request details to use when modifying an existing assistant.
         required: true
         content:
           application/json:
@@ -264,7 +264,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/AssistantThread'
       requestBody:
-        description: Body parameter.
+        description: The details used to create a new assistant thread.
         required: true
         content:
           application/json:
@@ -283,7 +283,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/ThreadRun'
       requestBody:
-        description: Body parameter.
+        description: The details used when creating and immediately running a new assistant thread.
         required: true
         content:
           application/json:
@@ -325,7 +325,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/AssistantThread'
       requestBody:
-        description: Body parameter.
+        description: The details used to update an existing assistant thread.
         required: true
         content:
           application/json:
@@ -367,7 +367,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/ThreadMessage'
       requestBody:
-        description: Body parameter.
+        description: A single message within an assistant thread, as provided during that thread's creation for its initial state.
         required: true
         content:
           application/json:
@@ -523,6 +523,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/ThreadRun'
       requestBody:
+        description: The details used when creating a new run of an assistant thread.
         required: true
         content:
           application/json: