DocumentModelAdministrationClient Osztály

A DocumentModelAdministrationClient a modellek létrehozásához és kezeléséhez használható Form Recognizer felület.

Modellek és osztályozók készítésére, valamint modellek és osztályozók megtekintésére és törlésére, modell- és osztályozóműveletek megtekintésére, fiókadatok elérésére, modellek másolására egy másik Form Recognizer erőforrásra, valamint új modell írására a meglévő modellek gyűjteményéből.

Megjegyzés

A DocumentModelAdministrationClient api-verziókkal használható

2022-08-31 és újabb. Az =v2.1 API-verziók <használatához hozzon létre egy FormTrainingClient példányt.

A 2022-08-31-es verzió újdonságai: A DocumentModelAdministrationClient és annak ügyfélmetodusai.

Öröklődés

azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Konstruktor

DocumentModelAdministrationClient(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 következőből: identity.

api_version

str vagy DocumentAnalysisApiVersion

A kérésekhez használni kívánt szolgáltatás API-verziója. Alapértelmezés szerint a legújabb szolgáltatásverziót használja. A régebbi verzióra való beállítás csökkentett funkciókompatibilitást eredményezhet. Az =v2.1 API-verziók <használatához hozzon létre egy FormTrainingClient példányt.

Példák

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

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

A DocumentModelAdministrationClient 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 DocumentModelAdministrationClient
   from azure.identity import DefaultAzureCredential

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, credential
   )

Metódusok

