DocumentModelAdministrationClient Klasa

DocumentModelAdministrationClient to interfejs Form Recognizer używany do tworzenia modeli i zarządzania nimi.

Udostępnia metody tworzenia modeli i klasyfikatorów, a także metody wyświetlania i usuwania modeli i klasyfikatorów, wyświetlania operacji modelu i klasyfikatora, uzyskiwania dostępu do informacji o koncie, kopiowania modeli do innego zasobu Form Recognizer i tworzenia nowego modelu z kolekcji istniejących modeli.

Uwaga

Element DocumentModelAdministrationClient powinien być używany z wersjami interfejsu API

2022-08-31 i nowszy. Aby użyć wersji <interfejsu API =v2.1, utwórz wystąpienie elementu FormTrainingClient.

Nowość w wersji 2022-08-31: DocumentModelAdministrationClient i jej metody klienta.

Dziedziczenie

azure.ai.formrecognizer.aio._form_base_client_async.FormRecognizerClientBaseAsync

DocumentModelAdministrationClient

Konstruktor

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

Parametry

endpoint

str

Wymagane

Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://westus2.api.cognitive.microsoft.com).

credential

AzureKeyCredential lub TokenCredential

Wymagane

Poświadczenia wymagane do nawiązania połączenia z platformą Azure przez klienta. Jest to wystąpienie obiektu AzureKeyCredential, jeśli używasz klucza interfejsu API lub poświadczeń tokenu z usługi identity.

api_version

str lub DocumentAnalysisApiVersion

Wersja interfejsu API usługi do użycia dla żądań. Domyślnie jest to najnowsza wersja usługi. Ustawienie starszej wersji może spowodować zmniejszenie zgodności funkcji. Aby użyć wersji <interfejsu API =v2.1, utwórz wystąpienie elementu FormTrainingClient.

Przykłady

Tworzenie obiektu DocumentModelAdministrationClient przy użyciu punktu końcowego i klucza interfejsu API.

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )

Tworzenie obiektu DocumentModelAdministrationClient przy użyciu poświadczeń tokenu.

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

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, credential
   )

Metody

