Merge pull request #269525 from mrbullwinkle/mrb_03_19_2024_content_filter

[Azure OpenAI] update

Author: prmerger-automator[bot]

articles/ai-services/openai/concepts/content-filter.md

@@ -325,7 +325,7 @@ import os
 from openai import AzureOpenAI
 client = AzureOpenAI(
     api_key=os.getenv("AZURE_OPENAI_API_KEY"),  
-    api_version="2023-10-01-preview",
+    api_version="2024-03-01-preview",
     azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT") 
     )
 
@@ -339,6 +339,93 @@ response = client.completions.create(
 print(response.model_dump_json(indent=2))
 ```
 
+### Output
+
+```json
+{ 
+  "choices": [ 
+    { 
+      "content_filter_results": { 
+        "hate": { 
+          "filtered": false, 
+          "severity": "safe" 
+        }, 
+        "protected_material_code": { 
+          "citation": { 
+            "URL": " https://github.com/username/repository-name/path/to/file-example.txt", 
+            "license": "EXAMPLE-LICENSE" 
+          }, 
+          "detected": true,
+          "filtered": false 
+        }, 
+        "protected_material_text": { 
+          "detected": false, 
+          "filtered": false 
+        }, 
+        "self_harm": { 
+          "filtered": false, 
+          "severity": "safe" 
+        }, 
+        "sexual": { 
+          "filtered": false, 
+          "severity": "safe" 
+        }, 
+        "violence": { 
+          "filtered": false, 
+          "severity": "safe" 
+        } 
+      }, 
+      "finish_reason": "stop", 
+      "index": 0, 
+      "message": { 
+        "content": "Example model response will be returned ", 
+        "role": "assistant" 
+      } 
+    } 
+  ], 
+  "created": 1699386280, 
+  "id": "chatcmpl-8IMI4HzcmcK6I77vpOJCPt0Vcf8zJ", 
+  "model": "gpt-35-turbo-instruct", 
+  "object": "text.completion",
+  "usage": { 
+    "completion_tokens": 40, 
+    "prompt_tokens": 11, 
+    "total_tokens": 417 
+  },  
+  "prompt_filter_results": [ 
+    { 
+      "content_filter_results": { 
+        "hate": { 
+          "filtered": false, 
+          "severity": "safe" 
+        }, 
+        "jailbreak": { 
+          "detected": false, 
+          "filtered": false 
+        }, 
+        "profanity": { 
+          "detected": false, 
+          "filtered": false 
+        }, 
+        "self_harm": { 
+          "filtered": false, 
+          "severity": "safe" 
+        }, 
+        "sexual": { 
+          "filtered": false, 
+          "severity": "safe" 
+        }, 
+        "violence": { 
+          "filtered": false, 
+          "severity": "safe" 
+        } 
+      }, 
+      "prompt_index": 0 
+    } 
+  ]
+} 
+```
+
 # [OpenAI Python 0.28.1](#tab/python)
 
 ```python
@@ -348,11 +435,11 @@ import os
 import openai
 openai.api_type = "azure"
 openai.api_base = os.getenv("AZURE_OPENAI_ENDPOINT") 
-openai.api_version = "2023-06-01-preview" # API version required to use Annotations
+openai.api_version = "2024-03-01-preview" # API version required to use Annotations
 openai.api_key = os.getenv("AZURE_OPENAI_API_KEY")
 
 response = openai.Completion.create(
-    engine="gpt-35-turbo", # engine = "deployment_name".
+    engine="gpt-35-turbo-instruct", # engine = "deployment_name".
     messages=[{"role": "system", "content": "You are a helpful assistant."}, {"role": "user", "content": "Example prompt that leads to a protected code completion that was detected, but not filtered"}]     # Content that is detected at severity level medium or high is filtered, 
     # while content detected at severity level low isn't filtered by the content filters.
 )
@@ -407,8 +494,13 @@ print(response)
   ], 
   "created": 1699386280, 
   "id": "chatcmpl-8IMI4HzcmcK6I77vpOJCPt0Vcf8zJ", 
-  "model": "gpt-35-turbo", 
-  "object": "chat.completion", 
+  "model": "gpt-35-turbo-instruct", 
+  "object": "text.completion",
+  "usage": { 
+    "completion_tokens": 40, 
+    "prompt_tokens": 11, 
+    "total_tokens": 417 
+  },  
   "prompt_filter_results": [ 
     { 
       "content_filter_results": { 
@@ -439,12 +531,7 @@ print(response)
       }, 
       "prompt_index": 0 
     } 
-  ], 
-  "usage": { 
-    "completion_tokens": 40, 
-    "prompt_tokens": 11, 
-    "total_tokens": 417 
-  } 
+  ]
 } 
 ```
 
@@ -457,7 +544,7 @@ import os
 import openai
 openai.api_type = "azure"
 openai.api_base = os.getenv("AZURE_OPENAI_ENDPOINT") 
-openai.api_version = "2023-06-01-preview" # API version required to use  Annotations
+openai.api_version = "2024-03-01-preview" # API version required to use  Annotations
 openai.api_key = os.getenv("AZURE_OPENAI_API_KEY")
 
 try: