[azopenai] Adding in image generation, as exported by the current .tsp (#21054)

Adding in image generation for both Azure OpenAI and OpenAI.
- Automated the remaining pieces so we can generate from a .tsp file.
- Updated from the latest tsp from Travis
- Adding a workaround for the bug in Azure OpenAI with streaming. Working on a fix as it needs to be done service side.

Author: richardpark-msft

eng/config.json

@@ -38,7 +38,7 @@
         },
         {
             "Name": "azopenai",
-            "CoverageGoal": 0.45
+            "CoverageGoal": 0.39
         },
         {
             "Name": "aztemplate",
@@ -102,4 +102,4 @@
             "CoverageGoal": 0.80
         }
     ]
-}
+}

sdk/cognitiveservices/azopenai/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "go",
   "TagPrefix": "go/cognitiveservices/azopenai",
-  "Tag": "go/cognitiveservices/azopenai_bf5b07347b"
+  "Tag": "go/cognitiveservices/azopenai_25f5951837"
 }

sdk/cognitiveservices/azopenai/autorest.md

@@ -4,14 +4,19 @@ These settings apply only when `--go` is specified on the command line.
 
 ``` yaml
 input-file:
-- https://github.com/mikekistler/azure-rest-api-specs/blob/baed660fd853b4a387ca9f0b9491fd1414b66e9e/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2023-03-15-preview/inference.json
+#- https://raw.githubusercontent.com/Azure/azure-rest-api-specs/13a645b66b741e3cc2ef378cb81974b30e6a7a86/specification/cognitiveservices/AzureOpenAI/inference/2023-06-01-preview/generated.json
+- ./testdata/generated/openapi3.json
+
 output-folder: ../azopenai
 clear-output-folder: false
 module: github.com/Azure/azure-sdk-for-go/sdk/cognitiveservices/azopenai
 license-header: MICROSOFT_MIT_NO_VERSION
 openapi-type: data-plane
 go: true
-use: "@autorest/[email protected]"
+use: "@autorest/[email protected]"
+title: "OpenAI"
+slice-elements-byval: true
+remove-non-reference-schema: true
 ```
 
 ## Transformations
@@ -30,25 +35,18 @@ directive:
     where: $.paths..parameters..[?(@.name=='deploymentId')]
     transform: $["x-ms-parameter-location"] = "client";
 
-  # Update operationIds to combine all operations into a single client
-  - rename-operation:
-      from: getCompletions
-      to: OpenAI_GetCompletions
-  - rename-operation:
-      from: getEmbeddings
-      to: OpenAI_GetEmbeddings
-  - rename-operation:
-      from: getChatCompletions
-      to: OpenAI_GetChatCompletions
-
-  # Mark request bodies as required (TypeSpec issue #1838)
   - from: openapi-document
-    where: $.paths["/deployments/{deploymentId}/completions"].post.requestBody
+    where: $..paths["/deployments/{deploymentId}/completions"].post.requestBody
     transform: $["required"] = true;
   - from: openapi-document
     where: $.paths["/deployments/{deploymentId}/embeddings"].post.requestBody
     transform: $["required"] = true;
 
+  # get rid of these auto-generated LRO status methods that aren't exposed.
+  - from: openapi-document
+    where: $.paths
+    transform: delete $["/operations/images/{operationId}"]
+
   # Remove stream property from CompletionsOptions and ChatCompletionsOptions
   - from: openapi-document
     where: $.components.schemas["CompletionsOptions"]
@@ -62,25 +60,44 @@ directive:
     where: '$.components.schemas["EmbeddingsOptions"].properties["input"]'
     transform: delete $.anyOf;
 
+  - from: openapi-document
+    where: $.paths["/images/generations:submit"].post
+    transform: $["x-ms-long-running-operation"] = true;
+
   # Fix autorest bug
