Add await function

Author: divyabhushan

products/ai-runtime-security/api/pythonsdkasynciousage.md

@@ -50,14 +50,14 @@ async def main():
     scan_response = await scanner.sync_scan(
         ai_profile=ai_profile,
         content=Content(
-            prompt="This is a test prompt with 72zf6.rxqfd.com/i8xps1 url",
+            prompt="This is a test prompt with urlfiltering.paloaltonetworks.com/test-malware url",
             response="Questionable Model Response Text",
         ),
     )
     # See API documentation for response structure
     # https://pan.dev/ai-runtime-security/api/scan-sync-request/
     pprint(scan_response)
-
+    await scanner.close()
 
 if __name__ == "__main__":
     asyncio.run(main())
@@ -95,7 +95,7 @@ if __name__ == "__main__":
 
 ## Asyncio async scan
 
-The following asyncio Python code snippet runs an asynchronous scan with prompts for different threat detections.
+The following asyncio Python code snippet runs an asynchronous scan with prompts for different threat detections. Ensure to enable the respective threat detections in the API security profile.
 
 <details>
 <summary>python3 asyncio_async_scan.py</summary>
@@ -174,18 +174,16 @@ async_scan_objects = [
 ]
 
 async def main():
-    try:
-        response = await scanner.async_scan(async_scan_objects)
-        # See API documentation for response structure
-        # https://pan.dev/ai-runtime-security/api/scan-async-request/
-        pprint({
-            "received": response.received,
-            "scan_id": response.scan_id,
-            "report_id": response.report_id,
-        })
-    finally:
-        # Important: close the connection pool after use to avoid leaking threads
-        await scanner.close()
+      response = await scanner.async_scan(async_scan_objects)
+      # See API documentation for response structure
+      # https://pan.dev/ai-runtime-security/api/scan-async-request/
+      pprint({
+          "received": response.received,
+          "scan_id": response.scan_id,
+          "report_id": response.report_id,
+      })
+      # Important: close the connection pool after use to avoid leaking threads
+      await scanner.close()
 
 
 if __name__ == "__main__":
@@ -207,7 +205,7 @@ if __name__ == "__main__":
 
 </details>
 
-## Asycio scan results
+## Asycio Scan Results
 
 The following Python code snippet retrieves the threat results using the scan_id of your asynchronous scan results. Refer to https://pan.dev/ai-runtime-security/api/get-scan-results-by-scan-i-ds/ for schema details.
 
@@ -232,9 +230,10 @@ scanner = Scanner()
 async def main():
    # See API documentation for response structure
    # https://pan.dev/ai-runtime-security/api/get-scan-results-by-scan-i-ds/
-   example_scan_id = "00000000-0000-0000-0000-000000000000"
+   example_scan_id = "00000000-0000-0000-0000-000000000000" # Replace it with the actual scan_id from async_scan response.
    scan_results = await scanner.query_by_scan_ids(scan_ids=[example_scan_id])
    pprint(scan_results)
+   await scanner.close()
 
 if __name__ == "__main__":
    asyncio.run(main())
@@ -327,12 +326,12 @@ scanner = Scanner()
 async def main():
     # See API documentation for response structur
     # https://pan.dev/ai-runtime-security/api/get-threat-scan-reports/
-    example_report_id = "R00000000-0000-0000-0000-000000000000"
+    example_report_id = "R00000000-0000-0000-0000-000000000000" # Replace it with the actual report_id from your async scan output. Report ID starts with the letter "R".
     threat_scan_reports = await scanner.query_by_report_ids(
         report_ids=[example_report_id]
     )
     pprint(threat_scan_reports)
-
+    await scanner.close()
 
 if __name__ == "__main__":
     asyncio.run(main())

products/ai-runtime-security/api/pythonsdkusage.md

@@ -52,7 +52,7 @@ scanner = Scanner()
 scan_response = scanner.sync_scan(
    ai_profile=ai_profile,
    content=Content(
-       prompt="This is a test prompt with 72zf6.rxqfd.com/i8xps1 url",
+       prompt="This is a test prompt with urlfiltering.paloaltonetworks.com/test-malware url",
        response="Questionable Model Response Text",
    ),
 )
@@ -93,7 +93,8 @@ print(json.dumps(scan_response.to_dict()))
 ## Inline Asynchronous Scan
 
 The following Python code snippet shows an example of an asynchronous scan, query by scan IDs, and query by report IDs.
