@azure-rest/ai-document-intelligence package

參考

介面

AddressValueOutput	位址域值。
AnalyzeBatchDocuments
AnalyzeBatchDocuments202Headers
AnalyzeBatchDocuments202Response	要求已接受進行處理，但尚未完成處理。
AnalyzeBatchDocumentsBodyParam
AnalyzeBatchDocumentsDefaultResponse
AnalyzeBatchDocumentsFeaturesQueryParam	這是參數的包裝函式物件 `features`，並將分解設定為 false 且樣式設定為表單。
AnalyzeBatchDocumentsLogicalResponse	長時間執行 analyzeBatchDocuments 作業的最終回應
AnalyzeBatchDocumentsMediaTypesParam
AnalyzeBatchDocumentsOutputQueryParam	這是參數的包裝函式物件 `output`，並將分解設定為 false 且樣式設定為表單。
AnalyzeBatchDocumentsQueryFieldsQueryParam	這是參數的包裝函式物件 `queryFields`，並將分解設定為 false 且樣式設定為表單。
AnalyzeBatchDocumentsQueryParam
AnalyzeBatchDocumentsQueryParamProperties
AnalyzeBatchDocumentsRequest	批次檔分析參數。
AnalyzeBatchOperationDetailOutput	批次分析中文件的作業詳細數據。
AnalyzeBatchOperationOutput	分析批次作業的狀態和結果。
AnalyzeBatchResultOutput	批次檔分析結果。
AnalyzeDocument202Headers
AnalyzeDocument202Response	要求已接受進行處理，但尚未完成處理。
AnalyzeDocumentBodyParam
AnalyzeDocumentDefaultResponse
AnalyzeDocumentFeaturesQueryParam	這是參數的包裝函式物件 `features`，並將分解設定為 false 且樣式設定為表單。
AnalyzeDocumentFromStream
AnalyzeDocumentFromStream202Headers
AnalyzeDocumentFromStream202Response	要求已接受進行處理，但尚未完成處理。
AnalyzeDocumentFromStreamBodyParam
AnalyzeDocumentFromStreamDefaultResponse
AnalyzeDocumentFromStreamFeaturesQueryParam	這是參數的包裝函式物件 `features`，並將分解設定為 false 且樣式設定為表單。
AnalyzeDocumentFromStreamLogicalResponse	長時間執行 analyzeDocumentFromStream 作業的最終回應
AnalyzeDocumentFromStreamMediaTypesParam
AnalyzeDocumentFromStreamOutputQueryParam	這是參數的包裝函式物件 `output`，並將分解設定為 false 且樣式設定為表單。
AnalyzeDocumentFromStreamQueryFieldsQueryParam	這是參數的包裝函式物件 `queryFields`，並將分解設定為 false 且樣式設定為表單。
AnalyzeDocumentFromStreamQueryParam
AnalyzeDocumentFromStreamQueryParamProperties
AnalyzeDocumentLogicalResponse	長時間執行 analyzeDocument 作業的最終回應
AnalyzeDocumentMediaTypesParam
AnalyzeDocumentOutputQueryParam	這是參數的包裝函式物件 `output`，並將分解設定為 false 且樣式設定為表單。
AnalyzeDocumentQueryFieldsQueryParam	這是參數的包裝函式物件 `queryFields`，並將分解設定為 false 且樣式設定為表單。
AnalyzeDocumentQueryParam
AnalyzeDocumentQueryParamProperties
AnalyzeDocumentRequest	檔分析參數。
AnalyzeOperationOutput	分析作業的狀態和結果。
AnalyzeResultOutput	檔分析結果。
AnalyzedDocumentOutput	物件，描述檔的位置和語意內容。
AuthorizeClassifierCopy
AuthorizeClassifierCopy200Response	要求已成功。
AuthorizeClassifierCopyBodyParam
AuthorizeClassifierCopyDefaultResponse
AuthorizeClassifierCopyRequest	要求本文以授權文件分類器複本。
AuthorizeCopyRequest	要求本文以授權檔模型複製。
AuthorizeModelCopy
AuthorizeModelCopy200Response	要求已成功。
AuthorizeModelCopyBodyParam
AuthorizeModelCopyDefaultResponse
AzureBlobContentSource	Azure Blob 記憶體內容。
AzureBlobContentSourceOutput	Azure Blob 記憶體內容。
AzureBlobFileListContentSource	Azure Blob 記憶體中的檔案清單。
AzureBlobFileListContentSourceOutput	Azure Blob 記憶體中的檔案清單。
BoundingRegionOutput	在輸入的特定頁面上系結多邊形。
BuildClassifier
BuildClassifier202Headers
BuildClassifier202Response	要求已接受進行處理，但尚未完成處理。
BuildClassifierBodyParam
BuildClassifierDefaultResponse
BuildClassifierLogicalResponse	長時間執行的 buildClassifier 作業的最終回應
BuildDocumentClassifierRequest	要求本文以建置新的自定義檔分類器。
BuildDocumentModelRequest	要求本文以建置新的自定義檔模型。
BuildModel
BuildModel202Headers
BuildModel202Response	要求已接受進行處理，但尚未完成處理。
BuildModelBodyParam
BuildModelDefaultResponse
BuildModelLogicalResponse	長時間執行的 buildModel 作業的最終回應
ClassifierCopyAuthorization	將檔案分類器複製到指定的目標資源和分類器Id的授權。
ClassifierCopyAuthorizationOutput	將檔案分類器複製到指定的目標資源和分類器Id的授權。
ClassifierDocumentTypeDetails	分類器檔類型資訊。
ClassifierDocumentTypeDetailsOutput	分類器檔類型資訊。
ClassifyDocument202Headers
ClassifyDocument202Response	要求已接受進行處理，但尚未完成處理。
ClassifyDocumentBodyParam
ClassifyDocumentDefaultResponse
ClassifyDocumentFromStream
ClassifyDocumentFromStream202Headers
ClassifyDocumentFromStream202Response	要求已接受進行處理，但尚未完成處理。
ClassifyDocumentFromStreamBodyParam
ClassifyDocumentFromStreamDefaultResponse
ClassifyDocumentFromStreamLogicalResponse	長時間執行的 classifyDocumentFromStream 作業的最終回應
ClassifyDocumentFromStreamMediaTypesParam
ClassifyDocumentFromStreamQueryParam
ClassifyDocumentFromStreamQueryParamProperties
ClassifyDocumentLogicalResponse	長時間執行的 classifyDocument 作業的最終回應
ClassifyDocumentMediaTypesParam
ClassifyDocumentQueryParam
ClassifyDocumentQueryParamProperties
ClassifyDocumentRequest	檔分類參數。
ComposeDocumentModelRequest	要求本文從元件檔模型建立撰寫的檔模型。
ComposeModel
ComposeModel202Headers
ComposeModel202Response	要求已接受進行處理，但尚未完成處理。
ComposeModelBodyParam
ComposeModelDefaultResponse
ComposeModelLogicalResponse	長時間執行的 composeModel 作業的最終回應
CopyClassifierTo
CopyClassifierTo202Headers
CopyClassifierTo202Response	要求已接受進行處理，但尚未完成處理。
CopyClassifierToBodyParam
CopyClassifierToDefaultResponse
CopyClassifierToLogicalResponse	長時間執行 copyClassifierTo 作業的最終回應
CopyModelTo
CopyModelTo202Headers
CopyModelTo202Response	要求已接受進行處理，但尚未完成處理。
CopyModelToBodyParam
CopyModelToDefaultResponse
CopyModelToLogicalResponse	長時間執行 copyModelTo 作業的最終回應
CurrencyValueOutput	貨幣域值。
CustomDocumentModelsDetailsOutput	有關自定義檔模型的詳細數據。
DeleteAnalyzeBatchResult204Response	此要求沒有內容可傳送，但標頭可能很有用。
DeleteAnalyzeBatchResultDefaultResponse
DeleteAnalyzeResult204Response	此要求沒有內容可傳送，但標頭可能很有用。
DeleteAnalyzeResultDefaultResponse
DeleteClassifier204Headers
DeleteClassifier204Response	此要求沒有內容可傳送，但標頭可能很有用。
DeleteClassifierDefaultResponse
DeleteClassifierHeaderParam
DeleteClassifierHeaders
DeleteModel204Headers
DeleteModel204Response	此要求沒有內容可傳送，但標頭可能很有用。
DeleteModelDefaultResponse
DeleteModelHeaderParam
DeleteModelHeaders
DocumentBarcodeOutput	條碼物件。
DocumentCaptionOutput	描述數據表或圖形的 caption 物件。
DocumentClassifierBuildOperationDetailsOutput	取得作業回應物件。
DocumentClassifierCopyToOperationDetailsOutput	取得作業回應物件。
DocumentClassifierDetailsOutput	檔分類器資訊。
DocumentFieldOutput	物件，表示域值的內容和位置。
DocumentFieldSchema	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFieldSchemaOutput	使用 JSON 架構樣式語法的欄位語意架構描述。
DocumentFigureOutput	物件，表示檔中的圖表。
DocumentFootnoteOutput	描述數據表或圖表的腳注物件。
DocumentFormulaOutput	公式物件。
DocumentIntelligenceClientOptions	用戶端的選擇性參數
DocumentIntelligenceErrorOutput	error 物件。
DocumentIntelligenceErrorResponseOutput	錯誤回應物件。
DocumentIntelligenceInnerErrorOutput	物件，包含有關錯誤的更特定資訊。
DocumentIntelligenceOperationDetailsOutputParent	作業資訊。
DocumentIntelligenceResourceDetailsOutput	目前資源的一般資訊。
DocumentIntelligenceWarningOutput	error 物件。
DocumentKeyValueElementOutput	物件，表示索引鍵/值組中的欄位索引鍵或值。
DocumentKeyValuePairOutput	物件，代表具有不同欄位卷標的表單域（索引鍵）和域值（可能是空的）。
DocumentLanguageOutput	物件，表示指定文字範圍的偵測到語言。
DocumentLineOutput	內容行物件，由相鄰的內容元素序列組成，例如文字和選取標記。
DocumentModelBuildOperationDetailsOutput	取得作業回應物件。
DocumentModelComposeOperationDetailsOutput	取得作業回應物件。
DocumentModelCopyToOperationDetailsOutput	取得作業回應物件。
DocumentModelDetailsOutput	檔模型資訊。
DocumentPageOutput	從輸入擷取自頁面的內容和版面配置專案。
DocumentParagraphOutput	包含連續行的段落物件，通常具有一般對齊和間距。
DocumentSectionOutput	物件，表示檔中的區段。
DocumentSelectionMarkOutput	選取標記物件，代表複選框、單選按鈕和其他表示選取範圍的元素。
DocumentSpanOutput	串連內容屬性的連續區域，指定為位移和長度。
DocumentStyleOutput	物件，表示觀察到的文字樣式。
DocumentTableCellOutput	物件，表示數據表單元格的位置和內容。
DocumentTableOutput	表格物件，包含以矩形版面配置排列的表格單元格。
DocumentTypeDetails	檔類型資訊。
DocumentTypeDetailsOutput	檔類型資訊。
DocumentWordOutput	由連續字元序列組成的 word 物件。對於非空格分隔的語言，例如中文、日文和韓文，每個字元都會以自己的單字表示。
GetAnalyzeBatchResult
GetAnalyzeBatchResult200Response	要求已成功。
GetAnalyzeBatchResultDefaultResponse
GetAnalyzeResult
GetAnalyzeResult200Response	要求已成功。
GetAnalyzeResultDefaultResponse
GetAnalyzeResultFigure
GetAnalyzeResultFigure200Headers
GetAnalyzeResultFigure200Response	要求已成功。
GetAnalyzeResultFigureDefaultResponse
GetAnalyzeResultPdf
GetAnalyzeResultPdf200Headers
GetAnalyzeResultPdf200Response	要求已成功。
GetAnalyzeResultPdfDefaultResponse
GetClassifier
GetClassifier200Headers
GetClassifier200Response	要求已成功。
GetClassifierDefaultResponse
GetClassifierHeaderParam
GetClassifierHeaders
GetClassifyResult
GetClassifyResult200Response	要求已成功。
GetClassifyResultDefaultResponse
GetDocumentClassifierBuildOperation200Headers
GetDocumentClassifierBuildOperation200Response	要求已成功。
GetDocumentClassifierBuildOperationDefaultResponse
GetDocumentClassifierBuildOperationHeaderParam
GetDocumentClassifierBuildOperationHeaders
GetDocumentClassifierCopyToOperation200Headers
GetDocumentClassifierCopyToOperation200Response	要求已成功。
GetDocumentClassifierCopyToOperationDefaultResponse
GetDocumentClassifierCopyToOperationHeaderParam
GetDocumentClassifierCopyToOperationHeaders
GetDocumentModelBuildOperation
GetDocumentModelBuildOperation200Headers
GetDocumentModelBuildOperation200Response	要求已成功。
GetDocumentModelBuildOperationDefaultResponse
GetDocumentModelBuildOperationHeaderParam
GetDocumentModelBuildOperationHeaders
GetDocumentModelComposeOperation200Headers
GetDocumentModelComposeOperation200Response	要求已成功。
GetDocumentModelComposeOperationDefaultResponse
GetDocumentModelComposeOperationHeaderParam
GetDocumentModelComposeOperationHeaders
GetDocumentModelCopyToOperation200Headers
GetDocumentModelCopyToOperation200Response	要求已成功。
GetDocumentModelCopyToOperationDefaultResponse
GetDocumentModelCopyToOperationHeaderParam
GetDocumentModelCopyToOperationHeaders
GetLongRunningPollerOptions	`getLongRunningPoller`的選項。
GetModel
GetModel200Headers
GetModel200Response	要求已成功。
GetModelDefaultResponse
GetModelHeaderParam
GetModelHeaders
GetOperation200Headers
GetOperation200Response	要求已成功。
GetOperationDefaultResponse
GetOperationHeaderParam
GetOperationHeaders
GetResourceDetails
GetResourceDetails200Response	要求已成功。
GetResourceDetailsDefaultResponse
ListAnalyzeBatchResults
ListAnalyzeBatchResults200Response	要求已成功。
ListAnalyzeBatchResultsDefaultResponse
ListClassifiers
ListClassifiers200Headers
ListClassifiers200Response	要求已成功。
ListClassifiersDefaultResponse
ListClassifiersHeaderParam
ListClassifiersHeaders
ListModels
ListModels200Headers
ListModels200Response	要求已成功。
ListModelsDefaultResponse
ListModelsHeaderParam
ListModelsHeaders
ListOperations
ListOperations200Headers
ListOperations200Response	要求已成功。
ListOperationsDefaultResponse
ListOperationsHeaderParam
ListOperationsHeaders
ModelCopyAuthorization	將檔案模型複製到指定的目標資源和modelId的授權。
ModelCopyAuthorizationOutput	將檔案模型複製到指定的目標資源和modelId的授權。
PageSettings	追蹤分頁反覆運算設定的介面
PagedAnalyzeBatchOperationOutput	AnalyzeBatchOperation 專案的分頁集合
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PagedDocumentClassifierDetailsOutput	DocumentClassifierDetails 專案的分頁集合
PagedDocumentIntelligenceOperationDetailsOutput	DocumentIntelligenceOperationDetails 專案的分頁集合
PagedDocumentModelDetailsOutput	DocumentModelDetails 專案的分頁集合
PagingOptions	分頁協助程序的選項
Routes

