DeidentificationClient.DeidentifyText Method

Definition

Namespace:
Azure.Health.Deidentification
Assembly:
Azure.Health.Deidentification.dll
Package:
Azure.Health.Deidentification v1.0.0
Package:
Azure.Health.Deidentification v1.1.0-beta.1

Overloads

Name Description
DeidentifyText(RequestContent, RequestContext)

[Protocol Method] A remote procedure call (RPC) operation.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeidentifyText(DeidentificationContent, CancellationToken)

A remote procedure call (RPC) operation.

DeidentifyText(RequestContent, RequestContext)

Source:
DeidentificationClient.cs
Source:
DeidentificationClient.cs

[Protocol Method] A remote procedure call (RPC) operation.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. 
public virtual Azure.Response DeidentifyText(Azure.Core.RequestContent content, Azure.RequestContext context = default);
abstract member DeidentifyText : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
override this.DeidentifyText : Azure.Core.RequestContent * Azure.RequestContext -> Azure.Response
Public Overridable Function DeidentifyText (content As RequestContent, Optional context As RequestContext = Nothing) As Response

Parameters

content
RequestContent

The content to send as the body of the request.

context
RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Response

The response returned from the service.

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeidentifyText and parse the result.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);

using RequestContent content = RequestContent.Create(new
{
    inputText = "Hello my name is John Smith.",
    operation = "Redact",
    customizations = new
    {
        redactionFormat = "[{type}]",
    },
});
Response response = client.DeidentifyText(content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.ToString());

Applies to

DeidentifyText(DeidentificationContent, CancellationToken)

Source:
DeidentificationClient.cs
Source:
DeidentificationClient.cs

A remote procedure call (RPC) operation.

public virtual Azure.Response<Azure.Health.Deidentification.DeidentificationResult> DeidentifyText(Azure.Health.Deidentification.DeidentificationContent content, System.Threading.CancellationToken cancellationToken = default);
abstract member DeidentifyText : Azure.Health.Deidentification.DeidentificationContent * System.Threading.CancellationToken -> Azure.Response<Azure.Health.Deidentification.DeidentificationResult>
override this.DeidentifyText : Azure.Health.Deidentification.DeidentificationContent * System.Threading.CancellationToken -> Azure.Response<Azure.Health.Deidentification.DeidentificationResult>
Public Overridable Function DeidentifyText (content As DeidentificationContent, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DeidentificationResult)

Parameters

content
DeidentificationContent

Request body for de-identification operation.

cancellationToken
CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Response<DeidentificationResult>

Exceptions

ArgumentNullException

content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DeidentifyText.

Uri endpoint = new Uri("<endpoint>");
TokenCredential credential = new DefaultAzureCredential();
DeidentificationClient client = new DeidentificationClient(endpoint, credential);

DeidentificationContent content = new DeidentificationContent("Hello my name is John Smith.")
{
    OperationType = DeidentificationOperationType.Redact,
    Customizations = new DeidentificationCustomizationOptions
    {
        RedactionFormat = "[{type}]",
    },
};
Response<DeidentificationResult> response = client.DeidentifyText(content);

Remarks

A remote procedure call (RPC) operation.

Applies to