FormTrainingClient Osztály

A FormTrainingClient az egyéni modellek létrehozásához és kezeléséhez használható Form Recognizer felület. Módszereket biztosít a betanítási modellekhez az Ön által megadott űrlapokon, valamint a modellek megtekintésére és törlésére, a fióktulajdonságok elérésére, a modellek másik Form Recognizer erőforrásba való másolására és a modellek írására a címkékkel betanított meglévő modellek gyűjteményéből.

Megjegyzés

A FormTrainingClientet a =v2.1 API-verziókkal <kell használni.

A 2022-08-31-s és újabb API-verziók használatához hozzon létre egy DocumentModelAdministrationClient példányt.

Öröklődés

azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

FormTrainingClient

Konstruktor

FormTrainingClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Paraméterek

endpoint

str

Kötelező

Támogatott Cognitive Services-végpontok (protokoll és állomásnév, például: https://westus2.api.cognitive.microsoft.com).

credential

AzureKeyCredential vagy TokenCredential

Kötelező

Az ügyfélnek az Azure-hoz való csatlakozáshoz szükséges hitelesítő adatok. Ez az AzureKeyCredential egy példánya, ha API-kulcsot vagy jogkivonat-hitelesítő adatokat használ a forrásból identity.

api_version

str vagy FormRecognizerApiVersion

A kérésekhez használni kívánt szolgáltatás API-verziója. Alapértelmezés szerint az API 2.1-es verziója. A régebbi verzióra való beállítás csökkentett funkciókompatibilitást eredményezhet. A legújabb támogatott API-verzió és -funkciók használatához hozzon létre helyette egy DocumentModelAdministrationClient példányt.

Példák

A FormTrainingClient létrehozása végponttal és API-kulccsal.

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import FormTrainingClient
   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]

   form_training_client = FormTrainingClient(endpoint, AzureKeyCredential(key))

A FormTrainingClient létrehozása token hitelesítő adatokkal.

   """DefaultAzureCredential will use the values from these environment
   variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
   """
   from azure.ai.formrecognizer import FormTrainingClient
   from azure.identity import DefaultAzureCredential

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   credential = DefaultAzureCredential()

   form_training_client = FormTrainingClient(endpoint, credential)

Metódusok

begin_copy_model	Másolja az erőforrásban (a forrásban) tárolt egyéni modellt a felhasználó által megadott cél Form Recognizer erőforrásba. Ezt a forrás Form Recognizer erőforrással kell meghívni (a másolandó modellel). A célparamétert a célerőforrás metódus meghívásából get_copy_authorization származó kimenetéből kell megadni.
begin_create_composed_model	Létrehoz egy összeállított modellt a címkékkel betanított meglévő modellek gyűjteményéből. A komponált modellek lehetővé teszik több modell meghívását egyetlen modellazonosítóval. Amikor egy dokumentumot egy összeállított modellazonosítóval szeretne elemezni, a rendszer először egy besorolási lépést hajt végre, amely a megfelelő egyéni modellhez irányítja. A 2.1-es verzió újdonságai: A begin_create_composed_model ügyfélmetódus
begin_training	Egyéni modell létrehozása és betanítása. A kérésnek tartalmaznia kell egy training_files_url paramétert, amely egy külsőleg elérhető Azure Storage-blobtároló URI-ja (lehetőleg közös hozzáférésű jogosultságkód URI-ja). Vegye figyelembe, hogy a tároló URI-ja (SAS nélkül) csak akkor fogadható el, ha a tároló nyilvános vagy felügyelt identitás van konfigurálva. A felügyelt identitások konfigurálásáról a következő Form Recognizer itt olvashat bővebben: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. A modellek betanítása a következő tartalomtípusú dokumentumok használatával történik: "application/pdf", "image/jpeg", "image/png", "image/tiff", vagy "image/bmp". A tároló egyéb típusú tartalmai figyelmen kívül lesznek hagyva. Új a 2.1-es verzióban: A model_name kulcsszó argumentum
close	Zárja be a munkamenetet FormTrainingClient .
delete_model	Modell megjelölése törlésre. A modellösszetevők egy előre meghatározott időszakon belül véglegesen törlődnek.
get_account_properties	Az űrlap-felismerő fiók modelljeinek adatainak lekérése.
get_copy_authorization	Hozzon létre egy egyéni modellnek a cél Form Recognizer erőforrásba való másolásának engedélyezését. Ezt a célerőforrásnak kell meghívnia (ahová a modellt átmásolja), és a kimenet átadható célparaméterként a következőnek begin_copy_model: .
get_custom_model	Lekérheti az egyéni modellek leírását, beleértve az általa felismerhető űrlaptípusokat és az egyes űrlaptípusokhoz kinyerni kívánt mezőket.
get_form_recognizer_client	A FormRecognizerClient példányának lekérése a FormTrainingClientből.
list_custom_models	Listázhatja az egyes modellek adatait, beleértve a modell azonosítóját, a modell állapotát, valamint a létrehozás és utolsó módosítás idejét.
send_request	Hálózati kérést futtat az ügyfél meglévő folyamatával. A kérelem URL-címe az alap URL-címhez lehet viszonyítva. A kéréshez használt szolgáltatás API-verzió megegyezik az ügyféléval, hacsak másként nem van megadva. A 2022-08-31-es és újabb API-verziójú ügyfél támogatja az ügyfél konfigurált API-verziójának relatív URL-címben való felülírását. Felül kell bírálni az ügyfélen bármilyen API-verzióval támogatott abszolút URL-címet. Ez a módszer nem merül fel, ha a válasz hiba; kivétel létrehozásához hívja meg a raise_for_status() parancsot a visszaadott válaszobjektumon. Az egyéni kérések ezzel a módszerrel történő elküldésére vonatkozó további információkért lásd: https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_copy_model