類型別名

AnalyzeBatchDocumentsParameters
AnalyzeDocumentFromStreamParameters
AnalyzeDocumentParameters
AnalyzeOutputOption	AnalyzeOutputOption 的別名
AuthorizeClassifierCopyParameters
AuthorizeModelCopyParameters
BuildClassifierParameters
BuildModelParameters
ClassifyDocumentFromStreamParameters
ClassifyDocumentParameters
ComposeModelParameters
ContentSourceKind	ContentSourceKind 的別名
ContentSourceKindOutput	ContentSourceKindOutput 的別名
CopyClassifierToParameters
CopyModelToParameters
DeleteAnalyzeBatchResultParameters
DeleteAnalyzeResultParameters
DeleteClassifierParameters
DeleteModelParameters
DocumentAnalysisFeature	DocumentAnalysisFeature 的別名
DocumentAnalysisFeatureOutput	DocumentAnalysisFeatureOutput 的別名
DocumentBarcodeKindOutput	DocumentBarcodeKindOutput 的別名
DocumentBuildMode	DocumentBuildMode 的別名
DocumentBuildModeOutput	DocumentBuildModeOutput 的別名
DocumentContentFormat	DocumentContentFormat 的別名
DocumentContentFormatOutput	DocumentContentFormatOutput 的別名
DocumentFieldType	DocumentFieldType 的別名
DocumentFieldTypeOutput	DocumentFieldTypeOutput 的別名
DocumentFontStyleOutput	DocumentFontStyleOutput 的別名
DocumentFontWeightOutput	DocumentFontWeightOutput 的別名
DocumentFormulaKindOutput	DocumentFormulaKindOutput 的別名
DocumentIntelligenceClient
DocumentIntelligenceOperationDetailsOutput	作業資訊。
DocumentIntelligenceOperationStatusOutput	DocumentIntelligenceOperationStatusOutput 的別名
DocumentSelectionMarkStateOutput	DocumentSelectionMarkStateOutput 的別名
DocumentSignatureTypeOutput	DocumentSignatureTypeOutput 的別名
DocumentTableCellKindOutput	DocumentTableCellKindOutput 的別名
GetAnalyzeBatchResultParameters
GetAnalyzeResultFigureParameters
GetAnalyzeResultParameters
GetAnalyzeResultPdfParameters
GetArrayType	用來擷取數位型別的協助程序類型
GetClassifierParameters
GetClassifyResultParameters
GetDocumentClassifierBuildOperationParameters
GetDocumentClassifierCopyToOperationParameters
GetDocumentModelBuildOperationParameters
GetDocumentModelComposeOperationParameters
GetDocumentModelCopyToOperationParameters
GetModelParameters
GetOperationParameters
GetPage	自定義函式的類型，定義如何取得頁面，以及下一個頁面的連結，如果有的話。
GetResourceDetailsParameters
LengthUnitOutput	LengthUnitOutput 的別名
ListAnalyzeBatchResultsParameters
ListClassifiersParameters
ListModelsParameters
ListOperationsParameters
OperationKindOutput	OperationKindOutput 的別名
PaginateReturn	協助程式類型，從回應類型推斷分頁元素的類型這個類型是根據 x-ms-pageable 的 Swagger 資訊，特別是 itemName 屬性上的 swagger 資訊，指出找到頁面專案之回應的屬性。預設值為 `value`。此類型可讓我們根據我們取得作為第二個參數的回應，提供強型別反覆運算器
ParagraphRoleOutput	ParagraphRoleOutput 的別名
SplitMode	SplitMode 的別名
SplitModeOutput	SplitModeOutput 的別名
StringIndexType	StringIndexType 的別名
StringIndexTypeOutput	StringIndexTypeOutput 的別名

