DocumentModelAdministrationClient Classe
DocumentModelAdministrationClient est l’interface Form Recognizer à utiliser pour créer et gérer des modèles.
Il fournit des méthodes permettant de créer des modèles et des classifieurs, ainsi que des méthodes d’affichage et de suppression de modèles et classifieurs, d’affichage des opérations de modèle et de classifieur, d’accès aux informations de compte, de copie de modèles vers une autre ressource Form Recognizer et de composition d’un nouveau modèle à partir d’une collection de modèles existants.
Notes
DocumentModelAdministrationClient doit être utilisé avec les versions d’API
2022-08-31 et plus. Pour utiliser les versions <d’API =v2.1, instanciez un FormTrainingClient.
Nouveauté de la version 2022-08-31 : DocumentModelAdministrationClient et ses méthodes clientes.
- Héritage
-
azure.ai.formrecognizer._form_base_client.FormRecognizerClientBaseDocumentModelAdministrationClient
Constructeur
DocumentModelAdministrationClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)
Paramètres
- endpoint
- str
Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus2.api.cognitive.microsoft.com).
- credential
- AzureKeyCredential ou TokenCredential
Informations d’identification nécessaires pour que le client se connecte à Azure. Il s’agit d’un instance d’AzureKeyCredential si vous utilisez une clé API ou des informations d’identification de jeton à partir de identity.
- api_version
- str ou DocumentAnalysisApiVersion
Version de l’API du service à utiliser pour les requêtes. Il utilise par défaut la dernière version du service. La définition d’une version antérieure peut réduire la compatibilité des fonctionnalités. Pour utiliser les versions <d’API =v2.1, instanciez un FormTrainingClient.
Exemples
Création du DocumentModelAdministrationClient avec un point de terminaison et une clé API.
from azure.core.credentials import AzureKeyCredential
from azure.ai.formrecognizer import DocumentModelAdministrationClient
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
document_model_admin_client = DocumentModelAdministrationClient(
endpoint, AzureKeyCredential(key)
)
Création du DocumentModelAdministrationClient avec des informations d’identification de jeton.
"""DefaultAzureCredential will use the values from these environment
variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
"""
from azure.ai.formrecognizer import DocumentModelAdministrationClient
from azure.identity import DefaultAzureCredential
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
credential = DefaultAzureCredential()
document_model_admin_client = DocumentModelAdministrationClient(
endpoint, credential
)
Méthodes
begin_build_document_classifier |
Créez un classifieur de documents. Pour plus d’informations sur la création et l’apprentissage d’un modèle classifieur personnalisé, consultez https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Nouveautés de la version 2023-07-31 : méthode cliente begin_build_document_classifier . |
begin_build_document_model |
Créez un modèle de document personnalisé. La demande doit inclure un paramètre blob_container_url mot clé qui est un URI de conteneur d’objets blob de stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé). Notez qu’un URI de conteneur (sans SAP) n’est accepté que lorsque le conteneur est public ou a une identité managée configurée. Pour plus d’informations sur la configuration des identités managées, utilisez Form Recognizer ici : https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », « image/bmp » ou « image/heif ». Les autres types de contenu dans le conteneur sont ignorés. Nouveauté de la version 2023-07-31 : l’argument file_list mot clé. |
begin_compose_document_model |
Crée un modèle de document composé à partir d’une collection de modèles existants. Un modèle composé permet d’appeler plusieurs modèles avec un seul ID de modèle. Lors de la soumission d’un document pour analyse avec un ID de modèle composé, une étape de classification a d’abord lieu pour l’acheminer vers le modèle personnalisé approprié. |
begin_copy_document_model_to |
Copiez un modèle de document stocké dans cette ressource (la source) vers la ressource cible spécifiée par l’utilisateur Form Recognizer ressource. Cela doit être appelé avec la ressource Form Recognizer source (avec le modèle destiné à être copié). Le paramètre cible doit être fourni à partir de la sortie de la ressource cible lors de l’appel de la get_copy_authorization méthode . |
close |
Fermez la DocumentModelAdministrationClient session. |
delete_document_classifier |
Supprimer un classifieur de documents. Nouveautés de la version 2023-07-31 : méthode cliente delete_document_classifier . |
delete_document_model |
Supprimer un modèle de document personnalisé. |
get_copy_authorization |
Générez l’autorisation de copie d’un modèle personnalisé dans la ressource Form Recognizer cible. Cela doit être appelé par la ressource cible (où le modèle sera copié) et la sortie peut être passée en tant que paramètre cible dans begin_copy_document_model_to. |
get_document_analysis_client |
Obtenez une instance d’un DocumentAnalysisClient à partir de DocumentModelAdministrationClient. |
get_document_classifier |
Obtenez un classifieur de documents par son ID. Nouveauté de la version 2023-07-31 : la méthode cliente get_document_classifier . |
get_document_model |
Obtenir un modèle de document par son ID. |
get_operation |
Obtenir une opération par son ID. Obtenez une opération associée à la ressource Form Recognizer. Notez que les informations d’opération ne sont conservées que pendant 24 heures. Si l’opération de modèle de document a réussi, le modèle est accessible à l’aide get_document_model des API ou list_document_models . |
get_resource_details |
Obtenez des informations sur les modèles sous la ressource Form Recognizer. |
list_document_classifiers |
Répertoriez les informations de chaque classifieur de documents, y compris son ID de classifieur, sa description et la date de sa création. Nouveautés de la version 2023-07-31 : méthode cliente list_document_classifiers . |
list_document_models |
Répertoriez les informations de chaque modèle, y compris son ID de modèle, sa description et sa date de création. |
list_operations |
Répertorier les informations pour chaque opération. Répertorie toutes les opérations associées à la ressource Form Recognizer. Notez que les informations d’opération ne sont conservées que pendant 24 heures. Si une opération de modèle de document a réussi, le modèle de document est accessible à l’aide get_document_model des API ou list_document_models . |
send_request |
Exécute une requête réseau à l’aide du pipeline existant du client. L’URL de la demande peut être relative à l’URL de base. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Le remplacement de la version d’API configurée du client dans l’URL relative est pris en charge sur le client avec la version d’API 2022-08-31 et ultérieure. Substitution dans l’URL absolue prise en charge sur le client avec n’importe quelle version d’API. Cette méthode ne se déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de demandes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request. |
begin_build_document_classifier
Créez un classifieur de documents. Pour plus d’informations sur la création et l’apprentissage d’un modèle classifieur personnalisé, consultez https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.
Nouveautés de la version 2023-07-31 : méthode cliente begin_build_document_classifier .
begin_build_document_classifier(doc_types: Mapping[str, ClassifierDocumentTypeDetails], *, classifier_id: str | None = None, description: str | None = None, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentClassifierDetails]
Paramètres
- doc_types
- Mapping[str, ClassifierDocumentTypeDetails]
Mappage des types de documents par rapport à classer.
- classifier_id
- str
Nom du classifieur de document unique. S’il n’est pas spécifié, un ID de classifieur est créé pour vous.
- description
- str
Description du classifieur de document.
Retours
Instance d’un DocumentModelAdministrationLROPoller. Appelez result() sur l’objet poller pour retourner un DocumentClassifierDetails.
Type de retour
Exceptions
Exemples
Créez un classifieur de documents.
import os
from azure.ai.formrecognizer import (
DocumentModelAdministrationClient,
ClassifierDocumentTypeDetails,
BlobSource,
BlobFileListSource,
)
from azure.core.credentials import AzureKeyCredential
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
container_sas_url = os.environ["CLASSIFIER_CONTAINER_SAS_URL"]
document_model_admin_client = DocumentModelAdministrationClient(
endpoint=endpoint, credential=AzureKeyCredential(key)
)
poller = document_model_admin_client.begin_build_document_classifier(
doc_types={
"IRS-1040-A": ClassifierDocumentTypeDetails(
source=BlobSource(
container_url=container_sas_url, prefix="IRS-1040-A/train"
)
),
"IRS-1040-D": ClassifierDocumentTypeDetails(
source=BlobFileListSource(
container_url=container_sas_url, file_list="IRS-1040-D.jsonl"
)
),
},
description="IRS document classifier",
)
result = poller.result()
print(f"Classifier ID: {result.classifier_id}")
print(f"API version used to build the classifier model: {result.api_version}")
print(f"Classifier description: {result.description}")
print(f"Document classes used for training the model:")
for doc_type, details in result.doc_types.items():
print(f"Document type: {doc_type}")
print(f"Container source: {details.source.container_url}\n")
begin_build_document_model
Créez un modèle de document personnalisé.
La demande doit inclure un paramètre blob_container_url mot clé qui est un URI de conteneur d’objets blob de stockage Azure accessible en externe (de préférence un URI de signature d’accès partagé). Notez qu’un URI de conteneur (sans SAP) n’est accepté que lorsque le conteneur est public ou a une identité managée configurée. Pour plus d’informations sur la configuration des identités managées, utilisez Form Recognizer ici : https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Les modèles sont créés à l’aide de documents du type de contenu suivant : « application/pdf », « image/jpeg », « image/png », « image/tiff », « image/bmp » ou « image/heif ». Les autres types de contenu dans le conteneur sont ignorés.
Nouveauté de la version 2023-07-31 : l’argument file_list mot clé.
begin_build_document_model(build_mode: str | ModelBuildMode, *, blob_container_url: str, prefix: str | None = None, model_id: str | None = None, description: str | None = None, tags: Mapping[str, str] | None = None, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]
Paramètres
- build_mode
- ModelBuildMode
Mode de génération du modèle personnalisé. Les valeurs possibles sont les suivantes : « template », « neural ». Pour plus d’informations sur les modes de génération, consultez : https://aka.ms/azsdk/formrecognizer/buildmode.
- blob_container_url
- str
URI SAS d’un conteneur d’objets blob Stockage Azure. Un URI de conteneur (sans SAP) peut être utilisé si le conteneur est public ou si une identité managée est configurée. Pour plus d’informations sur la configuration d’un jeu de données d’apprentissage, consultez : https://aka.ms/azsdk/formrecognizer/buildtrainingset.
- model_id
- str
ID unique pour votre modèle. S’il n’est pas spécifié, un ID de modèle est créé pour vous.
- description
- str
Description facultative à ajouter au modèle.
- prefix
- str
Chaîne de préfixe respectant la casse pour filtrer les documents dans le chemin d’url du conteneur d’objets blob. Par exemple, lorsque vous utilisez un URI d’objet blob de stockage Azure, utilisez le préfixe pour restreindre les sous-dossiers. le préfixe doit se terminer par « / » pour éviter les cas où les noms de fichiers partagent le même préfixe.
- file_list
- str
Chemin d’accès à un fichier JSONL dans le conteneur spécifiant un sous-ensemble de documents pour l’entraînement.
Liste des attributs de balise clé-valeur définis par l’utilisateur associés au modèle.
Retours
Instance d’un DocumentModelAdministrationLROPoller. Appelez result() sur l’objet poller pour retourner un DocumentModelDetails.
Type de retour
Exceptions
Exemples
Génération d’un modèle à partir de fichiers d’entraînement.
from azure.ai.formrecognizer import (
DocumentModelAdministrationClient,
ModelBuildMode,
)
from azure.core.credentials import AzureKeyCredential
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
container_sas_url = os.environ["CONTAINER_SAS_URL"]
document_model_admin_client = DocumentModelAdministrationClient(
endpoint, AzureKeyCredential(key)
)
poller = document_model_admin_client.begin_build_document_model(
ModelBuildMode.TEMPLATE,
blob_container_url=container_sas_url,
description="my model description",
)
model = poller.result()
print(f"Model ID: {model.model_id}")
print(f"Description: {model.description}")
print(f"Model created on: {model.created_on}")
print(f"Model expires on: {model.expires_on}")
print("Doc types the model can recognize:")
for name, doc_type in model.doc_types.items():
print(
f"Doc Type: '{name}' built with '{doc_type.build_mode}' mode which has the following fields:"
)
for field_name, field in doc_type.field_schema.items():
print(
f"Field: '{field_name}' has type '{field['type']}' and confidence score "
f"{doc_type.field_confidence[field_name]}"
)
begin_compose_document_model
Crée un modèle de document composé à partir d’une collection de modèles existants.
Un modèle composé permet d’appeler plusieurs modèles avec un seul ID de modèle. Lors de la soumission d’un document pour analyse avec un ID de modèle composé, une étape de classification a d’abord lieu pour l’acheminer vers le modèle personnalisé approprié.
begin_compose_document_model(component_model_ids: List[str], **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]
Paramètres
- model_id
- str
ID unique pour votre modèle composé. S’il n’est pas spécifié, un ID de modèle est créé pour vous.
- description
- str
Description facultative à ajouter au modèle.
Liste des attributs de balise clé-valeur définis par l’utilisateur associés au modèle.
Retours
Instance d’un DocumentModelAdministrationLROPoller. Appelez result() sur l’objet poller pour retourner un DocumentModelDetails.
Type de retour
Exceptions
Exemples
Création d’un modèle composé avec des modèles existants.
from azure.core.credentials import AzureKeyCredential
from azure.ai.formrecognizer import (
DocumentModelAdministrationClient,
ModelBuildMode,
)
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
po_supplies = os.environ["PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL"]
po_equipment = os.environ["PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL"]
po_furniture = os.environ["PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL"]
po_cleaning_supplies = os.environ["PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL"]
document_model_admin_client = DocumentModelAdministrationClient(
endpoint=endpoint, credential=AzureKeyCredential(key)
)
supplies_poller = document_model_admin_client.begin_build_document_model(
ModelBuildMode.TEMPLATE,
blob_container_url=po_supplies,
description="Purchase order-Office supplies",
)
equipment_poller = document_model_admin_client.begin_build_document_model(
ModelBuildMode.TEMPLATE,
blob_container_url=po_equipment,
description="Purchase order-Office Equipment",
)
furniture_poller = document_model_admin_client.begin_build_document_model(
ModelBuildMode.TEMPLATE,
blob_container_url=po_furniture,
description="Purchase order-Furniture",
)
cleaning_supplies_poller = document_model_admin_client.begin_build_document_model(
ModelBuildMode.TEMPLATE,
blob_container_url=po_cleaning_supplies,
description="Purchase order-Cleaning Supplies",
)
supplies_model = supplies_poller.result()
equipment_model = equipment_poller.result()
furniture_model = furniture_poller.result()
cleaning_supplies_model = cleaning_supplies_poller.result()
purchase_order_models = [
supplies_model.model_id,
equipment_model.model_id,
furniture_model.model_id,
cleaning_supplies_model.model_id,
]
poller = document_model_admin_client.begin_compose_document_model(
purchase_order_models, description="Office Supplies Composed Model"
)
model = poller.result()
print("Office Supplies Composed Model Info:")
print(f"Model ID: {model.model_id}")
print(f"Description: {model.description}")
print(f"Model created on: {model.created_on}")
print(f"Model expires on: {model.expires_on}")
print("Doc types the model can recognize:")
for name, doc_type in model.doc_types.items():
print(f"Doc Type: '{name}' which has the following fields:")
for field_name, field in doc_type.field_schema.items():
print(
f"Field: '{field_name}' has type '{field['type']}' and confidence score "
f"{doc_type.field_confidence[field_name]}"
)
begin_copy_document_model_to
Copiez un modèle de document stocké dans cette ressource (la source) vers la ressource cible spécifiée par l’utilisateur Form Recognizer ressource.
Cela doit être appelé avec la ressource Form Recognizer source (avec le modèle destiné à être copié). Le paramètre cible doit être fourni à partir de la sortie de la ressource cible lors de l’appel de la get_copy_authorization méthode .
begin_copy_document_model_to(model_id: str, target: TargetAuthorization, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]
Paramètres
- target
- <xref:azure.ai.formrecognizer.TargetAuthorization>
Autorisation de copie générée à partir de l’appel de la ressource cible à get_copy_authorization.
Retours
Instance d’un DocumentModelAdministrationLROPoller. Appelez result() sur l’objet poller pour retourner un DocumentModelDetails.
Type de retour
Exceptions
Exemples
Copier un modèle de la ressource source vers la ressource cible
from azure.core.credentials import AzureKeyCredential
from azure.ai.formrecognizer import DocumentModelAdministrationClient
source_endpoint = os.environ["AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT"]
source_key = os.environ["AZURE_FORM_RECOGNIZER_SOURCE_KEY"]
target_endpoint = os.environ["AZURE_FORM_RECOGNIZER_TARGET_ENDPOINT"]
target_key = os.environ["AZURE_FORM_RECOGNIZER_TARGET_KEY"]
source_model_id = os.getenv("AZURE_SOURCE_MODEL_ID", custom_model_id)
target_client = DocumentModelAdministrationClient(
endpoint=target_endpoint, credential=AzureKeyCredential(target_key)
)
target = target_client.get_copy_authorization(
description="model copied from other resource"
)
source_client = DocumentModelAdministrationClient(
endpoint=source_endpoint, credential=AzureKeyCredential(source_key)
)
poller = source_client.begin_copy_document_model_to(
model_id=source_model_id,
target=target, # output from target client's call to get_copy_authorization()
)
copied_over_model = poller.result()
print(f"Model ID: {copied_over_model.model_id}")
print(f"Description: {copied_over_model.description}")
print(f"Model created on: {copied_over_model.created_on}")
print(f"Model expires on: {copied_over_model.expires_on}")
print("Doc types the model can recognize:")
for name, doc_type in copied_over_model.doc_types.items():
print(f"Doc Type: '{name}' which has the following fields:")
for field_name, field in doc_type.field_schema.items():
print(
f"Field: '{field_name}' has type '{field['type']}' and confidence score "
f"{doc_type.field_confidence[field_name]}"
)
close
delete_document_classifier
Supprimer un classifieur de documents.
Nouveautés de la version 2023-07-31 : méthode cliente delete_document_classifier .
delete_document_classifier(classifier_id: str, **kwargs: Any) -> None
Paramètres
Retours
None
Type de retour
Exceptions
Exemples
Supprimer un classifieur.
document_model_admin_client.delete_document_classifier(
classifier_id=my_classifier.classifier_id
)
try:
document_model_admin_client.get_document_classifier(
classifier_id=my_classifier.classifier_id
)
except ResourceNotFoundError:
print(f"Successfully deleted classifier with ID {my_classifier.classifier_id}")
delete_document_model
Supprimer un modèle de document personnalisé.
delete_document_model(model_id: str, **kwargs: Any) -> None
Paramètres
Retours
None
Type de retour
Exceptions
Exemples
Supprimer un modèle.
document_model_admin_client.delete_document_model(model_id=my_model.model_id)
try:
document_model_admin_client.get_document_model(model_id=my_model.model_id)
except ResourceNotFoundError:
print(f"Successfully deleted model with ID {my_model.model_id}")
get_copy_authorization
Générez l’autorisation de copie d’un modèle personnalisé dans la ressource Form Recognizer cible.
Cela doit être appelé par la ressource cible (où le modèle sera copié) et la sortie peut être passée en tant que paramètre cible dans begin_copy_document_model_to.
get_copy_authorization(**kwargs: Any) -> TargetAuthorization
Paramètres
- model_id
- str
ID unique pour votre modèle copié. S’il n’est pas spécifié, un ID de modèle est créé pour vous.
- description
- str
Description facultative à ajouter au modèle.
Liste des attributs de balise clé-valeur définis par l’utilisateur associés au modèle.
Retours
Dictionnaire avec les valeurs nécessaires pour l’autorisation de copie.
Type de retour
Exceptions
get_document_analysis_client
Obtenez une instance d’un DocumentAnalysisClient à partir de DocumentModelAdministrationClient.
get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient
Retours
A DocumentAnalysisClient
Type de retour
Exceptions
get_document_classifier
Obtenez un classifieur de documents par son ID.
Nouveauté de la version 2023-07-31 : la méthode cliente get_document_classifier .
get_document_classifier(classifier_id: str, **kwargs: Any) -> DocumentClassifierDetails
Paramètres
Retours
DocumentClassifierDetails
Type de retour
Exceptions
Exemples
Obtenir un classifieur par son ID.
my_classifier = document_model_admin_client.get_document_classifier(
classifier_id=classifier_model.classifier_id
)
print(f"\nClassifier ID: {my_classifier.classifier_id}")
print(f"Description: {my_classifier.description}")
print(f"Classifier created on: {my_classifier.created_on}")
get_document_model
Obtenir un modèle de document par son ID.
get_document_model(model_id: str, **kwargs: Any) -> DocumentModelDetails
Paramètres
Retours
DocumentModelDetails
Type de retour
Exceptions
Exemples
Obtenir un modèle par son ID.
my_model = document_model_admin_client.get_document_model(model_id=model.model_id)
print(f"\nModel ID: {my_model.model_id}")
print(f"Description: {my_model.description}")
print(f"Model created on: {my_model.created_on}")
print(f"Model expires on: {my_model.expires_on}")
get_operation
Obtenir une opération par son ID.
Obtenez une opération associée à la ressource Form Recognizer. Notez que les informations d’opération ne sont conservées que pendant 24 heures. Si l’opération de modèle de document a réussi, le modèle est accessible à l’aide get_document_model des API ou list_document_models .
get_operation(operation_id: str, **kwargs: Any) -> OperationDetails
Paramètres
Retours
OperationDetails
Type de retour
Exceptions
Exemples
Obtenir une opération de modèle de document par son ID.
# Get an operation by ID
if operations:
print(f"\nGetting operation info by ID: {operations[0].operation_id}")
operation_info = document_model_admin_client.get_operation(
operations[0].operation_id
)
if operation_info.status == "succeeded":
print(f"My {operation_info.kind} operation is completed.")
result = operation_info.result
if result is not None:
if operation_info.kind == "documentClassifierBuild":
print(f"Classifier ID: {result.classifier_id}")
else:
print(f"Model ID: {result.model_id}")
elif operation_info.status == "failed":
print(f"My {operation_info.kind} operation failed.")
error = operation_info.error
if error is not None:
print(f"{error.code}: {error.message}")
else:
print(f"My operation status is {operation_info.status}")
else:
print("No operations found.")
get_resource_details
Obtenez des informations sur les modèles sous la ressource Form Recognizer.
get_resource_details(**kwargs: Any) -> ResourceDetails
Retours
Résumé des modèles personnalisés sous la ressource - nombre et limite de modèles.
Type de retour
Exceptions
Exemples
Obtenez le nombre de modèles et les limites sous la ressource Form Recognizer.
document_model_admin_client = DocumentModelAdministrationClient(
endpoint=endpoint, credential=AzureKeyCredential(key)
)
account_details = document_model_admin_client.get_resource_details()
print(
f"Our resource has {account_details.custom_document_models.count} custom models, "
f"and we can have at most {account_details.custom_document_models.limit} custom models"
)
neural_models = account_details.neural_document_model_quota
print(
f"The quota limit for custom neural document models is {neural_models.quota} and the resource has"
f"used {neural_models.used}. The resource quota will reset on {neural_models.quota_resets_on}"
)
list_document_classifiers
Répertoriez les informations de chaque classifieur de documents, y compris son ID de classifieur, sa description et la date de sa création.
Nouveautés de la version 2023-07-31 : méthode cliente list_document_classifiers .
list_document_classifiers(**kwargs: Any) -> ItemPaged[DocumentClassifierDetails]
Retours
Paginable de DocumentClassifierDetails.
Type de retour
Exceptions
Exemples
Répertoriez tous les classifieurs qui ont été générés avec succès sous la ressource Form Recognizer.
classifiers = document_model_admin_client.list_document_classifiers()
print("We have the following 'ready' models with IDs and descriptions:")
for classifier in classifiers:
print(f"{classifier.classifier_id} | {classifier.description}")
list_document_models
Répertoriez les informations de chaque modèle, y compris son ID de modèle, sa description et sa date de création.
list_document_models(**kwargs: Any) -> ItemPaged[DocumentModelSummary]
Retours
Paginable de DocumentModelSummary.
Type de retour
Exceptions
Exemples
Répertoriez tous les modèles qui ont été générés avec succès sous la ressource Form Recognizer.
models = document_model_admin_client.list_document_models()
print("We have the following 'ready' models with IDs and descriptions:")
for model in models:
print(f"{model.model_id} | {model.description}")
list_operations
Répertorier les informations pour chaque opération.
Répertorie toutes les opérations associées à la ressource Form Recognizer. Notez que les informations d’opération ne sont conservées que pendant 24 heures. Si une opération de modèle de document a réussi, le modèle de document est accessible à l’aide get_document_model des API ou list_document_models .
list_operations(**kwargs: Any) -> ItemPaged[OperationSummary]
Retours
Paginable d’OperationSummary.
Type de retour
Exceptions
Exemples
Répertorie toutes les opérations de modèle de document au cours des dernières 24 heures.
from azure.core.credentials import AzureKeyCredential
from azure.ai.formrecognizer import DocumentModelAdministrationClient
endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
document_model_admin_client = DocumentModelAdministrationClient(
endpoint=endpoint, credential=AzureKeyCredential(key)
)
operations = list(document_model_admin_client.list_operations())
print("The following document model operations exist under my resource:")
for operation in operations:
print(f"\nOperation ID: {operation.operation_id}")
print(f"Operation kind: {operation.kind}")
print(f"Operation status: {operation.status}")
print(f"Operation percent completed: {operation.percent_completed}")
print(f"Operation created on: {operation.created_on}")
print(f"Operation last updated on: {operation.last_updated_on}")
print(
f"Resource location of successful operation: {operation.resource_location}"
)
send_request
Exécute une requête réseau à l’aide du pipeline existant du client.
L’URL de la demande peut être relative à l’URL de base. La version de l’API de service utilisée pour la requête est identique à celle du client, sauf indication contraire. Le remplacement de la version d’API configurée du client dans l’URL relative est pris en charge sur le client avec la version d’API 2022-08-31 et ultérieure. Substitution dans l’URL absolue prise en charge sur le client avec n’importe quelle version d’API. Cette méthode ne se déclenche pas si la réponse est une erreur ; pour déclencher une exception, appelez raise_for_status() sur l’objet de réponse retourné. Pour plus d’informations sur l’envoi de demandes personnalisées avec cette méthode, consultez https://aka.ms/azsdk/dpcodegen/python/send_request.
send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse
Paramètres
- stream
- bool
Indique si la charge utile de réponse sera diffusée en continu. Valeur par défaut False.
Retours
Réponse de votre appel réseau. Ne gère pas les erreurs sur votre réponse.
Type de retour
Exceptions
Azure SDK for Python