cspell tidying and temp snippet tag collision workaround

Author: trrwilson

.vscode/cspell.json

@@ -220,6 +220,10 @@
         "azureai",
         "bleu",
         "gleu",
+        "includable",
+        "inpaint",
+        "inpainting",
+        "logprobs",
         "ubinary"
       ]
     },

sdk/ai/Azure.AI.Agents/README.md

@@ -3,7 +3,7 @@
 To enable your Agent to Computer Use tool, you need to use `ComputerTool` while creating `PromptAgentDefinition`.
 1. First, we need to create an Agent client and read the environment variables, which will be used in the next steps.
 
-```C# Snippet:Sample_CreateAgentClient_ComputerUse
+```C# Snippet:Sample_CreateAgentClient_ComputerUse_2
 var projectEndpoint = System.Environment.GetEnvironmentVariable("PROJECT_ENDPOINT");
 var modelDeploymentName = System.Environment.GetEnvironmentVariable("COMPUTER_USE_DEPLOYMENT_NAME");
 AgentClient client = new(endpoint: new Uri(projectEndpoint), tokenProvider: new DefaultAzureCredential());
@@ -13,7 +13,7 @@ OpenAIClient openAIClient = client.GetOpenAIClient();
 2. To use the tool, we need to read image files using `ReadImageFile` method.
 
 Synchronous sample:
