你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
@azure-rest/ai-document-intelligence package
接口
类型别名
函数
函数详细信息
default(string, TokenCredential | KeyCredential, ClientOptions)
初始化 的新实例 DocumentIntelligenceClient
function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentIntelligenceClient
参数
- endpoint
-
string
文档智能服务终结点。
- credentials
唯一标识客户端凭据
- options
- ClientOptions
所有可选参数的 参数
返回
getLongRunningPoller<TResult>(Client, BuildModelDefaultResponse | BuildModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
帮助程序函数,生成 Poller 对象以帮助轮询长时间运行的操作。
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModelDefaultResponse | BuildModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
参数
- client
- Client
用于发送请求以获取其他页面的客户端。
- initialResponse
初始响应。
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
用于设置恢复状态或自定义轮询间隔的选项。
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
- 轮询器对象,用于轮询操作状态更新并最终获取最终响应。
getLongRunningPoller<TResult>(Client, ComposeModelDefaultResponse | ComposeModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModelDefaultResponse | ComposeModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
参数
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, CopyModelToDefaultResponse | CopyModelTo202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelToDefaultResponse | CopyModelTo202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
参数
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, BuildClassifierDefaultResponse | BuildClassifier202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifierDefaultResponse | BuildClassifier202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
参数
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
参数
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
参数
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
返回
Promise<@azure/core-lro.SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
参数
返回
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
参数
返回
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response
参数
返回
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
参数
返回
response
isUnexpected(AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse): response
参数
返回
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
参数
- response
返回
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
参数
- response
返回
response
isUnexpected(BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response)
function isUnexpected(response: BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response): response
参数
返回
response
isUnexpected(ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response)
function isUnexpected(response: ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response): response
参数
返回
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
参数
返回
response
isUnexpected(CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response)
function isUnexpected(response: CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response): response
参数
返回
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
参数
- response
返回
response
isUnexpected(BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response)
function isUnexpected(response: BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response): response
参数
返回
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
参数
返回
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
参数
返回
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
参数
返回
response
isUnexpected(ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse): response
参数
返回
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
参数
返回
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