+  - from: openapi-document
+    where: $.components.schemas["BatchImageGenerationOperationResponse"].properties
+    transform: |
+      $.result["$ref"] = "#/components/schemas/ImageGenerations"; delete $.allOf;
+      $.status["$ref"] = "#/components/schemas/AzureOpenAIOperationState"; delete $.allOf;
+      $.error["$ref"] = "#/components/schemas/Azure.Core.Foundations.Error"; delete $.allOf;
   - from: openapi-document
     where: $.components.schemas["ChatMessage"].properties.role
-    transform: >
-      delete $.allOf;
-      $["$ref"] = "#/components/schemas/ChatRole";
-
-  # Fix another autorest bug
+    transform: $["$ref"] = "#/components/schemas/ChatRole"; delete $.oneOf;
   - from: openapi-document
     where: $.components.schemas["Choice"].properties.finish_reason
-    transform: >
-      delete $.oneOf;
-      $["$ref"] = "#/components/schemas/CompletionsFinishReason";
+    transform: $["$ref"] = "#/components/schemas/CompletionsFinishReason"; delete $.oneOf;
+  - from: openapi-document
+    where: $.components.schemas["ImageOperation"].properties.status
+    transform: $["$ref"] = $.anyOf[0]["$ref"];delete $.anyOf;
+  - from: openapi-document
+    where: $.components.schemas["ImageGenerationOptions"].properties
+    transform: |
+      $.size["$ref"] = "#/components/schemas/ImageSize"; delete $.allOf;
+      $.response_format["$ref"] = "#/components/schemas/ImageGenerationResponseFormat"; delete $.allOf;
+  - from: openapi-document
+    where: $.components.schemas["ImageOperationResponse"].properties
+    transform: |
+      $.status["$ref"] = "#/components/schemas/State"; delete $.status.allOf;
+      $.result["$ref"] = "#/components/schemas/ImageResponse"; delete $.status.allOf;      
+  - from: openapi-document
+    where: $.components.schemas["ImageOperationStatus"].properties.status
+    transform: $["$ref"] = "#/components/schemas/State"; delete $.allOf; 
   - from: openapi-document
     where: $.components.schemas["ChatChoice"].properties.finish_reason
     transform: >
       delete $.oneOf;
       $["$ref"] = "#/components/schemas/CompletionsFinishReason";
-
   # Fix "AutoGenerated" models
   - from: openapi-document
     where: $.components.schemas["ChatCompletions"].properties.usage
@@ -108,28 +125,29 @@ directive:
         /(\s+)urlPath\s*:=\s*"\/deployments\/\{deploymentId\}\/([^"]+)".+?url\.PathEscape.+?\n/gs, 
         "$1urlPath := \"$2\"\n")
 
+  # Unexport the the poller state enum.
+  - from: 
+      - constants.go
+      - models.go
+    where: $
+    transform: return $.replace(/AzureOpenAIOperationState/g, "azureOpenAIOperationState");
+
   # splice out the auto-generated `deploymentID` field from the client
   - from: client.go
     where: $
     transform: >-
       return $.replace(
-        /(type Client struct.+?)deploymentID string([^}]+})/s, 
-        "$1$2")
+        /(type Client struct[^}]+})/s, 
+        "type Client struct {\ninternal *azcore.Client; clientData;\n}")
 
-  # delete unused error models
-  - from: models.go
-    where: $
-    transform: >-
-      return $.replace(
-        /\/\/ AzureCoreFoundations.*?type AzureCoreFoundations(Error|ErrorResponse|ErrorResponseError|InnerError|InnerErrorInnererror|ErrorInnererror) struct \{[^}]+\}/gs, 
-        "")
-  - from: models_serde.go
+  - from: 
+    - models_serde.go
+    - models.go
     where: $
-    transform: >-
-      return $.replace(
-        /\/\/ (UnmarshalJSON|MarshalJSON) implements.*?AzureCoreFoundations.*?func.+?\n}/gs, 
-        "")
-  - from: models_serde.go
+    transform: return $.replace(/AzureCoreFoundations/g, "azureCoreFoundations");
+  - from: 
+    - models_serde.go
+    - models.go
     where: $
     transform: return $.replace(/(?:\/\/.*\s)?func \(\w \*?(?:ErrorResponse|ErrorResponseError|InnerError|InnerErrorInnererror)\).*\{\s(?:.+\s)+\}\s/g, "");
 
