DocumentModelAdministrationClient Třída

Reference

DocumentModelAdministrationClient je rozhraní Rozpoznávání formulářů, které se používá k vytváření a správě modelů.

Poskytuje metody pro vytváření modelů a klasifikátorů a také metody pro zobrazení a odstranění modelů a klasifikátorů, zobrazení operací modelu a klasifikátoru, přístup k informacím o účtu, kopírování modelů do jiného Rozpoznávání formulářů prostředku a vytvoření nového modelu z kolekce existujících modelů.

Poznámka

DocumentModelAdministrationClient by se měl používat s verzemi rozhraní API.

2022-08-31 a novější. Pokud chcete použít rozhraní API verze <=v2.1, vytvořte instanci FormTrainingClient.

Novinka ve verzi 2022-08-31: DocumentModelAdministrationClient a jeho klientské metody.

Dědičnost: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Konstruktor

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

Parametry

endpoint: str

Vyžadováno

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential nebo TokenCredential

Vyžadováno

Přihlašovací údaje potřebné pro připojení klienta k Azure Toto je instance AzureKeyCredential, pokud používáte klíč rozhraní API nebo přihlašovací údaje tokenu z identity.

api_version: str nebo DocumentAnalysisApiVersion

Verze rozhraní API služby, která se má použít pro požadavky. Výchozí hodnota je nejnovější verze služby. Nastavení na starší verzi může mít za následek snížení kompatibility funkcí. Pokud chcete použít verze <rozhraní API =v2.1, vytvořte instanci FormTrainingClient.

Příklady

Vytvoření DocumentModelAdministrationClient s koncovým bodem a klíčem rozhraní 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)
   )

