跳转到主要内容

Microsoft Azure Health Deidentification Client Library for Python

项目描述

Azure Health Deidentification client library for Python

Azure.Health.Deidentification是一个托管服务,它允许用户对健康数据进行标记、编辑或代理。

入门

安装包

python -m pip install azure-health-deidentification

先决条件

  • 要使用此包,需要Python 3.8或更高版本。
  • 您需要一个Azure订阅来使用此包。
  • 现有的Azure Health Deidentification实例。

使用Azure Active Directory凭据创建

要使用Azure Active Directory (AAD) 令牌凭据,请提供一个从azure-identity库获得的所需凭据类型的实例。

要使用AAD进行身份验证,您必须首先使用pip安装azure-identity

设置完成后,您可以从azure.identity中选择要使用的凭据类型。例如,DefaultAzureCredential可用于对客户端进行身份验证

将 AAD 应用程序的客户端 ID、租户 ID 和客户端密钥的值设置为环境变量:AZURE_CLIENT_IDAZURE_TENANT_IDAZURE_CLIENT_SECRET

使用返回的令牌凭证对客户端进行身份验证

>>> from azure.health.deidentification import DeidentificationClient
>>> from azure.identity import DefaultAzureCredential
>>> client = DeidentificationClient(endpoint='<endpoint>', credential=DefaultAzureCredential())

关键概念

操作模式

  • 标签:将返回包含相关文本跨度 PHI 类别的偏移量和长度的结构。
  • 撤消:将返回带有占位符占位文本的输出文本。例如:[name]
  • 代理:将返回带有合成替换的输出文本。
    • 我的名字是约翰·史密斯
    • 我的名字是汤姆·琼斯

与 Azure 存储的作业集成 您可以发送 Azure 存储位置到服务,而不是发送文本。我们将异步处理文件列表,并将去标识化文件输出到您选择的任何位置。

限制

  • 每个作业的最大文件数:1000 个文档
  • 每个文件的最大文件大小:2 MB

示例

>>> from azure.health.deidentification import DeidentificationClient
>>> from azure.identity import DefaultAzureCredential
>>> from azure.core.exceptions import HttpResponseError

>>> client = DeidentificationClient(endpoint='<endpoint>', credential=DefaultAzureCredential())
>>> try:
        <!-- write test code here -->
    except HttpResponseError as e:
        print('service responds error: {}'.format(e.response.json()))

下一步

  • 发现错误或有反馈?请使用“健康去标识化”标签提出问题。

故障排除

  • 无法访问源或目标存储
    • 确保您使用系统分配的托管身份创建您的去标识化服务
    • 确保您的存储帐户已授予该托管身份权限

贡献

本项目欢迎贡献和建议。大多数贡献需要您同意贡献者许可协议(CLA),声明您有权并实际授予我们使用您贡献的权利。有关详细信息,请访问https://cla.microsoft.com

当您提交拉取请求时,CLA-bot 将自动确定您是否需要提供 CLA 并相应地装饰 PR(例如,标签、注释)。只需遵循机器人提供的说明即可。您只需在整个使用我们 CLA 的所有存储库中这样做一次。

本项目已采用Microsoft 开源行为准则。有关更多信息,请参阅行为准则 FAQ 或通过opencode@microsoft.com联系以提出任何额外的问题或评论。

项目详情


下载文件

为您的平台下载文件。如果您不确定要选择哪个,请了解更多关于安装包的信息。

源分布

azure-health-deidentification-1.0.0b1.tar.gz (58.6 kB 查看散列)

上传时间:

构建分布

azure_health_deidentification-1.0.0b1-py3-none-any.whl (60.0 kB 查看散列)

上传时间: Python 3

由以下支持