AnalyzeSentimentResultCollection Class

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

public class AnalyzeSentimentResultCollection
extends IterableStream<AnalyzeSentimentResult>

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

Constructor Summary

Constructor 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 IterableStream

<T>of iterator stream

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

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 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.

Returns:

The batch statistics of response.

Applies to