@azure-rest/ai-document-intelligence package

Interfaces

AddressValueOutput	Address field value.
AnalyzeBatchDocuments
AnalyzeBatchDocuments202Headers
AnalyzeBatchDocuments202Response	The request has been accepted for processing, but processing has not yet completed.
AnalyzeBatchDocumentsBodyParam
AnalyzeBatchDocumentsDefaultResponse
AnalyzeBatchDocumentsFeaturesQueryParam	This is the wrapper object for the parameter features with explode set to false and style set to form.
AnalyzeBatchDocumentsLogicalResponse	The final response for long-running analyzeBatchDocuments operation
AnalyzeBatchDocumentsMediaTypesParam
AnalyzeBatchDocumentsOutputQueryParam	This is the wrapper object for the parameter output with explode set to false and style set to form.
AnalyzeBatchDocumentsQueryFieldsQueryParam	This is the wrapper object for the parameter queryFields with explode set to false and style set to form.
AnalyzeBatchDocumentsQueryParam
AnalyzeBatchDocumentsQueryParamProperties
AnalyzeBatchDocumentsRequest	Batch document analysis parameters.
AnalyzeBatchOperationDetailOutput	Operation detail for a document in a batch analysis.
AnalyzeBatchOperationOutput	Status and result of the analyze batch operation.
AnalyzeBatchResultOutput	Batch document analysis result.
AnalyzeDocument202Headers
AnalyzeDocument202Response	The request has been accepted for processing, but processing has not yet completed.
AnalyzeDocumentBodyParam
AnalyzeDocumentDefaultResponse
AnalyzeDocumentFeaturesQueryParam	This is the wrapper object for the parameter features with explode set to false and style set to form.
AnalyzeDocumentFromStream
AnalyzeDocumentFromStream202Headers
AnalyzeDocumentFromStream202Response	The request has been accepted for processing, but processing has not yet completed.
AnalyzeDocumentFromStreamBodyParam
AnalyzeDocumentFromStreamDefaultResponse
AnalyzeDocumentFromStreamFeaturesQueryParam	This is the wrapper object for the parameter features with explode set to false and style set to form.
AnalyzeDocumentFromStreamLogicalResponse	The final response for long-running analyzeDocumentFromStream operation
AnalyzeDocumentFromStreamMediaTypesParam
AnalyzeDocumentFromStreamOutputQueryParam	This is the wrapper object for the parameter output with explode set to false and style set to form.
AnalyzeDocumentFromStreamQueryFieldsQueryParam	This is the wrapper object for the parameter queryFields with explode set to false and style set to form.
AnalyzeDocumentFromStreamQueryParam
AnalyzeDocumentFromStreamQueryParamProperties
AnalyzeDocumentLogicalResponse	The final response for long-running analyzeDocument operation
AnalyzeDocumentMediaTypesParam
AnalyzeDocumentOutputQueryParam	This is the wrapper object for the parameter output with explode set to false and style set to form.
AnalyzeDocumentQueryFieldsQueryParam	This is the wrapper object for the parameter queryFields with explode set to false and style set to form.
AnalyzeDocumentQueryParam
AnalyzeDocumentQueryParamProperties
AnalyzeDocumentRequest	Document analysis parameters.
AnalyzeOperationOutput	Status and result of the analyze operation.
AnalyzeResultOutput	Document analysis result.
AnalyzedDocumentOutput	An object describing the location and semantic content of a document.
AuthorizeClassifierCopy
AuthorizeClassifierCopy200Response	The request has succeeded.
AuthorizeClassifierCopyBodyParam
AuthorizeClassifierCopyDefaultResponse
AuthorizeClassifierCopyRequest	Request body to authorize document classifier copy.
AuthorizeCopyRequest	Request body to authorize document model copy.
AuthorizeModelCopy
AuthorizeModelCopy200Response	The request has succeeded.
AuthorizeModelCopyBodyParam
AuthorizeModelCopyDefaultResponse
AzureBlobContentSource	Azure Blob Storage content.
AzureBlobContentSourceOutput	Azure Blob Storage content.
AzureBlobFileListContentSource	File list in Azure Blob Storage.
AzureBlobFileListContentSourceOutput	File list in Azure Blob Storage.
BoundingRegionOutput	Bounding polygon on a specific page of the input.
BuildClassifier
BuildClassifier202Headers
BuildClassifier202Response	The request has been accepted for processing, but processing has not yet completed.
BuildClassifierBodyParam
BuildClassifierDefaultResponse
BuildClassifierLogicalResponse	The final response for long-running buildClassifier operation
BuildDocumentClassifierRequest	Request body to build a new custom document classifier.
BuildDocumentModelRequest	Request body to build a new custom document model.
BuildModel
BuildModel202Headers
BuildModel202Response	The request has been accepted for processing, but processing has not yet completed.
BuildModelBodyParam
BuildModelDefaultResponse
BuildModelLogicalResponse	The final response for long-running buildModel operation
ClassifierCopyAuthorization	Authorization to copy a document classifier to the specified target resource and classifierId.
ClassifierCopyAuthorizationOutput	Authorization to copy a document classifier to the specified target resource and classifierId.
ClassifierDocumentTypeDetails	Classifier document type info.
ClassifierDocumentTypeDetailsOutput	Classifier document type info.
ClassifyDocument202Headers
ClassifyDocument202Response	The request has been accepted for processing, but processing has not yet completed.
ClassifyDocumentBodyParam
ClassifyDocumentDefaultResponse
ClassifyDocumentFromStream
ClassifyDocumentFromStream202Headers
ClassifyDocumentFromStream202Response	The request has been accepted for processing, but processing has not yet completed.
ClassifyDocumentFromStreamBodyParam
ClassifyDocumentFromStreamDefaultResponse
ClassifyDocumentFromStreamLogicalResponse	The final response for long-running classifyDocumentFromStream operation
ClassifyDocumentFromStreamMediaTypesParam
ClassifyDocumentFromStreamQueryParam
ClassifyDocumentFromStreamQueryParamProperties
ClassifyDocumentLogicalResponse	The final response for long-running classifyDocument operation
ClassifyDocumentMediaTypesParam
ClassifyDocumentQueryParam
ClassifyDocumentQueryParamProperties
ClassifyDocumentRequest	Document classification parameters.
ComposeDocumentModelRequest	Request body to create a composed document model from component document models.
ComposeModel
ComposeModel202Headers
ComposeModel202Response	The request has been accepted for processing, but processing has not yet completed.
ComposeModelBodyParam
ComposeModelDefaultResponse
ComposeModelLogicalResponse	The final response for long-running composeModel operation
CopyClassifierTo
CopyClassifierTo202Headers
CopyClassifierTo202Response	The request has been accepted for processing, but processing has not yet completed.
CopyClassifierToBodyParam
CopyClassifierToDefaultResponse
CopyClassifierToLogicalResponse	The final response for long-running copyClassifierTo operation
CopyModelTo
CopyModelTo202Headers
CopyModelTo202Response	The request has been accepted for processing, but processing has not yet completed.
CopyModelToBodyParam
CopyModelToDefaultResponse
CopyModelToLogicalResponse	The final response for long-running copyModelTo operation
CurrencyValueOutput	Currency field value.
CustomDocumentModelsDetailsOutput	Details regarding custom document models.
DeleteAnalyzeBatchResult204Response	There is no content to send for this request, but the headers may be useful.
DeleteAnalyzeBatchResultDefaultResponse
DeleteAnalyzeResult204Response	There is no content to send for this request, but the headers may be useful.
DeleteAnalyzeResultDefaultResponse
DeleteClassifier204Headers
DeleteClassifier204Response	There is no content to send for this request, but the headers may be useful.
DeleteClassifierDefaultResponse
DeleteClassifierHeaderParam
DeleteClassifierHeaders
DeleteModel204Headers
DeleteModel204Response	There is no content to send for this request, but the headers may be useful.
DeleteModelDefaultResponse
DeleteModelHeaderParam
DeleteModelHeaders
DocumentBarcodeOutput	A barcode object.
DocumentCaptionOutput	A caption object describing a table or figure.
DocumentClassifierBuildOperationDetailsOutput	Get Operation response object.
DocumentClassifierCopyToOperationDetailsOutput	Get Operation response object.
DocumentClassifierDetailsOutput	Document classifier info.
DocumentFieldOutput	An object representing the content and location of a field value.
DocumentFieldSchema	Description of the field semantic schema using a JSON Schema style syntax.
DocumentFieldSchemaOutput	Description of the field semantic schema using a JSON Schema style syntax.
DocumentFigureOutput	An object representing a figure in the document.
DocumentFootnoteOutput	A footnote object describing a table or figure.
DocumentFormulaOutput	A formula object.
DocumentIntelligenceClientOptions	The optional parameters for the client
DocumentIntelligenceErrorOutput	The error object.
DocumentIntelligenceErrorResponseOutput	Error response object.
DocumentIntelligenceInnerErrorOutput	An object containing more specific information about the error.
DocumentIntelligenceOperationDetailsOutputParent	Operation info.
DocumentIntelligenceResourceDetailsOutput	General information regarding the current resource.
DocumentIntelligenceWarningOutput	The error object.
DocumentKeyValueElementOutput	An object representing the field key or value in a key-value pair.
DocumentKeyValuePairOutput	An object representing a form field with distinct field label (key) and field value (may be empty).
DocumentLanguageOutput	An object representing the detected language for a given text span.
DocumentLineOutput	A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.
DocumentModelBuildOperationDetailsOutput	Get Operation response object.
DocumentModelComposeOperationDetailsOutput	Get Operation response object.
DocumentModelCopyToOperationDetailsOutput	Get Operation response object.
DocumentModelDetailsOutput	Document model info.
DocumentPageOutput	Content and layout elements extracted from a page from the input.
DocumentParagraphOutput	A paragraph object consisting with contiguous lines generally with common alignment and spacing.
DocumentSectionOutput	An object representing a section in the document.
DocumentSelectionMarkOutput	A selection mark object representing check boxes, radio buttons, and other elements indicating a selection.
DocumentSpanOutput	Contiguous region of the concatenated content property, specified as an offset and length.
DocumentStyleOutput	An object representing observed text styles.
DocumentTableCellOutput	An object representing the location and content of a table cell.
DocumentTableOutput	A table object consisting table cells arranged in a rectangular layout.
DocumentTypeDetails	Document type info.
DocumentTypeDetailsOutput	Document type info.
DocumentWordOutput	A word object consisting of a contiguous sequence of characters. For non-space delimited languages, such as Chinese, Japanese, and Korean, each character is represented as its own word.
GetAnalyzeBatchResult
GetAnalyzeBatchResult200Response	The request has succeeded.
GetAnalyzeBatchResultDefaultResponse
GetAnalyzeResult
GetAnalyzeResult200Response	The request has succeeded.
GetAnalyzeResultDefaultResponse
GetAnalyzeResultFigure
GetAnalyzeResultFigure200Headers
GetAnalyzeResultFigure200Response	The request has succeeded.
GetAnalyzeResultFigureDefaultResponse
GetAnalyzeResultPdf
GetAnalyzeResultPdf200Headers
GetAnalyzeResultPdf200Response	The request has succeeded.
GetAnalyzeResultPdfDefaultResponse
GetClassifier
GetClassifier200Headers
GetClassifier200Response	The request has succeeded.
GetClassifierDefaultResponse
GetClassifierHeaderParam
GetClassifierHeaders
GetClassifyResult
GetClassifyResult200Response	The request has succeeded.
GetClassifyResultDefaultResponse
GetDocumentClassifierBuildOperation200Headers
GetDocumentClassifierBuildOperation200Response	The request has succeeded.
GetDocumentClassifierBuildOperationDefaultResponse
GetDocumentClassifierBuildOperationHeaderParam
GetDocumentClassifierBuildOperationHeaders
GetDocumentClassifierCopyToOperation200Headers
GetDocumentClassifierCopyToOperation200Response	The request has succeeded.
GetDocumentClassifierCopyToOperationDefaultResponse
GetDocumentClassifierCopyToOperationHeaderParam
GetDocumentClassifierCopyToOperationHeaders
GetDocumentModelBuildOperation
GetDocumentModelBuildOperation200Headers
GetDocumentModelBuildOperation200Response	The request has succeeded.
GetDocumentModelBuildOperationDefaultResponse
GetDocumentModelBuildOperationHeaderParam
GetDocumentModelBuildOperationHeaders
GetDocumentModelComposeOperation200Headers
GetDocumentModelComposeOperation200Response	The request has succeeded.
GetDocumentModelComposeOperationDefaultResponse
GetDocumentModelComposeOperationHeaderParam
GetDocumentModelComposeOperationHeaders
GetDocumentModelCopyToOperation200Headers
GetDocumentModelCopyToOperation200Response	The request has succeeded.
GetDocumentModelCopyToOperationDefaultResponse
GetDocumentModelCopyToOperationHeaderParam
GetDocumentModelCopyToOperationHeaders
GetLongRunningPollerOptions	Options for getLongRunningPoller.
GetModel
GetModel200Headers
GetModel200Response	The request has succeeded.
GetModelDefaultResponse
GetModelHeaderParam
GetModelHeaders
GetOperation200Headers
GetOperation200Response	The request has succeeded.
GetOperationDefaultResponse
GetOperationHeaderParam
GetOperationHeaders
GetResourceDetails
GetResourceDetails200Response	The request has succeeded.
GetResourceDetailsDefaultResponse
ListAnalyzeBatchResults
ListAnalyzeBatchResults200Response	The request has succeeded.
ListAnalyzeBatchResultsDefaultResponse
ListClassifiers
ListClassifiers200Headers
ListClassifiers200Response	The request has succeeded.
ListClassifiersDefaultResponse
ListClassifiersHeaderParam
ListClassifiersHeaders
ListModels
ListModels200Headers
ListModels200Response	The request has succeeded.
ListModelsDefaultResponse
ListModelsHeaderParam
ListModelsHeaders
ListOperations
ListOperations200Headers
ListOperations200Response	The request has succeeded.
ListOperationsDefaultResponse
ListOperationsHeaderParam
ListOperationsHeaders
ModelCopyAuthorization	Authorization to copy a document model to the specified target resource and modelId.
ModelCopyAuthorizationOutput	Authorization to copy a document model to the specified target resource and modelId.
PageSettings	An interface that tracks the settings for paged iteration
PagedAnalyzeBatchOperationOutput	Paged collection of AnalyzeBatchOperation items
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagedDocumentClassifierDetailsOutput	Paged collection of DocumentClassifierDetails items
PagedDocumentIntelligenceOperationDetailsOutput	Paged collection of DocumentIntelligenceOperationDetails items
PagedDocumentModelDetailsOutput	Paged collection of DocumentModelDetails items
PagingOptions	Options for the paging helper
Routes