函式

default(string, TokenCredential \| KeyCredential, DocumentIntelligenceClientOptions)	初始化 `DocumentIntelligenceClient` 的新實例
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response \| AnalyzeBatchDocumentsDefaultResponse, GetLongRunningPollerOptions)	建置 Poller 物件的 Helper 函式，以協助輪詢長時間執行的作業。
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>)	協助程式，從遵循 Autorest `x-ms-pageable` 擴充功能規格的初始回應分頁結果
parseResultIdFromResponse({ headers: { operation-location: string } })	從 initialResponse 標頭傳回 operation-id
streamToUint8Array(ReadableStream)	將 NodeJS.ReadableStream 轉換為 Uint8Array。

函式詳細資料

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

初始化 DocumentIntelligenceClient 的新實例

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

參數

endpointParam: string

Document Intelligence 服務端點。

credentials: TokenCredential | KeyCredential

唯一識別客戶端認證

options: DocumentIntelligenceClientOptions

所有選擇性參數的參數

傳回

DocumentIntelligenceClient

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

建置 Poller 物件的 Helper 函式，以協助輪詢長時間執行的作業。

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

參數

client: Client

用來傳送要求以取得其他頁面的用戶端。

initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse

初始回應。

options: GetLongRunningPollerOptions

設定繼續狀態或自定義輪詢間隔的選項。

