@azure-rest/ai-document-intelligence package
Interfaces
Type Aliases
Functions
Function Details
default(string, TokenCredential | KeyCredential, ClientOptions)
Initialize a new instance of DocumentIntelligenceClient
function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): DocumentIntelligenceClient
Parameters
- endpoint
-
string
The Document Intelligence service endpoint.
- credentials
uniquely identify client credential
- options
- ClientOptions
the parameter for all optional parameters
Returns
getLongRunningPoller<TResult>(Client, BuildModelDefaultResponse | BuildModel202Response, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
Helper function that builds a Poller object to help polling a long running operation.
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModelDefaultResponse | BuildModel202Response, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
Client to use for sending the request to get additional pages.
- initialResponse
The initial response.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Options to set a resume state or custom polling interval.
Returns
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- A poller object to poll for operation state updates and eventually get the final response.
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>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<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>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<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>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<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>>
Parameters
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<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>>
Parameters
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Returns
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelComposeOperation200Response | GetDocumentModelCopyToOperation200Response | GetDocumentClassifierBuildOperation200Response | GetOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Parameters
Returns
response
isUnexpected(AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStreamLogicalResponse | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStream202Response | AnalyzeDocument202Response | AnalyzeDocumentLogicalResponse): response
Parameters
Returns
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response)
function isUnexpected(response: BuildModelLogicalResponse | BuildModelDefaultResponse | BuildModel202Response): response
Parameters
Returns
response
isUnexpected(ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response)
function isUnexpected(response: ComposeModelLogicalResponse | ComposeModelDefaultResponse | ComposeModel202Response): response
Parameters
Returns
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Parameters
Returns
response
isUnexpected(CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response)
function isUnexpected(response: CopyModelToLogicalResponse | CopyModelToDefaultResponse | CopyModelTo202Response): response
Parameters
Returns
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Parameters
- response
Returns
response
isUnexpected(BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response)
function isUnexpected(response: BuildClassifierLogicalResponse | BuildClassifierDefaultResponse | BuildClassifier202Response): response
Parameters
Returns
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Parameters
Returns
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Parameters
Returns
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Parameters
Returns
response
isUnexpected(ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStreamLogicalResponse | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStream202Response | ClassifyDocument202Response | ClassifyDocumentLogicalResponse): response
Parameters
Returns
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Parameters
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
Azure SDK for JavaScript
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for