Type Aliases

AnalyzeBatchDocumentsParameters
AnalyzeDocumentFromStreamParameters
AnalyzeDocumentParameters
AnalyzeOutputOption	Alias for AnalyzeOutputOption
AuthorizeClassifierCopyParameters
AuthorizeModelCopyParameters
BuildClassifierParameters
BuildModelParameters
ClassifyDocumentFromStreamParameters
ClassifyDocumentParameters
ComposeModelParameters
ContentSourceKind	Alias for ContentSourceKind
ContentSourceKindOutput	Alias for ContentSourceKindOutput
CopyClassifierToParameters
CopyModelToParameters
DeleteAnalyzeBatchResultParameters
DeleteAnalyzeResultParameters
DeleteClassifierParameters
DeleteModelParameters
DocumentAnalysisFeature	Alias for DocumentAnalysisFeature
DocumentAnalysisFeatureOutput	Alias for DocumentAnalysisFeatureOutput
DocumentBarcodeKindOutput	Alias for DocumentBarcodeKindOutput
DocumentBuildMode	Alias for DocumentBuildMode
DocumentBuildModeOutput	Alias for DocumentBuildModeOutput
DocumentContentFormat	Alias for DocumentContentFormat
DocumentContentFormatOutput	Alias for DocumentContentFormatOutput
DocumentFieldType	Alias for DocumentFieldType
DocumentFieldTypeOutput	Alias for DocumentFieldTypeOutput
DocumentFontStyleOutput	Alias for DocumentFontStyleOutput
DocumentFontWeightOutput	Alias for DocumentFontWeightOutput
DocumentFormulaKindOutput	Alias for DocumentFormulaKindOutput
DocumentIntelligenceClient
DocumentIntelligenceOperationDetailsOutput	Operation info.
DocumentIntelligenceOperationStatusOutput	Alias for DocumentIntelligenceOperationStatusOutput
DocumentSelectionMarkStateOutput	Alias for DocumentSelectionMarkStateOutput
DocumentSignatureTypeOutput	Alias for DocumentSignatureTypeOutput
DocumentTableCellKindOutput	Alias for DocumentTableCellKindOutput
GetAnalyzeBatchResultParameters
GetAnalyzeResultFigureParameters
GetAnalyzeResultParameters
GetAnalyzeResultPdfParameters
GetArrayType	Helper type to extract the type of an array
GetClassifierParameters
GetClassifyResultParameters
GetDocumentClassifierBuildOperationParameters
GetDocumentClassifierCopyToOperationParameters
GetDocumentModelBuildOperationParameters
GetDocumentModelComposeOperationParameters
GetDocumentModelCopyToOperationParameters
GetModelParameters
GetOperationParameters
GetPage	The type of a custom function that defines how to get a page and a link to the next one if any.
GetResourceDetailsParameters
LengthUnitOutput	Alias for LengthUnitOutput
ListAnalyzeBatchResultsParameters
ListClassifiersParameters
ListModelsParameters
ListOperationsParameters
OperationKindOutput	Alias for OperationKindOutput
PaginateReturn	Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
ParagraphRoleOutput	Alias for ParagraphRoleOutput
SplitMode	Alias for SplitMode
SplitModeOutput	Alias for SplitModeOutput
StringIndexType	Alias for StringIndexType
StringIndexTypeOutput	Alias for StringIndexTypeOutput

