[openai] Migrate openai projects to use snippets extraction (#33264)

### Packages impacted by this PR

- @azure/openai

### Issues associated with this PR

- #32416

### Describe the problem that is addressed by this PR

Updates all projects under `openai` to use snippets extraction.

### What are the possible designs available to address the problem? If
there are more than one possible design, why was the one in this PR
chosen?


### Are there test cases added in this PR? _(If not, why?)_


### Provide a list of related PRs _(if any)_


### Command used to generate this PR:**_(Applicable only to SDK release
request PRs)_

### Checklists
- [ ] Added impacted package name to the issue description
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [ ] Added a changelog (if necessary)

Author: mpodwysocki

common/tools/dev-tool/src/commands/admin/list/snippets-migrations.ts

@@ -94,7 +94,7 @@ function setMigrationResult(
   if (
     packageJson.scripts &&
     packageJson.scripts["update-snippets"] &&
-    packageJson.scripts["update-snippets"] === "dev-tool run update-snippets"
+    packageJson.scripts["update-snippets"].includes("dev-tool run update-snippets")
   ) {
     results.snippets[project.packageName] = project.projectFolder;
     results.totalSnippets++;

common/tools/dev-tool/src/commands/admin/migrate-package.ts

@@ -219,11 +219,13 @@ async function fixApiExtractorConfig(apiExtractorJsonPath: string): Promise<void
   }
   const apiExtractorJson = JSON.parse(await readFile(apiExtractorJsonPath, "utf-8"));
 
-  const oldPath = apiExtractorJson.dtsRollup.publicTrimmedFilePath;
-  const projectName = basename(oldPath, ".d.ts");
+  if (apiExtractorJson.dtsRollup.publicTrimmedFilePath) {
+    const oldPath = apiExtractorJson.dtsRollup.publicTrimmedFilePath;
+    const projectName = basename(oldPath, ".d.ts");
+    apiExtractorJson.dtsRollup.publicTrimmedFilePath = `dist/${projectName}.d.ts`;
+  }
 
   apiExtractorJson.mainEntryPointFilePath = "dist/esm/index.d.ts";
-  apiExtractorJson.dtsRollup.publicTrimmedFilePath = `dist/${projectName}.d.ts`;
 
   // TODO: Clean up the betaTrimmedFilePath
   delete apiExtractorJson.dtsRollup.betaTrimmedFilePath;
@@ -233,7 +235,7 @@ async function fixApiExtractorConfig(apiExtractorJsonPath: string): Promise<void
 
 async function cleanupFiles(projectFolder: string): Promise<void> {
   // Remove the old test files
-  const filesToRemove = ["karma.conf.js", "karma.conf.cjs", ".nycrc"];
+  const filesToRemove = ["karma.conf.js", "karma.conf.cjs", ".nycrc", ".mocharc.json"];
   for (const file of filesToRemove) {
     try {
       await unlink(resolve(projectFolder, file));

sdk/openai/openai/.mocharc.json

@@ -1,3 +1,5 @@
+<!-- dev-tool snippets ignore -->
+
 # Release History
 
 ## 2.1.0-beta.1 (Unreleased)
@@ -71,17 +73,18 @@ This release adds types for Azure features supported in Azure OpenAI Service API
 - Adds a new property `logprobs` in `ChatChoice` to support log probabilities for this chat choice
 - Adds new properties `logprobs` and `topLogprobs` in `ChatCompletionsOptions` class to support log probabilities for chat completions
 - Adds `dimensions` in `GetEmbeddingsOptions`.
-when using Azure OpenAI, specifies the input type to use for embedding search.
+  when using Azure OpenAI, specifies the input type to use for embedding search.
 - Updates the default service API version to `2024-03-01-preview`
 - Returns content filter results and prompt filter results for image generations through `contentFilterResults` and `promptFilterResults` properties
 
 ### Breaking Changes
 
 - `AzureChatExtensionConfiguration`, `OnYourDataAuthenticationOptions`, `OnYourDataVectorizationSource`, `OnYourDataVectorizationSourceType`, `ChatCompletionsNamedToolSelection`, `ChatCompletionsToolDefinition`, `ChatCompletionsToolCall`, `ChatMessageContentItem`, `ChatRequestMessage`, `ChatFinishDetails` are renamed with `Union` postfix.
-- `AzureCognitiveSearchQueryType`, `ChatMessageImageDetailLevel`, `ElasticsearchQueryType`, `FunctionCallPreset`, `ImageGenerationQuality`, `ImageGenerationResponseFormat`, `ImageSize`, `ImageGenerationStyle`, `OnYourDataAuthenticationType`, `OnYourDataVectorizationSourceType`  union types no longer have fixed values.
+- `AzureCognitiveSearchQueryType`, `ChatMessageImageDetailLevel`, `ElasticsearchQueryType`, `FunctionCallPreset`, `ImageGenerationQuality`, `ImageGenerationResponseFormat`, `ImageSize`, `ImageGenerationStyle`, `OnYourDataAuthenticationType`, `OnYourDataVectorizationSourceType` union types no longer have fixed values.
 - `prompFilterResults` property in `ChatCompletions`, `prompFilterResults` property in `Choice`, `toolCalls` in `ChatResponseMessage` are now optional
 
 Changes to "bring your own data" features:
+
 - Introduces a new type: `AzureChatExtensionDataSourceResponseCitation`
 - For `AzureChatExtensionsMessageContext`, replaced `messages` property with `citations` and added `intent` as a string
 - Rename `AzureCognitiveSearch` to `AzureSearch`
@@ -118,10 +121,10 @@ Changes to "bring your own data" features:
 - `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 ...
-  }
+const events = await client.streamChatCompletions(deploymentId, messages);
+for await (const event of events) {
+  // use event ...
+}
 ```
 
 ## 1.0.0-beta.8 (2023-12-07)
@@ -142,18 +145,18 @@ features and changes to the client library.
 `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`.
+  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.
+  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.
+  configuration object itself.
 
 ## 1.0.0-beta.7 (2023-10-25)
 
@@ -194,7 +197,7 @@ On Your Data:
 
 ### Breaking Changes
 
-- Remove `beginAzureBatchImageGeneration` and `getAzureBatchImageGenerationOperationStatus` methods. 
+- 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)

sdk/openai/openai/CHANGELOG.md

@@ -1,3 +1,5 @@
+<!-- dev-tool snippets ignore -->
+
 # Migrating to `openai`
 
 **Note ⚠️**: This document is a work-in-progress and may change to reflect updates to the package. We value your feedback, please [create an issue](https://github.com/Azure/azure-sdk-for-js/issues/new/choose) to suggest any improvements or report any problems with this guide or with the package itself.
@@ -70,7 +72,7 @@ Migrated code:
 import { AzureOpenAI } from "openai";
 const deployment = "Your Azure OpenAI deployment";
 const apiVersion = "2024-11-01-preview";
-const options = { azureADTokenProvider, deployment, apiVersion }
+const options = { azureADTokenProvider, deployment, apiVersion };
 const client = new AzureOpenAI(options);
 ```
 
@@ -101,7 +103,7 @@ const result = await client.getChatCompletions(deploymentName, messages, { maxTo
 Migrated code:
 
 ```typescript
-const result = await client.chat.completions.create({ messages, model: '', max_tokens: 100 });
+const result = await client.chat.completions.create({ messages, model: "", max_tokens: 100 });
 ```
 
 Notice the following:
@@ -124,7 +126,12 @@ const stream = await client.streamChatCompletions(deploymentName, messages, { ma
 Migrated code:
 
 ```typescript
-const stream = await client.chat.completions.create({ model: '', messages, max_tokens: 100, stream: true });
+const stream = await client.chat.completions.create({
+  model: "",
+  messages,
+  max_tokens: 100,
+  stream: true,
+});
 ```
 
 ### Azure On Your Data
@@ -136,16 +143,19 @@ Original code:
 ```typescript
 const azureSearchEndpoint = "Your Azure Search resource endpoint";
 const azureSearchIndexName = "Your Azure Search index name";
-const result = await client.getChatCompletions(deploymentName, messages, { azureExtensionOptions: { 
-    data_sources: [{
-      type: "azure_search",
-      endpoint: azureSearchEndpoint,
-      indexName: azureSearchIndexName,
-      authentication: {
-        type: "system_assigned_managed_identity",
-      }
-    }]
-  } 
+const result = await client.getChatCompletions(deploymentName, messages, {
+  azureExtensionOptions: {
+    data_sources: [
+      {
+        type: "azure_search",
+        endpoint: azureSearchEndpoint,
+        indexName: azureSearchIndexName,
+        authentication: {
+          type: "system_assigned_managed_identity",
+        },
+      },
+    ],
+  },
 });
 ```
 
@@ -157,18 +167,20 @@ import "@azure/openai/types";
 const azureSearchEndpoint = "Your Azure Search resource endpoint";
 const azureSearchIndexName = "Your Azure Search index name";
 const result = await client.chat.completions.create({
-  model: '',
+  model: "",
   messages,
-  data_sources: [{
+  data_sources: [
+    {
       type: "azure_search",
       parameters: {
         endpoint: azureSearchEndpoint,
         index_name: azureSearchIndexName,
         authentication: {
           type: "system_assigned_managed_identity",
-        }
-      }
-  }]
+        },
+      },
+    },
+  ],
 });
 ```
 
@@ -199,7 +211,7 @@ Migrated code:
 import { createReadStream } from "fs";
 
 const result = await client.audio.transcriptions.create({
-  model: '',
+  model: "",
   file: createReadStream(audioFilePath),
 });
 ```
@@ -231,7 +243,7 @@ Migrated code:
 import { createReadStream } from "fs";
 
 const result = await client.audio.translations.create({
-  model: '',
+  model: "",
   file: createReadStream(audioFilePath),
 });
 ```
@@ -300,23 +312,16 @@ The following example shows how to migrate the `createMessage` method call.
 Original code:
 
 ```typescript
-const threadResponse = await assistantsClient.createMessage(
-  assistantThread.id,
-  role,
-  message
-);
+const threadResponse = await assistantsClient.createMessage(assistantThread.id, role, message);
 ```
 
 Migration code:
 
 ```typescript
-const threadResponse = await assistantsClient.beta.threads.messages.create(
-  assistantThread.id,
-  {
-    role,
-    content: message,
-  }
-);
+const threadResponse = await assistantsClient.beta.threads.messages.create(assistantThread.id, {
+  role,
+  content: message,
+});
 ```
 
 Notice that:
@@ -356,7 +361,7 @@ const runResponse = await assistantsClient.beta.threads.runs.createAndPoll(
   {
     assistant_id: assistantResponse.id,
   },
-  { pollIntervalMs: 500 }
+  { pollIntervalMs: 500 },
 );
 ```
 
@@ -404,7 +409,7 @@ const embeddings = await client.getEmbeddings(deploymentName, input);
 Migrated code:
 
 ```typescript
-const embeddings = await client.embeddings.create({ input, model: '' });
+const embeddings = await client.embeddings.create({ input, model: "" });
 ```
 
 Notice that:
@@ -426,7 +431,7 @@ const results = await client.getImages(deploymentName, prompt, { n, size });
 Migrated code:
 
 ```typescript
-  const results = await client.images.generate({ prompt, model: '', n, size });
+const results = await client.images.generate({ prompt, model: "", n, size });
 ```
 
 Notice that: