com.azure.ai.textanalytics.util

Class RecognizePiiEntitiesResultCollection

java.lang.Object

com.azure.core.util.IterableStream<RecognizePiiEntitiesResult>

com.azure.ai.textanalytics.util.RecognizePiiEntitiesResultCollection

All Implemented Interfaces:

Iterable<RecognizePiiEntitiesResult>

public final class RecognizePiiEntitiesResultCollection
extends com.azure.core.util.IterableStream<RecognizePiiEntitiesResult>

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

Constructor Summary

Constructors

Constructor and 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 class com.azure.core.util.IterableStream

iterator, of, stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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 Detail

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.

Returns:

The batch statistics of response.