DocumentModelAdministrationClient Clase
- java.
lang. Object - com.
azure. ai. formrecognizer. documentanalysis. administration. DocumentModelAdministrationClient
- com.
public final class DocumentModelAdministrationClient
Esta clase proporciona un cliente asincrónico para conectarse a la Form Recognizer Azure Cognitive Service.
Este cliente proporciona métodos asincrónicos para realizar:
- Compilación de un modelo personalizado: extraiga datos de los documentos específicos mediante la creación de modelos personalizados mediante el beginBuidlDocumentModel método para proporcionar una dirección URL de SAS de contenedor al contenedor de blobs de Azure Storage.
- Modelos personalizados compuestos: crea un nuevo modelo a partir de tipos de documento de colección de modelos existentes mediante el beginComposeDocumentModel método .
- Copiar modelo personalizado: copie un modelo de Form Recognizer personalizado en un recurso de Form Recognizer de destino mediante el beginCopyDocumentModelTo método .
- Administración de modelos personalizados: obtenga información detallada, elimine y enumere modelos personalizados mediante métodos getDocumentModel(String modelId), listDocumentModels() y deleteDocumentModel(String modelId) respectivamente.
- Administración de operaciones: obtenga información detallada y enumerar las operaciones en la cuenta de Form Recognizer mediante métodos getOperation(String operationId) ylistOperations(), respectivamente.
- Sondeo y devoluciones de llamada: incluye mecanismos para sondear el servicio para comprobar el estado de una operación de análisis o registrar devoluciones de llamada para recibir notificaciones cuando se complete el análisis.
Nota: Este cliente solo admite V2022_08_31 y versiones más recientes. Para usar una versión de servicio anterior y FormRecognizerClient.formrecognizer.training.FormTrainingClient.
Los clientes de servicio son el punto de interacción para que los desarrolladores usen Azure Form Recognizer. DocumentModelAdministrationClient es el cliente de servicio sincrónico y DocumentModelAdministrationAsyncClient es el cliente de servicio asincrónico. Los ejemplos que se muestran en este documento usan un objeto de credencial denominado DefaultAzureCredential para la autenticación, que es adecuado para la mayoría de los escenarios, incluidos los entornos de desarrollo y producción locales. Además, se recomienda usar la identidad administrada para la autenticación en entornos de producción. Puede encontrar más información sobre las distintas formas de autenticación y sus tipos de credenciales correspondientes en la documentación de Identidad de Azure".
Ejemplo: Construcción de un DocumentModelAdministrationAsyncClient con DefaultAzureCredential
En el ejemplo de código siguiente se muestra la creación de un DocumentModelAdministrationAsyncClient, con "DefaultAzureCredentialBuilder" para configurarlo.
DocumentModelAdministrationClient client = new DocumentModelAdministrationClientBuilder()
.endpoint("{endpoint}")
.credential(new DefaultAzureCredentialBuilder().build())
.buildClient();
Además, consulte el ejemplo de código siguiente para usarlo AzureKeyCredential para la creación de clientes.
DocumentModelAdministrationAsyncClient documentModelAdministrationAsyncClient =
new DocumentModelAdministrationClientBuilder()
.credential(new AzureKeyCredential("{key}"))
.endpoint("{endpoint}")
.buildAsyncClient();
Resumen del método
Métodos heredados de java.lang.Object
Detalles del método
beginBuildDocumentClassifier
public SyncPoller
Crea un modelo de documento clasificador personalizado.
Los modelos clasificadores pueden identificar varios documentos o varias instancias de un único documento. Para ello, necesita al menos cinco documentos para cada clase y dos clases de documentos.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
HashMap<String, ClassifierDocumentTypeDetails> documentTypes = new HashMap<>();
documentTypes.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
));
documentTypes.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
));
DocumentClassifierDetails classifierDetails
= documentModelAdministrationClient.beginBuildDocumentClassifier(documentTypes)
.getFinalResult();
System.out.printf("Classifier ID: %s%n", classifierDetails.getClassifierId());
System.out.printf("Classifier description: %s%n", classifierDetails.getDescription());
System.out.printf("Classifier created on: %s%n", classifierDetails.getCreatedOn());
System.out.printf("Classifier expires on: %s%n", classifierDetails.getExpiresOn());
classifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
.getContentSource()).getContainerUrl());
}
});
Parameters:
Returns:
beginBuildDocumentClassifier
public SyncPoller
Crea un modelo de documento clasificador personalizado.
Los modelos clasificadores pueden identificar varios documentos o varias instancias de un único documento. Para ello, necesita al menos cinco documentos para cada clase y dos clases de documentos.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String blobContainerUrl1040D = "{SAS_URL_of_your_container_in_blob_storage}";
String blobContainerUrl1040A = "{SAS_URL_of_your_container_in_blob_storage}";
HashMap<String, ClassifierDocumentTypeDetails> documentTypesDetailsMap = new HashMap<>();
documentTypesDetailsMap.put("1040-D", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040D)
));
documentTypesDetailsMap.put("1040-A", new ClassifierDocumentTypeDetails(new BlobContentSource(blobContainerUrl1040A)
));
DocumentClassifierDetails classifierDetails
= documentModelAdministrationClient.beginBuildDocumentClassifier(documentTypesDetailsMap,
new BuildDocumentClassifierOptions()
.setClassifierId("classifierId")
.setDescription("classifier desc"),
Context.NONE)
.getFinalResult();
System.out.printf("Classifier ID: %s%n", classifierDetails.getClassifierId());
System.out.printf("Classifier description: %s%n", classifierDetails.getDescription());
System.out.printf("Classifier created on: %s%n", classifierDetails.getCreatedOn());
System.out.printf("Classifier expires on: %s%n", classifierDetails.getExpiresOn());
classifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
.getContentSource()).getContainerUrl());
}
});
Parameters:
Returns:
beginBuildDocumentModel
public SyncPoller
Crea un modelo de análisis de documentos personalizado.
Los modelos se crean con documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Cualquier otro tipo de contenido se ignora.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
String fileList = "";
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(
new BlobFileListContentSource(blobContainerUrl, fileList),
DocumentModelBuildMode.TEMPLATE)
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
beginBuildDocumentModel
public SyncPoller
Crea un modelo de análisis de documentos personalizado.
Los modelos se crean con documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Cualquier otro tipo de contenido se ignora.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
String fileList = "";
String modelId = "custom-model-id";
Map<String, String> attrs = new HashMap<String, String>();
attrs.put("createdBy", "sample");
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(
new BlobFileListContentSource(blobContainerUrl, fileList),
DocumentModelBuildMode.TEMPLATE,
new BuildDocumentModelOptions()
.setModelId(modelId)
.setDescription("model desc")
.setTags(attrs),
Context.NONE)
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
beginBuildDocumentModel
public SyncPoller
Crea un modelo de análisis de documentos personalizado.
Los modelos se crean con documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Cualquier otro tipo de contenido se ignora.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(blobContainerUrl,
DocumentModelBuildMode.TEMPLATE)
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
beginBuildDocumentModel
public SyncPoller
Crea un modelo de análisis de documentos personalizado.
Los modelos se crean con documentos que son del siguiente tipo de contenido: "application/pdf", "image/jpeg", "image/png", "image/tiff", image/bmp. Cualquier otro tipo de contenido se ignora.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String blobContainerUrl = "{SAS-URL-of-your-container-in-blob-storage}";
String modelId = "custom-model-id";
String prefix = "Invoice";
Map<String, String> attrs = new HashMap<String, String>();
attrs.put("createdBy", "sample");
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginBuildDocumentModel(blobContainerUrl,
DocumentModelBuildMode.TEMPLATE,
prefix,
new BuildDocumentModelOptions()
.setModelId(modelId)
.setDescription("model desc")
.setTags(attrs),
Context.NONE)
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
beginComposeDocumentModel
public SyncPoller
Cree un modelo compuesto a partir de la lista proporcionada de modelos existentes en la cuenta.
Se produce un error en estas operaciones si la lista consta de un id. de modelo no válido o de identificadores duplicados.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String modelId1 = "{custom-model-id_1}";
String modelId2 = "{custom-model-id_2}";
final DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2))
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
beginComposeDocumentModel
public SyncPoller
Cree un modelo compuesto a partir de la lista proporcionada de modelos existentes en la cuenta.
Se produce un error en estas operaciones si la lista consta de un id. de modelo no válido o de identificadores duplicados.
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String modelId1 = "{custom-model-id_1}";
String modelId2 = "{custom-model-id_2}";
String modelId = "my-composed-model";
Map<String, String> attrs = new HashMap<String, String>();
attrs.put("createdBy", "sample");
final DocumentModelDetails documentModelDetails =
documentModelAdministrationClient.beginComposeDocumentModel(Arrays.asList(modelId1, modelId2),
new ComposeDocumentModelOptions()
.setModelId(modelId)
.setDescription("my composed model desc")
.setTags(attrs),
Context.NONE)
.setPollInterval(Duration.ofSeconds(5))
.getFinalResult();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
System.out.printf("Model assigned tags: %s%n", documentModelDetails.getTags());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
beginCopyDocumentModelTo
public SyncPoller
Copie un modelo personalizado almacenado en este recurso (el origen) en el destino especificado por el usuario Form Recognizer recurso.
Se debe llamar a esto con el recurso de Form Recognizer de origen (con el modelo que está pensado para copiarse). El parámetro de destino debe proporcionarse a partir de la salida del recurso de destino del getCopyAuthorization() método .
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String copyModelId = "copy-model";
// Get authorization to copy the model to target resource
DocumentModelCopyAuthorization documentModelCopyAuthorization
= documentModelAdministrationClient.getCopyAuthorization();
// Start copy operation from the source client
DocumentModelDetails documentModelDetails
= documentModelAdministrationClient.beginCopyDocumentModelTo(copyModelId, documentModelCopyAuthorization)
.getFinalResult();
System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
documentModelDetails.getModelId(),
documentModelDetails.getCreatedOn());
Parameters:
Returns:
beginCopyDocumentModelTo
public SyncPoller
Copie un modelo personalizado almacenado en este recurso (el origen) en el destino especificado por el usuario Form Recognizer recurso.
Se debe llamar a esto con el recurso de Form Recognizer de origen (con el modelo que está pensado para copiarse). El parámetro de destino debe proporcionarse a partir de la salida del recurso de destino del getCopyAuthorization() método .
El servicio no admite la cancelación de la operación de larga duración y devuelve un mensaje de error que indica la ausencia de compatibilidad con la cancelación.
Código de ejemplo
String copyModelId = "copy-model";
// Get authorization to copy the model to target resource
DocumentModelCopyAuthorization documentModelCopyAuthorization
= documentModelAdministrationClient.getCopyAuthorization();
// Start copy operation from the source client
DocumentModelDetails documentModelDetails =
documentModelAdministrationClient.beginCopyDocumentModelTo(copyModelId,
documentModelCopyAuthorization,
Context.NONE)
.getFinalResult();
System.out.printf("Copied model has model ID: %s, was created on: %s.%n,",
documentModelDetails.getModelId(),
documentModelDetails.getCreatedOn());
Parameters:
Returns:
deleteDocumentClassifier
public void deleteDocumentClassifier(String classifierId)
Elimina el clasificador de documentos especificado.
Código de ejemplo
String classifierId = "{classifierId}";
documentModelAdministrationClient.deleteDocumentClassifier(classifierId);
System.out.printf("Classifier ID: %s is deleted.%n", classifierId);
Parameters:
deleteDocumentClassifierWithResponse
public Response
Elimina el clasificador de documentos especificado.
Código de ejemplo
String classifierId = "{classifierId}";
Response<Void> response
= documentModelAdministrationClient.deleteDocumentClassifierWithResponse(classifierId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
System.out.printf("Classifier ID: %s is deleted.%n", classifierId);
Parameters:
Returns:
deleteDocumentModel
public void deleteDocumentModel(String modelId)
Elimina el modelo de análisis de documentos personalizado especificado.
Código de ejemplo
String modelId = "{custom-model-id}";
documentModelAdministrationClient.deleteDocumentModel(modelId);
System.out.printf("Model ID: %s is deleted.%n", modelId);
Parameters:
deleteDocumentModelWithResponse
public Response
Elimina el modelo de análisis de documentos personalizado especificado.
Código de ejemplo
String modelId = "{custom-model-id}";
Response<Void> response
= documentModelAdministrationClient.deleteDocumentModelWithResponse(modelId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
System.out.printf("Model ID: %s is deleted.%n", modelId);
Parameters:
Returns:
getCopyAuthorization
public DocumentModelCopyAuthorization getCopyAuthorization()
Genere autorización para copiar un modelo personalizado en el recurso de Form Recognizer de destino.
El recurso de destino debe llamar a esto (donde se copiará el modelo) y la salida se puede pasar como parámetro de destino a beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).
Código de ejemplo
DocumentModelCopyAuthorization documentModelCopyAuthorization
= documentModelAdministrationClient.getCopyAuthorization();
System.out.printf("Copy Authorization for model id: %s, access token: %s, expiration time: %s, "
+ "target resource ID; %s, target resource region: %s%n",
documentModelCopyAuthorization.getTargetModelId(),
documentModelCopyAuthorization.getAccessToken(),
documentModelCopyAuthorization.getExpiresOn(),
documentModelCopyAuthorization.getTargetResourceId(),
documentModelCopyAuthorization.getTargetResourceRegion()
);
Returns:
getCopyAuthorizationWithResponse
public Response
Genere autorización para copiar un modelo personalizado en el recurso de Form Recognizer de destino.
El recurso de destino debe llamar a esto (donde se copiará el modelo) y la salida se puede pasar como parámetro de destino a beginCopyDocumentModelTo(String sourceModelId, DocumentModelCopyAuthorization target).
Parameters:
Response<DocumentModelCopyAuthorization> copyAuthorizationResponse = documentModelAdministrationClient.getCopyAuthorizationWithResponse( new CopyAuthorizationOptions() .setModelId(modelId) .setDescription("model-desc") .setTags(attrs), Context.NONE); System.out.printf("Copy Authorization operation returned with status: %s", copyAuthorizationResponse.getStatusCode()); DocumentModelCopyAuthorization documentModelCopyAuthorization = copyAuthorizationResponse.getValue(); System.out.printf("Copy Authorization for model id: %s, access token: %s, " + "expiration time: %s, target resource ID; %s, target resource region: %s%n", documentModelCopyAuthorization.getTargetModelId(), documentModelCopyAuthorization.getAccessToken(), documentModelCopyAuthorization.getExpiresOn(), documentModelCopyAuthorization.getTargetResourceId(), documentModelCopyAuthorization.getTargetResourceRegion() );
Returns:
getDocumentAnalysisClient
public DocumentAnalysisClient getDocumentAnalysisClient()
Crea un nuevo objeto DocumentAnalysisClient. El nuevo DocumentAnalysisClient usa la misma canalización de directiva de solicitud que .DocumentAnalysisClient
Returns:
getDocumentClassifier
public DocumentClassifierDetails getDocumentClassifier(String classifierId)
Obtenga información detallada para un clasificador de documentos por su identificador.
Código de ejemplo
String classifierId = "{classifierId}";
DocumentClassifierDetails documentClassifierDetails
= documentModelAdministrationClient.getDocumentClassifier(classifierId);
System.out.printf("Classifier ID: %s%n", documentClassifierDetails.getClassifierId());
System.out.printf("Classifier Description: %s%n", documentClassifierDetails.getDescription());
System.out.printf("Classifier Created on: %s%n", documentClassifierDetails.getCreatedOn());
documentClassifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
.getContentSource()).getContainerUrl());
}
if (documentTypeDetails.getContentSource() instanceof BlobFileListContentSource) {
System.out.printf("Blob File List Source container Url: %s",
((BlobFileListContentSource) documentTypeDetails
.getContentSource()).getContainerUrl());
}
});
Parameters:
Returns:
getDocumentClassifierWithResponse
public Response
Obtenga información detallada para un clasificador de documentos por su identificador.
Código de ejemplo
String modelId = "{custom-model-id}";
Response<DocumentClassifierDetails> response
= documentModelAdministrationClient.getDocumentClassifierWithResponse(modelId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
DocumentClassifierDetails documentClassifierDetails = response.getValue();
System.out.printf("Classifier ID: %s%n", documentClassifierDetails.getClassifierId());
System.out.printf("Classifier Description: %s%n", documentClassifierDetails.getDescription());
System.out.printf("Classifier Created on: %s%n", documentClassifierDetails.getCreatedOn());
documentClassifierDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
if (documentTypeDetails.getContentSource() instanceof BlobContentSource) {
System.out.printf("Blob Source container Url: %s", ((BlobContentSource) documentTypeDetails
.getContentSource()).getContainerUrl());
}
if (documentTypeDetails.getContentSource() instanceof BlobFileListContentSource) {
System.out.printf("Blob File List Source container Url: %s",
((BlobFileListContentSource) documentTypeDetails
.getContentSource()).getContainerUrl());
}
});
Parameters:
Returns:
getDocumentModel
public DocumentModelDetails getDocumentModel(String modelId)
Obtenga información detallada para un identificador de modelo especificado.
Código de ejemplo
String modelId = "{custom-model-id}";
DocumentModelDetails documentModelDetails = documentModelAdministrationClient.getDocumentModel(modelId);
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
getDocumentModelWithResponse
public Response
Obtenga información detallada para un identificador de modelo especificado.
Código de ejemplo
String modelId = "{custom-model-id}";
Response<DocumentModelDetails> response
= documentModelAdministrationClient.getDocumentModelWithResponse(modelId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
DocumentModelDetails documentModelDetails = response.getValue();
System.out.printf("Model ID: %s%n", documentModelDetails.getModelId());
System.out.printf("Model Description: %s%n", documentModelDetails.getDescription());
System.out.printf("Model Created on: %s%n", documentModelDetails.getCreatedOn());
documentModelDetails.getDocumentTypes().forEach((key, documentTypeDetails) -> {
documentTypeDetails.getFieldSchema().forEach((field, documentFieldSchema) -> {
System.out.printf("Field: %s", field);
System.out.printf("Field type: %s", documentFieldSchema.getType());
System.out.printf("Field confidence: %.2f", documentTypeDetails.getFieldConfidence().get(field));
});
});
Parameters:
Returns:
getOperation
public OperationDetails getOperation(String operationId)
Obtenga información detallada de la operación para el identificador especificado con respuesta Http.
Se produce un error en estas operaciones si el identificador de operación usado es de las últimas 24 horas.
Código de ejemplo
String operationId = "{operation-id}";
OperationDetails operationDetails
= documentModelAdministrationClient.getOperation(operationId);
System.out.printf("Operation ID: %s%n", operationDetails.getOperationId());
System.out.printf("Operation Kind: %s%n", operationDetails.getKind());
System.out.printf("Operation Status: %s%n", operationDetails.getStatus());
System.out.printf("Model ID created with this operation: %s%n",
((DocumentModelBuildOperationDetails) operationDetails).getResult().getModelId());
if (OperationStatus.FAILED.equals(operationDetails.getStatus())) {
System.out.printf("Operation fail error: %s%n", operationDetails.getError().getMessage());
}
Parameters:
Returns:
getOperationWithResponse
public Response
Obtenga información detallada de la operación para el identificador especificado con respuesta Http.
Se produce un error en estas operaciones si el identificador de operación usado es de las últimas 24 horas.
Código de ejemplo
String operationId = "{operation-id}";
Response<OperationDetails> response =
documentModelAdministrationClient.getOperationWithResponse(operationId, Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
OperationDetails operationDetails = response.getValue();
System.out.printf("Operation ID: %s%n", operationDetails.getOperationId());
System.out.printf("Operation Kind: %s%n", operationDetails.getKind());
System.out.printf("Operation Status: %s%n", operationDetails.getStatus());
System.out.printf("Model ID created with this operation: %s%n",
((DocumentModelBuildOperationDetails) operationDetails).getResult().getModelId());
if (OperationStatus.FAILED.equals(operationDetails.getStatus())) {
System.out.printf("Operation fail error: %s%n", operationDetails.getError().getMessage());
}
Parameters:
Returns:
getResourceDetails
public ResourceDetails getResourceDetails()
Obtenga información sobre el recurso Form Recognizer actual.
Código de ejemplo
ResourceDetails resourceDetails = documentModelAdministrationClient.getResourceDetails();
System.out.printf("Max number of models that can be build for this account: %d%n",
resourceDetails.getCustomDocumentModelLimit());
System.out.printf("Current count of built document analysis models: %d%n",
resourceDetails.getCustomDocumentModelCount());
Returns:
getResourceDetailsWithResponse
public Response
Obtenga información sobre el recurso de Form recognizer actual con una respuesta Http y un especificado Context.
Código de ejemplo
Response<ResourceDetails> response =
documentModelAdministrationClient.getResourceDetailsWithResponse(Context.NONE);
System.out.printf("Response Status Code: %d.", response.getStatusCode());
ResourceDetails resourceDetails = response.getValue();
System.out.printf("Max number of models that can be build for this account: %d%n",
resourceDetails.getCustomDocumentModelLimit());
System.out.printf("Current count of built document analysis models: %d%n",
resourceDetails.getCustomDocumentModelCount());
Parameters:
Returns:
listDocumentClassifiers
public PagedIterable
Enumere la información de cada clasificador de documentos en la cuenta de Form Recognizer que se ha compilado correctamente.
Código de ejemplo
documentModelAdministrationClient.listDocumentClassifiers()
.forEach(documentModel ->
System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
documentModel.getClassifierId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Returns:
listDocumentClassifiers
public PagedIterable
Enumere la información de cada clasificador de documentos en la cuenta de Form Recognizer que se compilaron correctamente con una respuesta Http y un especificadoContext.
Código de ejemplo
documentModelAdministrationClient.listDocumentClassifiers(Context.NONE)
.forEach(documentModel ->
System.out.printf("Classifier ID: %s, Classifier description: %s, Created on: %s.%n",
documentModel.getClassifierId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Parameters:
Returns:
listDocumentModels
public PagedIterable
Enumere la información de cada modelo en la cuenta de Form Recognizer que se compilaron correctamente.
Código de ejemplo
documentModelAdministrationClient.listDocumentModels()
.forEach(documentModel ->
System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
documentModel.getModelId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Returns:
listDocumentModels
public PagedIterable
Enumere la información de cada modelo en la cuenta de Form Recognizer que se compilaron correctamente con una respuesta Http y un especificadoContext.
Código de ejemplo
documentModelAdministrationClient.listDocumentModels(Context.NONE)
.forEach(documentModel ->
System.out.printf("Model ID: %s, Model description: %s, Created on: %s.%n",
documentModel.getModelId(),
documentModel.getDescription(),
documentModel.getCreatedOn())
);
Parameters:
Returns:
listOperations
public PagedIterable
Enumere la información de cada operación de modelo en la cuenta de Form Recognizer en las últimas 24 horas.
Código de ejemplo
PagedIterable<OperationSummary>
modelOperationInfo = documentModelAdministrationClient.listOperations();
modelOperationInfo.forEach(modelOperationSummary -> {
System.out.printf("Operation ID: %s%n", modelOperationSummary.getOperationId());
System.out.printf("Operation Status: %s%n", modelOperationSummary.getStatus());
System.out.printf("Operation Created on: %s%n", modelOperationSummary.getCreatedOn());
System.out.printf("Operation Percent completed: %d%n", modelOperationSummary.getPercentCompleted());
System.out.printf("Operation Kind: %s%n", modelOperationSummary.getKind());
System.out.printf("Operation Last updated on: %s%n", modelOperationSummary.getLastUpdatedOn());
System.out.printf("Operation resource location: %s%n", modelOperationSummary.getResourceLocation());
});
Returns:
listOperations
public PagedIterable
Enumere la información de cada operación en la cuenta de Form Recognizer en las últimas 24 horas con una respuesta HTTP y un especificadoContext.
Código de ejemplo
PagedIterable<OperationSummary>
modelOperationInfo = documentModelAdministrationClient.listOperations(Context.NONE);
modelOperationInfo.forEach(modelOperationSummary -> {
System.out.printf("Operation ID: %s%n", modelOperationSummary.getOperationId());
System.out.printf("Operation Status: %s%n", modelOperationSummary.getStatus());
System.out.printf("Operation Created on: %s%n", modelOperationSummary.getCreatedOn());
System.out.printf("Operation Percent completed: %d%n", modelOperationSummary.getPercentCompleted());
System.out.printf("Operation Kind: %s%n", modelOperationSummary.getKind());
System.out.printf("Operation Last updated on: %s%n", modelOperationSummary.getLastUpdatedOn());
System.out.printf("Operation resource location: %s%n", modelOperationSummary.getResourceLocation());
});
Parameters:
Returns:
Se aplica a
Azure SDK for Java
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de