傳回

PollerLike<OperationState<TResult>, TResult>

輪詢作業狀態更新的輪詢器對象，最終會取得最終回應。

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

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

參數

client: Client

initialResponse: BuildModel202Response | BuildModelDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

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

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

參數

client: Client

initialResponse: ComposeModel202Response | ComposeModelDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

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

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

參數

client: Client

initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

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

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

參數

client: Client

initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

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

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

參數

client: Client

initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

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

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

參數

client: Client

initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

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

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

參數

client: Client

initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse

options: GetLongRunningPollerOptions

傳回

PollerLike<OperationState<TResult>, TResult>

isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)

function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response

參數

response: ListOperations200Response | ListOperationsDefaultResponse

傳回

response

isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response

參數

response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse

傳回

response

isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response

參數

response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse

傳回

response

isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)

function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response

參數

response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse

傳回

response

isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)

function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response

參數

response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse

傳回

response

isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)

function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response

參數

response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse

傳回

response

isUnexpected(GetOperation200Response | GetOperationDefaultResponse)

function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response

參數

response: GetOperation200Response | GetOperationDefaultResponse

傳回

response

isUnexpected(GetResourceDetails200Response | GetResourceDetailsDefaultResponse)

function isUnexpected(response: GetResourceDetails200Response | GetResourceDetailsDefaultResponse): response

