Azure OpenAI: TypeSpec updates for 2023-12-01-preview

specification/cognitiveservices/OpenAI.Inference/client.tsp

@@ -3,44 +3,45 @@ import "./main.tsp";
 
 using Azure.ClientGenerator.Core;
 
+#suppress "@azure-tools/typespec-azure-core/casing-style" "OpenAI is a case-sensitive name"
+namespace Azure.OpenAI;
+
 // Azure-specific long-running operations should be treated as implementation details that are wrapped into
 // appropriately merged public surface.
-@@access(Azure.OpenAI.beginAzureBatchImageGeneration, Access.internal);
-@@access(Azure.OpenAI.getAzureBatchImageGenerationOperationStatus,
-  Access.internal
-);
+@@access(beginAzureBatchImageGeneration, Access.internal);
+@@access(getAzureBatchImageGenerationOperationStatus, Access.internal);
 
 // Azure-specific Chat Completions with extensions should be handled by clients as a conditional selection within the
 // shared Chat Completions route, with the selection gated by the presence or non-presence of additional child
 // configuration options on the request payload options model.
-@@access(Azure.OpenAI.getChatCompletionsWithAzureExtensions, Access.internal);
+@@access(getChatCompletionsWithAzureExtensions, Access.internal);
 
 // Some models from routes with suppressed visibility are still desired for custom public surface.
-@@access(Azure.OpenAI.ImageGenerationOptions, Access.public);
-@@usage(Azure.OpenAI.ImageGenerationOptions, Usage.input | Usage.output);
-@@access(Azure.OpenAI.ImageLocation, Access.public);
-@@usage(Azure.OpenAI.ImageLocation, Usage.input | Usage.output);
-@@access(Azure.OpenAI.ImageSize, Access.public);
-@@usage(Azure.OpenAI.ImageGenerations, Usage.input | Usage.output);
+@@access(ImageGenerationOptions, Access.public);
+@@usage(ImageGenerationOptions, Usage.input | Usage.output);
+@@access(ImageSize, Access.public);
+@@usage(ImageGenerations, Usage.input | Usage.output);
 
 // Java will need to have those models expose in public surface.
-@@access(Azure.OpenAI.AudioTranscription, Access.public, "java");
-@@access(Azure.OpenAI.AudioTranscriptionOptions, Access.public, "java");
-@@access(Azure.OpenAI.AudioTranslation, Access.public, "java");
-@@access(Azure.OpenAI.AudioTranslationOptions, Access.public, "java");
-@@access(Azure.OpenAI.AzureOpenAIOperationState, Access.public, "java");
-
-@@access(Azure.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions,
-  Access.public
-);
-@@usage(Azure.OpenAI.AzureCognitiveSearchIndexFieldMappingOptions, Usage.input);
+@@access(AudioTranscription, Access.public, "java");
+@@access(AudioTranscriptionOptions, Access.public, "java");
+@@access(AudioTranslation, Access.public, "java");
+@@access(AudioTranslationOptions, Access.public, "java");
+@@access(AzureOpenAIOperationState, Access.public, "java");
 
-@@access(Azure.OpenAI.AzureCognitiveSearchQueryType, Access.public);
-@@usage(Azure.OpenAI.AzureCognitiveSearchQueryType, Usage.input);
+@@access(AzureCognitiveSearchIndexFieldMappingOptions, Access.public);
+@@usage(AzureCognitiveSearchIndexFieldMappingOptions, Usage.input);
 