begin_build_document_classifier	Tworzenie klasyfikatora dokumentów. Aby uzyskać więcej informacji na temat tworzenia i trenowania niestandardowego modelu klasyfikatora, zobacz https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Nowość w wersji 2023-07-31: metoda klienta begin_build_document_classifier .
begin_build_document_model	Tworzenie niestandardowego modelu dokumentu. Żądanie musi zawierać parametr słowa kluczowego blob_container_url , który jest identyfikatorem URI kontenera obiektów blob usługi Azure Storage dostępnym zewnętrznie (najlepiej identyfikatorem URI sygnatury dostępu współdzielonego). Pamiętaj, że identyfikator URI kontenera (bez sygnatury dostępu współdzielonego) jest akceptowany tylko wtedy, gdy kontener jest publiczny lub ma skonfigurowaną tożsamość zarządzaną, zobacz więcej o konfigurowaniu tożsamości zarządzanych do pracy z Form Recognizer tutaj: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modele są tworzone przy użyciu dokumentów o następującym typie zawartości: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" lub "image/heif". Inne typy zawartości w kontenerze są ignorowane. Nowość w wersji 2023-07-31: argument słowa kluczowego file_list .
begin_compose_document_model	Tworzy utworzony model dokumentu na podstawie kolekcji istniejących modeli. Skomponowany model umożliwia wywoływanie wielu modeli przy użyciu jednego identyfikatora modelu. Po przesłaniu dokumentu do analizy za pomocą złożonego identyfikatora modelu najpierw jest wykonywany krok klasyfikacji w celu kierowania go do prawidłowego modelu niestandardowego.
begin_copy_document_model_to	Skopiuj model dokumentu przechowywany w tym zasobie (źródle) do określonego przez użytkownika docelowego zasobu Form Recognizer. Należy to wywołać za pomocą zasobu Form Recognizer źródłowego (z modelem, który ma zostać skopiowany). Parametr docelowy powinien zostać dostarczony z danych wyjściowych zasobu docelowego z wywołania get_copy_authorization metody .
close	Zamknij sesję DocumentModelAdministrationClient .
delete_document_classifier	Usuń klasyfikator dokumentów. Nowość w wersji 2023-07-31: metoda klienta delete_document_classifier .
delete_document_model	Usuń niestandardowy model dokumentu.
get_copy_authorization	Generuj autoryzację do kopiowania modelu niestandardowego do zasobu Form Recognizer docelowego. Powinno to być wywoływane przez zasób docelowy (gdzie model zostanie skopiowany do), a dane wyjściowe mogą być przekazywane jako parametr docelowy do begin_copy_document_model_to.
get_document_analysis_client	Pobierz wystąpienie klasy DocumentAnalysisClient z klasy DocumentModelAdministrationClient.
get_document_classifier	Pobierz klasyfikator dokumentów według jego identyfikatora. Nowość w wersji 2023-07-31: metoda klienta get_document_classifier .
get_document_model	Pobierz model dokumentu według jego identyfikatora.
get_operation	Pobierz operację według jego identyfikatora. Pobierz operację skojarzona z zasobem Form Recognizer. Należy pamiętać, że informacje o operacji są utrwalane tylko przez 24 godziny. Jeśli operacja modelu dokumentu zakończyła się pomyślnie, można uzyskać dostęp do modelu przy użyciu get_document_model interfejsów API lub list_document_models .
get_resource_details	Uzyskaj informacje o modelach w zasobie Form Recognizer.
list_document_classifiers	Wyświetl listę informacji dla każdego klasyfikatora dokumentów, w tym jego identyfikator klasyfikatora, opis i kiedy został utworzony. Nowość w wersji 2023-07-31: metoda klienta list_document_classifiers .
list_document_models	Wyświetl listę informacji dla każdego modelu, w tym jego identyfikator modelu, opis i kiedy został utworzony.
list_operations	Wyświetl listę informacji dla każdej operacji. Wyświetla listę wszystkich operacji skojarzonych z zasobem Form Recognizer. Należy pamiętać, że informacje o operacji są utrwalane tylko przez 24 godziny. Jeśli operacja modelu dokumentu zakończyła się pomyślnie, można uzyskać dostęp do modelu dokumentów przy użyciu get_document_model interfejsów API lub list_document_models .
send_request	Uruchamia żądanie sieciowe przy użyciu istniejącego potoku klienta. Adres URL żądania może być względny dla podstawowego adresu URL. Wersja interfejsu API usługi używana dla żądania jest taka sama jak wersja klienta, chyba że określono inaczej. Zastępowanie skonfigurowanej wersji interfejsu API klienta w względnym adresie URL jest obsługiwane na kliencie z interfejsem API w wersji 2022-08-31 lub nowszej. Zastępowanie bezwzględnego adresu URL obsługiwanego na kliencie z dowolną wersją interfejsu API. Ta metoda nie zgłasza się, jeśli odpowiedź jest błędem; aby zgłosić wyjątek, wywołaj metodę raise_for_status() dla zwróconego obiektu odpowiedzi. Aby uzyskać więcej informacji na temat wysyłania żądań niestandardowych za pomocą tej metody, zobacz https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Tworzenie klasyfikatora dokumentów. Aby uzyskać więcej informacji na temat tworzenia i trenowania niestandardowego modelu klasyfikatora, zobacz https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Nowość w wersji 2023-07-31: metoda klienta begin_build_document_classifier .

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

Parametry

doc_types

Mapping[str, ClassifierDocumentTypeDetails]

Wymagane

Mapowanie typów dokumentów do klasyfikowania.

classifier_id

str

Unikatowa nazwa klasyfikatora dokumentów. Jeśli nie zostanie określony, zostanie utworzony identyfikator klasyfikatora.

description

str

Opis klasyfikatora dokumentów.

Zwraca

Wystąpienie obiektu AsyncDocumentModelAdministrationLROPoller. Wywołaj metodę result() obiektu poller, aby zwrócić element DocumentClassifierDetails.

Typ zwracany

AsyncDocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Wyjątki

HttpResponseError

Przykłady

Tworzenie klasyfikatora dokumentów.

   import os
   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
   from azure.ai.formrecognizer import (
       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)
   )

   async with document_model_admin_client:
       poller = await 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 = await 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

Tworzenie niestandardowego modelu dokumentu.

Żądanie musi zawierać parametr słowa kluczowego blob_container_url , który jest identyfikatorem URI kontenera obiektów blob usługi Azure Storage dostępnym zewnętrznie (najlepiej identyfikatorem URI sygnatury dostępu współdzielonego). Pamiętaj, że identyfikator URI kontenera (bez sygnatury dostępu współdzielonego) jest akceptowany tylko wtedy, gdy kontener jest publiczny lub ma skonfigurowaną tożsamość zarządzaną, zobacz więcej o konfigurowaniu tożsamości zarządzanych do pracy z Form Recognizer tutaj: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modele są tworzone przy użyciu dokumentów o następującym typie zawartości: "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" lub "image/heif". Inne typy zawartości w kontenerze są ignorowane.

