azure-sdk · azure-sdk · Feb 17, 2024
diff --git a/sdk/openai/ci.yml b/sdk/openai/ci.yml
@@ -16,6 +16,8 @@ pr:
       - feature/*
       - release/*
       - hotfix/*
+    exclude:
+      - feature/v4
   paths:
     include:
       - sdk/openai/

diff --git a/sdk/openai/openai/CHANGELOG.md b/sdk/openai/openai/CHANGELOG.md
@@ -1,144 +1,3 @@
-# Release History
+## 1.0.0-beta.12 (2024-02-17)
 
-## 1.0.0-beta.12 (Unreleased)
-
-### Features Added
-
-### Breaking Changes
-
-### Bugs Fixed
-
-### Other Changes
-
-## 1.0.0-beta.11 (2024-01-25)
-
-### Bugs Fixed
-
-- Fix a bug where `toolChoice` field in the input options to chat completion methods wasn't defined correctly.
-- Fix a bug where the service returns undefined `choices` in chat completion methods.
-- Fix a bug in chat completion methods where the returned stream was causing an error in Bun.
-
-## 1.0.0-beta.10 (2024-01-03)
-
-### Bugs Fixed
-
-- Fix `responseFormat` behavior in `getAudioTranscription` and `getAudioTranslation` methods where request wasn't properly formed if it wasn't specified.
-
-## 1.0.0-beta.9 (2024-01-02)
-
-### Breaking Changes
-
-- `listChatCompletions` and `listCompletions` are renamed to `streamChatCompletions` and `streamCompletions` respectively and their return types are updated to be a `ReadableStream`. For example, `streamChatCompletions` can be used as follows:
-
-```js
-  const events = await client.streamChatCompletions(deploymentId, messages);
-  for await (const event of events) {
-    // use event ...
-  }
-```
-
-## 1.0.0-beta.8 (2023-12-07)
-
-Following OpenAI's November Dev Day and Microsoft's 2023 Ignite conference, this update brings a slew of new
-features and changes to the client library.
-
-### Features Added
-
-- `-1106` model feature support for `gpt-35-turbo` and `gpt-4-turbo`, including use of `seed`, `system_fingerprint`, parallel function calling via tools, "JSON mode" for guaranteed function outputs, and more
-- `dall-e-3` image generation capabilities via `getImages`, featuring higher model quality, automatic prompt revisions by `gpt-4`, and customizable quality/style settings
-- Greatly expanded "On Your Data" capabilities in Azure OpenAI, including many new data source options and authentication mechanisms
-- Early support for `gpt-4-vision-preview`, which allows the hybrid use of text and images as input to enable scenarios like "describe this image for me"
-- Support for Azure enhancements to `gpt-4-vision-preview` results that include grounding and OCR features
-
-### Breaking Changes
-
-`ChatMessage` changes:
-
-- The singular `ChatMessage` type has been replaced by `ChatRequestMessage` and `ChatResponseMessage`, the former of
-    which is a union of special message structures such as `ChatRequestSystemMessage` and
-    `ChatRequestUserMessage`.
-
-Dall-e-3:
-
-- Azure OpenAI now uses `dall-e-3` model deployments for its image generation API and such a valid deployment must
-    be provided to the `GetImageGenerations` method.
-
-On Your Data:
-
-- The `AzureExtensionChatConfiguration` type has been updated to inline the parameters of the extension into the
-    configuration object itself.
-
-## 1.0.0-beta.7 (2023-10-25)
-
-### Bugs Fixed
-
-- Support Cloudflare workers by only setting the available fields in the `Request` class for the Fetch API.
-- Wait before stop listening to the abort signal until after the response stream has been drained to allow for aborting prolonged responses.
-
-### Other Changes
-
-- NodeJS v18 is now the minimum version supported. Check out the [LTS versions of Node.js](https://github.com/nodejs/release#release-schedule) for more information on NodeJS support timelines. And check out the [Microsoft Support Policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md#microsoft-support-policy) for more information on Microsoft support timelines.
-
-## 1.0.0-beta.6 (2023-09-21)
-
-### Features Added
-
-- Introduces speech to text and translation capabilities for a wide variety of audio file formats.
-  - Adds `getAudioTranscription` and `getAudioTranslation` methods for transcribing and translating audio files. The result can be either a simple JSON structure with just a `text` field or a more detailed JSON structure containing the text alongside additional information. In addition, VTT (Web Video Text Tracks), SRT (SubRip Text), and plain text formats are also supported. The type of the result depends on the `format` parameter if specified, otherwise, a simple JSON output is assumed. The methods could take as input an optional text prompt to guide the model's style or continue a previous audio segment. The language of the prompt should match that of the audio file.
-  - The available model at the time of this release supports the following list of audio file formats: m4a, mp3, wav, ogg, flac, webm, mp4, mpga, mpeg, and oga.
-
-### Bugs Fixed
-
-- Returns `usage` information when available.
-- Fixes a bug where errors weren't properly being thrown from the streaming methods.
-- Returns `error` information in `ContentFilterResults` when available.
-- Fixes parsing of `functionCall` in `ChatMessage` objects.
-
-## 1.0.0-beta.5 (2023-08-25)
-
-### Features Added
-
-- (Azure OpenAI specific) Chat completions with your own data is now supported, see [Azure OpenAI's quickstart guide](https://learn.microsoft.com/azure/ai-services/openai/use-your-data-quickstart?tabs=command-line&pivots=programming-language-studio) for details.
-  - A list of AzureExtensionChatConfiguration may be populated on `ChatCompletionsOptions` via its `azureExtensionOption.extensions` property. These configurations include a type together with a JSON Schema representation of its parameters. The type is used to determine which extension to use when generating chat completions. See the `bringYourOwnData.js` sample for an example of how to use this feature.
-- Functions for chat completions are now supported: see [OpenAI's blog post on the topic](https://openai.com/blog/function-calling-and-other-api-updates) for much more detail.
-  - A list of `FunctionDefinition` objects may be populated on `ChatCompletionsOptions` via its `functions` property. These definitions include a name and description together with a serialized JSON Schema representation of its parameters.
-  - **NOTE**: Chat Functions requires a minimum of the `-0613` model versions for `gpt-4` and `gpt-3.5-turbo`/`gpt-35-turbo`. Please ensure you're using these later model versions, as Functions are not supported with older model revisions. For Azure OpenAI, you can update a deployment's model version or create a new model deployment with an updated version via the Azure AI Studio interface, also accessible through Azure Portal.
-- (Azure OpenAI specific) Completions and Chat Completions responses now include embedded content filter annotations for prompts and responses
-
-### Breaking Changes
-
-- Remove `beginAzureBatchImageGeneration` and `getAzureBatchImageGenerationOperationStatus` methods. 
-- `getImages` has been updated to return the image URLs/payloads directly, rather than requiring the user to call `getAzureBatchImageGenerationOperationStatus` to retrieve them.
-
-## 1.0.0-beta.4 (2023-08-09)
-
-### Features Added
-
-- Exporting individual capabilities as separate functions to be used in code-size-concious applications. For example, streaming completions can be imported individually as follows:
-
-```js
-import { listCompletions, createOpenAI } from "@azure/openai/api";
-const client = createOpenAI(endpoint, new AzureKeyCredential(azureApiKey));
-const events = listCompletions(client, prompt, deploymentId, { maxTokens: 128 });
-```
-
-### Bugs Fixed
-
-- Fix a bug where server-sent events were not being parsed correctly.
-
-## 1.0.0-beta.3 (2023-07-13)
-
-### Features Added
-
-- Added support for batch image generation via `beginAzureBatchImageGeneration` and `getAzureBatchImageGenerationOperationStatus`.
-- Added GetImages convenience API for above, as well as supporting ImageGenerationOptions and ImageGenerationResponse aliases.
-
-## 1.0.0-beta.2 (2023-06-06)
-
-### Bugs Fixed
-
-- Fix a bug where the customer-passed options for credentials were overwritten by the defaults values.
-
-## 1.0.0-beta.1 (2023-05-22)
-
-- This is the initial beta release for Azure OpenAI inference capabilities, including completions, chat completions, and embeddings.
+  - Initial Release
diff --git a/sdk/openai/openai/api-extractor.json b/sdk/openai/openai/api-extractor.json
@@ -1,18 +1,31 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
   "mainEntryPointFilePath": "./types/src/index.d.ts",
-  "docModel": { "enabled": true },
-  "apiReport": { "enabled": true, "reportFolder": "./review" },
+  "docModel": {
+    "enabled": true
+  },
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "./review"
+  },
   "dtsRollup": {
     "enabled": true,
     "untrimmedFilePath": "",
     "publicTrimmedFilePath": "./types/openai.d.ts"
   },
   "messages": {
-    "tsdocMessageReporting": { "default": { "logLevel": "none" } },
+    "tsdocMessageReporting": {
+      "default": {
+        "logLevel": "none"
+      }
+    },
     "extractorMessageReporting": {
-      "ae-missing-release-tag": { "logLevel": "none" },
-      "ae-unresolved-link": { "logLevel": "none" }
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      },
+      "ae-unresolved-link": {
+        "logLevel": "none"
+      }
     }
   }
-}
+}
diff --git a/sdk/openai/openai/package.json b/sdk/openai/openai/package.json
@@ -152,4 +152,4 @@
       "Azure Cognitive Services instance": "https://learn.microsoft.com/azure/cognitive-services/openai/how-to/create-resource"
     }
   }
-}
+}
diff --git a/sdk/openai/openai/sources/generated/src/OpenAIClient.ts b/sdk/openai/openai/sources/generated/src/OpenAIClient.ts