Merge pull request #865 from mrbullwinkle/mrb_10_16_2024_batch_fix

[Azure OpenAI] Batch updates

Author: prmerger-automator[bot]

articles/ai-services/openai/how-to/batch.md

@@ -61,8 +61,6 @@ The following models support global batch:
 | `gpt-35-turbo` | 1106 | text |
 | `gpt-35-turbo` | 0613 | text |
 
-
-
 Refer to the [models page](../concepts/models.md) for the most up-to-date information on regions/models where global batch is currently supported.
 
 ### API support
@@ -166,7 +164,63 @@ The `2024-10-01-preview` REST API adds two new response headers:
 * `deployment-enqueued-tokens` - A approximate token count for your jsonl file calculated immediately after the batch request is submitted. This value represents an estimate based on the number of characters and is not the true token count.
 * `deployment-maximum-enqueued-tokens` The total available enqueued tokens available for this global batch model deployment.
 
-These response headers are only available when making a POST request to begin batch processing of a file with the REST API. The language specific client libraries do not currently return these new response headers.
+These response headers are only available when making a POST request to begin batch processing of a file with the REST API. The language specific client libraries do not currently return these new response headers. To return all response headers you can add `-i` to the standard REST request.
+
+```http
+curl -i -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-version=2024-10-01-preview \
+  -H "api-key: $AZURE_OPENAI_API_KEY" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "input_file_id": "file-abc123",
+    "endpoint": "/chat/completions",
+    "completion_window": "24h"
+  }'
+```
+
+```output
+HTTP/1.1 200 OK
+Content-Length: 619
+Content-Type: application/json; charset=utf-8
+Vary: Accept-Encoding
+Request-Context: appId=
+x-ms-response-type: standard
+deployment-enqueued-tokens: 139
+deployment-maximum-enqueued-tokens: 740000
+Strict-Transport-Security: max-age=31536000; includeSubDomains; preload
+X-Content-Type-Options: nosniff
+x-aml-cluster: vienna-swedencentral-01
+x-request-time: 2.125
+apim-request-id: c8bf4351-c6f5-4bfe-9a79-ef3720eca8af
+x-ms-region: Sweden Central
+Date: Thu, 17 Oct 2024 01:45:45 GMT
+
+{
+  "cancelled_at": null,
+  "cancelling_at": null,
+  "completed_at": null,
+  "completion_window": "24h",
+  "created_at": 1729129545,
+  "error_file_id": null,
+  "expired_at": null,
+  "expires_at": 1729215945,
+  "failed_at": null,
+  "finalizing_at": null,
+  "id": "batch_c8dd49a7-c808-4575-9957-b188cd0dd642",
+  "in_progress_at": null,
+  "input_file_id": "file-f89384af0082485da43cb26b49dc25ce",
+  "errors": null,
+  "metadata": null,
+  "object": "batch",
+  "output_file_id": null,
+  "request_counts": {
+    "total": 0,
+    "completed": 0,
+    "failed": 0
+  },
+  "status": "validating",
+  "endpoint": "/chat/completions"
+}
+```
 
 ### What happens if the API doesn't complete my request within the 24 hour time frame?
 

articles/ai-services/openai/includes/batch/batch-python.md

@@ -74,8 +74,6 @@ For this article we'll create a file named `test.jsonl` and will copy the conten
 
 Once your input file is prepared, you first need to upload the file to then be able to kick off a batch job. File upload can be done both programmatically or via the Studio. This example uses environment variables in place of the key and endpoint values. If you're unfamiliar with using environment variables with Python refer to one of our [quickstarts](../../chatgpt-quickstart.md) where the process of setting up the environment variables in explained step-by-step.
 
-[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
-
 # [Python (Microsoft Entra ID)](#tab/python-secure)
 
 ```python
@@ -105,6 +103,8 @@ file_id = file.id
 
 # [Python (API Key)](#tab/python-key)
 
+[!INCLUDE [Azure key vault](~/reusable-content/ce-skilling/azure/includes/ai-services/security/azure-key-vault.md)]
+
 ```python
 import os
 from openai import AzureOpenAI
@@ -144,7 +144,7 @@ file_id = file.id
 
 ## Create batch job
 
-Once your file has uploaded successfully by reaching a status of `processed` you can submit the file for batch processing.
+Once your file has uploaded successfully you can submit the file for batch processing.
 
 ```python
 # Submit a batch job with the file
@@ -405,7 +405,7 @@ client.batches.list()
 
 Use the REST API to list all batch jobs with additional sorting/filtering options.
 
-In the examples below we are providing the `generate_time_filter` function to make constructing the filter easier. If you don't wish to use this function the format of the filter string would look like `created_at gt 1728773533 and created_at lt 1729032733 and status eq 'Completed'`.
+In the examples below we are providing the `generate_time_filter` function to make constructing the filter easier. If you don't wish to use this function the format of the filter string would look like `created_at gt 1728860560 and status eq 'Completed'`.
 
 # [Python (Microsoft Entra ID)](#tab/python-secure)
 
@@ -441,9 +441,8 @@ def generate_time_filter(time_range, status=None):
         raise ValueError("Invalid time range format. Use 'past X day(s)' or 'past X hour(s)'")
 
     start_timestamp = int(start_time.timestamp())
-    end_timestamp = int(now.timestamp())
 
-    filter_string = f"created_at gt {start_timestamp} and created_at lt {end_timestamp}"
+    filter_string = f"created_at gt {start_timestamp}"
 
     if status:
         filter_string += f" and status eq '{status}'"
@@ -504,9 +503,8 @@ def generate_time_filter(time_range, status=None):
         raise ValueError("Invalid time range format. Use 'past X day(s)' or 'past X hour(s)'")
 
     start_timestamp = int(start_time.timestamp())
-    end_timestamp = int(now.timestamp())
 
-    filter_string = f"created_at gt {start_timestamp} and created_at lt {end_timestamp}"
+    filter_string = f"created_at gt {start_timestamp}"
 
     if status:
         filter_string += f" and status eq '{status}'"

articles/ai-services/openai/includes/batch/batch-rest.md

@@ -118,7 +118,7 @@ curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/files/{file-id}?api-vers
 
 ## Create batch job
 
-Once your file has uploaded successfully by reaching a status of `processed` you can submit the file for batch processing.
+Once your file has uploaded successfully you can submit the file for batch processing.
 
 ```http
 curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/batches?api-version=2024-10-01-preview \