Add AOAI 2024-12-01-preview API version (#31934)

* Add AOAI 2024-12-01-preview API version; * Reformat file; fix spelling; * Add back status and status_details for File in authoring; * Refine the description of OYDonYourDataContextProperty; * Revert the description change; --------- Co-authored-by: Yunsong Bai <yunba@microsoft.com>
Azure · Jan 7, 2025 · 698431b · 698431b
1 parent 74157f1
commit 698431b
Show file tree

Hide file tree

Showing 201 changed files with 38,952 additions and 1 deletion.
diff --git a/...tiveservices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/azureopenai.json b/...tiveservices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/azureopenai.json
diff --git a/...tiveservices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/azureopenai.yaml b/...tiveservices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/azureopenai.yaml
diff --git a/...es/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_batch.json b/...es/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_batch.json
@@ -0,0 +1,41 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "object": "batch",
+        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
+        "endpoint": "/chat/completions",
+        "errors": null,
+        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
+        "completion_window": "24h",
+        "status": "cancelling",
+        "output_file_id": null,
+        "error_file_id": null,
+        "created_at": 1646126127,
+        "in_progress_at": 1646126130,
+        "expires_at": 1646126170,
+        "finalizing_at": null,
+        "completed_at": null,
+        "failed_at": null,
+        "expired_at": null,
+        "cancelling_at": 1646126138,
+        "cancelled_at": null,
+        "request_counts": {
+          "total": 500,
+          "completed": 100,
+          "failed": 5
+        },
+        "metadata": {
+          "batch_description": "Evaluation job"
+        }
+      }
+    }
+  }
+}
diff --git a/...es/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_batch.yaml b/...es/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_batch.yaml
@@ -0,0 +1,33 @@
+parameters:
+  endpoint: https://aoairesource.openai.azure.com
+  api-key: "{api key}"
+  api-version: 2024-12-01-preview
+  batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f
+responses:
+  "200":
+    headers: {}
+    body:
+      object: batch
+      id: batch_72a2792ef7d24ba7b82c7fe4a37e379f
+      endpoint: /chat/completions
+      errors: null
+      input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f
+      completion_window: 24h
+      status: cancelling
+      output_file_id: null
+      error_file_id: null
+      created_at: 1646126127
+      in_progress_at: 1646126130
+      expires_at: 1646126170
+      finalizing_at: null
+      completed_at: null
+      failed_at: null
+      expired_at: null
+      cancelling_at: 1646126138
+      cancelled_at: null
+      request_counts:
+        total: 500
+        completed: 100
+        failed: 5
+      metadata:
+        batch_description: Evaluation job
diff --git a/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_finetuning_job.json b/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_finetuning_job.json
@@ -0,0 +1,37 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "hyperparameters": {
+          "n_epochs": -1
+        },
+        "integrations": [
+          {
+            "type": "wandb",
+            "wandb": {
+              "project": "custom-wandb-project",
+              "tags": [
+                "project:tag",
+                "lineage"
+              ]
+            }
+          }
+        ],
+        "status": "cancelled",
+        "model": "curie",
+        "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
+        "finished_at": 1646127311,
+        "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
+        "created_at": 1646126127,
+        "object": "fine_tuning.job"
+      }
+    }
+  }
+}
diff --git a/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_finetuning_job.yaml b/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/cancel_finetuning_job.yaml
@@ -0,0 +1,34 @@
+parameters:
+  endpoint: https://aoairesource.openai.azure.com
+  api-key: '{api key}'
+  api-version: 2024-12-01-preview
+  fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f
+responses:
+  200:
+    headers: {}
+    body:
+      hyperparameters:
+        n_epochs: -1
+      suffix: 
+      seed: 
+      integrations:
+      - type: wandb
+        wandb:
+          project: custom-wandb-project
+          name: 
+          entity: 
+          tags:
+          - project:tag
+          - lineage
+      status: cancelled
+      model: curie
+      fine_tuned_model: 
+      training_file: file-181a1cbdcdcf4677ada87f63a0928099
+      validation_file: 
+      result_files: 
+      finished_at: 1646127311
+      organisation_id: 
+      error: 
+      id: ft-72a2792ef7d24ba7b82c7fe4a37e379f
+      created_at: 1646126127
+      object: fine_tuning.job
diff --git a/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_file.json b/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_file.json
@@ -0,0 +1,18 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "file-id": "file-181a1cbdcdcf4677ada87f63a0928099"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "object": "file",
+        "deleted": true,
+        "id": "file-181a1cbdcdcf4677ada87f63a0928099"
+      }
+    }
+  }
+}
diff --git a/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_file.yaml b/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_file.yaml
@@ -0,0 +1,12 @@
+parameters:
+  endpoint: https://aoairesource.openai.azure.com
+  api-key: "{api key}"
+  api-version: 2024-12-01-preview
+  file-id: file-181a1cbdcdcf4677ada87f63a0928099
+responses:
+  200:
+    headers: {}
+    body:
+      object: file
+      deleted: true
+      id: file-181a1cbdcdcf4677ada87f63a0928099
diff --git a/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_finetuning_job.json b/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_finetuning_job.json
@@ -0,0 +1,13 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "fine-tuning-job-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f"
+  },
+  "responses": {
+    "204": {
+      "headers": {}
+    }
+  }
+}
diff --git a/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_finetuning_job.yaml b/...lane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/delete_finetuning_job.yaml
@@ -0,0 +1,9 @@
+parameters:
+  endpoint: https://aoairesource.openai.azure.com
+  api-key: "{api key}"
+  api-version: 2024-12-01-preview
+  fine-tuning-job-id: ft-72a2792ef7d24ba7b82c7fe4a37e379f
+responses:
+  204:
+    headers: {}
+    body:
diff --git a/...vices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batch.json b/...vices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batch.json
@@ -0,0 +1,41 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "batch-id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "object": "batch",
+        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
+        "endpoint": "/chat/completions",
+        "errors": null,
+        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
+        "completion_window": "24h",
+        "status": "completed",
+        "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
+        "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
+        "created_at": 1646126127,
+        "in_progress_at": 1646126130,
+        "expires_at": 1646126170,
+        "finalizing_at": 1646126134,
+        "completed_at": 1646126136,
+        "failed_at": null,
+        "expired_at": null,
+        "cancelling_at": null,
+        "cancelled_at": null,
+        "request_counts": {
+          "total": 500,
+          "completed": 400,
+          "failed": 100
+        },
+        "metadata": {
+          "batch_description": "Evaluation job"
+        }
+      }
+    }
+  }
+}
diff --git a/...vices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batch.yaml b/...vices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batch.yaml
@@ -0,0 +1,33 @@
+parameters:
+  endpoint: https://aoairesource.openai.azure.com
+  api-key: "{api key}"
+  api-version: 2024-12-01-preview
+  batch-id: batch_72a2792ef7d24ba7b82c7fe4a37e379f
+responses:
+  "200":
+    headers: {}
+    body:
+      object: batch
+      id: batch_72a2792ef7d24ba7b82c7fe4a37e379f
+      endpoint: /chat/completions
+      errors: null
+      input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f
+      completion_window: 24h
+      status: completed
+      output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b
+      error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c
+      created_at: 1646126127
+      in_progress_at: 1646126130
+      expires_at: 1646126170
+      finalizing_at: 1646126134
+      completed_at: 1646126136
+      failed_at: null
+      expired_at: null
+      cancelling_at: null
+      cancelled_at: null
+      request_counts:
+        total: 500
+        completed: 400
+        failed: 100
+      metadata:
+        batch_description: Evaluation job
diff --git a/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batches.json b/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batches.json
@@ -0,0 +1,50 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "$filter": "created_at gt 1646120000 and created_at lt 1646130000 and status eq 'completed'",
+    "$orderby": "created_at asc"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "has_more": false,
+        "data": [
+          {
+            "object": "batch",
+            "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
+            "endpoint": "/chat/completions",
+            "errors": null,
+            "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
+            "completion_window": "24h",
+            "status": "completed",
+            "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
+            "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
+            "created_at": 1646126127,
+            "in_progress_at": 1646126130,
+            "expires_at": 1646126170,
+            "finalizing_at": 1646126134,
+            "completed_at": 1646126136,
+            "failed_at": null,
+            "expired_at": null,
+            "cancelling_at": null,
+            "cancelled_at": null,
+            "request_counts": {
+              "total": 500,
+              "completed": 400,
+              "failed": 100
+            },
+            "first_id": "batch_abc123",
+            "last_id": "batch_abc456",
+            "metadata": {
+              "batch_description": "Evaluation job"
+            }
+          }
+        ],
+        "object": "list"
+      }
+    }
+  }
+}
diff --git a/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batches.yaml b/...ces/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_batches.yaml
@@ -0,0 +1,39 @@
+parameters:
+  endpoint: https://aoairesource.openai.azure.com
+  api-key: "{api key}"
+  api-version: 2024-12-01-preview
+  $filter: created_at gt 1646120000 and created_at lt 1646130000 and status eq 'completed'
+  $orderby: created_at asc
+responses:
+  "200":
+    headers: {}
+    body:
+      has_more: false
+      data:
+        - object: batch
+          id: batch_72a2792ef7d24ba7b82c7fe4a37e379f
+          endpoint: /chat/completions
+          errors: null
+          input_file_id: file-b4fa7277f3eb4722ac18b90f46102c3f
+          completion_window: 24h
+          status: completed
+          output_file_id: file-f2ddaf43-b48b-46dd-b264-90da10c7a85b
+          error_file_id: file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c
+          created_at: 1646126127
+          in_progress_at: 1646126130
+          expires_at: 1646126170
+          finalizing_at: 1646126134
+          completed_at: 1646126136
+          failed_at: null
+          expired_at: null
+          cancelling_at: null
+          cancelled_at: null
+          request_counts:
+            total: 500
+            completed: 400
+            failed: 100
+          first_id: batch_abc123
+          last_id: batch_abc456
+          metadata:
+            batch_description: Evaluation job
+      object: list
diff --git a/...rvices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_file.json b/...rvices/data-plane/AzureOpenAI/authoring/preview/2024-12-01-preview/examples/get_file.json
@@ -0,0 +1,21 @@
+{
+  "parameters": {
+    "endpoint": "https://aoairesource.openai.azure.com",
+    "api-key": "{api key}",
+    "api-version": "2024-12-01-preview",
+    "file-id": "file-181a1cbdcdcf4677ada87f63a0928099"
+  },
+  "responses": {
+    "200": {
+      "headers": {},
+      "body": {
+        "bytes": 140,
+        "purpose": "fine-tune",
+        "filename": "puppy.jsonl",
+        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
+        "created_at": 1646126127,
+        "object": "file"
+      }
+    }
+  }
+}