通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@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

描述表格或图形的题注对象。
DocumentClassifierBuildOperationDetailsOutput

获取操作响应对象。
DocumentClassifierCopyToOperationDetailsOutput

获取操作响应对象。
DocumentClassifierDetailsOutput

文档分类器信息。
DocumentFieldOutput

一个对象，表示字段值的内容和位置。
DocumentFieldSchema

使用 JSON 架构样式语法描述字段语义架构。
DocumentFieldSchemaOutput

使用 JSON 架构样式语法描述字段语义架构。
DocumentFigureOutput

一个对象，表示文档中的图。
DocumentFootnoteOutput

描述表格或图形的脚注对象。
DocumentFormulaOutput

公式对象。
DocumentIntelligenceClientOptions

客户端的可选参数
DocumentIntelligenceErrorOutput

错误对象。
DocumentIntelligenceErrorResponseOutput

错误响应对象。
DocumentIntelligenceInnerErrorOutput

包含有关错误的更具体信息的对象。
DocumentIntelligenceOperationDetailsOutputParent

操作信息。
DocumentIntelligenceResourceDetailsOutput

有关当前资源的常规信息。
DocumentIntelligenceWarningOutput

错误对象。
DocumentKeyValueElementOutput

一个对象，表示键值对中的字段键或值。
DocumentKeyValuePairOutput

一个对象，表示具有不同字段标签（键）和字段值（可能为空）的窗体字段。
DocumentLanguageOutput

一个对象，表示给定文本范围的检测到的语言。
DocumentLineOutput

内容行对象，由相邻的内容元素序列（如字词和选择标记）组成。
DocumentModelBuildOperationDetailsOutput

获取操作响应对象。
DocumentModelComposeOperationDetailsOutput

获取操作响应对象。
DocumentModelCopyToOperationDetailsOutput

获取操作响应对象。
DocumentModelDetailsOutput

文档模型信息。
DocumentPageOutput

从输入页中提取的内容和布局元素。
DocumentParagraphOutput

包含连续线条的段落对象通常具有常见的对齐和间距。
DocumentSectionOutput

一个对象，表示文档中的节。
DocumentSelectionMarkOutput

表示复选框、单选按钮和其他指示所选内容的元素的选择标记对象。
DocumentSpanOutput

串联内容属性的连续区域，指定为偏移量和长度。
DocumentStyleOutput

表示观察到的文本样式的对象。
DocumentTableCellOutput

一个对象，表示表单元格的位置和内容。
DocumentTableOutput

一个表格对象，该对象由排列在矩形布局中的表格单元格组成。
DocumentTypeDetails

文档类型信息。
DocumentTypeDetailsOutput

文档类型信息。
DocumentWordOutput

由连续字符序列组成的单词对象。 对于非空格分隔语言（如中文、日语和朝鲜语），每个字符都表示为自己的单词。
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

用于推断响应类型中分页元素的帮助程序类型。此类型基于特定于 itemName 属性的 x-ms-pageable 的 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 对象的帮助程序函数，以帮助轮询长时间运行的操作。
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

文档智能服务终结点。

credentials

TokenCredential | KeyCredential

唯一标识客户端凭据

options
DocumentIntelligenceClientOptions

所有可选参数的参数

返回

DocumentIntelligenceClient

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

生成 Poller 对象的帮助程序函数，以帮助轮询长时间运行的操作。

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

包含 nextLink 和元素当前页的初始响应

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>