@@ -144,7 +162,74 @@ directive:
   - from:
       - client.go
       - models.go
-      - response_types.go
+      - options.go
+      - response_types.go      
     where: $
     transform: return $.replace(/Client(\w+)((?:Options|Response))/g, "$1$2");
+
+  # allow interception of formatting the URL path
+  - from: client.go
+    where: $
+    transform: return $.replace(/runtime\.JoinPaths\(client.endpoint, urlPath\)/g, "client.formatURL(urlPath)");
+
+  - from: models.go
+    where: $
+    transform: |
+      return $.replace(/type ImageGenerationsDataItem struct {[^}]+}/, "// ImageGenerationsDataItem represents an image URL or payload\ntype ImageGenerationsDataItem struct{\nImageLocation\nImagePayload\n}");
+
+  # delete the auto-generated ImageGenerationsDataItem, we handle that custom
+  - from: models.go
+    where: $
+    transform: return $.replace(/\/\/ ImageGenerationsDataItem represents[^}]+}/s, "");
+
+  # rename the image constants
+  - from: constants.go
+    where: $
+    transform: |
+      return $.replace(/ImageSizeFiveHundredTwelveX512/g, "ImageSize512x512")
+        .replace(/ImageSizeOneThousandTwentyFourX1024/g, "ImageSize1024x1024")
+        .replace(/ImageSizeTwoHundredFiftySixX256/g, "ImageSize256x256");
+
+  # scrub the Image(Payload|Location) deserializers.
+  - from: models_serde.go
+    where: $
+    transform: |
+      return $.replace(/\/\/ UnmarshalJSON implements the json.Unmarshaller interface for type ImagePayload.+?\n}/s, "")
+        .replace(/\/\/ MarshalJSON implements the json.Marshaller interface for type ImagePayload.+?\n}/s, "")
+        .replace(/\/\/ UnmarshalJSON implements the json.Unmarshaller interface for type ImageLocation.+?\n}/s, "")
+        .replace(/\/\/ MarshalJSON implements the json.Marshaller interface for type ImageLocation.+?\n}/s, "");
+
+  # hide the image generation pollers.
+  - rename-operation:
+      from: beginAzureBatchImageGeneration
+      to: azureBatchImageGenerationInternal
+  - from: 
+    - client.go
+    - models.go
+    - models_serde.go
+    - options.go
+    - response_types.go
+    where: $
+    transform: |
+      return $.replace(/GetAzureBatchImageGenerationOperationStatusResponse/g, "getAzureBatchImageGenerationOperationStatusResponse")
+        .replace(/AzureBatchImageGenerationInternalResponse/g, "azureBatchImageGenerationInternalResponse")
+        .replace(/GetAzureBatchImageGenerationOperationStatusOptions/g, "getAzureBatchImageGenerationOperationStatusOptions")
+        .replace(/GetAzureBatchImageGenerationOperationStatus/g, "getAzureBatchImageGenerationOperationStatus")
+        .replace(/BeginAzureBatchImageGenerationInternal/g, "beginAzureBatchImageGeneration")
+        .replace(/BatchImageGenerationOperationResponse/g, "batchImageGenerationOperationResponse");
+
+  # fix some casing
+  - from: 
+    - client.go
+    - models.go
+    - models_serde.go
+    - options.go
+    - response_types.go
+    where: $
+    transform: return $.replace(/Logprobs/g, "LogProbs")
+
+  # remove PossibleazureOpenAIOperationStateValues, since we don't expose the poller
+  - from: constants.go
+    where: $
+    transform: return $.replace(/\/\/ PossibleazureOpenAIOperationStateValues returns.+?\n}/s, "");
 ```

sdk/cognitiveservices/azopenai/build.go

@@ -1,7 +1,10 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
 //go:build go1.18
 // +build go1.18
 
-//go:generate autorest ./autorest.md
+//go:generate pwsh ./genopenapi3.ps1
+//go:generate autorest  ./autorest.md
 //go:generate go mod tidy
 //go:generate goimports -w .