-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial Creation of Azure.Health.Deidentification Dataplane API Types…
…pec (#29745) * Updates HealthDataAiService.Deid with feedback from SDK Review Team (#29036) * Generate new Service for deidentification * [data-plane] Initial Creation of HealthDataAiServices.Deid 2 (#27563) Initial Creation of HealthDataAIServices Deid Service Spec. --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com> * Adds errorCode and explanation; Replaces pagination with continuationToken (#28061) * Adds errorCode and explanation; Replaces pagination with continuationToken * Updates to use standard Azure Foundation Error --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com> * Updated CompletedAt to LastUpdatedAt for all terminal states (#28349) * Updated CompletedAt to LastUpdatedAt for all terminal states * Updates examples; Moves error order * Set examples to more realistic value * Updates File model for future expansion * Adds Input FileLocation --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com> * Updates parameter validators/defaults/nullability; Replaces checksum with etag (#28528) * Updates minor tweaks * Updates examples --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com> * Updates HealthDataAiService.Deid with feedback from SDK Review Team * Updates TSPconfig for c# * Adds CSharp special * Updates version to match live version * Updates java package name * Fix java namespace name * Updates python package name * Updates to match version service is currently using * Updates package names * Removes update in cspell * Updates java namespace * Fixes cspell.json * Test1 * Convert to diff long running operation * Adds client config * Attempt base LRO * Updated naming and LRO config * Stash merge * Linter fixes; SDK related Updates * SDK Related Updates * Changes ordering of parameters; Fixes StringIndexType enum values * Removes script update * Updates examples * Don't update vscode settings * Updates examples * Fixes linter issues * Fixes documentDataType enum value to match casing within service * fix documentDataType enum value * change name of js package * changing property continuationToken because of a conflict in java * revert changes for continuationToken * Adding post processing for java --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com> Co-authored-by: Daniel Szaniszlo <daszanis@microsoft.com> * Updates linter extends value * Updates typespec with new validations for 0.57 * Fixing namespace suppression * Fixing namespace suppression 2 * Fixing namespace suppression 3 * Fixing namespace suppression 4 * Fixes formatting * Updates how StringIndices are handled * Update docstring to contain languages * Makes etag optional for PhiTaggerResult on realtime requests * Removes redundant read decorator on etag * Regenerates with new docs * Fixes formatting * Removes @secret on location * Team review updates * Renames folder to match namespace change * Updates client name after namespace change * Makes fields with defaults optional --------- Co-authored-by: Graham Thomas <gthomas@microsoft.com> Co-authored-by: Daniel Szaniszlo <daszanis@microsoft.com>
- Loading branch information
3 people
authored
Jul 17, 2024
1 parent
9280478
commit 2771da5
Showing
22 changed files
with
2,558 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
specification/healthdataaiservices/HealthDataAIServices.DeidServices/client.tsp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| import "./main.tsp"; | ||
| import "@azure-tools/typespec-client-generator-core"; | ||
|
|
||
| using Azure.ClientGenerator.Core; |
41 changes: 41 additions & 0 deletions
41
...taaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/CancelJob.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
75 changes: 75 additions & 0 deletions
75
...taaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/CreateJob.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } | ||
| } | ||
| } |
40 changes: 40 additions & 0 deletions
40
...aaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/Deidentify.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
...taaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/DeleteJob.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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": {} | ||
| } | ||
| } |
41 changes: 41 additions & 0 deletions
41
...hdataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/GetJob.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
38 changes: 38 additions & 0 deletions
38
...vices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/ListJobDocuments.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } | ||
| } | ||
| } |
47 changes: 47 additions & 0 deletions
47
...ataaiservices/HealthDataAIServices.DeidServices/examples/2024-07-12-preview/ListJobs.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
specification/healthdataaiservices/HealthDataAIServices.DeidServices/main.tsp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| import "@typespec/rest"; | ||
| import "@typespec/versioning"; | ||
| import "@azure-tools/typespec-azure-core"; | ||
| import "./routes.tsp"; | ||
|
|
||
| using TypeSpec.Http; | ||
| using TypeSpec.Rest; | ||
| using TypeSpec.Versioning; | ||
| using Azure.Core; | ||
| using Azure.Core.Traits; | ||
|
|
||
| // Official Name: Azure Health Data Services de-identification service | ||
| @useAuth(AadToken) | ||
| @service({ | ||
| title: "Azure Health Data Services de-identification service", | ||
| }) | ||
| @server( | ||
| "https://{endpoint}", | ||
| "De-identification Service service endpoint", | ||
| { | ||
| @doc("Url of your De-identification Service.") | ||
| endpoint: string, | ||
| } | ||
| ) | ||
| @versioned(HealthDataAIServices.DeidServices.Versions) | ||
| namespace HealthDataAIServices.DeidServices; | ||
|
|
||
| @doc("The Azure Active Directory OAuth2 Flow") | ||
| model AadToken | ||
| is OAuth2Auth<[ | ||
| { | ||
| type: OAuth2FlowType.authorizationCode; | ||
| authorizationUrl: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; | ||
| tokenUrl: "https://login.microsoftonline.com/common/oauth2/token"; | ||
| scopes: ["https://deid.azure.com/.default"]; | ||
| } | ||
| ]>; | ||
|
|
||
| @doc("Azure Health Data Services de-identification service versions.") | ||
| enum Versions { | ||
| @doc("Public preview release version.") | ||
| @useDependency(Azure.Core.Versions.v1_0_Preview_2) | ||
| v2024_07_12_preview: "2024-07-12-preview", | ||
| } |
Oops, something went wrong.