Vytvoření DocumentModelAdministrationClient s přihlašovacími údaji tokenu


   """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
   )

Metody

begin_build_document_classifier	Sestavte klasifikátor dokumentů. Další informace o tom, jak sestavit a vytrénovat vlastní model klasifikátoru, najdete v tématu https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Novinka ve verzi 2023-07-31: Metoda klienta begin_build_document_classifier .
begin_build_document_model	Vytvořte vlastní model dokumentu. Požadavek musí obsahovat parametr klíčového slova blob_container_url , který je externě přístupný identifikátor URI kontejneru objektů blob služby Azure Storage (nejlépe identifikátor URI sdíleného přístupového podpisu). Všimněte si, že identifikátor URI kontejneru (bez SAS) se přijímá pouze v případě, že je kontejner veřejný nebo má nakonfigurovanou spravovanou identitu. Další informace o konfiguraci spravovaných identit pro práci s Rozpoznávání formulářů najdete tady: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modely se vytvářejí pomocí dokumentů, které mají následující typ obsahu: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" nebo "image/heif". Ostatní typy obsahu v kontejneru se ignorují. Novinka ve verzi 2023-07-31: Argument file_list klíčového slova.
begin_compose_document_model	Vytvoří složený model dokumentu z kolekce existujících modelů. Složený model umožňuje volat více modelů s jedním ID modelu. Když je dokument odeslán k analýze se složeným ID modelu, nejprve se provede klasifikační krok, který ho nasměruje do správného vlastního modelu.
begin_copy_document_model_to	Zkopírujte model dokumentu uložený v tomto prostředku (zdroji) do uživatelem zadaného cílového Rozpoznávání formulářů prostředku. Mělo by se volat se zdrojovým Rozpoznávání formulářů prostředkem (s modelem, který se má zkopírovat). Parametr target by měl být zadán z výstupu cílového prostředku z volání get_copy_authorization metody.
close	Zavřete DocumentModelAdministrationClient relaci.
delete_document_classifier	Odstraňte klasifikátor dokumentu. Novinka ve verzi 2023-07-31: Metoda delete_document_classifier klienta.
delete_document_model	Odstranění vlastního modelu dokumentu
get_copy_authorization	Vygenerujte autorizaci pro kopírování vlastního modelu do cílového prostředku Rozpoznávání formulářů. To by měl volat cílový prostředek (do kterého se model zkopíruje) a výstup se dá předat jako cílový parametr do begin_copy_document_model_to.
get_document_analysis_client	Získejte instanci DocumentAnalysisClient z DocumentModelAdministrationClient.
get_document_classifier	Získejte klasifikátor dokumentu podle jeho ID. Novinka ve verzi 2023-07-31: Metoda get_document_classifier klienta.
get_document_model	Získejte model dokumentu podle jeho ID.
get_operation	Získejte operaci podle jejího ID. Získejte operaci přidruženou k prostředku Rozpoznávání formulářů. Mějte na paměti, že informace o operaci trvají pouze 24 hodin. Pokud byla operace modelu dokumentu úspěšná, je možné k modelu přistupovat pomocí get_document_model rozhraní API nebo list_document_models .
get_resource_details	Získejte informace o modelech v rámci prostředku Rozpoznávání formulářů.
list_document_classifiers	Seznam informací pro jednotlivé klasifikátory dokumentů, včetně ID, popisu a data vytvoření klasifikátoru Novinka ve verzi 2023-07-31: Metoda list_document_classifiers klienta.
list_document_models	Vypíše informace o každém modelu, včetně jeho ID, popisu a data vytvoření.
list_operations	Seznam informací pro každou operaci Zobrazí seznam všech operací přidružených k prostředku Rozpoznávání formulářů. Mějte na paměti, že informace o operaci trvají pouze 24 hodin. Pokud byla operace modelu dokumentu úspěšná, je možné k modelu dokumentu přistupovat pomocí get_document_model rozhraní API nebo list_document_models .
send_request	Spustí síťový požadavek pomocí existujícího kanálu klienta. Adresa URL požadavku může být relativní vzhledem k základní adrese URL. Verze rozhraní API služby použitá pro požadavek je stejná jako verze klienta, pokud není uvedeno jinak. Přepsání nakonfigurované verze rozhraní API klienta na relativní adresu URL se podporuje u klienta s rozhraním API verze 2022-08-31 a novější. Přepsání v absolutní adrese URL podporované na klientovi s libovolnou verzí rozhraní API Tato metoda nevyvolá, pokud odpověď je chyba; Pokud chcete vyvolat výjimku, zavolejte raise_for_status() u vráceného objektu odpovědi. Další informace o odesílání vlastních požadavků pomocí této metody najdete v tématu https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Sestavte klasifikátor dokumentů. Další informace o tom, jak sestavit a vytrénovat vlastní model klasifikátoru, najdete v tématu https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Novinka ve verzi 2023-07-31: Metoda klienta 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]

Parametry

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Vyžadováno

Mapování typů dokumentů, které se mají klasifikovat.

classifier_id: str

Jedinečný název klasifikátoru dokumentu. Pokud není zadáno, vytvoří se pro vás ID klasifikátoru.

description: str

Popis klasifikátoru dokumentu

Návraty

An instance of an DocumentModelAdministrationLROPoller. Voláním result() u objektu poller vrátíte DocumentClassifierDetails.

Návratový typ

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Výjimky

HttpResponseError

Příklady

Sestavte klasifikátor dokumentů.


   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

Vytvořte vlastní model dokumentu.

Požadavek musí obsahovat parametr klíčového slova blob_container_url , který je externě přístupný identifikátor URI kontejneru objektů blob služby Azure Storage (nejlépe identifikátor URI sdíleného přístupového podpisu). Všimněte si, že identifikátor URI kontejneru (bez SAS) se přijímá pouze v případě, že je kontejner veřejný nebo má nakonfigurovanou spravovanou identitu. Další informace o konfiguraci spravovaných identit pro práci s Rozpoznávání formulářů najdete tady: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modely se vytvářejí pomocí dokumentů, které mají následující typ obsahu: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" nebo "image/heif". Ostatní typy obsahu v kontejneru se ignorují.

Novinka ve verzi 2023-07-31: Argument file_list klíčového slova.

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]

Parametry

build_mode: ModelBuildMode

Vyžadováno

Režim sestavení vlastního modelu. Mezi možné hodnoty patří: "template", "neural". Další informace o režimech sestavení najdete tady: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

Identifikátor URI SAS kontejneru objektů blob služby Azure Storage Identifikátor URI kontejneru (bez SAS) je možné použít, pokud je kontejner veřejný nebo má nakonfigurovanou spravovanou identitu. Další informace o nastavení trénovací sady dat najdete tady: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

Jedinečné ID vašeho modelu. Pokud není zadané, vytvoří se pro vás ID modelu.

description: str

Volitelný popis, který se má přidat do modelu.

prefix: str

Řetězec předpony rozlišující velká a malá písmena pro filtrování dokumentů v cestě URL kontejneru objektů blob. Například při použití identifikátoru URI objektu blob služby Azure Storage použijte k omezení dílčích složek předponu. Předpona by měla končit na /, aby se zabránilo případům, kdy názvy souborů sdílejí stejnou předponu.

file_list: str

Cesta k souboru JSONL v kontejneru určující podmnožinu dokumentů pro trénování

tags: dict[str, str]

Seznam atributů značky klíč-hodnota definovaných uživatelem přidružených k modelu

Návraty

An instance of an DocumentModelAdministrationLROPoller. Voláním result() u objektu poller vrátíte DocumentModelDetails.

Návratový typ

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Výjimky

HttpResponseError

Příklady

Vytvoření modelu z trénovacích souborů


   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

Vytvoří složený model dokumentu z kolekce existujících modelů.

Složený model umožňuje volat více modelů s jedním ID modelu. Když je dokument odeslán k analýze se složeným ID modelu, nejprve se provede klasifikační krok, který ho nasměruje do správného vlastního modelu.

begin_compose_document_model(component_model_ids: List[str], **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Parametry

component_model_ids: list[str]

Vyžadováno

Seznam ID modelů, které se mají použít ve složeného modelu

model_id: str

Jedinečné ID pro složený model. Pokud není zadané, vytvoří se pro vás ID modelu.

description: str

Volitelný popis, který se má přidat do modelu.

tags: dict[str, str]

Seznam atributů značky klíč-hodnota definovaných uživatelem přidružených k modelu

Návraty

An instance of an DocumentModelAdministrationLROPoller. Voláním result() u objektu poller vrátíte DocumentModelDetails.

Návratový typ

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Výjimky

HttpResponseError

Příklady

Vytvoření složeného modelu s existujícími modely


   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

Zkopírujte model dokumentu uložený v tomto prostředku (zdroji) do uživatelem zadaného cílového Rozpoznávání formulářů prostředku.

Mělo by se volat se zdrojovým Rozpoznávání formulářů prostředkem (s modelem, který se má zkopírovat). Parametr target by měl být zadán z výstupu cílového prostředku z volání get_copy_authorization metody.

begin_copy_document_model_to(model_id: str, target: TargetAuthorization, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Parametry

model_id: str

Vyžadováno

Identifikátor modelu, který se má zkopírovat do cílového prostředku.

target: <xref:azure.ai.formrecognizer.TargetAuthorization>

Vyžadováno

Autorizace kopírování vygenerovaná voláním cílového prostředku na get_copy_authorization.

Návraty

An instance of a DocumentModelAdministrationLROPoller. Voláním result() u objektu poller vrátíte DocumentModelDetails.

Návratový typ

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Výjimky

HttpResponseError

Příklady

Kopírování modelu ze zdrojového prostředku do cílového prostředku


   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

Zavřete DocumentModelAdministrationClient relaci.

close() -> None

Výjimky

HttpResponseError

delete_document_classifier

Odstraňte klasifikátor dokumentu.

Novinka ve verzi 2023-07-31: Metoda delete_document_classifier klienta.

delete_document_classifier(classifier_id: str, **kwargs: Any) -> None

Parametry

classifier_id: str

Vyžadováno

Identifikátor klasifikátoru.

Návraty

Žádné

Návratový typ

None

Výjimky

HttpResponseError

ResourceNotFoundError

Příklady

Odstraňte klasifikátor.


   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

Odstranění vlastního modelu dokumentu

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

Parametry

model_id: str

Vyžadováno

Identifikátor modelu.

Návraty

Žádné

Návratový typ

None

Výjimky

HttpResponseError

ResourceNotFoundError

Příklady

Odstranění modelu


   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

Vygenerujte autorizaci pro kopírování vlastního modelu do cílového prostředku Rozpoznávání formulářů.

To by měl volat cílový prostředek (do kterého se model zkopíruje) a výstup se dá předat jako cílový parametr do begin_copy_document_model_to.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parametry

model_id: str

Jedinečné ID zkopírovaného modelu. Pokud není zadané, vytvoří se pro vás ID modelu.

description: str

Volitelný popis, který se má přidat do modelu.

tags: dict[str, str]

Seznam atributů značky klíč-hodnota definovaných uživatelem přidružených k modelu

Návraty

Slovník s hodnotami potřebnými pro autorizaci kopírování.

Návratový typ

<xref:azure.ai.formrecognizer.TargetAuthorization>

Výjimky

HttpResponseError

get_document_analysis_client

Získejte instanci DocumentAnalysisClient z DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Návraty

A DocumentAnalysisClient

Návratový typ

DocumentAnalysisClient

Výjimky

HttpResponseError

get_document_classifier

Získejte klasifikátor dokumentu podle jeho ID.

Novinka ve verzi 2023-07-31: Metoda get_document_classifier klienta.

get_document_classifier(classifier_id: str, **kwargs: Any) -> DocumentClassifierDetails

Parametry

classifier_id: str

Vyžadováno

Identifikátor klasifikátoru.

Návraty

DocumentClassifierDetails

Návratový typ

DocumentClassifierDetails

Výjimky

HttpResponseError

ResourceNotFoundError

Příklady

Získejte klasifikátor podle jeho 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

Získejte model dokumentu podle jeho ID.

get_document_model(model_id: str, **kwargs: Any) -> DocumentModelDetails

Parametry

model_id: str

Vyžadováno

Identifikátor modelu.

Návraty

DocumentModelDetails

Návratový typ

DocumentModelDetails

Výjimky

HttpResponseError

ResourceNotFoundError

Příklady

Získejte model podle jeho 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

Získejte operaci podle jejího ID.

Získejte operaci přidruženou k prostředku Rozpoznávání formulářů. Mějte na paměti, že informace o operaci trvají pouze 24 hodin. Pokud byla operace modelu dokumentu úspěšná, je možné k modelu přistupovat pomocí get_document_model rozhraní API nebo list_document_models .

get_operation(operation_id: str, **kwargs: Any) -> OperationDetails

Parametry

operation_id: str

Vyžadováno

ID operace.

Návraty

Podrobnosti o operacích

Návratový typ

OperationDetails

Výjimky

HttpResponseError

Příklady

Získejte operaci modelu dokumentu podle jejího 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

Získejte informace o modelech v rámci prostředku Rozpoznávání formulářů.

get_resource_details(**kwargs: Any) -> ResourceDetails

Návraty

Souhrn vlastních modelů v rámci prostředku – počet a limit modelů

Návratový typ

ResourceDetails

Výjimky

HttpResponseError

Příklady

V rámci prostředku Rozpoznávání formulářů získejte počty a limity modelů.


   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

Seznam informací pro jednotlivé klasifikátory dokumentů, včetně ID, popisu a data vytvoření klasifikátoru

Novinka ve verzi 2023-07-31: Metoda list_document_classifiers klienta.

list_document_classifiers(**kwargs: Any) -> ItemPaged[DocumentClassifierDetails]

Návraty

Pageable pro DocumentClassifierDetails.

Návratový typ

ItemPaged[DocumentClassifierDetails]

Výjimky

HttpResponseError

Příklady

Vypište všechny klasifikátory, které byly úspěšně sestaveny v rámci prostředku Rozpoznávání formulářů.


   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

Vypíše informace o každém modelu, včetně jeho ID, popisu a data vytvoření.

list_document_models(**kwargs: Any) -> ItemPaged[DocumentModelSummary]

Návraty

Pageable modelu DocumentModelSummary.

Návratový typ

ItemPaged[DocumentModelSummary]

Výjimky

HttpResponseError

Příklady

Vypíše všechny modely, které byly úspěšně vytvořeny v rámci prostředku Rozpoznávání formulářů.


   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

Seznam informací pro každou operaci

Zobrazí seznam všech operací přidružených k prostředku Rozpoznávání formulářů. Mějte na paměti, že informace o operaci trvají pouze 24 hodin. Pokud byla operace modelu dokumentu úspěšná, je možné k modelu dokumentu přistupovat pomocí get_document_model rozhraní API nebo list_document_models .

list_operations(**kwargs: Any) -> ItemPaged[OperationSummary]

Návraty

A pageable of OperationSummary.

Návratový typ

ItemPaged[OperationSummary]

Výjimky

HttpResponseError

Příklady

Vypíše všechny operace modelu dokumentů za posledních 24 hodin.


   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

Spustí síťový požadavek pomocí existujícího kanálu klienta.

Adresa URL požadavku může být relativní vzhledem k základní adrese URL. Verze rozhraní API služby použitá pro požadavek je stejná jako verze klienta, pokud není uvedeno jinak. Přepsání nakonfigurované verze rozhraní API klienta na relativní adresu URL se podporuje u klienta s rozhraním API verze 2022-08-31 a novější. Přepsání v absolutní adrese URL podporované na klientovi s libovolnou verzí rozhraní API Tato metoda nevyvolá, pokud odpověď je chyba; Pokud chcete vyvolat výjimku, zavolejte raise_for_status() u vráceného objektu odpovědi. Další informace o odesílání vlastních požadavků pomocí této metody najdete v tématu https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametry

request: HttpRequest

Vyžadováno

Síťový požadavek, který chcete vytvořit.

stream: bool

Určuje, jestli se datová část odpovědi bude streamovat. Výchozí hodnota je False.

Návraty

Odpověď síťového volání. Nezvládá zpracování chyb ve vaší odpovědi.

Návratový typ

HttpResponse

Výjimky

HttpResponseError

Share via

DocumentModelAdministrationClient Třída

Konstruktor

Parametry

Příklady

Metody

begin_build_document_classifier

Parametry

Návraty

Návratový typ

Výjimky

Příklady

begin_build_document_model

Parametry

Návraty

Návratový typ

Výjimky

Příklady

begin_compose_document_model

Parametry

Návraty

Návratový typ

Výjimky

Příklady

begin_copy_document_model_to

Parametry

Návraty

Návratový typ

Výjimky

Příklady

close

Výjimky

delete_document_classifier

Parametry

Návraty

Návratový typ

Výjimky

Příklady

delete_document_model

Parametry

Návraty

Návratový typ

Výjimky

Příklady

get_copy_authorization

Parametry

Návraty

Návratový typ

Výjimky

get_document_analysis_client

Návraty

Návratový typ

Výjimky

get_document_classifier

Parametry

Návraty

Návratový typ

Výjimky

Příklady

get_document_model

Parametry

Návraty

Návratový typ

Výjimky

Příklady

get_operation

Parametry

Návraty

Návratový typ

Výjimky

Příklady

get_resource_details

Návraty

Návratový typ

Výjimky

Příklady

list_document_classifiers

Návraty

Návratový typ

Výjimky