Functions

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)	Initialize a new instance of DocumentIntelligenceClient
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, GetLongRunningPollerOptions)	Helper function that builds a Poller object to help polling a long running operation.
getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, GetLongRunningPollerOptions)
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, GetLongRunningPollerOptions)
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, GetLongRunningPollerOptions)
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, GetLongRunningPollerOptions)
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, GetLongRunningPollerOptions)
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
isUnexpected(GetResourceDetails200Response | GetResourceDetailsDefaultResponse)
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
isUnexpected(DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse)
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
isUnexpected(DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse)
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
isUnexpected(ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse)
isUnexpected(GetModel200Response | GetModelDefaultResponse)
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension
parseResultIdFromResponse({ headers: { operation-location: string } })	Returns the operation-id from the initialResponse header
streamToUint8Array(ReadableStream)	Converts a NodeJS.ReadableStream to a Uint8Array.

Function Details

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

Initialize a new instance of DocumentIntelligenceClient

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient

Parameters

endpointParam

string

The Document Intelligence service endpoint.

credentials

TokenCredential | KeyCredential

uniquely identify client credential

options

DocumentIntelligenceClientOptions

the parameter for all optional parameters

Returns

DocumentIntelligenceClient

getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, GetLongRunningPollerOptions)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

Client to use for sending the request to get additional pages.

