Share via

PagedAnalyzeHealthcareEntitiesResult interface

  • Reference
Package:
@azure/ai-text-analytics

The results of a healthcare operation represented as a paged iterator that can either iterate over the results on a document-by-document basis or, by byPage(), can iterate over pages of documents.

Extends
PagedAsyncIterableAnalyzeHealthcareEntitiesResult

Properties

modelVersion

The version of the text analytics model used by this operation on this batch of input documents.
statistics

Statistics about the input document batch and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.

Inherited Properties

byPage

Return an AsyncIterableIterator that works a page at a time

Inherited Methods

next()

The next method, part of the iteration protocol
[asyncIterator]()

The connection to the async iterator, part of the iteration protocol

Property Details

modelVersion

The version of the text analytics model used by this operation on this batch of input documents.

modelVersion: string

Property Value

string

statistics

Statistics about the input document batch and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.

statistics?: TextDocumentBatchStatistics

Property Value

TextDocumentBatchStatistics

Inherited Property Details

byPage

Return an AsyncIterableIterator that works a page at a time

byPage: (settings?: PageSettings) => AsyncIterableIterator<AnalyzeHealthcareEntitiesResultArray>

Property Value

(settings?: PageSettings) => AsyncIterableIterator<AnalyzeHealthcareEntitiesResultArray>

Inherited From PagedAsyncIterableAnalyzeHealthcareEntitiesResult.byPage

Inherited Method Details

next()

The next method, part of the iteration protocol

function next(): Promise<IteratorResult<AnalyzeHealthcareEntitiesResult, any>>

Returns

Promise<IteratorResult<AnalyzeHealthcareEntitiesResult, any>>

Inherited From PagedAsyncIterableAnalyzeHealthcareEntitiesResult.next

[asyncIterator]()

The connection to the async iterator, part of the iteration protocol

function [asyncIterator](): PagedAsyncIterableIterator<AnalyzeHealthcareEntitiesResult, AnalyzeHealthcareEntitiesResultArray, PageSettings>

Returns

PagedAsyncIterableIterator<AnalyzeHealthcareEntitiesResult, AnalyzeHealthcareEntitiesResultArray, PageSettings>

Inherited From PagedAsyncIterableAnalyzeHealthcareEntitiesResult.__@asyncIterator@456