com.azure.ai.textanalytics.util

Class AnalyzeSentimentResultCollection

java.lang.Object

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

com.azure.ai.textanalytics.util.AnalyzeSentimentResultCollection

All Implemented Interfaces:

Iterable<AnalyzeSentimentResult>

public class AnalyzeSentimentResultCollection
extends com.azure.core.util.IterableStream<AnalyzeSentimentResult>

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

Constructor Summary

Constructors

Constructor and Description
AnalyzeSentimentResultCollection(Iterable<AnalyzeSentimentResult> documentResults, String modelVersion, TextDocumentBatchStatistics statistics) Creates a AnalyzeSentimentResultCollection model that maintains a list of AnalyzeSentimentResult 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

AnalyzeSentimentResultCollection

public AnalyzeSentimentResultCollection(Iterable<AnalyzeSentimentResult> documentResults,
                                        String modelVersion,
                                        TextDocumentBatchStatistics statistics)

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

Parameters:

documentResults - A list of AnalyzeSentimentResult.

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.