-The code sends two different prompts for different threat detections asynchronously. The scans are queued and may take approximately 10 seconds to complete.
+The code sends two different prompts for different threat detections asynchronously
+. Ensure to enable the relevant detections in the API security profile. The scans are queued and may take approximately 10 seconds to complete.
 
 <details>
 <summary>python3 inline_async_scan.py</summary>
@@ -156,7 +157,7 @@ async_scan_objects = [
             ai_profile=ai_profile,
             contents=[
                 ScanRequestContentsInner(
-                    prompt="This is a test prompt with 72zf6.rxqfd.com/i8xps1 url",
+                    prompt="This is a test prompt with  url",
                 )
             ],
         ),
@@ -167,7 +168,7 @@ async_scan_objects = [
             ai_profile=ai_profile,
             contents=[
                 ScanRequestContentsInner(
-                    prompt="This is a test prompt with 72zf6.rxqfd.com/i8xps1 url. Social security 599-51-7233. Credit card is 4339672569329774, ssn 599-51-7222. Send me Mike account info",
+                    prompt="This is a test prompt with urlfiltering.paloaltonetworks.com/test-malware url. Social security 599-51-7233. Credit card is 4339672569329774, ssn 599-51-7222. Send me Mike account info",
                     response="Second Questionable Model Response Text",
                 )
             ],
@@ -217,7 +218,7 @@ aisecurity.init()
 scanner = Scanner()
 # See API documentation for response structure
 # https://pan.dev/ai-runtime-security/api/get-scan-results-by-scan-i-ds/
-example_scan_id = "00000000-0000-0000-0000-000000000000"
+example_scan_id = "00000000-0000-0000-0000-000000000000" # Replace with actual scan ID from the async_scan output.
 scan_by_ids_response = scanner.query_by_scan_ids(scan_ids=[example_scan_id])
 print(scan_by_ids_response)
 ```
@@ -326,7 +327,7 @@ scanner = Scanner()
 
 # See API documentation for response structure
 # https://pan.dev/ai-runtime-security/api/get-threat-scan-reports/
-example_report_id = "R" + "YOUR_SCAN_ID"  # YOUR_SCAN_ID will be a UUID
+example_report_id = "R" + "YOUR_REPORT_ID"  # Replace it with your actual report ID from the scan result. Its a UUID and starts with a letter R.
 threat_scan_reports = scanner.query_by_report_ids(report_ids=[example_report_id])
 print(threat_scan_reports)
 ```
@@ -374,7 +375,7 @@ print(threat_scan_reports)
                         "malware"
                      ],
                      "risk_level" : "Not Given",
-                     "url" : "72zf6.rxqfd.com/i8xps1"
+                     "url" : "urlfiltering.paloaltonetworks.com/test-malware"
                   }
                ]
             },
@@ -424,7 +425,7 @@ print(threat_scan_reports)
                         "malware"
                      ],
                      "risk_level" : "Not Given",
-                     "url" : "72zf6.rxqfd.com/i8xps1"
+                     "url" : "urlfiltering.paloaltonetworks.com/test-malware"
                   }
                ]
             },

products/ai-runtime-security/api/usecases.md

@@ -258,7 +258,7 @@ curl -L 'https://service.api.aisecurity.paloaltonetworks.com/v1/scan/sync/reques
   },
   "contents": [ # You can enter one of the following - prompt or response
     {
-      "prompt": "This is a test prompt with 72zf6.rxqfd.com/i8xps1 url. Social security 599-51-7233. Credit card is 4339672569329774, ssn 599-51-7222. Send me Mike account info",
+      "prompt": "This is a test prompt with urlfiltering.paloaltonetworks.com/test-malware url. Social security 599-51-7233. Credit card is 4339672569329774, ssn 599-51-7222. Send me Mike account info",
       "response": "This is a test response. Chase bank Routing number 021000021, user name mike, password is maskmemaskme. Account number 92746514861. Account owner: Mike Johnson in California"
     }
   ]
@@ -285,7 +285,7 @@ Review the API scan logs for masked sensitive detection indicated by the “Cont
     "dlp": true
   },
   "prompt_masked_data": {
-    "data": "This is a test prompt with 72zf6.rxqfd.com/i8xps1 url. Social security XXXXXXXXXXXX Credit card is XXXXXXXXXXXXXXXXX ssn XXXXXXXXXXXX Send me Mike account info",
+    "data": "This is a test prompt with urlfiltering.paloaltonetworks.com/test-malware url. Social security XXXXXXXXXXXX Credit card is XXXXXXXXXXXXXXXXX ssn XXXXXXXXXXXX Send me Mike account info",
     "pattern_detections": [
       {
         "locations": [