-```C# Snippet:Sample_ReadImageFile_ComputerUse
+```C# Snippet:Sample_ReadImageFile_ComputerUse_2
 private static BinaryData ReadImageFile(string name, [CallerFilePath] string pth = "")
 {
     var dirName = Path.GetDirectoryName(pth) ?? "";
@@ -23,7 +23,7 @@ private static BinaryData ReadImageFile(string name, [CallerFilePath] string pth
 
 3. In this example we will read in three toy schreenshots and place them into dictionary.
 
-```C# Snippet:Sample_ReadImageFilesToDictionaries_ComputerUse
+```C# Snippet:Sample_ReadImageFilesToDictionaries_ComputerUse_2
 Dictionary<string, BinaryData> screenshots = new() {
     { "browser_search", ReadImageFile("Assets/cua_browser_search.png")},
     { "search_typed", ReadImageFile("Assets/cua_search_typed.png")},
@@ -34,7 +34,7 @@ Dictionary<string, BinaryData> screenshots = new() {
 4. Create a `PromptAgentDefinition` with `ComputerTool`.
 
 Synchronous sample:
-```C# Snippet:Sample_CreateAgent_ComputerUse_Sync
+```C# Snippet:Sample_CreateAgent_ComputerUse_Sync_2
 PromptAgentDefinition agentDefinition = new(model: modelDeploymentName)
 {
     Instructions = "You are a computer automation assistant.\n\n" +
@@ -54,7 +54,7 @@ AgentVersion agentVersion = client.CreateAgentVersion(
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_CreateAgent_ComputerUse_Async
+```C# Snippet:Sample_CreateAgent_ComputerUse_Async_2
 PromptAgentDefinition agentDefinition = new(model: modelDeploymentName)
 {
     Instructions = "You are a computer automation assistant.\n\n" +
@@ -75,7 +75,7 @@ AgentVersion agentVersion = await client.CreateAgentVersionAsync(
 
 4. Create a helper method to parse the ComputerTool outputs and to respond to Agents queries with new screenshots. Please note that throughout this sample we set the media type for image. Agents support `image/jpeg`, `image/png`, `image/gif` and `image/webp` media types.
 
-```C# Snippet:Sample_ProcessComputerUseCall_ComputerUse
+```C# Snippet:Sample_ProcessComputerUseCall_ComputerUse_2
 private static string ProcessComputerUseCall(ComputerCallResponseItem item, string oldScreenshot)
 {
     string currentScreenshot = "browser_search";
@@ -141,7 +141,7 @@ private static string ProcessComputerUseCall(ComputerCallResponseItem item, stri
 5. For brevity create the methods to wait for response to be returned.
 
 Synchronous sample:
-```C# Snippet:Sample_WaitForResponse_ComputerUse_Sync
+```C# Snippet:Sample_WaitForResponse_ComputerUse_Sync_2
 public static OpenAIResponse CreateAndWaitForResponse(OpenAIResponseClient responseClient, IEnumerable<ResponseItem> items, ResponseCreationOptions options)
 {
     OpenAIResponse response = responseClient.CreateResponse(
@@ -158,7 +158,7 @@ public static OpenAIResponse CreateAndWaitForResponse(OpenAIResponseClient respo
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_WaitForResponse_ComputerUse_Async
+```C# Snippet:Sample_WaitForResponse_ComputerUse_Async_2
 public static async Task<OpenAIResponse> CreateAndWaitForResponseAsync(OpenAIResponseClient responseClient, IEnumerable<ResponseItem> items, ResponseCreationOptions options)
 {
     OpenAIResponse response = await responseClient.CreateResponseAsync(
@@ -177,7 +177,7 @@ public static async Task<OpenAIResponse> CreateAndWaitForResponseAsync(OpenAIRes
 6. Create an `OpenAIResponse` using `ResponseItem`, containing two `ResponseContentPart`: one with the image and another with the text. In the loop we will request Agent while it is continuing to browse web. Finally, print the tool output message.
 
 Synchronous sample:
-```C# Snippet:Sample_CreateResponse_ComputerUse_Sync
+```C# Snippet:Sample_CreateResponse_ComputerUse_Sync_2
 OpenAIResponseClient responseClient = openAIClient.GetOpenAIResponseClient(modelDeploymentName);
 ResponseCreationOptions responseOptions = new();
 responseOptions.SetAgentReference(new AgentReference(name: agentVersion.Name));
@@ -218,7 +218,7 @@ Console.WriteLine(response.GetOutputText());
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_CreateResponse_ComputerUse_Async
+```C# Snippet:Sample_CreateResponse_ComputerUse_Async_2
 OpenAIResponseClient responseClient = openAIClient.GetOpenAIResponseClient(modelDeploymentName);
 ResponseCreationOptions responseOptions = new();
 responseOptions.SetAgentReference(new AgentReference(name: agentVersion.Name));
@@ -262,11 +262,11 @@ Console.WriteLine(response.GetOutputText());
 7. Clean up resources by deleting Agent and uploaded files.
 
 Synchronous sample:
-```C# Snippet:Sample_Cleanup_ComputerUse_Sync
+```C# Snippet:Sample_Cleanup_ComputerUse_Sync_2
 client.DeleteAgentVersion(agentName: agentVersion.Name, agentVersion: agentVersion.Version);
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_Cleanup_ComputerUse_Async
+```C# Snippet:Sample_Cleanup_ComputerUse_Async_2
 await client.DeleteAgentVersionAsync(agentName: agentVersion.Name, agentVersion: agentVersion.Version);
 ```

sdk/ai/Azure.AI.Agents/samples/Sample10_ComputerUse.md

@@ -4,7 +4,7 @@ In this example we will create the local file, upload it to Azure and will use i
 
 1. First, we need to create agent client and read the environment variables, which will be used in the next steps.
 
-```C# Snippet:Sample_CreateAgentClient_FileSearch_Streaming
+```C# Snippet:Sample_CreateAgentClient_FileSearch_Streaming_2
 var projectEndpoint = System.Environment.GetEnvironmentVariable("PROJECT_ENDPOINT");
 var modelDeploymentName = System.Environment.GetEnvironmentVariable("MODEL_DEPLOYMENT_NAME");
 AgentClient client = new(endpoint: new Uri(projectEndpoint), tokenProvider: new DefaultAzureCredential());
@@ -14,7 +14,7 @@ OpenAIClient openAIClient = client.GetOpenAIClient();
 2. We will create a toy example file and upload it using OpenAI mechanism.
 
 Synchronous sample: 
-```C# Snippet:Sample_UploadFile_FileSearch_Streaming_Sync
+```C# Snippet:Sample_UploadFile_FileSearch_Streaming_Sync_2
 string filePath = "sample_file_for_upload.txt";
 File.WriteAllText(
     path: filePath,
@@ -25,7 +25,7 @@ File.Delete(filePath);
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_UploadFile_FileSearch_Streaming_Async
+```C# Snippet:Sample_UploadFile_FileSearch_Streaming_Async_2
 string filePath = "sample_file_for_upload.txt";
 File.WriteAllText(
     path: filePath,
@@ -38,7 +38,7 @@ File.Delete(filePath);
 3. Create the `VectorStore` and provide it with uploaded file ID.
 
 Synchronous sample:
-```C# Snippet:Sample_CreateVectorStore_FileSearch_Streaming_Sync
+```C# Snippet:Sample_CreateVectorStore_FileSearch_Streaming_Sync_2
 VectorStoreClient vctStoreClient = openAIClient.GetVectorStoreClient();
 VectorStoreCreationOptions options = new()
 {
@@ -49,7 +49,7 @@ VectorStore vectorStore = vctStoreClient.CreateVectorStore(options);
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_CreateVectorStore_FileSearch_Streaming_Async
+```C# Snippet:Sample_CreateVectorStore_FileSearch_Streaming_Async_2
 VectorStoreClient vctStoreClient = openAIClient.GetVectorStoreClient();
 VectorStoreCreationOptions options = new()
 {
@@ -62,7 +62,7 @@ VectorStore vectorStore = await vctStoreClient.CreateVectorStoreAsync(options);
 2. Now we can create an agent capable of using File search. 
 
 Synchronous sample:
-```C# Snippet:Sample_CreateAgent_FileSearch_Streaming_Sync
+```C# Snippet:Sample_CreateAgent_FileSearch_Streaming_Sync_2
 PromptAgentDefinition agentDefinition = new(model: modelDeploymentName)
 {
     Instructions = "You are a helpful agent that can help fetch data from files you know about.",
@@ -75,7 +75,7 @@ AgentVersion agentVersion = client.CreateAgentVersion(
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_CreateAgent_FileSearch_Streaming_Async
+```C# Snippet:Sample_CreateAgent_FileSearch_Streaming_Async_2
 PromptAgentDefinition agentDefinition = new(model: modelDeploymentName)
 {
     Instructions = "You are a helpful agent that can help fetch data from files you know about.",
@@ -90,7 +90,7 @@ AgentVersion agentVersion = await client.CreateAgentVersionAsync(
 3. In this example we will ask a question to the file contents.
 
 Synchronous sample:
-```C# Snippet:Sample_CreateResponse_FileSearch_Streaming_Sync
+```C# Snippet:Sample_CreateResponse_FileSearch_Streaming_Sync_2
 OpenAIResponseClient responseClient = openAIClient.GetOpenAIResponseClient(modelDeploymentName);
 ResponseCreationOptions responseOptions = new();
 ConversationClient conversationClient = client.GetConversationClient();
@@ -102,7 +102,7 @@ ResponseItem request = ResponseItem.CreateUserMessageItem("Can you give me the d
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_CreateResponse_FileSearch_Streaming_Async
+```C# Snippet:Sample_CreateResponse_FileSearch_Streaming_Async_2
 OpenAIResponseClient responseClient = openAIClient.GetOpenAIResponseClient(modelDeploymentName);
 ResponseCreationOptions responseOptions = new();
 ConversationClient conversationClient = client.GetConversationClient();
@@ -115,7 +115,7 @@ ResponseItem request = ResponseItem.CreateUserMessageItem("Can you give me the d
 
 4. To format streaming response output we will create a helper method `ParseResponse`. If the stream ends up in error state, it will throw an error. 
 
-```C# Snippet:Sample_ParseResponse_FileSearch_Streaming
+```C# Snippet:Sample_ParseResponse_FileSearch_Streaming_2
 private static void ParseResponse(StreamingResponseUpdate streamResponse)
 {
     if (streamResponse is StreamingResponseCreatedUpdate createUpdate)
@@ -158,15 +158,15 @@ private static void ParseResponse(StreamingResponseUpdate streamResponse)
 5. Wait for the stream to complete.
 
 Synchronous sample:
-```C# Snippet:Sample_StreamingResponse_FileSearch_Streaming_Sync
+```C# Snippet:Sample_StreamingResponse_FileSearch_Streaming_Sync_2
 foreach (StreamingResponseUpdate streamResponse in responseClient.CreateResponseStreaming([request], responseOptions))
 {
     ParseResponse(streamResponse);
 }
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_StreamingResponse_FileSearch_Streaming_Async
+```C# Snippet:Sample_StreamingResponse_FileSearch_Streaming_Async_2
 await foreach (StreamingResponseUpdate streamResponse in responseClient.CreateResponseStreamingAsync([request], responseOptions))
 {
     ParseResponse(streamResponse);
@@ -176,7 +176,7 @@ await foreach (StreamingResponseUpdate streamResponse in responseClient.CreateRe
 6. Ask follow up question and start a new stream.
 
 Synchronous sample:
-```C# Snippet:Sample_FollowUp_FileSearch_Streaming_Sync
+```C# Snippet:Sample_FollowUp_FileSearch_Streaming_Sync_2
 Console.WriteLine("Demonstrating follow-up query with streaming...");
 request = ResponseItem.CreateUserMessageItem("What was my previous question about?");
 foreach (StreamingResponseUpdate streamResponse in responseClient.CreateResponseStreaming([request], responseOptions))
@@ -186,7 +186,7 @@ foreach (StreamingResponseUpdate streamResponse in responseClient.CreateResponse
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_FollowUp_FileSearch_Streaming_Async
+```C# Snippet:Sample_FollowUp_FileSearch_Streaming_Async_2
 Console.WriteLine("Demonstrating follow-up query with streaming...");
 request = ResponseItem.CreateUserMessageItem("What was my previous question about?");
 await foreach (StreamingResponseUpdate streamResponse in responseClient.CreateResponseStreamingAsync([request], responseOptions))
@@ -198,14 +198,14 @@ await foreach (StreamingResponseUpdate streamResponse in responseClient.CreateRe
 5. Finally, delete all the resources, we have created in this sample.
 
 Synchronous sample:
-```C# Snippet:Sample_Cleanup_FileSearch_Streaming_Sync
+```C# Snippet:Sample_Cleanup_FileSearch_Streaming_Sync_2
 client.DeleteAgentVersion(agentName: agentVersion.Name, agentVersion: agentVersion.Version);
 vctStoreClient.DeleteVectorStore(vectorStoreId: vectorStore.Id);
 fileClient.DeleteFile(uploadedFile.Id);
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_Cleanup_FileSearch_Streaming_Async
+```C# Snippet:Sample_Cleanup_FileSearch_Streaming_Async_2
 await client.DeleteAgentVersionAsync(agentName: agentVersion.Name, agentVersion: agentVersion.Version);
 await vctStoreClient.DeleteVectorStoreAsync(vectorStoreId: vectorStore.Id);
 await fileClient.DeleteFileAsync(uploadedFile.Id);

sdk/ai/Azure.AI.Agents/samples/Sample11_FileSearch_Streaming.md

@@ -4,7 +4,7 @@ In this example we will demonstrate how to get a response without an Agent in st
 
 1. First, we need to create agent client and read the environment variables, which will be used in the next steps.
 
-```C# Snippet:Sample_CreateAgentClient_ResponseStreaming
+```C# Snippet:Sample_CreateAgentClient_ResponseStreaming_2
 var projectEndpoint = System.Environment.GetEnvironmentVariable("PROJECT_ENDPOINT");
 var modelDeploymentName = System.Environment.GetEnvironmentVariable("MODEL_DEPLOYMENT_NAME");
 AgentClient client = new(endpoint: new Uri(projectEndpoint), tokenProvider: new DefaultAzureCredential());
@@ -13,15 +13,15 @@ AgentClient client = new(endpoint: new Uri(projectEndpoint), tokenProvider: new
 2. Use the client to create a `Responses`, which will be used to create `AgentResponse` object.
 
 Synchronous sample:
-```C# Snippet:Sample_CreateResponseStreaming
+```C# Snippet:Sample_CreateResponseStreaming_2
 OpenAIClient openAIClient = client.GetOpenAIClient();
 OpenAIResponseClient responseClient = openAIClient.GetOpenAIResponseClient(modelDeploymentName);
 ```
 
 3. Stream the results; raise the error if the request was not successful.
 
 Synchronous sample:
-```C# Snippet:Sample_WriteOutput_ResponseStreaming_Sync
+```C# Snippet:Sample_WriteOutput_ResponseStreaming_Sync_2
 foreach (StreamingResponseUpdate streamResponse in responsesClient.CreateResponseStreaming("What is the size of France in square miles?"))
 {
     if (streamResponse is StreamingResponseCreatedUpdate createUpdate)
@@ -44,7 +44,7 @@ foreach (StreamingResponseUpdate streamResponse in responsesClient.CreateRespons
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_WriteOutput_ResponseStreaming_Async
+```C# Snippet:Sample_WriteOutput_ResponseStreaming_Async2
 await foreach (StreamingResponseUpdate streamResponse in responseClient.CreateResponseStreamingAsync("What is the size of France in square miles?"))
 {
     if (streamResponse is StreamingResponseCreatedUpdate createUpdate)

sdk/ai/Azure.AI.Agents/samples/Sample12_ResponseStreaming.md

@@ -4,7 +4,7 @@ In this example we will demonstrate how to generate an image based on prompt.
 
 1. First, we need to create agent client and read the environment variables, which will be used in the next steps.
 
-```C# Snippet:Sample_CreateClient_ImageGeneration
+```C# Snippet:Sample_CreateClient_ImageGeneration_2
 var projectEndpoint = System.Environment.GetEnvironmentVariable("PROJECT_ENDPOINT");
 var modelDeploymentName = System.Environment.GetEnvironmentVariable("MODEL_DEPLOYMENT_NAME");
 var imageGenerationModelName = System.Environment.GetEnvironmentVariable("IMAGE_GENERATION_DEPLOYMENT_NAME");
@@ -14,7 +14,7 @@ AgentClient client = new(endpoint: new Uri(projectEndpoint), tokenProvider: new
 2. Use the client to create the versioned agent object. To generate images, we need to provide agent with the `ImageGenerationTool` when we are creating this tool. The `ImageGenerationTool` parameters include the image generation model, image quality and resolution. Supported image generation models are `gpt-image-1` and `gpt-image-1-mini`.
 
 Synchronous sample:
-```C# Snippet:Sample_CreateAgent_ImageGeneration_Sync
+```C# Snippet:Sample_CreateAgent_ImageGeneration_Sync_2
 PromptAgentDefinition agentDefinition = new(model: modelDeploymentName)
 {
     Instructions = "Generate images based on user prompts.",
@@ -32,7 +32,7 @@ AgentVersion agentVersion = client.CreateAgentVersion(
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_CreateAgent_ImageGeneration_Async
+```C# Snippet:Sample_CreateAgent_ImageGeneration_Async_2
 PromptAgentDefinition agentDefinition = new(model: modelDeploymentName)
 {
     Instructions = "Generate images based on user prompts.",
@@ -51,7 +51,7 @@ AgentVersion agentVersion = await client.CreateAgentVersionAsync(
 
 3. To use image generation, we will need to provide the custom header to web requests, containing model deployment name, for example `x-ms-oai-image-generation-deployment: gpt-image-1`. To implement it we need to create custom header policy.
 
-```C# Snippet:Sample_CustomHeader_ImageGeneration
+```C# Snippet:Sample_CustomHeader_ImageGeneration_2
 internal class HeaderPolicy(string image_deployment) : PipelinePolicy
 {
     private const string image_deployment_header = "x-ms-oai-image-generation-deployment";
@@ -74,7 +74,7 @@ internal class HeaderPolicy(string image_deployment) : PipelinePolicy
 4. Use the policy to create the `OpenAIClient` object and create the `OpenAIResponseClient` by asking the Agent to generate the image.
 
 Synchronous sample:
-```C# Snippet:Sample_GetResponse_ImageGeneration_Sync
+```C# Snippet:Sample_GetResponse_ImageGeneration_Sync_2
 OpenAIClientOptions options = new();
 options.AddPolicy(new HeaderPolicy(imageGenerationModelName), PipelinePosition.PerCall);
 OpenAIClient openAIClient = client.GetOpenAIClient(options: options);
@@ -89,7 +89,7 @@ OpenAIResponse response = responseClient.CreateResponse(
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_GetResponse_ImageGeneration_Async
+```C# Snippet:Sample_GetResponse_ImageGeneration_Async_2
 OpenAIClientOptions options = new();
 options.AddPolicy(new HeaderPolicy(imageGenerationModelName), PipelinePosition.PerCall);
 OpenAIClient openAIClient = client.GetOpenAIClient(options: options);
@@ -106,7 +106,7 @@ OpenAIResponse response = await responseClient.CreateResponseAsync(
 5. Waiting for response.
 
 Synchronous sample:
-```C# Snippet:Sample_WaitForRun_ImageGeneration_Sync
+```C# Snippet:Sample_WaitForRun_ImageGeneration_Sync_2
 while (response.Status != ResponseStatus.Incomplete && response.Status != ResponseStatus.Failed && response.Status != ResponseStatus.Completed)
 {
     Thread.Sleep(TimeSpan.FromMilliseconds(500));
@@ -115,7 +115,7 @@ while (response.Status != ResponseStatus.Incomplete && response.Status != Respon
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_WaitForRun_ImageGeneration_Async
+```C# Snippet:Sample_WaitForRun_ImageGeneration_Async_2
 while (response.Status != ResponseStatus.Incomplete && response.Status != ResponseStatus.Failed && response.Status != ResponseStatus.Completed){
     await Task.Delay(TimeSpan.FromMilliseconds(500));
     response = await responseClient.GetResponseAsync(responseId:  response.Id);
@@ -124,7 +124,7 @@ while (response.Status != ResponseStatus.Incomplete && response.Status != Respon
 
 6. Parse the `OpenAIResponse` object and save the generated image.
 
-```C# Snippet:Sample_SaveImage_ImageGeneration
+```C# Snippet:Sample_SaveImage_ImageGeneration_2
 foreach (ResponseItem item in response.OutputItems)
 {
     if (item is ImageGenerationCallResponseItem imageItem)
@@ -138,11 +138,11 @@ foreach (ResponseItem item in response.OutputItems)
 7. Clean up resources by deleting the Agent.
 
 Synchronous sample:
-```C# Snippet:Sample_Cleanup_ImageGeneration_Sync
+```C# Snippet:Sample_Cleanup_ImageGeneration_Sync_2
 client.DeleteAgentVersion(agentName: agentVersion.Name, agentVersion: agentVersion.Version);
 ```
 
 Asynchronous sample:
-```C# Snippet:Sample_Cleanup_ImageGeneration_Async
+```C# Snippet:Sample_Cleanup_ImageGeneration_Async_2
 await client.DeleteAgentVersionAsync(agentName: agentVersion.Name, agentVersion: agentVersion.Version);
 ```