[TA] Adding support for PII endpoint #13687
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,204 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.ai.textanalytics; | ||
|
|
||
| import com.azure.ai.textanalytics.implementation.TextAnalyticsClientImpl; | ||
| import com.azure.ai.textanalytics.implementation.models.EntitiesResult; | ||
| import com.azure.ai.textanalytics.implementation.models.MultiLanguageBatchInput; | ||
| import com.azure.ai.textanalytics.implementation.models.WarningCodeValue; | ||
| import com.azure.ai.textanalytics.models.EntityCategory; | ||
| import com.azure.ai.textanalytics.models.PiiEntity; | ||
| import com.azure.ai.textanalytics.models.PiiEntityCollection; | ||
| import com.azure.ai.textanalytics.models.RecognizePiiEntitiesResult; | ||
| import com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions; | ||
| import com.azure.ai.textanalytics.models.TextAnalyticsWarning; | ||
| import com.azure.ai.textanalytics.models.TextDocumentInput; | ||
| import com.azure.ai.textanalytics.models.WarningCode; | ||
| import com.azure.ai.textanalytics.util.RecognizePiiEntitiesResultCollection; | ||
| import com.azure.core.http.rest.Response; | ||
| import com.azure.core.http.rest.SimpleResponse; | ||
| import com.azure.core.util.Context; | ||
| import com.azure.core.util.IterableStream; | ||
| import com.azure.core.util.logging.ClientLogger; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static com.azure.ai.textanalytics.TextAnalyticsAsyncClient.COGNITIVE_TRACING_NAMESPACE_VALUE; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.inputDocumentsValidation; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.mapToHttpResponseExceptionIfExist; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.toBatchStatistics; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.toMultiLanguageInput; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.toTextAnalyticsError; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.toTextAnalyticsException; | ||
| import static com.azure.ai.textanalytics.implementation.Utility.toTextDocumentStatistics; | ||
| import static com.azure.core.util.FluxUtil.monoError; | ||
| import static com.azure.core.util.FluxUtil.withContext; | ||
| import static com.azure.core.util.tracing.Tracer.AZ_TRACING_NAMESPACE_KEY; | ||
|
|
||
| /** | ||
| * Helper class for managing recognize Personally Identifiable Information entity endpoint. | ||
| */ | ||
| class RecognizePiiEntityAsyncClient { | ||
| private final ClientLogger logger = new ClientLogger(RecognizePiiEntityAsyncClient.class); | ||
| private final TextAnalyticsClientImpl service; | ||
|
|
||
| /** | ||
| * Create a {@link RecognizePiiEntityAsyncClient} that sends requests to the Text Analytics services's | ||
| * recognize Personally Identifiable Information entity endpoint. | ||
| * | ||
| * @param service The proxy service used to perform REST calls. | ||
| */ | ||
| RecognizePiiEntityAsyncClient(TextAnalyticsClientImpl service) { | ||
samvaity marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| this.service = service; | ||
| } | ||
|
|
||
| /** | ||
| * Helper function for calling service with max overloaded parameters that returns a {@link Mono} | ||
| * which contains {@link PiiEntityCollection}. | ||
| * | ||
| * @param document A single document. | ||
| * @param language The language code. | ||
| * | ||
| * @return The {@link Mono} of {@link PiiEntityCollection}. | ||
| */ | ||
| Mono<PiiEntityCollection> recognizePiiEntities(String document, String language) { | ||
| try { | ||
| Objects.requireNonNull(document, "'document' cannot be null."); | ||
| return recognizePiiEntitiesBatch( | ||
| Collections.singletonList(new TextDocumentInput("0", document).setLanguage(language)), null) | ||
| .map(resultCollectionResponse -> { | ||
| PiiEntityCollection entityCollection = null; | ||
| // for each loop will have only one entry inside | ||
| for (RecognizePiiEntitiesResult entitiesResult : resultCollectionResponse.getValue()) { | ||
| if (entitiesResult.isError()) { | ||
| throw logger.logExceptionAsError(toTextAnalyticsException(entitiesResult.getError())); | ||
| } | ||
| entityCollection = new PiiEntityCollection(entitiesResult.getEntities(), | ||
| entitiesResult.getEntities().getWarnings()); | ||
| } | ||
| return entityCollection; | ||
| }); | ||
| } catch (RuntimeException ex) { | ||
| return monoError(logger, ex); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Helper function for calling service with max overloaded parameters. | ||
| * | ||
| * @param documents The list of documents to recognize Personally Identifiable Information entities for. | ||
| * @param options The {@link TextAnalyticsRequestOptions} request options. | ||
| * | ||
| * @return A mono {@link Response} that contains {@link RecognizePiiEntitiesResultCollection}. | ||
| */ | ||
| Mono<Response<RecognizePiiEntitiesResultCollection>> recognizePiiEntitiesBatch( | ||
| Iterable<TextDocumentInput> documents, TextAnalyticsRequestOptions options) { | ||
| try { | ||
| inputDocumentsValidation(documents); | ||
| return withContext(context -> getRecognizePiiEntitiesResponse(documents, options, context)); | ||
| } catch (RuntimeException ex) { | ||
| return monoError(logger, ex); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Helper function for calling service with max overloaded parameters with {@link Context} is given. | ||
| * | ||
| * @param documents The list of documents to recognize Personally Identifiable Information entities for. | ||
| * @param options The {@link TextAnalyticsRequestOptions} request options. | ||
| * @param context Additional context that is passed through the Http pipeline during the service call. | ||
| * | ||
| * @return A mono {@link Response} that contains {@link RecognizePiiEntitiesResultCollection}. | ||
| */ | ||
| Mono<Response<RecognizePiiEntitiesResultCollection>> recognizePiiEntitiesBatchWithContext( | ||
| Iterable<TextDocumentInput> documents, TextAnalyticsRequestOptions options, Context context) { | ||
| try { | ||
| inputDocumentsValidation(documents); | ||
| return getRecognizePiiEntitiesResponse(documents, options, context); | ||
| } catch (RuntimeException ex) { | ||
| return monoError(logger, ex); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Helper method to convert the service response of {@link EntitiesResult} to {@link Response} which contains | ||
| * {@link RecognizePiiEntitiesResultCollection}. | ||
| * | ||
| * @param response the {@link Response} of {@link EntitiesResult} returned by the service. | ||
| * | ||
| * @return A {@link Response} that contains {@link RecognizePiiEntitiesResultCollection}. | ||
| */ | ||
| private Response<RecognizePiiEntitiesResultCollection> toRecognizePiiEntitiesResultCollectionResponse( | ||
| final Response<EntitiesResult> response) { | ||
| final EntitiesResult entitiesResult = response.getValue(); | ||
| // List of documents results | ||
| final List<RecognizePiiEntitiesResult> recognizeEntitiesResults = new ArrayList<>(); | ||
| entitiesResult.getDocuments().forEach(documentEntities -> { | ||
| // Pii entities list | ||
| final List<PiiEntity> piiEntities = documentEntities.getEntities().stream().map(entity -> | ||
| new PiiEntity(entity.getText(), EntityCategory.fromString(entity.getCategory()), | ||
| entity.getSubcategory(), entity.getConfidenceScore(), entity.getOffset(), entity.getLength())) | ||
| .collect(Collectors.toList()); | ||
| // Warnings | ||
| final List<TextAnalyticsWarning> warnings = documentEntities.getWarnings().stream() | ||
| .map(warning -> { | ||
| final WarningCodeValue warningCodeValue = warning.getCode(); | ||
| return new TextAnalyticsWarning( | ||
| WarningCode.fromString(warningCodeValue == null ? null : warningCodeValue.toString()), | ||
| warning.getMessage()); | ||
| }).collect(Collectors.toList()); | ||
|
|
||
| recognizeEntitiesResults.add(new RecognizePiiEntitiesResult( | ||
| documentEntities.getId(), | ||
| documentEntities.getStatistics() == null ? null | ||
| : toTextDocumentStatistics(documentEntities.getStatistics()), | ||
| null, | ||
| new PiiEntityCollection(new IterableStream<>(piiEntities), new IterableStream<>(warnings)) | ||
| )); | ||
| }); | ||
| // Document errors | ||
| entitiesResult.getErrors().forEach(documentError -> { | ||
| recognizeEntitiesResults.add( | ||
| new RecognizePiiEntitiesResult(documentError.getId(), null, | ||
| toTextAnalyticsError(documentError.getError()), null)); | ||
| }); | ||
|
|
||
| return new SimpleResponse<>(response, | ||
| new RecognizePiiEntitiesResultCollection(recognizeEntitiesResults, entitiesResult.getModelVersion(), | ||
| entitiesResult.getStatistics() == null ? null : toBatchStatistics(entitiesResult.getStatistics()))); | ||
| } | ||
|
|
||
| /** | ||
| * Call the service with REST response, convert to a {@link Mono} of {@link Response} that contains | ||
| * {@link RecognizePiiEntitiesResultCollection} from a {@link SimpleResponse} of {@link EntitiesResult}. | ||
| * | ||
| * @param documents The list of documents to recognize Personally Identifiable Information entities for. | ||
| * @param options The {@link TextAnalyticsRequestOptions} request options. | ||
| * @param context Additional context that is passed through the Http pipeline during the service call. | ||
| * | ||
| * @return A mono {@link Response} that contains {@link RecognizePiiEntitiesResultCollection}. | ||
| */ | ||
| private Mono<Response<RecognizePiiEntitiesResultCollection>> getRecognizePiiEntitiesResponse( | ||
| Iterable<TextDocumentInput> documents, TextAnalyticsRequestOptions options, Context context) { | ||
| return service.entitiesRecognitionPiiWithResponseAsync( | ||
| new MultiLanguageBatchInput().setDocuments(toMultiLanguageInput(documents)), | ||
| options == null ? null : options.getModelVersion(), | ||
| options == null ? null : options.isIncludeStatistics(), | ||
| null, | ||
| context.addData(AZ_TRACING_NAMESPACE_KEY, COGNITIVE_TRACING_NAMESPACE_VALUE)) | ||
| .doOnSubscribe(ignoredValue -> logger.info( | ||
| "Start recognizing Personally Identifiable Information entities for a batch of documents.")) | ||
| .doOnSuccess(response -> logger.info( | ||
| "Successfully recognized Personally Identifiable Information entities for a batch of documents.")) | ||
| .doOnError(error -> | ||
| logger.warning("Failed to recognize Personally Identifiable Information entities - {}", error)) | ||
| .map(this::toRecognizePiiEntitiesResultCollectionResponse) | ||
| .onErrorMap(throwable -> mapToHttpResponseExceptionIfExist(throwable)); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.