參數

response: GetResourceDetails200Response | GetResourceDetailsDefaultResponse

傳回

response

isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)

function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response

參數

response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse

傳回

response

isUnexpected(DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse)

function isUnexpected(response: DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse): response

參數

response: DeleteAnalyzeResult204Response | DeleteAnalyzeResultDefaultResponse

傳回

response

isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)

function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response

參數

response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse

傳回

response

isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)

function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response

參數

response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse

傳回

response

isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)

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

參數

response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse

傳回

response

isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)

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

參數

response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse

傳回

response

isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)

function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response

參數

response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse

傳回

response

isUnexpected(DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse)

function isUnexpected(response: DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse): response

參數

response: DeleteAnalyzeBatchResult204Response | DeleteAnalyzeBatchResultDefaultResponse

傳回

response

isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)

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

參數

response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse

傳回

response

isUnexpected(ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse)

function isUnexpected(response: ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse): response

參數

response: ListAnalyzeBatchResults200Response | ListAnalyzeBatchResultsDefaultResponse

傳回

response

isUnexpected(GetModel200Response | GetModelDefaultResponse)

function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response

參數

response: GetModel200Response | GetModelDefaultResponse

傳回

response

isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)

function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response

參數

response: DeleteModel204Response | DeleteModelDefaultResponse