initialResponse

AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse

The initial response.

options

GetLongRunningPollerOptions

Options to set a resume state or custom polling interval.

Returns

PollerLike<OperationState<TResult>, TResult>

• A poller object to poll for operation state updates and eventually get the final response.

getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

BuildModel202Response | BuildModelDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

ComposeModel202Response | ComposeModelDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

CopyModelTo202Response | CopyModelToDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

BuildClassifier202Response | BuildClassifierDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

CopyClassifierTo202Response | CopyClassifierToDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, GetLongRunningPollerOptions)

function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: GetLongRunningPollerOptions): PollerLike<OperationState<TResult>, TResult>

Parameters

client

Client

initialResponse

ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse

options

GetLongRunningPollerOptions

Returns

PollerLike<OperationState<TResult>, TResult>

isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)

function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response

Parameters

response

ListOperations200Response | ListOperationsDefaultResponse

Returns

response

isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response

Parameters

response

GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse

Returns

response

isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response

Parameters

response

GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse

Returns

response

isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response

Parameters

response

GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse

Returns

response

isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)

function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response

Parameters

response

GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse

Returns

response

isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)

function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response

Parameters

response

GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse

Returns

response

isUnexpected(GetOperation200Response | GetOperationDefaultResponse)

function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response

Parameters

response

