com.azure.ai.textanalytics.models

Class TextDocumentBatchStatistics

java.lang.Object

com.azure.ai.textanalytics.models.TextDocumentBatchStatistics

public final class TextDocumentBatchStatistics
extends Object

If TextAnalyticsRequestOptions.isIncludeStatistics() is set to true this class will will contain information about the request payload.

Constructor Summary

Constructors

Constructor and Description
TextDocumentBatchStatistics(int documentCount, int validDocumentCount, int invalidDocumentCount, long transactionCount) Creates a TextDocumentBatchStatistics model that describes the statistics of batch text.

Method Summary

Modifier and Type	Method and Description
int	getDocumentCount() Get the documentCount property: Number of documents submitted in the request.
int	getInvalidDocumentCount() Get the invalidDocumentCount property: Number of invalid documents.
long	getTransactionCount() Get the transactionCount property: Number of transactions for the request.
int	getValidDocumentCount() Get the validDocumentCount property: Number of valid documents.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextDocumentBatchStatistics

public TextDocumentBatchStatistics(int documentCount,
                                   int validDocumentCount,
                                   int invalidDocumentCount,
                                   long transactionCount)

Creates a TextDocumentBatchStatistics model that describes the statistics of batch text.

Parameters:

documentCount - The number of documents submitted in the request.

validDocumentCount - The number of valid documents. This excludes empty, over-size limit or non-supported languages documents.

invalidDocumentCount - The number of invalid documents. This includes empty, over-size limit or non-supported languages documents.

transactionCount - The number of transactions for the request.

Method Detail

getDocumentCount

public int getDocumentCount()

Get the documentCount property: Number of documents submitted in the request.

Returns:

The documentCount value.

getValidDocumentCount

public int getValidDocumentCount()

Get the validDocumentCount property: Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.

Returns:

The validDocumentCount value.

getInvalidDocumentCount

public int getInvalidDocumentCount()

Get the invalidDocumentCount property: Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.

Returns:

the invalidDocumentCount value.

getTransactionCount

public long getTransactionCount()

Get the transactionCount property: Number of transactions for the request.

Returns:

the transactionCount value.