DocumentIntelligenceAdministrationAsyncClient Class
- java.
lang. Object - com.
azure. ai. documentintelligence. DocumentIntelligenceAdministrationAsyncClient
- com.
public final class DocumentIntelligenceAdministrationAsyncClient
Initializes a new instance of the asynchronous DocumentIntelligenceAdministrationClient type.
Method Summary
Methods inherited from java.lang.Object
Method Details
authorizeClassifierCopy
public Mono
Generates authorization to copy a document classifier to this location with specified classifierId and optional description.
Parameters:
Returns:
authorizeClassifierCopyWithResponse
public Mono
Generates authorization to copy a document classifier to this location with specified classifierId and optional description.
Request Body Schema
{
classifierId: String (Required)
description: String (Optional)
tags (Optional): {
String: String (Required)
}
}
Response Body Schema
{
targetResourceId: String (Required)
targetResourceRegion: String (Required)
targetClassifierId: String (Required)
targetClassifierLocation: String (Required)
accessToken: String (Required)
expirationDateTime: OffsetDateTime (Required)
}
Parameters:
Returns:
authorizeModelCopy
public Mono
Generates authorization to copy a document model to this location with specified modelId and optional description.
Parameters:
Returns:
authorizeModelCopyWithResponse
public Mono
Generates authorization to copy a document model to this location with specified modelId and optional description.
Request Body Schema
{
modelId: String (Required)
description: String (Optional)
tags (Optional): {
String: String (Required)
}
}
Response Body Schema
{
targetResourceId: String (Required)
targetResourceRegion: String (Required)
targetModelId: String (Required)
targetModelLocation: String (Required)
accessToken: String (Required)
expirationDateTime: OffsetDateTime (Required)
}
Parameters:
Returns:
beginBuildClassifier
public PollerFlux
Builds a custom document classifier.
Parameters:
Returns:
beginBuildClassifier
public PollerFlux
Builds a custom document classifier.
Request Body Schema
{
classifierId: String (Required)
description: String (Optional)
baseClassifierId: String (Optional)
docTypes (Required): {
String (Required): {
sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
}
}
allowOverwrite: Boolean (Optional)
}
Parameters:
Returns:
beginBuildDocumentModel
public PollerFlux
Builds a custom document analysis model.
Parameters:
Returns:
beginBuildDocumentModel
public PollerFlux
Builds a custom document analysis model.
Request Body Schema
{
modelId: String (Required)
description: String (Optional)
buildMode: String(template/neural) (Required)
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
tags (Optional): {
String: String (Required)
}
maxTrainingHours: Double (Optional)
allowOverwrite: Boolean (Optional)
}
Parameters:
Returns:
beginComposeModel
public PollerFlux
Creates a new document model from document types of existing document models.
Parameters:
Returns:
beginComposeModel
public PollerFlux
Creates a new document model from document types of existing document models.
Request Body Schema
{
modelId: String (Required)
description: String (Optional)
classifierId: String (Required)
split: String(auto/none/perPage) (Optional)
docTypes (Required): {
String (Required): {
description: String (Optional)
buildMode: String(template/neural) (Optional)
fieldSchema (Optional): {
String (Required): {
type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean/selectionGroup) (Required)
description: String (Optional)
example: String (Optional)
items (Optional): (recursive schema, see items above)
properties (Optional): {
String (Required): (recursive schema, see String above)
}
}
}
fieldConfidence (Optional): {
String: double (Required)
}
modelId: String (Optional)
confidenceThreshold: Double (Optional)
features (Optional): [
String(ocrHighResolution/languages/barcodes/formulas/keyValuePairs/styleFont/queryFields) (Optional)
]
queryFields (Optional): [
String (Optional)
]
maxDocumentsToAnalyze: Integer (Optional)
}
}
tags (Optional): {
String: String (Required)
}
}
Parameters:
Returns:
beginCopyClassifierTo
public PollerFlux
Copies document classifier to the target resource, region, and classifierId.
Parameters:
Returns:
beginCopyClassifierTo
public PollerFlux
Copies document classifier to the target resource, region, and classifierId.
Request Body Schema
{
targetResourceId: String (Required)
targetResourceRegion: String (Required)
targetClassifierId: String (Required)
targetClassifierLocation: String (Required)
accessToken: String (Required)
expirationDateTime: OffsetDateTime (Required)
}
Parameters:
Returns:
beginCopyModelTo
public PollerFlux
Copies document model to the target resource, region, and modelId.
Parameters:
Returns:
beginCopyModelTo
public PollerFlux
Copies document model to the target resource, region, and modelId.
Request Body Schema
{
targetResourceId: String (Required)
targetResourceRegion: String (Required)
targetModelId: String (Required)
targetModelLocation: String (Required)
accessToken: String (Required)
expirationDateTime: OffsetDateTime (Required)
}
Parameters:
Returns:
deleteClassifier
public Mono
Deletes document classifier.
Parameters:
Returns:
deleteClassifierWithResponse
public Mono
Deletes document classifier.
Parameters:
Returns:
deleteModel
public Mono
Deletes document model.
Parameters:
Returns:
deleteModelWithResponse
public Mono
Deletes document model.
Parameters:
Returns:
getClassifier
public Mono
Gets detailed document classifier information.
Parameters:
Returns:
getClassifierWithResponse
public Mono
Gets detailed document classifier information.
Response Body Schema
{
classifierId: String (Required)
description: String (Optional)
createdDateTime: OffsetDateTime (Required)
expirationDateTime: OffsetDateTime (Optional)
modifiedDateTime: OffsetDateTime (Optional)
apiVersion: String (Required)
baseClassifierId: String (Optional)
docTypes (Required): {
String (Required): {
sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
}
}
warnings (Optional): [
(Optional){
code: String (Required)
message: String (Required)
target: String (Optional)
}
]
}
Parameters:
Returns:
getModel
public Mono
Gets detailed document model information.
Parameters:
Returns:
getModelWithResponse
public Mono
Gets detailed document model information.
Response Body Schema
{
modelId: String (Required)
description: String (Optional)
createdDateTime: OffsetDateTime (Required)
expirationDateTime: OffsetDateTime (Optional)
modifiedDateTime: OffsetDateTime (Optional)
apiVersion: String (Optional)
tags (Optional): {
String: String (Required)
}
buildMode: String(template/neural) (Optional)
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
classifierId: String (Optional)
split: String(auto/none/perPage) (Optional)
docTypes (Optional): {
String (Required): {
description: String (Optional)
buildMode: String(template/neural) (Optional)
fieldSchema (Optional): {
String (Required): {
type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean/selectionGroup) (Required)
description: String (Optional)
example: String (Optional)
items (Optional): (recursive schema, see items above)
properties (Optional): {
String (Required): (recursive schema, see String above)
}
}
}
fieldConfidence (Optional): {
String: double (Required)
}
modelId: String (Optional)
confidenceThreshold: Double (Optional)
features (Optional): [
String(ocrHighResolution/languages/barcodes/formulas/keyValuePairs/styleFont/queryFields) (Optional)
]
queryFields (Optional): [
String (Optional)
]
maxDocumentsToAnalyze: Integer (Optional)
}
}
warnings (Optional): [
(Optional){
code: String (Required)
message: String (Required)
target: String (Optional)
}
]
trainingHours: Double (Optional)
}
Parameters:
Returns:
getOperation
public Mono
Gets operation info.
Parameters:
Returns:
getOperationWithResponse
public Mono
Gets operation info.
Response Body Schema
{
kind: String(documentModelBuild/documentModelCompose/documentModelCopyTo/documentClassifierCopyTo/documentClassifierBuild) (Required)
operationId: String (Required)
status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
percentCompleted: Integer (Optional)
createdDateTime: OffsetDateTime (Required)
lastUpdatedDateTime: OffsetDateTime (Required)
resourceLocation: String (Required)
apiVersion: String (Optional)
tags (Optional): {
String: String (Required)
}
error (Optional): {
code: String (Required)
message: String (Required)
target: String (Optional)
details (Optional): [
(recursive schema, see above)
]
innererror (Optional): {
code: String (Optional)
message: String (Optional)
innererror (Optional): (recursive schema, see innererror above)
}
}
}
Parameters:
Returns:
getResourceDetails
public Mono
Return information about the current resource.
Returns:
getResourceDetailsWithResponse
public Mono
Return information about the current resource.
Response Body Schema
{
customDocumentModels (Required): {
count: int (Required)
limit: int (Required)
}
}
Parameters:
Returns:
listClassifiers
public PagedFlux
List all document classifiers.
Returns:
listClassifiers
public PagedFlux
List all document classifiers.
Response Body Schema
{
classifierId: String (Required)
description: String (Optional)
createdDateTime: OffsetDateTime (Required)
expirationDateTime: OffsetDateTime (Optional)
modifiedDateTime: OffsetDateTime (Optional)
apiVersion: String (Required)
baseClassifierId: String (Optional)
docTypes (Required): {
String (Required): {
sourceKind: String(url/base64/azureBlob/azureBlobFileList) (Optional)
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
}
}
warnings (Optional): [
(Optional){
code: String (Required)
message: String (Required)
target: String (Optional)
}
]
}
Parameters:
Returns:
listModels
public PagedFlux
List all document models.
Returns:
listModels
public PagedFlux
List all document models.
Response Body Schema
{
modelId: String (Required)
description: String (Optional)
createdDateTime: OffsetDateTime (Required)
expirationDateTime: OffsetDateTime (Optional)
modifiedDateTime: OffsetDateTime (Optional)
apiVersion: String (Optional)
tags (Optional): {
String: String (Required)
}
buildMode: String(template/neural) (Optional)
azureBlobSource (Optional): {
containerUrl: String (Required)
prefix: String (Optional)
}
azureBlobFileListSource (Optional): {
containerUrl: String (Required)
fileList: String (Required)
}
classifierId: String (Optional)
split: String(auto/none/perPage) (Optional)
docTypes (Optional): {
String (Required): {
description: String (Optional)
buildMode: String(template/neural) (Optional)
fieldSchema (Optional): {
String (Required): {
type: String(string/date/time/phoneNumber/number/integer/selectionMark/countryRegion/signature/array/object/currency/address/boolean/selectionGroup) (Required)
description: String (Optional)
example: String (Optional)
items (Optional): (recursive schema, see items above)
properties (Optional): {
String (Required): (recursive schema, see String above)
}
}
}
fieldConfidence (Optional): {
String: double (Required)
}
modelId: String (Optional)
confidenceThreshold: Double (Optional)
features (Optional): [
String(ocrHighResolution/languages/barcodes/formulas/keyValuePairs/styleFont/queryFields) (Optional)
]
queryFields (Optional): [
String (Optional)
]
maxDocumentsToAnalyze: Integer (Optional)
}
}
warnings (Optional): [
(Optional){
code: String (Required)
message: String (Required)
target: String (Optional)
}
]
trainingHours: Double (Optional)
}
Parameters:
Returns:
listOperations
public PagedFlux
Lists all operations.
Returns:
listOperations
public PagedFlux
Lists all operations.
Response Body Schema
{
kind: String(documentModelBuild/documentModelCompose/documentModelCopyTo/documentClassifierCopyTo/documentClassifierBuild) (Required)
operationId: String (Required)
status: String(notStarted/running/failed/succeeded/canceled/skipped) (Required)
percentCompleted: Integer (Optional)
createdDateTime: OffsetDateTime (Required)
lastUpdatedDateTime: OffsetDateTime (Required)
resourceLocation: String (Required)
apiVersion: String (Optional)
tags (Optional): {
String: String (Required)
}
error (Optional): {
code: String (Required)
message: String (Required)
target: String (Optional)
details (Optional): [
(recursive schema, see above)
]
innererror (Optional): {
code: String (Optional)
message: String (Optional)
innererror (Optional): (recursive schema, see innererror above)
}
}
}
Parameters:
Returns:
Applies to
Azure SDK for Java