Másolja az erőforrásban (a forrásban) tárolt egyéni modellt a felhasználó által megadott cél Form Recognizer erőforrásba. Ezt a forrás Form Recognizer erőforrással kell meghívni (a másolandó modellel). A célparamétert a célerőforrás metódus meghívásából get_copy_authorization származó kimenetéből kell megadni.

begin_copy_model(model_id: str, target: Dict[str, str | int], **kwargs: Any) -> LROPoller[CustomFormModelInfo]

Paraméterek

model_id

str

Kötelező

A célerőforrásba másolandó modell modellazonosítója.

target

Dict[str, Union[str, int]]

Kötelező

A célerőforrás hívásából létrehozott másolási engedélyezés a következőre get_copy_authorization: .

continuation_token

str

Egy folytatási jogkivonat, amely újraindít egy lekérdezést egy mentett állapotból.

Válaszok

Egy LROPoller-példány. Hívja meg a result() parancsot a poller objektumon, hogy visszaadjon egy CustomFormModelInfoértéket.

Visszatérési típus

LROPoller[CustomFormModelInfo]

Kivételek

HttpResponseError

Példák

Modell másolása a forráserőforrásból a célerőforrásba

   source_client = FormTrainingClient(endpoint=source_endpoint, credential=AzureKeyCredential(source_key))

   poller = source_client.begin_copy_model(
       model_id=source_model_id,
       target=target  # output from target client's call to get_copy_authorization()
   )
   copied_over_model = poller.result()

   print("Model ID: {}".format(copied_over_model.model_id))
   print("Status: {}".format(copied_over_model.status))

begin_create_composed_model

Létrehoz egy összeállított modellt a címkékkel betanított meglévő modellek gyűjteményéből.

A komponált modellek lehetővé teszik több modell meghívását egyetlen modellazonosítóval. Amikor egy dokumentumot egy összeállított modellazonosítóval szeretne elemezni, a rendszer először egy besorolási lépést hajt végre, amely a megfelelő egyéni modellhez irányítja.

A 2.1-es verzió újdonságai: A begin_create_composed_model ügyfélmetódus

begin_create_composed_model(model_ids: List[str], **kwargs: Any) -> LROPoller[CustomFormModel]

Paraméterek

model_ids

list[str]

Kötelező

A komponált modellben használandó modellazonosítók listája.

