Package com.azure.ai.textanalytics.util

Class ExtractKeyPhrasesResultCollection

java.lang.Object

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

com.azure.ai.textanalytics.util.ExtractKeyPhrasesResultCollection

All Implemented Interfaces:

Iterable<ExtractKeyPhraseResult>

public class ExtractKeyPhrasesResultCollection
extends com.azure.core.util.IterableStream<ExtractKeyPhraseResult>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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

ExtractKeyPhrasesResultCollection

public ExtractKeyPhrasesResultCollection(Iterable<ExtractKeyPhraseResult> documentResults,
                                         String modelVersion,
                                         TextDocumentBatchStatistics statistics)

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

Parameters:

documentResults - A list of ExtractKeyPhraseResult.

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.