Deidentify Text - Deidentify Text

Service:

Health Data

Version d'API:

2024-11-15

Décochez le texte.
Opération d’appel de procédure distante (RPC).

POST {endpoint}/deid?api-version=2024-11-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL de votre service de dé-identification.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Nom	Obligatoire	Type	Description
inputText	True	string maxLength: 48000	Texte d’entrée à dé-identifier.
customizations		DeidentificationCustomizationOptions	Paramètres de personnalisation pour remplacer les comportements de service par défaut.
operation		DeidentificationOperationType	Opération à effectuer sur les documents d’entrée.

Réponses

Nom	Type	Description
200 OK	DeidentificationResult	La demande a réussi. En-têtes x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

AadToken

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://deid.azure.com/.default

Exemples

De-identify text.

Exemple de requête

HTTP

POST {endpoint}/deid?api-version=2024-11-15


{
  "inputText": "Hello my name is John Smith.",
  "operation": "Redact",
  "customizations": {
    "redactionFormat": "[{type}]"
  }
}

Exemple de réponse

Code d’état:

200

{
  "outputText": "Hello my name is [name]."
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
DeidentificationContent	Corps de la demande pour l’opération de dé-identification.
DeidentificationCustomizationOptions	Options de personnalisation pour remplacer les comportements de service par défaut pour une utilisation synchrone.
DeidentificationOperationType	Opération à effectuer sur les documents d’entrée.
DeidentificationResult	Corps de réponse pour l’opération de dé-identification.
PhiCategory	Liste des entités PHI.
PhiEntity	Balise d’entité PHI dans l’entrée.
PhiTaggerResult	Résultat de l’opération « Balise ».
StringIndex	Modèle d’encodage d’index de chaîne.

Azure.Core.Foundations.Error

Object

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Object

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

DeidentificationContent

Object

Corps de la demande pour l’opération de dé-identification.

Nom	Type	Valeur par défaut	Description
customizations	DeidentificationCustomizationOptions		Paramètres de personnalisation pour remplacer les comportements de service par défaut.
inputText	string maxLength: 48000		Texte d’entrée à dé-identifier.
operation	DeidentificationOperationType	Surrogate	Opération à effectuer sur les documents d’entrée.

DeidentificationCustomizationOptions

Object

Options de personnalisation pour remplacer les comportements de service par défaut pour une utilisation synchrone.

Nom	Type	Valeur par défaut	Description
redactionFormat	string minLength: 1 maxLength: 16		Format de la sortie adoptée. Valide uniquement lorsque l’opération est réacte. Pour plus d’informations, reportez-vous à https://learn.microsoft.com/azure/healthcare-apis/deidentification/redaction-format.
surrogateLocale	string	en-US	Paramètres régionaux dans lesquels les substitutions de sortie sont écrites.

DeidentificationOperationType

Énumération

Opération à effectuer sur les documents d’entrée.

Valeur	Description
Redact	L’opération d’actualisation supprime toutes les entités de PHI et les remplace par une valeur d’espace réservé.
Surrogate	L’opération de substitution remplace toutes les entités de PHI par une valeur de substitution.
Tag	L’opération de balise détecte toutes les entités de PHI, leur type et retourne leurs emplacements dans le document.

DeidentificationResult

Object

Corps de réponse pour l’opération de dé-identification.

Nom	Type	Description
outputText	string	Texte de sortie après dé-identification. Non disponible pour l’opération « Balise ».
taggerResult	PhiTaggerResult	Résultat de l’opération « Balise ». Disponible uniquement pour l’opération « Balise ».

PhiCategory

Énumération

Liste des entités PHI.

Valeur	Description
Account	Numéro de compte.
Age	Âge.
BioID	Identificateur biologique, tel qu’une empreinte digitale ou une analyse rétine.
City	Ville.
CountryOrRegion	Pays ou région.
Date	Date.
Device	ID d’appareil ou numéros de série.
Doctor	Nom du docteur.
Email	Adresses e-mail.
Fax	Numéro de télécopie.
HealthPlan	Numéros d’ID du plan d’intégrité.
Hospital	Nom de l’hôpital.
IDNum	Numéro d’ID, par exemple. numéro de passeport.
IPAddress	Adresse IP.
License	Licence, par exemple. Permis de conduire ou permis médical.
LocationOther	Emplacement Autre, par exemple. Golden Gate Park.
MedicalRecord	Numéro d’enregistrement médical.
Organization	Organisation, par exemple. Microsoft.
Patient	Nom du patient.
Phone	Numéro de téléphone.
Profession	Profession.
SocialSecurity	Numéro de sécurité sociale.
State	État.
Street	Rue.
Unknown	Type PHI inconnu.
Url	URL web.
Username	Noms d’utilisateur, par exemple. un handle de médias sociaux.
Vehicle	ID de véhicule, par exemple. plaque d’immatriculation ou numéro VIN.
Zip	Code postal.

PhiEntity

Object

Balise d’entité PHI dans l’entrée.

Nom	Type	Description
category	PhiCategory	Catégorie PHI de l’entité.
confidenceScore	number (double)	Score de confiance de la correspondance de catégorie.
length	StringIndex	Longueur du texte d’entrée.
offset	StringIndex	Index de départ de l’emplacement à partir du texte d’entrée.
text	string	Texte de l’entité.

PhiTaggerResult

Object

Résultat de l’opération « Balise ».

Nom	Type	Description
entities	PhiEntity[]	Liste des entités détectées dans l’entrée.

StringIndex

Object

Modèle d’encodage d’index de chaîne.

Nom	Type	Description
codePoint	integer (int32)	Décalage ou longueur de la sous-chaîne dans l’encodage CodePoint. Encodage principal utilisé par Python.
utf16	integer (int32)	Décalage ou longueur de la sous-chaîne dans l’encodage UTF-16. Encodage principal utilisé par .NET, Java et JavaScript.
utf8	integer (int32)	Décalage ou longueur de la sous-chaîne dans l’encodage UTF-8