GetOperation200Response | GetOperationDefaultResponse

Returns

response

isUnexpected(GetResourceDetails200Response | GetResourceDetailsDefaultResponse)

function isUnexpected(response: GetResourceDetails200Response | GetResourceDetailsDefaultResponse): response

Parameters

response

GetResourceDetails200Response | GetResourceDetailsDefaultResponse

Returns

response

isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)

function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response

Parameters

response

GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse

Returns

response

isUnexpected(DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse)

function isUnexpected(response: DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse): response

Parameters

response

DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse

Returns

response

isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)

function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response

Parameters

response

GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse

Returns

response

isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)

function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response

Parameters

response

GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse

Returns

response

isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)

function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response

Parameters

response

AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse

Returns

response

isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)

function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response

Parameters

response

AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse

Returns

response

isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)

function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response

Parameters

response

GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse

Returns

response

isUnexpected(DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse)

function isUnexpected(response: DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse): response

Parameters

response

DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse

Returns

response

isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)

function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response

Parameters

response

AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse

Returns

response

isUnexpected(ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse)

function isUnexpected(response: ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse): response

Parameters

response

ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse

Returns

response

isUnexpected(GetModel200Response | GetModelDefaultResponse)

function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response

Parameters

response

GetModel200Response | GetModelDefaultResponse

