RecognizePiiEntitiesResultCollection Class

Package:: com.azure.ai.textanalytics.util

Maven Artifact:: com.azure:azure-ai-textanalytics:5.5.12

java.lang.Object
- com.azure.core.util.IterableStream<T>
- - com.azure.ai.textanalytics.util.RecognizePiiEntitiesResultCollection

public final class RecognizePiiEntitiesResultCollection
extends IterableStream<RecognizePiiEntitiesResult>

A collection model that contains a list of RecognizePiiEntitiesResult along with model version and batch's statistics.

Constructor Summary

Constructor	Description
RecognizePiiEntitiesResultCollection(Iterable<RecognizePiiEntitiesResult> documentResults, String modelVersion, TextDocumentBatchStatistics statistics)	Creates a `RecognizePiiEntitiesResultCollection` model that maintains a list of RecognizePiiEntitiesResult along with model version and batch's statistics.

Method Summary

Modifier and Type	Method and Description
String	getModelVersion() Gets the model version trained in service for the request.
TextDocumentBatchStatistics	getStatistics() Gets the batch statistics of response.

Methods inherited from IterableStream

<T>of iterator stream

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RecognizePiiEntitiesResultCollection

public RecognizePiiEntitiesResultCollection(Iterable<RecognizePiiEntitiesResult> documentResults, String modelVersion, TextDocumentBatchStatistics statistics)

Creates a RecognizePiiEntitiesResultCollection model that maintains a list of RecognizePiiEntitiesResult along with model version and batch's statistics.

Parameters:

documentResults - A list of RecognizePiiEntitiesResult.

modelVersion - The model version trained in service for the request.

statistics - The batch statistics of response.

Method Details

getModelVersion

public String getModelVersion()

Gets the model version trained in service for the request.

Returns:

The model version trained in service for the request.

getStatistics

public TextDocumentBatchStatistics getStatistics()

Gets the batch statistics of response.