model_name

str

A modellhez társítandó, nem kötelező, felhasználó által definiált név.

continuation_token

str

Egy folytatási jogkivonat, amely újraindít egy lekérdezést egy mentett állapotból.

Válaszok

Egy LROPoller-példány. Hívja meg a result() parancsot a poller objektumon, hogy visszaadjon egy CustomFormModelértéket.

Visszatérési típus

LROPoller[CustomFormModel]

Kivételek

HttpResponseError

Példák

Összeállított modell létrehozása

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import FormTrainingClient

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   po_supplies = os.environ['PURCHASE_ORDER_OFFICE_SUPPLIES_SAS_URL_V2']
   po_equipment = os.environ['PURCHASE_ORDER_OFFICE_EQUIPMENT_SAS_URL_V2']
   po_furniture = os.environ['PURCHASE_ORDER_OFFICE_FURNITURE_SAS_URL_V2']
   po_cleaning_supplies = os.environ['PURCHASE_ORDER_OFFICE_CLEANING_SUPPLIES_SAS_URL_V2']

   form_training_client = FormTrainingClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   supplies_poller = form_training_client.begin_training(
       po_supplies, use_training_labels=True, model_name="Purchase order - Office supplies"
   )
   equipment_poller = form_training_client.begin_training(
       po_equipment, use_training_labels=True, model_name="Purchase order - Office Equipment"
   )
   furniture_poller = form_training_client.begin_training(
       po_furniture, use_training_labels=True, model_name="Purchase order - Furniture"
   )
   cleaning_supplies_poller = form_training_client.begin_training(
       po_cleaning_supplies, use_training_labels=True, model_name="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()

   models_trained_with_labels = [
       supplies_model.model_id,
       equipment_model.model_id,
       furniture_model.model_id,
       cleaning_supplies_model.model_id
   ]

   poller = form_training_client.begin_create_composed_model(
       models_trained_with_labels, model_name="Office Supplies Composed Model"
   )
   model = poller.result()

   print("Office Supplies Composed Model Info:")
   print("Model ID: {}".format(model.model_id))
   print("Model name: {}".format(model.model_name))
   print("Is this a composed model?: {}".format(model.properties.is_composed_model))
   print("Status: {}".format(model.status))
   print("Composed model creation started on: {}".format(model.training_started_on))
   print("Creation completed on: {}".format(model.training_completed_on))

begin_training

Egyéni modell létrehozása és betanítása. A kérésnek tartalmaznia kell egy training_files_url paramétert, amely egy külsőleg elérhető Azure Storage-blobtároló URI-ja (lehetőleg közös hozzáférésű jogosultságkód URI-ja). Vegye figyelembe, hogy a tároló URI-ja (SAS nélkül) csak akkor fogadható el, ha a tároló nyilvános vagy felügyelt identitás van konfigurálva. A felügyelt identitások konfigurálásáról a következő Form Recognizer itt olvashat bővebben: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. A modellek betanítása a következő tartalomtípusú dokumentumok használatával történik: "application/pdf", "image/jpeg", "image/png", "image/tiff", vagy "image/bmp". A tároló egyéb típusú tartalmai figyelmen kívül lesznek hagyva.

Új a 2.1-es verzióban: A model_name kulcsszó argumentum

begin_training(training_files_url: str, use_training_labels: bool, **kwargs: Any) -> LROPoller[CustomFormModel]

Paraméterek

training_files_url

str

Kötelező

Egy Azure Storage-blobtároló SAS URI-ja. A tároló URI-ja (SAS nélkül) akkor használható, ha a tároló nyilvános, vagy felügyelt identitás van konfigurálva. A betanítási adatkészlet beállításával kapcsolatos további információkért lásd: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

use_training_labels

bool

Kötelező

Legyen szó címkékkel történő betanítása vagy sem. A megfelelő címkézett fájloknak létezniük kell a blobtárolóban, ha Igaz értékre van állítva.

prefix

str

A betanítás forrásútvonalában lévő dokumentumok szűrésére szolgáló kis- és nagybetűkre érzékeny előtagsztring. Azure Storage-blob URI használata esetén például az előtaggal korlátozhatja az almappák betanítását.

include_subfolders

bool

Az előtagmappák halmazában lévő almappákat jelző jelzőt is tartalmaznia kell az előfeldolgozáshoz szükséges tartalom keresésekor. Címkékkel való betanítás esetén nem támogatott.

model_name

str

A modellhez társítandó, nem kötelező, felhasználó által definiált név.

continuation_token

str

Egy folytatási jogkivonat, amely újraindít egy lekérdezést egy mentett állapotból.

Válaszok

Egy LROPoller-példány. Hívja meg a result() parancsot a poller objektumon, hogy visszaadjon egy CustomFormModelértéket.

Visszatérési típus

LROPoller[CustomFormModel]

Kivételek

HttpResponseError

Vegye figyelembe, hogy ha a betanítás sikertelen, a rendszer kivételt hoz létre, de az "érvénytelen" állapotú modell továbbra is létrejön. Ezt a modellt a hívással törölheti

delete_model

Példák

Modell betanítása (címkék nélkül) az egyéni űrlapokkal.

   from azure.ai.formrecognizer import FormTrainingClient
   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_V2"]

   form_training_client = FormTrainingClient(endpoint, AzureKeyCredential(key))
   poller = form_training_client.begin_training(container_sas_url, use_training_labels=False)
   model = poller.result()

   # Custom model information
   print("Model ID: {}".format(model.model_id))
   print("Status: {}".format(model.status))
   print("Model name: {}".format(model.model_name))
   print("Training started on: {}".format(model.training_started_on))
   print("Training completed on: {}".format(model.training_completed_on))

   print("Recognized fields:")
   # Looping through the submodels, which contains the fields they were trained on
   for submodel in model.submodels:
       print("...The submodel has form type '{}'".format(submodel.form_type))
       for name, field in submodel.fields.items():
           print("...The model found field '{}' to have label '{}'".format(
               name, field.label
           ))

close

Zárja be a munkamenetet FormTrainingClient .

close() -> None

Kivételek

HttpResponseError

delete_model

Modell megjelölése törlésre. A modellösszetevők egy előre meghatározott időszakon belül véglegesen törlődnek.

delete_model(model_id: str, **kwargs: Any) -> None

Paraméterek

model_id

str

Kötelező

Modellazonosító.

Visszatérési típus

None

Kivételek

HttpResponseError

ResourceNotFoundError

Példák

Egyéni modell törlése.

   form_training_client.delete_model(model_id=custom_model.model_id)

   try:
       form_training_client.get_custom_model(model_id=custom_model.model_id)
   except ResourceNotFoundError:
       print("Successfully deleted model with id {}".format(custom_model.model_id))

get_account_properties

Az űrlap-felismerő fiók modelljeinek adatainak lekérése.

get_account_properties(**kwargs: Any) -> AccountProperties

Válaszok

A fiókok modelljeinek összegzése – egyéni modellek száma, egyéni modellkorlát.

Visszatérési típus

AccountProperties

Kivételek

HttpResponseError

Példák

Az űrlap-felismerő fiók tulajdonságainak lekérése.

   form_training_client = FormTrainingClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   # First, we see how many custom models we have, and what our limit is
   account_properties = form_training_client.get_account_properties()
   print("Our account has {} custom models, and we can have at most {} custom models\n".format(
       account_properties.custom_model_count, account_properties.custom_model_limit
   ))

get_copy_authorization

Hozzon létre egy egyéni modellnek a cél Form Recognizer erőforrásba való másolásának engedélyezését. Ezt a célerőforrásnak kell meghívnia (ahová a modellt átmásolja), és a kimenet átadható célparaméterként a következőnek begin_copy_model: .

get_copy_authorization(resource_id: str, resource_region: str, **kwargs: Any) -> Dict[str, str | int]

Paraméterek

resource_id

str

Kötelező

Annak a célerőforrásnak az Azure-erőforrás-azonosítója Form Recognizer, amelybe a modell át lesz másolva.

resource_region

str

Kötelező

A cél Form Recognizer erőforrás helye. A Cognitive Services által támogatott érvényes Azure-régiónév. Például: "westus", "eastus" stb. Tekintse meg https://azure.microsoft.com/global-infrastructure/services/?products=cognitive-services a Cognitive Services regionális elérhetőségét.

Válaszok

Szótár a másolás engedélyezéséhez – "modelId", "accessToken", "resourceId", "resourceRegion" és "expirationDateTimeTicks".

Visszatérési típus

Dict[str, Union[str, int]]

Kivételek

HttpResponseError

Példák

A célerőforrás engedélyezése a másolt modell fogadásához

   target_client = FormTrainingClient(endpoint=target_endpoint, credential=AzureKeyCredential(target_key))

   target = target_client.get_copy_authorization(
       resource_region=target_region,
       resource_id=target_resource_id
   )
   # model ID that target client will use to access the model once copy is complete
   print("Model ID: {}".format(target["modelId"]))

get_custom_model

Lekérheti az egyéni modellek leírását, beleértve az általa felismerhető űrlaptípusokat és az egyes űrlaptípusokhoz kinyerni kívánt mezőket.

get_custom_model(model_id: str, **kwargs: Any) -> CustomFormModel

Paraméterek

model_id

str

Kötelező

Modellazonosító.

Válaszok

CustomFormModel

Visszatérési típus

CustomFormModel

Kivételek

HttpResponseError

ResourceNotFoundError

Példák

Egyéni modell lekérése modellazonosítóval.

   custom_model = form_training_client.get_custom_model(model_id=model.model_id)
   print("\nModel ID: {}".format(custom_model.model_id))
   print("Status: {}".format(custom_model.status))
   print("Model name: {}".format(custom_model.model_name))
   print("Is this a composed model?: {}".format(custom_model.properties.is_composed_model))
   print("Training started on: {}".format(custom_model.training_started_on))
   print("Training completed on: {}".format(custom_model.training_completed_on))

get_form_recognizer_client

A FormRecognizerClient példányának lekérése a FormTrainingClientből.

get_form_recognizer_client(**kwargs: Any) -> FormRecognizerClient

Válaszok

A FormRecognizerClient

Visszatérési típus

FormRecognizerClient

Kivételek

HttpResponseError

list_custom_models

Listázhatja az egyes modellek adatait, beleértve a modell azonosítóját, a modell állapotát, valamint a létrehozás és utolsó módosítás idejét.

list_custom_models(**kwargs: Any) -> ItemPaged[CustomFormModelInfo]

Válaszok

ItemPaged[CustomFormModelInfo]

Visszatérési típus

ItemPaged

Kivételek

HttpResponseError

Példák

A fiók minden modelljének modelladatainak listázása.

   custom_models = form_training_client.list_custom_models()

   print("We have models with the following IDs:")
   for model_info in custom_models:
       print(model_info.model_id)

send_request

Hálózati kérést futtat az ügyfél meglévő folyamatával.

A kérelem URL-címe az alap URL-címhez lehet viszonyítva. A kéréshez használt szolgáltatás API-verzió megegyezik az ügyféléval, hacsak másként nem van megadva. A 2022-08-31-es és újabb API-verziójú ügyfél támogatja az ügyfél konfigurált API-verziójának relatív URL-címben való felülírását. Felül kell bírálni az ügyfélen bármilyen API-verzióval támogatott abszolút URL-címet. Ez a módszer nem merül fel, ha a válasz hiba; kivétel létrehozásához hívja meg a raise_for_status() parancsot a visszaadott válaszobjektumon. Az egyéni kérések ezzel a módszerrel történő elküldésére vonatkozó további információkért lásd: https://aka.ms/azsdk/dpcodegen/python/send_request.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Paraméterek

request

HttpRequest

Kötelező

A létrehozni kívánt hálózati kérelem.

stream

bool

A válasz hasznos adatainak streamelése. Alapértelmezés szerint Hamis.

Válaszok

A hálózati hívás válasza. Nem végez hibakezelést a válaszon.

Visszatérési típus

HttpResponse

Kivételek

HttpResponseError