Returns

response

isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)

function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response

Parameters

response

DeleteModel204Response | DeleteModelDefaultResponse

Returns

response

isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)

function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response

Parameters

response

BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse

Returns

response

isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)

function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response

Parameters

response

ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse

Returns

response

isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)

function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response

Parameters

response

AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse

Returns

response

isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)

function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response

Parameters

response

CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse

Returns

response

isUnexpected(ListModels200Response | ListModelsDefaultResponse)

function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response

Parameters

response

ListModels200Response | ListModelsDefaultResponse

Returns

response

isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)

function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response

Parameters

response

BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse

Returns

response

isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)

function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response

Parameters

response

ListClassifiers200Response | ListClassifiersDefaultResponse

Returns

response

isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)

function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response

Parameters

response

GetClassifier200Response | GetClassifierDefaultResponse

Returns

response

isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)

function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response

Parameters

response

DeleteClassifier204Response | DeleteClassifierDefaultResponse

Returns

response

isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)

function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response

Parameters

response

ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse

Returns

response

isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)

function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response

Parameters

response

ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse

Returns

response

isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)

function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response

Parameters

response

GetClassifyResult200Response | GetClassifyResultDefaultResponse

Returns

response

isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)

function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response

Parameters

response

AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse

Returns

response

isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)

function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response

Parameters

response

CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client

Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator to iterate the elements

parseResultIdFromResponse({ headers: { operation-location: string } })

Returns the operation-id from the initialResponse header

function parseResultIdFromResponse(initialResponse: { headers: { operation-location: string } }): string

Parameters

initialResponse

{ headers: { operation-location: string } }

Returns

string

streamToUint8Array(ReadableStream)

Converts a NodeJS.ReadableStream to a Uint8Array.

function streamToUint8Array(stream: ReadableStream): Promise<Uint8Array>

Parameters

stream

ReadableStream

Returns

Promise<Uint8Array>