update

Author: mrbullwinkle

articles/ai-foundry/openai/includes/evaluation-python.md

@@ -23,8 +23,11 @@ async def create_eval():
     response = await asyncio.to_thread(
         requests.post,
         f'{API_ENDPOINT}/openai/v1/evals',
-        params={'api-version': f"{API_VERSION}"},
-        headers={'api-key': API_KEY},
+        params={'api-version': "preview"},
+        headers={
+            'api-key': API_KEY,
+            'aoai-evals': 'preview'
+        },
         json={
             'name': 'My Evaluation',
             'data_source_config': {
@@ -88,8 +91,11 @@ import json
 response = await asyncio.to_thread(
     requests.post,
     f'{API_ENDPOINT}/openai/v1/evals/{eval_id}/runs',
-    params={'api-version': f"{API_VERSION}"},
-    headers={'api-key': API_KEY},
+    params={'api-version': "preview"},
+    headers={
+        'api-key': API_KEY,
+        'aoai-evals': 'preview'
+    },
     json={
         "name": "No sample",
         "metadata": {
@@ -120,8 +126,11 @@ async def update_eval():
     response = await asyncio.to_thread(
         requests.post,
         f'{API_ENDPOINT}/openai/v1/evals/{eval_id}',
-        params={'api-version': f"{API_VERSION}"},
-        headers={'api-key': API_KEY},
+        params={'api-version': "preview"},
+        headers={
+            'api-key': API_KEY,
+            'aoai-evals': 'preview'
+        },
         json={
             "name": "Updated Eval Name",
             "metadata": {
@@ -147,8 +156,11 @@ async def get_eval():
     response = await asyncio.to_thread(
         requests.get,
         f'{API_ENDPOINT}/openai/v1/evals/{eval_id}',
-        params={'api-version': f"{API_VERSION}"},
-        headers={'api-key': API_KEY}
+        params={'api-version': "preview"},
+        headers={
+            'api-key': API_KEY,
+            'aoai-evals': 'preview'
+        })
 
     print(response.status_code)
     print(response.json())
@@ -167,8 +179,11 @@ async def get_eval_run():
     response = await asyncio.to_thread(
         requests.get,
         f'{API_ENDPOINT}/openai/v1/evals/eval_67fd95c864f08190817f0dff5f42f49e/runs/evalrun_67fe987a6c548190ba6f33f7cd89343d',
-        params={'api-version': f"{API_VERSION}"},
-        headers={'api-key': API_KEY})
+        params={'api-version': "preview"},
+        headers={
+            'api-key': API_KEY,
+            'aoai-evals': 'preview'
+        })
 
     print(response.status_code)
     print(json.dumps(response.json(), indent=2))
@@ -200,8 +215,11 @@ async def get_eval_list():
     response = await asyncio.to_thread(
         requests.get,
         f'{API_ENDPOINT}/openai/v1/evals',
-        params={'api-version': f"{API_VERSION}"},
-        headers={'api-key': API_KEY})
+        params={'api-version': "preview"},
+        headers={
+            'api-key': API_KEY,
+            'aoai-evals': 'preview'
+        })
 
     print(response.status_code)
     print(json.dumps(response.json(), indent=2))
@@ -220,8 +238,11 @@ async def get_eval_output_item_list():
     response = await asyncio.to_thread(
         requests.get,
         f'{API_ENDPOINT}/openai/v1/evals/eval_67fd95c864f08190817f0dff5f42f49e/runs/evalrun_67fe987a6c548190ba6f33f7cd89343d/output_items',
-        params={'api-version': f"{API_VERSION}"},
-        headers={'api-key': API_KEY})
+        params={'api-version': "preview"},
+        headers={
+            'api-key': API_KEY,
+            'aoai-evals': 'preview'
+        })
 
     print(response.status_code)
     print(json.dumps(response.json(), indent=2))

articles/ai-foundry/openai/includes/evaluation-rest.md

@@ -18,6 +18,7 @@ You can create an evaluation by specifying a data source config and the evaluati
 curl -X POST "$AZURE_OPENAI_ENDPOINT/openai/v1/evals?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" \
+  -H "aoai-evals: preview" \
   -d '{
     "name": "Math Quiz",
     "data_source_config": {
@@ -56,6 +57,7 @@ You can add new evaluation runs to the evaluation job you had created in the pre
 curl -X POST "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}/runs?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
+  -H "aoai-evals: preview" \
 ```
 
 ### Update Existing Evaluation
@@ -64,6 +66,7 @@ curl -X POST "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}/runs?api-version=
 curl -X POST "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
+  -H "aoai-evals: preview" \
 ```
 
 ## Evaluation Results
@@ -74,6 +77,7 @@ Once evaluation is complete, you can fetch the evaluation results for the evalua
 curl -X GET "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
+  -H "aoai-evals: preview" \
 ```
 
 ### Single Evaluation Run Result
@@ -84,6 +88,7 @@ Just like how you can create a single evaluation run under an existing evaluatio
 curl -X GET "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}/runs/{run-id}?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
+  -H "aoai-evals: preview" \
 ```
 
 In addition to the parameters in the examples above, you can optionally add these parameters for more specific drill-downs into the evaluation results: 
@@ -107,6 +112,7 @@ To see the list of all evaluation jobs that were created:
 curl -X GET "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}/runs?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
+  -H "aoai-evals: preview" \
 ```
 
 ### Output Details for a Run
@@ -117,6 +123,7 @@ You can view the individual outputs generated from the graders for a single eval
 curl -X GET "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}/runs/{run-id}/output_items?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY" 
+  -H "aoai-evals: preview" \
 ```
 
 If you have a particular output result you would like to see, you can specify the output item ID: 
@@ -125,4 +132,5 @@ If you have a particular output result you would like to see, you can specify th
 curl -X GET "$AZURE_OPENAI_ENDPOINT/openai/v1/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=preview" \
   -H "Content-Type: application/json" \
   -H "api-key: $AZURE_OPENAI_API_KEY"
+  -H "aoai-evals: preview" \
 ```