From 606aa5011f45be59e1b135950dfd670d179e1464 Mon Sep 17 00:00:00 2001 From: Josiah Vinson Date: Fri, 6 Dec 2024 17:14:28 -0800 Subject: [PATCH] Adding back Deid examples --- .../examples/CancelJob.json | 41 ++++++++++ .../examples/CreateJob.json | 75 +++++++++++++++++++ .../examples/Deidentify.json | 40 ++++++++++ .../examples/DeleteJob.json | 12 +++ .../2024-07-12-preview/examples/GetJob.json | 41 ++++++++++ .../examples/ListJobDocuments.json | 38 ++++++++++ .../2024-07-12-preview/examples/ListJobs.json | 47 ++++++++++++ 7 files changed, 294 insertions(+) create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json create mode 100644 specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CancelJob.json new file mode 100644 index 000000000000..95e12934f9f8 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/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 + } + } + } + } + } \ No newline at end of file diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/CreateJob.json new file mode 100644 index 000000000000..58a59e7cf1a0 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/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" + } + } + } + } \ No newline at end of file diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/Deidentify.json new file mode 100644 index 000000000000..1e6a1db64f25 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/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" + } + } + } + } + } \ No newline at end of file diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/DeleteJob.json new file mode 100644 index 000000000000..e6f808e9f909 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/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": {} + } + } \ No newline at end of file diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/GetJob.json new file mode 100644 index 000000000000..b3ac2f26b407 --- /dev/null +++ b/specification/healthdataaiservices/data-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 + } + } + } + } + } \ No newline at end of file diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobDocuments.json new file mode 100644 index 000000000000..865816f192d0 --- /dev/null +++ b/specification/healthdataaiservices/data-plane/HealthDataAIServices.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" + } + } + } + } \ No newline at end of file diff --git a/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json b/specification/healthdataaiservices/data-plane/HealthDataAIServices.DeidServices/preview/2024-07-12-preview/examples/ListJobs.json new file mode 100644 index 000000000000..247a15127a5a --- /dev/null +++ b/specification/healthdataaiservices/data-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" + } + } + } + } \ No newline at end of file