begin_build_document_classifier	Hozzon létre egy dokumentumosztályozót. Az egyéni osztályozómodellek összeállításáról és betanításairól további információt a következő témakörben talál https://aka.ms/azsdk/formrecognizer/buildclassifiermodel: . A 2023-07-31-es verzió újdonságai: A begin_build_document_classifier ügyfélmetódus.
begin_build_document_model	Egyéni dokumentummodell létrehozása. A kérésnek tartalmaznia kell egy blob_container_url kulcsszóparamétert, amely egy külsőleg elérhető Azure Storage-blobtároló URI (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. További információ a felügyelt identitások konfigurálásáról a Form Recognizer való használatához itt: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. A modellek a következő tartalomtípusú dokumentumok használatával készülnek: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", vagy "image/heif". A tároló egyéb típusú tartalmai figyelmen kívül lesznek hagyva. A 2023-07-31-es verzió újdonsága: A file_list kulcsszóargumentum.
begin_compose_document_model	Létrehozott dokumentummodellt hoz létre egy meglévő modellek gyűjteményéből. Egy összeállított modell lehetővé teszi több modell meghívását egyetlen modellazonosítóval. Amikor egy dokumentumot egy összeállított modellazonosítóval való elemzésre küld, először egy besorolási lépést hajt végre, amely a megfelelő egyéni modellhez irányítja azt.
begin_copy_document_model_to	Másolja az erőforrásban (a forrásban) tárolt dokumentummodellt a felhasználó által megadott célként megadott 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.
close	Zárja be a munkamenetet DocumentModelAdministrationClient .
delete_document_classifier	Dokumentumosztályozó törlése. A 2023-07-31-es verzió újdonságai: Az delete_document_classifier ügyfélmetódus.
delete_document_model	Egyéni dokumentummodell törlése.
get_copy_authorization	Hozzon létre engedélyt egy egyéni modell cél Form Recognizer erőforrásba való másolásához. 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_document_model_to: .
get_document_analysis_client	Egy DocumentAnalysisClient példányának lekérése a DocumentModelAdministrationClient webhelyről.
get_document_classifier	Szerezzen be egy dokumentumosztályozót az azonosítója alapján. A 2023-07-31-es verzió újdonságai: A get_document_classifier ügyfélmetódus.
get_document_model	Dokumentummodell lekérése az azonosító alapján.
get_operation	Művelet lekérése az azonosító alapján. Az Form Recognizer erőforráshoz társított művelet lekérése. Vegye figyelembe, hogy a műveletinformációk csak 24 óráig maradnak meg. Ha a dokumentummodell-művelet sikeres volt, a modell a vagy list_document_models API-k használatával get_document_model érhető el.
get_resource_details	A Form Recognizer erőforrás alatti modellekre vonatkozó információk lekérése.
list_document_classifiers	Listázhatja az egyes dokumentumosztályozók adatait, beleértve az osztályozó azonosítóját, leírását és létrehozási helyét. A 2023-07-31-es verzió újdonságai: A list_document_classifiers ügyfélmetódus.
list_document_models	Listázhatja az egyes modellek adatait, beleértve a modell azonosítóját, leírását és létrehozását.
list_operations	Az egyes műveletek adatainak listázása. Felsorolja az Form Recognizer erőforráshoz társított összes műveletet. Vegye figyelembe, hogy a műveletinformációk csak 24 óráig maradnak meg. Ha egy dokumentummodell-művelet sikeres volt, a dokumentummodell a vagy list_document_models API-k használatával get_document_model érhető el.
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 nincs megadva. Az ügyfél konfigurált API-verziójának relatív URL-címben való felülírása támogatott a 2022-08-31-es és újabb API-verziójú ügyfélen. Felül kell bírálni a bármely API-verzióval rendelkező ügyfélen támogatott abszolút URL-címet. Ez a módszer nem jelentkezik, ha a válasz hiba; kivétel létrehozásához hívja meg a raise_for_status() parancsot a visszaadott válaszobjektumon. További információ arról, hogyan küldhet egyéni kéréseket ezzel a módszerrel: https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Hozzon létre egy dokumentumosztályozót. Az egyéni osztályozómodellek összeállításáról és betanításairól további információt a következő témakörben talál https://aka.ms/azsdk/formrecognizer/buildclassifiermodel: .

A 2023-07-31-es verzió újdonságai: A begin_build_document_classifier ügyfélmetódus.

begin_build_document_classifier(doc_types: Mapping[str, ClassifierDocumentTypeDetails], *, classifier_id: str | None = None, description: str | None = None, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Paraméterek

doc_types

Mapping[str, ClassifierDocumentTypeDetails]

Kötelező

Az osztályozandó dokumentumtípusok leképezése.

classifier_id

str

Egyedi dokumentumosztályozó neve. Ha nincs megadva, a rendszer létrehoz egy osztályozóazonosítót.

description

str

Dokumentumosztályozó leírása.

Válaszok

Egy DocumentModelAdministrationLROPoller példánya. Hívja meg a result() függvényt a poller objektumon, hogy visszaadjon egy DocumentClassifierDetailsértéket.

Visszatérési típus

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Kivételek

HttpResponseError

Példák

Hozzon létre egy dokumentumosztályozót.

   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

Egyéni dokumentummodell létrehozása.

A kérésnek tartalmaznia kell egy blob_container_url kulcsszóparamétert, amely egy külsőleg elérhető Azure Storage-blobtároló URI (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. További információ a felügyelt identitások konfigurálásáról a Form Recognizer való használatához itt: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. A modellek a következő tartalomtípusú dokumentumok használatával készülnek: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp", vagy "image/heif". A tároló egyéb típusú tartalmai figyelmen kívül lesznek hagyva.

A 2023-07-31-es verzió újdonsága: A file_list kulcsszóargumentum.

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éterek

build_mode

ModelBuildMode

Kötelező

Az egyéni modell buildelési módja. Lehetséges értékek: "template", "neurális". A buildelési módokkal kapcsolatos további információkért lásd: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url

str

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 konfigurált felügyelt identitással rendelkezik. 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.

model_id

str

A modell egyedi azonosítója. Ha nincs megadva, a rendszer létrehoz egy modellazonosítót.

description

str

A modellhez hozzáadandó leírás nem kötelező.

prefix

str

Kis- és nagybetűkre érzékeny előtagsztring a blobtároló URL-elérési útjának dokumentumainak szűréséhez. Azure Storage-blob URI használata esetén például az előtaggal korlátozhatja az almappák körét. az előtagnak "/" végződésűnek kell lennie, hogy elkerülje azokat az eseteket, amikor a fájlnevek azonos előtaggal osztoznak.

file_list

str

Egy JSONL-fájl elérési útja a tárolóban, amely a betanításhoz szükséges dokumentumok egy részhalmazát adja meg.

tags

dict[str, str]

A modellhez társított, felhasználó által definiált kulcs-érték címkeattribútumok listája.

Válaszok

Egy DocumentModelAdministrationLROPoller példánya. Hívja meg a result() függvényt a poller objektumon, hogy visszaadjon egy DocumentModelDetailsértéket.

Visszatérési típus

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Kivételek

HttpResponseError

Példák

Modell létrehozása betanítási fájlokból.

   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

Létrehozott dokumentummodellt hoz létre egy meglévő modellek gyűjteményéből.

Egy összeállított modell lehetővé teszi több modell meghívását egyetlen modellazonosítóval. Amikor egy dokumentumot egy összeállított modellazonosítóval való elemzésre küld, először egy besorolási lépést hajt végre, amely a megfelelő egyéni modellhez irányítja azt.

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

Paraméterek

component_model_ids

list[str]

Kötelező

Az összeállított modellben használandó modellazonosítók listája.

model_id

str

A összeállított modell egyedi azonosítója. Ha nincs megadva, a rendszer létrehoz egy modellazonosítót.

description

str

A modellhez hozzáadandó leírás nem kötelező.

tags

dict[str, str]

A modellhez társított, felhasználó által definiált kulcs-érték címkeattribútumok listája.

Válaszok

Egy DocumentModelAdministrationLROPoller példánya. Hívja meg a result() függvényt a poller objektumon, hogy visszaadjon egy DocumentModelDetailsértéket.

Visszatérési típus

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Kivételek

HttpResponseError

Példák

Összeállított modell létrehozása meglévő modellekkel.

   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

Másolja az erőforrásban (a forrásban) tárolt dokumentummodellt a felhasználó által megadott célként megadott 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_document_model_to(model_id: str, target: TargetAuthorization, **kwargs: Any) -> DocumentModelAdministrationLROPoller[DocumentModelDetails]

Paraméterek

model_id

str

Kötelező

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

target

<xref:azure.ai.formrecognizer.TargetAuthorization>

Kötelező

A célerőforrás hívásából get_copy_authorizationlétrehozott másolási engedély.

Válaszok

A DocumentModelAdministrationLROPoller példánya. Hívja meg a result() függvényt a poller objektumon, hogy visszaadjon egy DocumentModelDetailsértéket.

Visszatérési típus

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Kivételek

HttpResponseError

Példák

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

   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

Zárja be a munkamenetet DocumentModelAdministrationClient .

close() -> None

Kivételek

HttpResponseError

delete_document_classifier

Dokumentumosztályozó törlése.

A 2023-07-31-es verzió újdonságai: Az delete_document_classifier ügyfélmetódus.

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

Paraméterek

classifier_id

str

Kötelező

Osztályozó azonosítója.

Válaszok

None

Visszatérési típus

None

Kivételek

HttpResponseError

ResourceNotFoundError

Példák

Osztályozó törlése.

   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

Egyéni dokumentummodell törlése.

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

Paraméterek

model_id

str

Kötelező

Modellazonosító.

Válaszok

None

Visszatérési típus

None

Kivételek

HttpResponseError

ResourceNotFoundError

Példák

Modell törlése.

   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

Hozzon létre engedélyt egy egyéni modell cél Form Recognizer erőforrásba való másolásához.

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_document_model_to: .

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Paraméterek

model_id

str

A másolt modell egyedi azonosítója. Ha nincs megadva, a rendszer létrehoz egy modellazonosítót.

description

str

A modellhez hozzáadandó leírás nem kötelező.

tags

dict[str, str]

A modellhez társított, felhasználó által definiált kulcs-érték címkeattribútumok listája.

Válaszok

A másolás engedélyezéséhez szükséges értékeket tartalmazó szótár.

Visszatérési típus

<xref:azure.ai.formrecognizer.TargetAuthorization>

Kivételek

HttpResponseError

get_document_analysis_client

Egy DocumentAnalysisClient példányának lekérése a DocumentModelAdministrationClient webhelyről.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Válaszok

A DocumentAnalysisClient

Visszatérési típus

DocumentAnalysisClient

Kivételek

HttpResponseError

get_document_classifier

Szerezzen be egy dokumentumosztályozót az azonosítója alapján.

A 2023-07-31-es verzió újdonságai: A get_document_classifier ügyfélmetódus.

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

Paraméterek

classifier_id

str

Kötelező

Osztályozó azonosítója.

Válaszok

DocumentClassifierDetails

Visszatérési típus

DocumentClassifierDetails

Kivételek

HttpResponseError

ResourceNotFoundError

Példák

Osztályozó lekérése az azonosító alapján.

   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

Dokumentummodell lekérése az azonosító alapján.

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

Paraméterek

model_id

str

Kötelező

Modellazonosító.

Válaszok

DocumentModelDetails

Visszatérési típus

DocumentModelDetails

Kivételek

HttpResponseError

ResourceNotFoundError

Példák

Modell lekérése az azonosító alapján.

   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

Művelet lekérése az azonosító alapján.

Az Form Recognizer erőforráshoz társított művelet lekérése. Vegye figyelembe, hogy a műveletinformációk csak 24 óráig maradnak meg. Ha a dokumentummodell-művelet sikeres volt, a modell a vagy list_document_models API-k használatával get_document_model érhető el.

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

Paraméterek

operation_id

str

Kötelező

A művelet azonosítója.

Válaszok

OperationDetails

Visszatérési típus

OperationDetails

Kivételek

HttpResponseError

Példák

Dokumentummodell-művelet lekérése az azonosító alapján.

   # 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

A Form Recognizer erőforrás alatti modellekre vonatkozó információk lekérése.

get_resource_details(**kwargs: Any) -> ResourceDetails

Válaszok

Az erőforrás alatti egyéni modellek összegzése – a modellek száma és korlátja.

Visszatérési típus

ResourceDetails

Kivételek

HttpResponseError

Példák

Lekérheti a modellek számát és korlátait az Form Recognizer erőforrás alatt.

   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

Listázhatja az egyes dokumentumosztályozók adatait, beleértve az osztályozó azonosítóját, leírását és létrehozási helyét.

A 2023-07-31-es verzió újdonságai: A list_document_classifiers ügyfélmetódus.

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

Válaszok

A DocumentClassifierDetails lapozható.

Visszatérési típus

ItemPaged[DocumentClassifierDetails]

Kivételek

HttpResponseError

Példák

Sorolja fel az összes sikeresen létrehozott osztályozót az Form Recognizer erőforrás alatt.

   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

Listázhatja az egyes modellek adatait, beleértve a modell azonosítóját, leírását és létrehozását.

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

Válaszok

A DocumentModelSummary lapozható.

Visszatérési típus

ItemPaged[DocumentModelSummary]

Kivételek

HttpResponseError

Példák

Sorolja fel a Form Recognizer erőforrás alatt sikeresen létrehozott összes modellt.

   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

Az egyes műveletek adatainak listázása.

Felsorolja az Form Recognizer erőforráshoz társított összes műveletet. Vegye figyelembe, hogy a műveletinformációk csak 24 óráig maradnak meg. Ha egy dokumentummodell-művelet sikeres volt, a dokumentummodell a vagy list_document_models API-k használatával get_document_model érhető el.

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

Válaszok

Az OperationSummary lapja.

Visszatérési típus

ItemPaged[OperationSummary]

Kivételek

HttpResponseError

Példák

Az elmúlt 24 óra összes dokumentummodell-műveletének listázása.

   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

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 nincs megadva. Az ügyfél konfigurált API-verziójának relatív URL-címben való felülírása támogatott a 2022-08-31-es és újabb API-verziójú ügyfélen. Felül kell bírálni a bármely API-verzióval rendelkező ügyfélen támogatott abszolút URL-címet. Ez a módszer nem jelentkezik, ha a válasz hiba; kivétel létrehozásához hívja meg a raise_for_status() parancsot a visszaadott válaszobjektumon. További információ arról, hogyan küldhet egyéni kéréseket ezzel a módszerrel: 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