Nowość w wersji 2023-07-31: argument słowa kluczowego file_list .

async 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) -> AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Parametry

build_mode

ModelBuildMode

Wymagane

Tryb kompilacji modelu niestandardowego. Możliwe wartości to: "template", "neural". Aby uzyskać więcej informacji na temat trybów kompilacji, zobacz: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url

str

Identyfikator URI sygnatury dostępu współdzielonego kontenera usługi Azure Storage. Identyfikator URI kontenera (bez sygnatury dostępu współdzielonego) może być używany, jeśli kontener jest publiczny lub ma skonfigurowaną tożsamość zarządzaną. Aby uzyskać więcej informacji na temat konfigurowania zestawu danych treningowych, zobacz: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id

str

Unikatowy identyfikator modelu. Jeśli nie zostanie określony, zostanie utworzony identyfikator modelu.

description

str

Opcjonalny opis do dodania do modelu.

prefix

str

Ciąg prefiksu uwzględniający wielkość liter do filtrowania dokumentów w ścieżce adresu URL kontenera obiektów blob. Na przykład w przypadku korzystania z identyfikatora URI obiektu blob usługi Azure Storage użyj prefiksu, aby ograniczyć podfoldery. prefiks powinien kończyć się ciągiem "/", aby uniknąć przypadków, w których nazwy plików mają ten sam prefiks.

file_list

str

Ścieżka do pliku JSONL w kontenerze określający podzestaw dokumentów do trenowania.

tags

dict[str, str]

Lista atrybutów tagów klucz-wartość zdefiniowana przez użytkownika skojarzona z modelem.

Zwraca

Wystąpienie obiektu AsyncDocumentModelAdministrationLROPoller. Wywołaj metodę result() obiektu poller, aby zwrócić element DocumentModelDetails.

Typ zwracany

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Wyjątki

HttpResponseError

Przykłady

Tworzenie modelu na podstawie plików szkoleniowych.

   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
   from azure.ai.formrecognizer import 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)
   )
   async with document_model_admin_client:
       poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=container_sas_url,
           description="my model description",
       )
       model = await 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

Tworzy utworzony model dokumentu na podstawie kolekcji istniejących modeli.

Skomponowany model umożliwia wywoływanie wielu modeli przy użyciu jednego identyfikatora modelu. Po przesłaniu dokumentu do analizy za pomocą złożonego identyfikatora modelu najpierw jest wykonywany krok klasyfikacji w celu kierowania go do prawidłowego modelu niestandardowego.

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

Parametry

component_model_ids

list[str]

Wymagane

Lista identyfikatorów modeli do użycia w skomponowanym modelu.

model_id

str

Unikatowy identyfikator skomponowanego modelu. Jeśli nie zostanie określony, zostanie utworzony identyfikator modelu.

description

str

Opcjonalny opis do dodania do modelu.

tags

dict[str, str]

Lista atrybutów tagów klucz-wartość zdefiniowana przez użytkownika skojarzona z modelem.

Zwraca

Wystąpienie obiektu AsyncDocumentModelAdministrationLROPoller. Wywołaj metodę result() obiektu poller, aby zwrócić element DocumentModelDetails.

Typ zwracany

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Wyjątki

HttpResponseError

Przykłady

Tworzenie skomponowanego modelu z istniejącymi modelami.

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
   from azure.ai.formrecognizer import 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)
   )
   async with document_model_admin_client:
       supplies_poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=po_supplies,
           description="Purchase order-Office supplies",
       )
       equipment_poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=po_equipment,
           description="Purchase order-Office Equipment",
       )
       furniture_poller = await document_model_admin_client.begin_build_document_model(
           ModelBuildMode.TEMPLATE,
           blob_container_url=po_furniture,
           description="Purchase order-Furniture",
       )
       cleaning_supplies_poller = (
           await document_model_admin_client.begin_build_document_model(
               ModelBuildMode.TEMPLATE,
               blob_container_url=po_cleaning_supplies,
               description="Purchase order-Cleaning Supplies",
           )
       )
       supplies_model = await supplies_poller.result()
       equipment_model = await equipment_poller.result()
       furniture_model = await furniture_poller.result()
       cleaning_supplies_model = await 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 = await document_model_admin_client.begin_compose_document_model(
           purchase_order_models, description="Office Supplies Composed Model"
       )
       model = await 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

Skopiuj model dokumentu przechowywany w tym zasobie (źródle) do określonego przez użytkownika docelowego zasobu Form Recognizer.

