@azure-rest/ai-document-intelligence package
Interfaces
Type-aliassen
AnalyzeBatchDocumentsParameters | |
AnalyzeDocumentFromStreamParameters | |
AnalyzeDocumentParameters | |
AnalyzeOutputOption |
Alias voor AnalyzeOutputOption |
AuthorizeClassifierCopyParameters | |
AuthorizeModelCopyParameters | |
BuildClassifierParameters | |
BuildModelParameters | |
ClassifyDocumentFromStreamParameters | |
ClassifyDocumentParameters | |
ComposeModelParameters | |
ContentFormat |
Alias voor ContentFormat |
ContentFormatOutput |
Alias voor ContentFormatOutput |
ContentSourceKind |
Alias voor ContentSourceKind |
ContentSourceKindOutput |
Alias voor ContentSourceKindOutput |
CopyClassifierToParameters | |
CopyModelToParameters | |
DeleteClassifierParameters | |
DeleteModelParameters | |
DocumentAnalysisFeature |
Alias voor DocumentAnalysisFeature |
DocumentAnalysisFeatureOutput |
Alias voor DocumentAnalysisFeatureOutput |
DocumentBarcodeKindOutput |
Alias voor DocumentBarcodeKindOutput |
DocumentBuildMode |
Alias voor DocumentBuildMode |
DocumentBuildModeOutput |
Alias voor DocumentBuildModeOutput |
DocumentFieldType |
Alias voor DocumentFieldType |
DocumentFieldTypeOutput |
Alias voor DocumentFieldTypeOutput |
DocumentFormulaKindOutput |
Alias voor DocumentFormulaKindOutput |
DocumentIntelligenceClient | |
DocumentSelectionMarkStateOutput |
Alias voor DocumentSelectionMarkStateOutput |
DocumentSignatureTypeOutput |
Alias voor DocumentSignatureTypeOutput |
DocumentTableCellKindOutput |
Alias voor DocumentTableCellKindOutput |
FontStyleOutput |
Alias voor FontStyleOutput |
FontWeightOutput |
Alias voor FontWeightOutput |
GetAnalyzeBatchResultParameters | |
GetAnalyzeResultFigureParameters | |
GetAnalyzeResultParameters | |
GetAnalyzeResultPdfParameters | |
GetArrayType |
Helpertype voor het extraheren van het type matrix |
GetClassifierParameters | |
GetClassifyResultParameters | |
GetDocumentClassifierBuildOperationParameters | |
GetDocumentClassifierCopyToOperationParameters | |
GetDocumentModelBuildOperationParameters | |
GetDocumentModelComposeOperationParameters | |
GetDocumentModelCopyToOperationParameters | |
GetModelParameters | |
GetOperationParameters | |
GetPage |
Het type aangepaste functie waarmee wordt gedefinieerd hoe u een pagina en een koppeling naar de volgende krijgt, indien van toepassing. |
GetResourceInfoParameters | |
LengthUnitOutput |
Alias voor LengthUnitOutput |
ListClassifiersParameters | |
ListModelsParameters | |
ListOperationsParameters | |
OperationDetailsOutput |
Bewerkingsgegevens. |
OperationKindOutput |
Alias voor OperationKindOutput |
OperationStatusOutput |
Alias voor OperationStatusOutput |
PagedDocumentClassifierDetailsOutput |
Gepaginade verzameling DocumentClassifierDetails-items |
PagedDocumentModelDetailsOutput |
Gepaginade verzameling DocumentModelDetails-items |
PagedOperationDetailsOutput |
Gepaginade verzameling OperationDetails-items |
PaginateReturn |
Helpertype voor het afleiden van het type gepaginade elementen van het antwoordtype Dit type wordt gegenereerd op basis van de swagger-informatie voor x-ms-pageable specifiek op de eigenschap itemName die de eigenschap aangeeft van het antwoord waarin de pagina-items worden gevonden. De standaardwaarde is |
ParagraphRoleOutput |
Alias voor AlineaRoleOutput |
SplitMode |
Alias voor SplitMode |
SplitModeOutput |
Alias voor SplitModeOutput |
StringIndexType |
Alias voor StringIndexType |
StringIndexTypeOutput |
Alias voor StringIndexTypeOutput |
Functies
Functiedetails
default(string, TokenCredential | KeyCredential, DocumentIntelligenceClientOptions)
Een nieuw exemplaar van DocumentIntelligenceClient
initialiseren
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: DocumentIntelligenceClientOptions): DocumentIntelligenceClient
Parameters
- endpointParam
-
string
Het Eindpunt van de Document Intelligence-service.
- credentials
clientreferenties uniek identificeren
de parameter voor alle optionele parameters
Retouren
getLongRunningPoller<TResult>(Client, AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
De Helper-functie waarmee een Poller-object wordt gebouwd om te helpen bij het peilen van een langdurige bewerking.
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
Client die moet worden gebruikt voor het verzenden van de aanvraag om extra pagina's op te halen.
- initialResponse
-
AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse
Het eerste antwoord.
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Opties voor het instellen van een cv-status of aangepast polling-interval.
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
- Een poller-object om te peilen naar updates van bewerkingsstatussen en uiteindelijk het uiteindelijke antwoord op te halen.
getLongRunningPoller<TResult>(Client, BuildModel202Response | BuildModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildModel202Response | BuildModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, ComposeModel202Response | ComposeModelDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ComposeModel202Response | ComposeModelDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, CopyModelTo202Response | CopyModelToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyModelTo202Response | CopyModelToDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, BuildClassifier202Response | BuildClassifierDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: BuildClassifier202Response | BuildClassifierDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- initialResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, CopyClassifierTo202Response | CopyClassifierToDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: CopyClassifierTo202Response | CopyClassifierToDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- initialResponse
-
CopyClassifierTo202Response | CopyClassifierToDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- initialResponse
-
AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
getLongRunningPoller<TResult>(Client, ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, CreateHttpPollerOptions<TResult, OperationState<TResult>>)
function getLongRunningPoller<TResult>(client: Client, initialResponse: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>
Parameters
- client
- Client
- options
-
CreateHttpPollerOptions<TResult, OperationState<TResult>>
Retouren
Promise<SimplePollerLike<OperationState<TResult>, TResult>>
isUnexpected(ListOperations200Response | ListOperationsDefaultResponse)
function isUnexpected(response: ListOperations200Response | ListOperationsDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelBuildOperation200Response | GetDocumentModelBuildOperationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelComposeOperation200Response | GetDocumentModelComposeOperationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentModelCopyToOperation200Response | GetDocumentModelCopyToOperationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierCopyToOperation200Response | GetDocumentClassifierCopyToOperationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse)
function isUnexpected(response: GetDocumentClassifierBuildOperation200Response | GetDocumentClassifierBuildOperationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetOperation200Response | GetOperationDefaultResponse)
function isUnexpected(response: GetOperation200Response | GetOperationDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetResourceInfo200Response | GetResourceInfoDefaultResponse)
function isUnexpected(response: GetResourceInfo200Response | GetResourceInfoDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse)
function isUnexpected(response: GetAnalyzeResult200Response | GetAnalyzeResultDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse)
function isUnexpected(response: GetAnalyzeResultPdf200Response | GetAnalyzeResultPdfDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse)
function isUnexpected(response: GetAnalyzeResultFigure200Response | GetAnalyzeResultFigureDefaultResponse): response
Parameters
Retouren
response
isUnexpected(AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse)
function isUnexpected(response: AnalyzeDocumentFromStream202Response | AnalyzeDocumentFromStreamDefaultResponse | AnalyzeDocumentFromStreamLogicalResponse): response
Parameters
Retouren
response
isUnexpected(AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse)
function isUnexpected(response: AnalyzeDocument202Response | AnalyzeDocumentDefaultResponse | AnalyzeDocumentLogicalResponse): response
Parameters
Retouren
response
isUnexpected(GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse)
function isUnexpected(response: GetAnalyzeBatchResult200Response | GetAnalyzeBatchResultDefaultResponse): response
Parameters
Retouren
response
isUnexpected(AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse)
function isUnexpected(response: AnalyzeBatchDocuments202Response | AnalyzeBatchDocumentsDefaultResponse | AnalyzeBatchDocumentsLogicalResponse): response
Parameters
Retouren
response
isUnexpected(GetModel200Response | GetModelDefaultResponse)
function isUnexpected(response: GetModel200Response | GetModelDefaultResponse): response
Parameters
- response
Retouren
response
isUnexpected(DeleteModel204Response | DeleteModelDefaultResponse)
function isUnexpected(response: DeleteModel204Response | DeleteModelDefaultResponse): response
Parameters
- response
Retouren
response
isUnexpected(BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse)
function isUnexpected(response: BuildModel202Response | BuildModelDefaultResponse | BuildModelLogicalResponse): response
Parameters
Retouren
response
isUnexpected(ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse)
function isUnexpected(response: ComposeModel202Response | ComposeModelDefaultResponse | ComposeModelLogicalResponse): response
Parameters
Retouren
response
isUnexpected(AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse)
function isUnexpected(response: AuthorizeModelCopy200Response | AuthorizeModelCopyDefaultResponse): response
Parameters
Retouren
response
isUnexpected(CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse)
function isUnexpected(response: CopyModelTo202Response | CopyModelToDefaultResponse | CopyModelToLogicalResponse): response
Parameters
Retouren
response
isUnexpected(ListModels200Response | ListModelsDefaultResponse)
function isUnexpected(response: ListModels200Response | ListModelsDefaultResponse): response
Parameters
- response
Retouren
response
isUnexpected(BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse)
function isUnexpected(response: BuildClassifier202Response | BuildClassifierDefaultResponse | BuildClassifierLogicalResponse): response
Parameters
Retouren
response
isUnexpected(ListClassifiers200Response | ListClassifiersDefaultResponse)
function isUnexpected(response: ListClassifiers200Response | ListClassifiersDefaultResponse): response
Parameters
Retouren
response
isUnexpected(GetClassifier200Response | GetClassifierDefaultResponse)
function isUnexpected(response: GetClassifier200Response | GetClassifierDefaultResponse): response
Parameters
Retouren
response
isUnexpected(DeleteClassifier204Response | DeleteClassifierDefaultResponse)
function isUnexpected(response: DeleteClassifier204Response | DeleteClassifierDefaultResponse): response
Parameters
Retouren
response
isUnexpected(ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse)
function isUnexpected(response: ClassifyDocumentFromStream202Response | ClassifyDocumentFromStreamDefaultResponse | ClassifyDocumentFromStreamLogicalResponse): response
Parameters
Retouren
response
isUnexpected(ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse)
function isUnexpected(response: ClassifyDocument202Response | ClassifyDocumentDefaultResponse | ClassifyDocumentLogicalResponse): response
Parameters
Retouren
response
isUnexpected(GetClassifyResult200Response | GetClassifyResultDefaultResponse)
function isUnexpected(response: GetClassifyResult200Response | GetClassifyResultDefaultResponse): response
Parameters
Retouren
response
isUnexpected(AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse)
function isUnexpected(response: AuthorizeClassifierCopy200Response | AuthorizeClassifierCopyDefaultResponse): response
Parameters
Retouren
response
isUnexpected(CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse)
function isUnexpected(response: CopyClassifierTo202Response | CopyClassifierToDefaultResponse | CopyClassifierToLogicalResponse): response
Parameters
Retouren
response
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)
Helper voor het pagineren van resultaten van een eerste antwoord dat volgt op de specificatie van autorest x-ms-pageable
-extensie
function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>
Parameters
- client
- Client
Client die moet worden gebruikt voor het verzenden van de volgende paginaaanvragen
- initialResponse
-
TResponse
Eerste antwoord met de nextLink en de huidige pagina met elementen
- options
-
PagingOptions<TResponse>
Retouren
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator om de elementen te herhalen
Azure SDK for JavaScript