Source code for azure.ai.formrecognizer.aio._form_training_client_async
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
# pylint: disable=protected-access
import json
from typing import (
Any,
Dict,
Union,
List,
)
from azure.core.credentials import AzureKeyCredential
from azure.core.credentials_async import AsyncTokenCredential
from azure.core.pipeline import PipelineResponse
from azure.core.polling import AsyncLROPoller
from azure.core.pipeline import AsyncPipeline
from azure.core.polling.async_base_polling import AsyncLROBasePolling
from azure.core.tracing.decorator import distributed_trace
from azure.core.tracing.decorator_async import distributed_trace_async
from azure.core.async_paging import AsyncItemPaged
from ._form_recognizer_client_async import FormRecognizerClient
from ._helpers_async import AsyncTransportWrapper
from .._api_versions import FormRecognizerApiVersion
from .._models import CustomFormModelInfo, AccountProperties, CustomFormModel
from ._form_base_client_async import FormRecognizerClientBaseAsync
from .._polling import FormTrainingPolling, CopyPolling
[docs]class FormTrainingClient(FormRecognizerClientBaseAsync):
"""FormTrainingClient is the Form Recognizer interface to use for creating
and managing custom models. It provides methods for training models on the forms
you provide, as well as methods for viewing and deleting models, accessing
account properties, copying models to another Form Recognizer resource, and
composing models from a collection of existing models trained with labels.
.. note:: FormTrainingClient should be used with API versions <=v2.1.
To use API versions 2022-08-31 and up, instantiate a DocumentModelAdministrationClient.
:param str endpoint: Supported Cognitive Services endpoints (protocol and hostname,
for example: https://westus2.api.cognitive.microsoft.com).
:param credential: Credentials needed for the client to connect to Azure.
This is an instance of AzureKeyCredential if using an API key or a token
credential from :mod:`azure.identity`.
:type credential: :class:`~azure.core.credentials.AzureKeyCredential`
or :class:`~azure.core.credentials_async.AsyncTokenCredential`
:keyword api_version:
The API version of the service to use for requests. It defaults to API version v2.1.
Setting to an older version may result in reduced feature compatibility. To use the
latest supported API version and features, instantiate a DocumentModelAdministrationClient instead.
:paramtype api_version: str or ~azure.ai.formrecognizer.FormRecognizerApiVersion
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_authentication_async.py
:start-after: [START create_ft_client_with_key_async]
:end-before: [END create_ft_client_with_key_async]
:language: python
:dedent: 8
:caption: Creating the FormTrainingClient with an endpoint and API key.
.. literalinclude:: ../samples/v3.1/async_samples/sample_authentication_async.py
:start-after: [START create_ft_client_with_aad_async]
:end-before: [END create_ft_client_with_aad_async]
:language: python
:dedent: 8
:caption: Creating the FormTrainingClient with a token credential.
"""
def __init__(
self, endpoint: str, credential: Union[AzureKeyCredential, AsyncTokenCredential], **kwargs: Any
) -> None:
api_version = kwargs.pop("api_version", FormRecognizerApiVersion.V2_1)
super().__init__(
endpoint=endpoint, credential=credential, api_version=api_version, client_kind="form", **kwargs
)
[docs] @distributed_trace_async
async def begin_training(
self, training_files_url: str, use_training_labels: bool, **kwargs: Any
) -> AsyncLROPoller[CustomFormModel]:
"""Create and train a custom model. The request must include a `training_files_url` parameter that is an
externally accessible Azure storage blob container URI (preferably a Shared Access Signature URI). Note that
a container URI (without SAS) is accepted only when the container is public or has a managed identity
configured, see more about configuring managed identities to work with Form Recognizer here:
https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities.
Models are trained using documents that are of the following content type - 'application/pdf',
'image/jpeg', 'image/png', 'image/tiff', or 'image/bmp'. Other types of content in the container is ignored.
:param str training_files_url: An Azure Storage blob container's SAS URI. A container URI (without SAS)
can be used if the container is public or has a managed identity configured. For more information on
setting up a training data set, see: https://aka.ms/azsdk/formrecognizer/buildtrainingset.
:param bool use_training_labels: Whether to train with labels or not. Corresponding labeled files must
exist in the blob container if set to `True`.
:keyword str prefix: A case-sensitive prefix string to filter documents in the source path for
training. For example, when using an Azure storage blob URI, use the prefix to restrict sub
folders for training.
:keyword bool include_subfolders: A flag to indicate if subfolders within the set of prefix folders
will also need to be included when searching for content to be preprocessed. Not supported if
training with labels.
:keyword str model_name: An optional, user-defined name to associate with your model.
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:return: An instance of an AsyncLROPoller. Call `result()` on the poller
object to return a :class:`~azure.ai.formrecognizer.CustomFormModel`.
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.formrecognizer.CustomFormModel]
:raises ~azure.core.exceptions.HttpResponseError:
Note that if the training fails, the exception is raised, but a model with an
"invalid" status is still created. You can delete this model by calling :func:`~delete_model()`
.. versionadded:: v2.1
The *model_name* keyword argument
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_train_model_without_labels_async.py
:start-after: [START training_async]
:end-before: [END training_async]
:language: python
:dedent: 8
:caption: Training a model (without labels) with your custom forms.
"""
def callback_v2_0(raw_response):
model = self._deserialize(self._generated_models.Model, raw_response)
return CustomFormModel._from_generated(model, api_version=self._api_version)
def callback_v2_1(raw_response, _, headers): # pylint: disable=unused-argument
model = self._deserialize(self._generated_models.Model, raw_response)
return CustomFormModel._from_generated(model, api_version=self._api_version)
cls = kwargs.pop("cls", None)
model_name = kwargs.pop("model_name", None)
continuation_token = kwargs.pop("continuation_token", None)
polling_interval = kwargs.pop("polling_interval", self._client._config.polling_interval)
if model_name and self._api_version == "2.0":
raise ValueError("'model_name' is only available for API version V2_1 and up")
if self._api_version == "2.0":
deserialization_callback = cls if cls else callback_v2_0
if continuation_token:
return AsyncLROPoller.from_continuation_token(
polling_method=AsyncLROBasePolling( # type: ignore
timeout=polling_interval, lro_algorithms=[FormTrainingPolling()], **kwargs
),
continuation_token=continuation_token,
client=self._client._client,
deserialization_callback=deserialization_callback,
)
response = await self._client.train_custom_model_async(
train_request=self._generated_models.TrainRequest(
source=training_files_url,
use_label_file=use_training_labels,
source_filter=self._generated_models.TrainSourceFilter(
prefix=kwargs.pop("prefix", ""),
include_sub_folders=kwargs.pop("include_subfolders", False),
),
),
cls=lambda pipeline_response, _, response_headers: pipeline_response,
**kwargs
)
return AsyncLROPoller(
self._client._client,
response,
deserialization_callback,
AsyncLROBasePolling( # type: ignore
timeout=polling_interval, lro_algorithms=[FormTrainingPolling()], **kwargs
),
)
deserialization_callback = cls if cls else callback_v2_1
return await self._client.begin_train_custom_model_async( # type: ignore
train_request=self._generated_models.TrainRequest(
source=training_files_url,
use_label_file=use_training_labels,
source_filter=self._generated_models.TrainSourceFilter(
prefix=kwargs.pop("prefix", ""),
include_sub_folders=kwargs.pop("include_subfolders", False),
),
model_name=model_name,
),
cls=deserialization_callback,
continuation_token=continuation_token,
polling=AsyncLROBasePolling(timeout=polling_interval, lro_algorithms=[FormTrainingPolling()], **kwargs),
**kwargs
)
[docs] @distributed_trace_async
async def delete_model(self, model_id: str, **kwargs: Any) -> None:
"""Mark model for deletion. Model artifacts will be permanently
removed within a predetermined period.
:param model_id: Model identifier.
:type model_id: str
:rtype: None
:raises ~azure.core.exceptions.HttpResponseError or ~azure.core.exceptions.ResourceNotFoundError:
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_manage_custom_models_async.py
:start-after: [START delete_model_async]
:end-before: [END delete_model_async]
:language: python
:dedent: 12
:caption: Delete a custom model.
"""
if not model_id:
raise ValueError("model_id cannot be None or empty.")
return await self._client.delete_custom_model(model_id=model_id, **kwargs)
[docs] @distributed_trace
def list_custom_models(self, **kwargs: Any) -> AsyncItemPaged[CustomFormModelInfo]:
"""List information for each model, including model id,
model status, and when it was created and last modified.
:return: AsyncItemPaged[:class:`~azure.ai.formrecognizer.CustomFormModelInfo`]
:rtype: ~azure.core.async_paging.AsyncItemPaged
:raises ~azure.core.exceptions.HttpResponseError:
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_manage_custom_models_async.py
:start-after: [START list_custom_models_async]
:end-before: [END list_custom_models_async]
:language: python
:dedent: 12
:caption: List model information for each model on the account.
"""
return self._client.list_custom_models( # type: ignore
cls=kwargs.pop(
"cls",
lambda objs: [CustomFormModelInfo._from_generated(x, api_version=self._api_version) for x in objs],
),
**kwargs
)
[docs] @distributed_trace_async
async def get_account_properties(self, **kwargs: Any) -> AccountProperties:
"""Get information about the models on the form recognizer account.
:return: Summary of models on account - custom model count,
custom model limit.
:rtype: ~azure.ai.formrecognizer.AccountProperties
:raises ~azure.core.exceptions.HttpResponseError:
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_manage_custom_models_async.py
:start-after: [START get_account_properties_async]
:end-before: [END get_account_properties_async]
:language: python
:dedent: 8
:caption: Get properties for the form recognizer account.
"""
response = await self._client.get_custom_models(**kwargs)
return AccountProperties._from_generated(response.summary)
[docs] @distributed_trace_async
async def get_custom_model(self, model_id: str, **kwargs: Any) -> CustomFormModel:
"""Get a description of a custom model, including the types of forms
it can recognize, and the fields it will extract for each form type.
:param str model_id: Model identifier.
:return: CustomFormModel
:rtype: ~azure.ai.formrecognizer.CustomFormModel
:raises ~azure.core.exceptions.HttpResponseError or ~azure.core.exceptions.ResourceNotFoundError:
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_manage_custom_models_async.py
:start-after: [START get_custom_model_async]
:end-before: [END get_custom_model_async]
:language: python
:dedent: 12
:caption: Get a custom model with a model ID.
"""
if not model_id:
raise ValueError("model_id cannot be None or empty.")
response = await self._client.get_custom_model(model_id=model_id, include_keys=True, **kwargs)
if hasattr(response, "composed_train_results") and response.composed_train_results: # type: ignore
return CustomFormModel._from_generated_composed(response)
return CustomFormModel._from_generated(response, api_version=self._api_version)
[docs] @distributed_trace_async
async def get_copy_authorization(
self, resource_id: str, resource_region: str, **kwargs: Any
) -> Dict[str, Union[str, int]]:
"""Generate authorization for copying a custom model into the target Form Recognizer resource.
This should be called by the target resource (where the model will be copied to)
and the output can be passed as the `target` parameter into :func:`~begin_copy_model()`.
:param str resource_id: Azure Resource Id of the target Form Recognizer resource
where the model will be copied to.
:param str resource_region: Location of the target Form Recognizer resource. A valid Azure
region name supported by Cognitive Services. For example, 'westus', 'eastus' etc.
See https://azure.microsoft.com/global-infrastructure/services/?products=cognitive-services
for the regional availability of Cognitive Services.
:return: A dictionary with values for the copy authorization -
"modelId", "accessToken", "resourceId", "resourceRegion", and "expirationDateTimeTicks".
:rtype: Dict[str, Union[str, int]]
:raises ~azure.core.exceptions.HttpResponseError:
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_copy_model_async.py
:start-after: [START get_copy_authorization_async]
:end-before: [END get_copy_authorization_async]
:language: python
:dedent: 8
:caption: Authorize the target resource to receive the copied model
"""
response = await self._client.generate_model_copy_authorization( # type: ignore
cls=lambda pipeline_response, deserialized, response_headers: pipeline_response, **kwargs
) # type: PipelineResponse
target = json.loads(response.http_response.text())
target["resourceId"] = resource_id
target["resourceRegion"] = resource_region
return target
[docs] @distributed_trace_async
async def begin_copy_model(
self, model_id: str, target: Dict[str, Union[str, int]], **kwargs: Any
) -> AsyncLROPoller[CustomFormModelInfo]:
"""Copy a custom model stored in this resource (the source) to the user specified
target Form Recognizer resource. This should be called with the source Form Recognizer resource
(with the model that is intended to be copied). The `target` parameter should be supplied from the
target resource's output from calling the :func:`~get_copy_authorization()` method.
:param str model_id: Model identifier of the model to copy to target resource.
:param Dict[str, Union[str, int]] target:
The copy authorization generated from the target resource's call to
:func:`~get_copy_authorization()`.
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:return: An instance of an AsyncLROPoller. Call `result()` on the poller
object to return a :class:`~azure.ai.formrecognizer.CustomFormModelInfo`.
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.formrecognizer.CustomFormModelInfo]
:raises ~azure.core.exceptions.HttpResponseError:
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_copy_model_async.py
:start-after: [START copy_model_async]
:end-before: [END copy_model_async]
:language: python
:dedent: 8
:caption: Copy a model from the source resource to the target resource
"""
if not model_id:
raise ValueError("model_id cannot be None or empty.")
polling_interval = kwargs.pop("polling_interval", self._client._config.polling_interval)
continuation_token = kwargs.pop("continuation_token", None)
def _copy_callback(raw_response, _, headers): # pylint: disable=unused-argument
copy_operation = self._deserialize(self._generated_models.CopyOperationResult, raw_response)
model_id = copy_operation.copy_result.model_id if hasattr(copy_operation, "copy_result") else None
if model_id:
return CustomFormModelInfo._from_generated(copy_operation, model_id, api_version=self._api_version)
if target:
return CustomFormModelInfo._from_generated(
copy_operation, target["model_id"], api_version=self._api_version
)
return CustomFormModelInfo._from_generated(copy_operation, None, api_version=self._api_version)
return await self._client.begin_copy_custom_model( # type: ignore
model_id=model_id,
copy_request=self._generated_models.CopyRequest(
target_resource_id=target["resourceId"],
target_resource_region=target["resourceRegion"],
copy_authorization=self._generated_models.CopyAuthorizationResult(
access_token=target["accessToken"],
model_id=target["modelId"],
expiration_date_time_ticks=target["expirationDateTimeTicks"],
),
)
if target
else None,
cls=kwargs.pop("cls", _copy_callback),
polling=AsyncLROBasePolling(timeout=polling_interval, lro_algorithms=[CopyPolling()], **kwargs),
continuation_token=continuation_token,
**kwargs
)
[docs] @distributed_trace_async
async def begin_create_composed_model(self, model_ids: List[str], **kwargs: Any) -> AsyncLROPoller[CustomFormModel]:
"""Creates a composed model from a collection of existing models that were trained with labels.
A composed model allows multiple models to be called with a single model ID. When a document is
submitted to be analyzed with a composed model ID, a classification step is first performed to
route it to the correct custom model.
:param list[str] model_ids: List of model IDs to use in the composed model.
:keyword str model_name: An optional, user-defined name to associate with your model.
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:return: An instance of an AsyncLROPoller. Call `result()` on the poller
object to return a :class:`~azure.ai.formrecognizer.CustomFormModel`.
:rtype: ~azure.core.polling.AsyncLROPoller[~azure.ai.formrecognizer.CustomFormModel]
:raises ~azure.core.exceptions.HttpResponseError:
.. versionadded:: v2.1
The *begin_create_composed_model* client method
.. admonition:: Example:
.. literalinclude:: ../samples/v3.1/async_samples/sample_create_composed_model_async.py
:start-after: [START begin_create_composed_model_async]
:end-before: [END begin_create_composed_model_async]
:language: python
:dedent: 8
:caption: Create a composed model
"""
def _compose_callback(raw_response, _, headers): # pylint: disable=unused-argument
model = self._deserialize(self._generated_models.Model, raw_response)
return CustomFormModel._from_generated_composed(model)
model_name = kwargs.pop("model_name", None)
polling_interval = kwargs.pop("polling_interval", self._client._config.polling_interval)
continuation_token = kwargs.pop("continuation_token", None)
try:
return await self._client.begin_compose_custom_models_async( # type: ignore
{"model_ids": model_ids, "model_name": model_name}, # type: ignore
cls=kwargs.pop("cls", _compose_callback),
polling=AsyncLROBasePolling(timeout=polling_interval, lro_algorithms=[FormTrainingPolling()], **kwargs),
continuation_token=continuation_token,
**kwargs
)
except ValueError:
raise ValueError("Method 'begin_create_composed_model' is only available for API version V2_1 and up")
[docs] def get_form_recognizer_client(self, **kwargs: Any) -> FormRecognizerClient:
"""Get an instance of a FormRecognizerClient from FormTrainingClient.
:rtype: ~azure.ai.formrecognizer.aio.FormRecognizerClient
:return: A FormRecognizerClient
"""
_pipeline = AsyncPipeline(
transport=AsyncTransportWrapper(self._client._client._pipeline._transport),
policies=self._client._client._pipeline._impl_policies,
) # type: AsyncPipeline
client = FormRecognizerClient(
endpoint=self._endpoint,
credential=self._credential,
pipeline=_pipeline,
api_version=self._api_version,
**kwargs
)
# need to share config, but can't pass as a keyword into client
client._client._config = self._client._client._config
return client
async def __aenter__(self) -> "FormTrainingClient":
await self._client.__aenter__()
return self
async def __aexit__(self, *args: "Any") -> None:
await self._client.__aexit__(*args)
[docs] async def close(self) -> None:
"""Close the :class:`~azure.ai.formrecognizer.aio.FormTrainingClient` session."""
await self._client.__aexit__()