Należy to wywołać za pomocą zasobu Form Recognizer źródłowego (z modelem, który ma zostać skopiowany). Parametr docelowy powinien zostać dostarczony z danych wyjściowych zasobu docelowego z wywołania get_copy_authorization metody .

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

Parametry

model_id

str

Wymagane

Identyfikator modelu do skopiowania do zasobu docelowego.

target

<xref:azure.ai.formrecognizer.TargetAuthorization>

Wymagane

Autoryzacja kopiowania wygenerowana na podstawie wywołania zasobu docelowego na .get_copy_authorization

Zwraca

Wystąpienie obiektu AsyncDocumentModelAdministrationLROPoller. Wywołaj metodę result() obiektu poller, aby zwrócić element DocumentModelDetails.

Typ zwracany

AsyncDocumentModelAdministrationLROPoller[DocumentModelDetails]

Wyjątki

HttpResponseError

Przykłady

Kopiowanie modelu z zasobu źródłowego do zasobu docelowego

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio 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)
   )
   async with target_client:
       target = await target_client.get_copy_authorization(
           description="model copied from other resource"
       )

   source_client = DocumentModelAdministrationClient(
       endpoint=source_endpoint, credential=AzureKeyCredential(source_key)
   )
   async with source_client:
       poller = await 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 = await 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

Zamknij sesję DocumentModelAdministrationClient .

async close() -> None

Wyjątki

HttpResponseError

delete_document_classifier

Usuń klasyfikator dokumentów.

Nowość w wersji 2023-07-31: metoda klienta delete_document_classifier .

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

Parametry

classifier_id

str

Wymagane

Identyfikator klasyfikatora.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Przykłady

Usuń klasyfikator.

   await document_model_admin_client.delete_document_classifier(
       classifier_id=my_classifier.classifier_id
   )

   try:
       await 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

Usuń niestandardowy model dokumentu.

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

Parametry

model_id

str

Wymagane

Identyfikator modelu.

Zwraca

Brak

Typ zwracany

None

Wyjątki

HttpResponseError

ResourceNotFoundError

Przykłady

Usuwanie modelu.

   await document_model_admin_client.delete_document_model(
       model_id=my_model.model_id
   )

   try:
       await 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

Generuj autoryzację do kopiowania modelu niestandardowego do zasobu Form Recognizer docelowego.

Powinno to być wywoływane przez zasób docelowy (gdzie model zostanie skopiowany do), a dane wyjściowe mogą być przekazywane jako parametr docelowy do begin_copy_document_model_to.

async get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parametry

model_id

str

Unikatowy identyfikator skopiowanego modelu. Jeśli nie zostanie określony, zostanie utworzony identyfikator modelu.

description

str

Opcjonalny opis do dodania do modelu.

tags

dict[str, str]

Lista atrybutów tagów klucz-wartość zdefiniowana przez użytkownika skojarzona z modelem.

Zwraca

Słownik z wartościami niezbędnymi do autoryzacji kopiowania.

Typ zwracany

<xref:azure.ai.formrecognizer.TargetAuthorization>

Wyjątki

HttpResponseError

get_document_analysis_client

Pobierz wystąpienie klasy DocumentAnalysisClient z klasy DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Zwraca

Element DocumentAnalysisClient

Typ zwracany

DocumentAnalysisClient

Wyjątki

HttpResponseError

get_document_classifier

Pobierz klasyfikator dokumentów według jego identyfikatora.

Nowość w wersji 2023-07-31: metoda klienta get_document_classifier .

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

Parametry

classifier_id

str

Wymagane

Identyfikator klasyfikatora.

Zwraca

DocumentClassifierDetails

Typ zwracany

DocumentClassifierDetails

Wyjątki

HttpResponseError

ResourceNotFoundError

Przykłady

Pobierz klasyfikator według jego identyfikatora.

   my_classifier = await 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

Pobierz model dokumentu według jego identyfikatora.

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

Parametry

model_id

str

Wymagane

Identyfikator modelu.

Zwraca

DocumentModelDetails

Typ zwracany

DocumentModelDetails

Wyjątki

HttpResponseError

ResourceNotFoundError

Przykłady

Pobierz model według jego identyfikatora.

   my_model = await 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

Pobierz operację według jego identyfikatora.

Pobierz operację skojarzona z zasobem Form Recognizer. Należy pamiętać, że informacje o operacji są utrwalane tylko przez 24 godziny. Jeśli operacja modelu dokumentu zakończyła się pomyślnie, można uzyskać dostęp do modelu przy użyciu get_document_model interfejsów API lub list_document_models .

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