-@@access(Azure.OpenAI.AzureCognitiveSearchChatExtensionConfiguration,
-  Access.public
-);
-@@usage(Azure.OpenAI.AzureCognitiveSearchChatExtensionConfiguration,
-  Usage.input
+@@access(AzureCognitiveSearchQueryType, Access.public);
+@@usage(AzureCognitiveSearchQueryType, Usage.input);
+
+@@access(AzureCognitiveSearchChatExtensionConfiguration, Access.public);
+@@usage(AzureCognitiveSearchChatExtensionConfiguration, Usage.input);
+
+// Remap "model" nomenclature to "DeploymentName" in appropriate containers; comments should clarify the dual use
+@@projectedName(ImageGenerationOptions.`model`, "csharp", "DeploymentName");
+
+@@projectedName(ChatResponseMessage.context,
+  "csharp",
+  "AzureExtensionsContext"
 );

specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_transcription_object.json

@@ -0,0 +1,16 @@
+{
+  "operationId": "GetAudioTranscriptionAsResponseObject",
+  "title": "Gets transcribed text and associated metadata from provided spoken audio data.",
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "2023-12-01-preview",
+    "deploymentId": "<deployment-id>"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "text": "A structured object when requesting json or verbose_json"
+      }
+    }
+  }
+}

specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_transcription_text.json

@@ -0,0 +1,16 @@
+{
+  "operationId": "GetAudioTranscriptionAsPlainText",
+  "title": "Gets transcribed text and associated metadata from provided spoken audio data.",
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "2023-12-01-preview",
+    "deploymentId": "<deployment-id>",
+    "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
+  },
+  "responses": {
+    "200": {
+      "type": "string",
+      "example": "plain text when requesting text, srt, or vtt"
+    }
+  }
+}

specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_translation_object.json

@@ -0,0 +1,17 @@
+{
+  "operationId": "GetAudioTranslationAsResponseObject",
+  "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.",
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "2023-12-01-preview",
+    "deploymentId": "<deployment-id>",
+    "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "text": "A structured object when requesting json or verbose_json"
+      }
+    }
+  }
+}

specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/audio_translation_text.json

@@ -0,0 +1,16 @@
+{
+  "operationId": "GetAudioTranslationAsPlainText",
+  "title": "Gets English language transcribed text and associated metadata from provided spoken audio data.",
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "2023-12-01-preview",
+    "deploymentId": "<deployment-id>",
+    "body": "---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
+  },
+  "responses": {
+    "200": {
+      "type": "string",
+      "example": "plain text when requesting text, srt, or vtt"
+    }
+  }
+}

specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/chat_completions.json

@@ -0,0 +1,44 @@
+{
+  "operationId": "GetChatCompletions",
+  "title": "Creates a completion for the provided prompt, parameters and chosen model.",
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "2023-12-01-preview",
+    "deploymentId": "<deployment-id>",
+    "body": {
+      "messages": [
+        {
+          "role": "system",
+          "content": "you are a helpful assistant that talks like a pirate"
+        },
+        {
+          "role": "user",
+          "content": "can you tell me how to care for a parrot?"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
+        "created": 1686676106,
+        "choices": [
+          {
+            "index": 0,
+            "finish_reason": "stop",
+            "message": {
+              "role": "assistant",
+              "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye’ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' ’bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
+            }
+          }
+        ],
+        "usage": {
+          "completion_tokens": 557,
+          "prompt_tokens": 33,
+          "total_tokens": 590
+        }
+      }
+    }
+  }
+}

specification/cognitiveservices/OpenAI.Inference/examples/2023-12-01-preview/completions.json

@@ -0,0 +1,38 @@
+{
+  "operationId": "GetCompletions",
+  "title": "Creates a completion for the provided prompt, parameters and chosen model.",
+  "parameters": {
+    "endpoint": "{endpoint}",
+    "api-version": "2023-12-01-preview",
+    "deploymentId": "<deployment-id>",
+    "body": {
+      "prompt": [
+        "tell me a joke about mango"
+      ],
+      "max_tokens": 32,
+      "temperature": 1.0,
+      "n": 1
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
+        "created": 1686617332,
+        "choices": [
+          {
+            "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
+            "index": 0,
+            "finish_reason": "stop",
+            "logprobs": null
+          }
+        ],
+        "usage": {
+          "completion_tokens": 20,
+          "prompt_tokens": 6,
+          "total_tokens": 26
+        }
+      }
+    }
+  }
+}