Adding back Deid examples

Azure · Dec 7, 2024 · 606aa50 · 606aa50
1 parent ab04533
commit 606aa50
Show file tree

Hide file tree

Showing 7 changed files with 294 additions and 0 deletions.
diff --git a/...lane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json b/...lane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json
@@ -0,0 +1,41 @@
+{
+    "title": "Cancel a de-identification job.",
+    "operationId": "CancelJob",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "name": "documents_smith_1",
+      "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+    },
+    "responses": {
+      "200": {
+        "body": {
+          "name": "documents_smith_1",
+          "sourceLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents",
+            "extensions": [
+              "*"
+            ]
+          },
+          "targetLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents"
+          },
+          "operation": "Redact",
+          "dataType": "Plaintext",
+          "redactionFormat": "[{type}]",
+          "status": "Canceled",
+          "lastUpdatedAt": "2024-01-26T01:15:00.009Z",
+          "createdAt": "2024-01-25T23:27:43.009Z",
+          "startedAt": "2024-01-25T23:27:43.009Z",
+          "summary": {
+            "successful": 10,
+            "failed": 0,
+            "canceled": 2,
+            "total": 12,
+            "bytesProcessed": 4096
+          }
+        }
+      }
+    }
+  }
diff --git a/...lane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json b/...lane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json
@@ -0,0 +1,75 @@
+{
+    "title": "Create a de-identification job.",
+    "operationId": "CreateJob",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "name": "documents_smith_1",
+      "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+      "resource": {
+        "sourceLocation": {
+          "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+          "prefix": "/documents",
+          "extensions": [
+            "*"
+          ]
+        },
+        "targetLocation": {
+          "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+          "prefix": "/documents"
+        },
+        "operation": "Redact",
+        "dataType": "Plaintext",
+        "redactionFormat": "[{type}]",
+        "status": "NotStarted"
+      }
+    },
+    "responses": {
+      "200": {
+        "body": {
+          "name": "documents_smith_1",
+          "sourceLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents",
+            "extensions": [
+              "*"
+            ]
+          },
+          "targetLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents"
+          },
+          "operation": "Redact",
+          "dataType": "Plaintext",
+          "redactionFormat": "[{type}]",
+          "status": "NotStarted",
+          "lastUpdatedAt": "2024-01-26T01:15:00.009Z",
+          "createdAt": "2024-01-25T23:27:43.009Z"
+        }
+      },
+      "201": {
+        "headers": {
+          "original-uri": "https://contoso.com/operationstatus"
+        },
+        "body": {
+          "name": "documents_smith_1",
+          "sourceLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents",
+            "extensions": [
+              "*"
+            ]
+          },
+          "targetLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents"
+          },
+          "operation": "Redact",
+          "dataType": "Plaintext",
+          "redactionFormat": "[{type}]",
+          "status": "NotStarted",
+          "lastUpdatedAt": "2024-01-26T01:15:00.009Z",
+          "createdAt": "2024-01-25T23:27:43.009Z"
+        }
+      }
+    }
+  }
diff --git a/...ane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json b/...ane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json
@@ -0,0 +1,40 @@
+{
+    "title": "De-identify text.",
+    "operationId": "Deidentify",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "body": {
+        "inputText": "Hello my name is John Smith.",
+        "operation": "Redact",
+        "dataType": "Plaintext",
+        "redactionFormat": "[{type}]"
+      }
+    },
+    "responses": {
+      "200": {
+        "body": {
+          "outputText": "Hello my name is [name].",
+          "taggerResult": {
+            "entities": [
+              {
+                "category": "Patient",
+                "offset": {
+                  "utf8": 17,
+                  "utf16": 17,
+                  "codePoint": 17
+                },
+                "length": {
+                  "utf8": 10,
+                  "utf16": 10,
+                  "codePoint": 10
+                },
+                "text": "John Smith",
+                "confidenceScore": 0.83
+              }
+            ],
+            "etag": "0x000000000000000"
+          }
+        }
+      }
+    }
+  }
diff --git a/...lane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json b/...lane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json
@@ -0,0 +1,12 @@
+{
+    "title": "Delete a de-identification job.",
+    "operationId": "DeleteJob",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "name": "documents_smith_1",
+      "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+    },
+    "responses": {
+      "204": {}
+    }
+  }
diff --git a/...a-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json b/...a-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json
@@ -0,0 +1,41 @@
+{
+    "title": "Get a de-identification job.",
+    "operationId": "GetJob",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "name": "documents_smith_1",
+      "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+    },
+    "responses": {
+      "200": {
+        "body": {
+          "name": "documents_smith_1",
+          "sourceLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents",
+            "extensions": [
+              "*"
+            ]
+          },
+          "targetLocation": {
+            "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+            "prefix": "/documents"
+          },
+          "operation": "Redact",
+          "dataType": "Plaintext",
+          "redactionFormat": "[{type}]",
+          "status": "Succeeded",
+          "lastUpdatedAt": "2024-01-26T01:15:00.009Z",
+          "createdAt": "2024-01-25T23:27:43.009Z",
+          "startedAt": "2024-01-25T23:27:43.009Z",
+          "summary": {
+            "successful": 10,
+            "failed": 0,
+            "canceled": 0,
+            "total": 10,
+            "bytesProcessed": 4096
+          }
+        }
+      }
+    }
+  }
diff --git a/...althDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json b/...althDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json
@@ -0,0 +1,38 @@
+{
+    "title": "List processed documents within a job.",
+    "operationId": "ListJobDocuments",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "name": "documents_smith_1",
+      "maxpagesize": 10,
+      "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==",
+      "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+    },
+    "responses": {
+      "200": {
+        "body": {
+          "value": [
+            {
+              "id": "00000000-0000-0000-0000-000000000000",
+              "input": {
+                "path": "/documents/patient_doc_1",
+                "etag": "0x8DB638EEA0CC717"
+              },
+              "output": {
+                "path": "_output/documents/patient_doc_1",
+                "etag": "0xAB298APO23099ZL"
+              },
+              "status": "Failed",
+              "error": {
+                "code": "FileNotFound",
+                "message": "File was moved after job started.",
+                "target": "SourceFile",
+                "details": []
+              }
+            }
+          ],
+          "nextLink": "https://deidtest.api.deid.azure.com/jobs/00000000-0000-0000-0000-000000000000/files?top=10&skip=10&maxpagesize=10"
+        }
+      }
+    }
+  }
diff --git a/...plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json b/...plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json
@@ -0,0 +1,47 @@
+{
+    "title": "List de-identification jobs.",
+    "operationId": "ListJobs",
+    "parameters": {
+      "api-version": "2024-07-12-preview",
+      "maxpagesize": 10,
+      "continuationToken": "K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==",
+      "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+    },
+    "responses": {
+      "200": {
+        "body": {
+          "value": [
+            {
+              "name": "documents_smith_1",
+              "sourceLocation": {
+                "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+                "prefix": "/documents",
+                "extensions": [
+                  "*"
+                ]
+              },
+              "targetLocation": {
+                "location": "https://blobtest.blob.core.windows.net/container?sp=r&st=2024-01-24T18:11:10Z&se=2024-01-25T02:11:10Z&spr=https&sv=2022-11-02&sr=c&sig=signature%3D",
+                "prefix": "/documents"
+              },
+              "operation": "Redact",
+              "dataType": "Plaintext",
+              "redactionFormat": "[{type}]",
+              "status": "Succeeded",
+              "lastUpdatedAt": "2024-01-26T01:15:00.009Z",
+              "createdAt": "2024-01-25T23:27:43.009Z",
+              "startedAt": "2024-01-25T23:27:43.009Z",
+              "summary": {
+                "successful": 10,
+                "failed": 0,
+                "canceled": 0,
+                "total": 10,
+                "bytesProcessed": 4096
+              }
+            }
+          ],
+          "nextLink": "https://deidtest.api.deid.azure.com/jobs?top=10&skip=10&maxpagesize=10"
+        }
+      }
+    }
+  }