Parametry

operation_id

str

Wymagane

Identyfikator operacji.

Zwraca

OperationDetails

Typ zwracany

OperationDetails

Wyjątki

HttpResponseError

Przykłady

Pobierz operację modelu dokumentu według jego identyfikatora.

   # Get an operation by ID
   try:
       first_operation = await operations.__anext__()

       print(f"\nGetting operation info by ID: {first_operation.operation_id}")
       operation_info = await document_model_admin_client.get_operation(
           first_operation.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}")
   except StopAsyncIteration:
       print("No operations found.")

get_resource_details

Uzyskaj informacje o modelach w zasobie Form Recognizer.

async get_resource_details(**kwargs: Any) -> ResourceDetails

Zwraca

Podsumowanie modeli niestandardowych w ramach zasobu — liczba modeli i limit.

Typ zwracany

ResourceDetails

Wyjątki

HttpResponseError

Przykłady

Pobieranie liczby i limitów modelu w ramach zasobu Form Recognizer.

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   async with document_model_admin_client:
       account_details = await 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

Wyświetl listę informacji dla każdego klasyfikatora dokumentów, w tym jego identyfikator klasyfikatora, opis i kiedy został utworzony.

Nowość w wersji 2023-07-31: metoda klienta list_document_classifiers .

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

Zwraca

Możliwość stronicowania elementu DocumentClassifierDetails.

Typ zwracany

AsyncItemPaged[DocumentClassifierDetails]

Wyjątki

HttpResponseError

Przykłady

Wyświetl listę wszystkich klasyfikatorów, które zostały pomyślnie utworzone w ramach zasobu Form Recognizer.

   classifiers = document_model_admin_client.list_document_classifiers()

   print("We have the following 'ready' models with IDs and descriptions:")
   async for classifier in classifiers:
       print(f"{classifier.classifier_id} | {classifier.description}")

list_document_models

Wyświetl listę informacji dla każdego modelu, w tym jego identyfikator modelu, opis i kiedy został utworzony.

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

Zwraca

Pageable of DocumentModelSummary.

Typ zwracany

AsyncItemPaged[DocumentModelSummary]

Wyjątki

HttpResponseError

Przykłady

Wyświetl listę wszystkich modeli, które zostały pomyślnie utworzone w ramach zasobu Form Recognizer.

   models = document_model_admin_client.list_document_models()

   print("We have the following 'ready' models with IDs and descriptions:")
   async for model in models:
       print(f"{model.model_id} | {model.description}")

list_operations

Wyświetl listę informacji dla każdej operacji.

Wyświetla listę wszystkich operacji skojarzonych z zasobem Form Recognizer. Należy pamiętać, że informacje o operacji są utrwalane tylko przez 24 godziny. Jeśli operacja modelu dokumentu zakończyła się pomyślnie, można uzyskać dostęp do modelu dokumentów przy użyciu get_document_model interfejsów API lub list_document_models .

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

Zwraca

Stronicowy element OperationSummary.

Typ zwracany

AsyncItemPaged[OperationSummary]

Wyjątki

HttpResponseError

Przykłady

Wyświetl listę wszystkich operacji modelu dokumentów w ciągu ostatnich 24 godzin.

   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio 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)
   )

   async with document_model_admin_client:
       operations = document_model_admin_client.list_operations()

       print("The following document model operations exist under my resource:")
       async 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

Uruchamia żądanie sieciowe przy użyciu istniejącego potoku klienta.

Adres URL żądania może być względny dla podstawowego adresu URL. Wersja interfejsu API usługi używana dla żądania jest taka sama jak wersja klienta, chyba że określono inaczej. Zastępowanie skonfigurowanej wersji interfejsu API klienta w względnym adresie URL jest obsługiwane na kliencie z interfejsem API w wersji 2022-08-31 lub nowszej. Zastępowanie bezwzględnego adresu URL obsługiwanego na kliencie z dowolną wersją interfejsu API. Ta metoda nie zgłasza się, jeśli odpowiedź jest błędem; aby zgłosić wyjątek, wywołaj metodę raise_for_status() dla zwróconego obiektu odpowiedzi. Aby uzyskać więcej informacji na temat wysyłania żądań niestandardowych za pomocą tej metody, zobacz https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametry

request

HttpRequest

Wymagane

Żądanie sieciowe, które chcesz utworzyć.

Zwraca

Odpowiedź połączenia sieciowego. Nie obsługuje błędów w odpowiedzi.

Typ zwracany

AsyncHttpResponse

Wyjątki

HttpResponseError