傳回

response

isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)

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

參數

response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse

傳回

response

isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)

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

參數

response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse

傳回

response

isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)

function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response

參數

response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse

傳回

response

isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)

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

參數

response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse

傳回

response

isUnexpected(ListModels200Response | ListModelsDefaultResponse)

function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response

參數

response: ListModels200Response | ListModelsDefaultResponse

傳回

response

isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)

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

參數

response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse

傳回

response

isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)

function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response

參數

response: ListClassifiers200Response | ListClassifiersDefaultResponse

傳回

response

isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)

function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response

參數

response: GetClassifier200Response | GetClassifierDefaultResponse

傳回

response

isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)

function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response

參數

response: DeleteClassifier204Response | DeleteClassifierDefaultResponse

傳回

response

isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)

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

參數

response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse

傳回

response

isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)

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

參數

response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse

傳回

response

isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)

function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response

參數

response: GetClassifyResult200Response | GetClassifyResultDefaultResponse

傳回

response

isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)

function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response

參數

response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse

傳回

response

isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)

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

參數

response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse

傳回

response

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

協助程式，從遵循 Autorest x-ms-pageable 擴充功能規格的初始回應分頁結果

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

參數

client: Client

用來傳送下一個頁面要求的用戶端

initialResponse: TResponse

包含專案下一頁和目前頁面的初始回應

options: PagingOptions<TResponse>

傳回

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

PagedAsyncIterableIterator 來反覆運算元素

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

從 initialResponse 標頭傳回 operation-id

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

參數

initialResponse: { headers: { operation-location: string } }

傳回

string

streamToUint8Array(ReadableStream)

將 NodeJS.ReadableStream 轉換為 Uint8Array。

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

參數

stream: ReadableStream

傳回

Promise<Uint8Array>

共用方式為

@azure-rest/ai-document-intelligence package

介面

類型別名

函式

函式詳細資料

default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)

參數

傳回

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

參數

傳回

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)

參數