DocumentModelAdministrationClient Klass

Referens

DocumentModelAdministrationClient är det Formigenkänning gränssnitt som ska användas för att skapa och hantera modeller.

Den innehåller metoder för att skapa modeller och klassificerare, samt metoder för att visa och ta bort modeller och klassificerare, visa modell- och klassificeraråtgärder, komma åt kontoinformation, kopiera modeller till en annan Formigenkänning resurs och skapa en ny modell från en samling befintliga modeller.

Anteckning

DocumentModelAdministrationClient ska användas med API-versioner

2022-08-31 och uppåt. Om du vill använda API-versioner <=v2.1 instansierar du en FormTrainingClient.

Ny i version 2022-08-31: DocumentModelAdministrationClient och dess klientmetoder.

Arv: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Konstruktor

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

Parametrar

endpoint: str

Obligatorisk

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential eller TokenCredential

Obligatorisk

Autentiseringsuppgifter som krävs för att klienten ska kunna ansluta till Azure. Det här är en instans av AzureKeyCredential om du använder en API-nyckel eller en tokenautentiseringsuppgift från identity.

api_version: str eller DocumentAnalysisApiVersion

API-versionen av tjänsten som ska användas för begäranden. Standardinställningen är den senaste tjänstversionen. Om du anger en äldre version kan funktionskompatibiliteten minska. Om du vill använda API-versioner <=v2.1 instansierar du en FormTrainingClient.

Exempel

Skapa DocumentModelAdministrationClient med en slutpunkt och API-nyckel.


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

Skapa DocumentModelAdministrationClient med en tokenautentiseringsuppgift.


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

Metoder

begin_build_document_classifier	Skapa en dokumentklassificerare. Mer information om hur du skapar och tränar en anpassad klassificerarmodell finns i https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Ny i version 2023-07-31: Begin_build_document_classifier-klientmetoden.
begin_build_document_model	Skapa en anpassad dokumentmodell. Begäran måste innehålla en blob_container_url nyckelordsparameter som är en externt tillgänglig URI för Azure Storage Blob-container (helst en URI för signatur för delad åtkomst). Observera att en container-URI (utan SAS) endast accepteras när containern är offentlig eller har en konfigurerad hanterad identitet. Läs mer om hur du konfigurerar hanterade identiteter så att de fungerar med Formigenkänning här: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modeller skapas med dokument som har följande innehållstyp – "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" eller "image/heif". Andra typer av innehåll i containern ignoreras. Nytt i version 2023-07-31: Nyckelordsargumentet file_list .
begin_compose_document_model	Skapar en sammansatt dokumentmodell från en samling befintliga modeller. Med en sammansatt modell kan flera modeller anropas med ett enda modell-ID. När ett dokument skickas för att analyseras med ett sammansatt modell-ID utförs först ett klassificeringssteg för att dirigera det till rätt anpassad modell.
begin_copy_document_model_to	Kopiera en dokumentmodell som lagras i den här resursen (källan) till användarens angivna mål Formigenkänning resurs. Detta ska anropas med källresursen Formigenkänning (med den modell som är avsedd att kopieras). Målparametern ska anges från målresursens utdata från anropet av get_copy_authorization metoden .
close	DocumentModelAdministrationClient Stäng sessionen.
delete_document_classifier	Ta bort en dokumentklassificerare. Ny i version 2023-07-31: Den delete_document_classifier-klientmetoden .
delete_document_model	Ta bort en anpassad dokumentmodell.
get_copy_authorization	Generera auktorisering för att kopiera en anpassad modell till målresursen Formigenkänning. Detta ska anropas av målresursen (där modellen kopieras till) och utdata kan skickas som målparametern till .begin_copy_document_model_to
get_document_analysis_client	Hämta en instans av en DocumentAnalysisClient från DocumentModelAdministrationClient.
get_document_classifier	Hämta en dokumentklassificerare efter dess ID. Ny i version 2023-07-31: den get_document_classifier klientmetoden.
get_document_model	Hämta en dokumentmodell efter dess ID.
get_operation	Hämta en åtgärd med dess ID. Hämta en åtgärd som är associerad med den Formigenkänning resursen. Observera att åtgärdsinformationen bara finns kvar i 24 timmar. Om dokumentmodellåtgärden lyckades kan modellen nås med hjälp av get_document_model API:erna eller list_document_models .
get_resource_details	Hämta information om modellerna under den Formigenkänning resursen.
list_document_classifiers	Visa information för varje dokumentklassificerare, inklusive dess klassificerar-ID, beskrivning och när den skapades. Ny i version 2023-07-31: list_document_classifiers-klientmetoden.
list_document_models	Visa information för varje modell, inklusive dess modell-ID, beskrivning och när den skapades.
list_operations	Lista information för varje åtgärd. Visar en lista över alla åtgärder som är associerade med den Formigenkänning resursen. Observera att åtgärdsinformationen bara finns kvar i 24 timmar. Om en dokumentmodellåtgärd lyckades kan dokumentmodellen nås med hjälp av get_document_model API:erna eller list_document_models .
send_request	Kör en nätverksbegäran med klientens befintliga pipeline. Begärande-URL:en kan vara relativ till bas-URL:en. Den tjänst-API-version som används för begäran är densamma som klientens om inget annat anges. Att åsidosätta klientens konfigurerade API-version i relativ URL stöds på klienten med API-version 2022-08-31 och senare. Åsidosätter i absolut URL som stöds på klienten med valfri API-version. Den här metoden genererar inte om svaret är ett fel. om du vill skapa ett undantag anropar du raise_for_status() på det returnerade svarsobjektet. Mer information om hur du skickar anpassade begäranden med den här metoden finns i https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Skapa en dokumentklassificerare. Mer information om hur du skapar och tränar en anpassad klassificerarmodell finns i https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Ny i version 2023-07-31: Begin_build_document_classifier-klientmetoden.

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

Parametrar

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Obligatorisk

Mappning av dokumenttyper att klassificera mot.

classifier_id: str

Unikt dokumentklassificerarenamn. Om inget anges skapas ett klassificerar-ID åt dig.

description: str

Beskrivning av dokumentklassificerare.

Returer

En instans av en DocumentModelAdministrationLROPoller. Anropa result() på pollerobjektet för att returnera en DocumentClassifierDetails.

Returtyp

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Undantag

HttpResponseError

Exempel

Skapa en dokumentklassificerare.


   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

Skapa en anpassad dokumentmodell.

Begäran måste innehålla en blob_container_url nyckelordsparameter som är en externt tillgänglig URI för Azure Storage Blob-container (helst en URI för signatur för delad åtkomst). Observera att en container-URI (utan SAS) endast accepteras när containern är offentlig eller har en konfigurerad hanterad identitet. Läs mer om hur du konfigurerar hanterade identiteter så att de fungerar med Formigenkänning här: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modeller skapas med dokument som har följande innehållstyp – "application/pdf", "image/jpeg", "image/png", "image/tiff", "image/bmp" eller "image/heif". Andra typer av innehåll i containern ignoreras.

Nytt i version 2023-07-31: Nyckelordsargumentet file_list .

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]

Parametrar

build_mode: ModelBuildMode

Obligatorisk

Det anpassade modellbyggläget. Möjliga värden är: "template", "neural". Mer information om bygglägen finns i: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

Sas-URI för en Azure Storage-blobcontainer. En container-URI (utan SAS) kan användas om containern är offentlig eller har en konfigurerad hanterad identitet. Mer information om hur du konfigurerar en träningsdatauppsättning finns i: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

Ett unikt ID för din modell. Om inget anges skapas ett modell-ID åt dig.

description: str

En valfri beskrivning att lägga till i modellen.

prefix: str

En skiftlägeskänslig prefixsträng för att filtrera dokument i url-sökvägen för blobcontainern. När du till exempel använder en Azure Storage Blob-URI använder du prefixet för att begränsa undermappar. prefixet ska sluta med "/" för att undvika fall där filnamnen delar samma prefix.

file_list: str

Sökväg till en JSONL-fil i containern som anger en delmängd av dokument för träning.

tags: dict[str, str]

Lista över användardefinierade nyckel/värde-taggattribut som är associerade med modellen.

Returer

En instans av en DocumentModelAdministrationLROPoller. Anropa result() på pollerobjektet för att returnera en DocumentModelDetails.

Returtyp

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Undantag

HttpResponseError

Exempel

Skapa en modell från träningsfiler.


   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

Skapar en sammansatt dokumentmodell från en samling befintliga modeller.

Med en sammansatt modell kan flera modeller anropas med ett enda modell-ID. När ett dokument skickas för att analyseras med ett sammansatt modell-ID utförs först ett klassificeringssteg för att dirigera det till rätt anpassad modell.

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

Parametrar

component_model_ids: list[str]

Obligatorisk

Lista över modell-ID:t som ska användas i den sammansatta modellen.

model_id: str

Ett unikt ID för din sammansatta modell. Om inget anges skapas ett modell-ID åt dig.

description: str

En valfri beskrivning att lägga till i modellen.

tags: dict[str, str]

Lista över användardefinierade nyckel/värde-taggattribut som är associerade med modellen.

Returer

En instans av en DocumentModelAdministrationLROPoller. Anropa result() på pollerobjektet för att returnera en DocumentModelDetails.

Returtyp

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Undantag

HttpResponseError

Exempel

Skapa en sammansatt modell med befintliga modeller.


   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

Kopiera en dokumentmodell som lagras i den här resursen (källan) till användarens angivna mål Formigenkänning resurs.

Detta ska anropas med källresursen Formigenkänning (med den modell som är avsedd att kopieras). Målparametern ska anges från målresursens utdata från anropet av get_copy_authorization metoden .

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

Parametrar

model_id: str

Obligatorisk

Modellidentifierare för modellen som ska kopieras till målresursen.

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

Obligatorisk

Kopieringsauktoriseringen som genereras från målresursens anrop till get_copy_authorization.

Returer

En instans av en DocumentModelAdministrationLROPoller. Anropa result() på pollerobjektet för att returnera en DocumentModelDetails.

Returtyp

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Undantag

HttpResponseError

Exempel

Kopiera en modell från källresursen till målresursen


   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

DocumentModelAdministrationClient Stäng sessionen.

close() -> None

Undantag

HttpResponseError

delete_document_classifier

Ta bort en dokumentklassificerare.

Ny i version 2023-07-31: Den delete_document_classifier-klientmetoden .

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

Parametrar

classifier_id: str

Obligatorisk

Identifierare för klassificerare.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Exempel

Ta bort en klassificerare.


   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

Ta bort en anpassad dokumentmodell.

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

Parametrar

model_id: str

Obligatorisk

Modellidentifierare.

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

ResourceNotFoundError

Exempel

Ta bort en modell.


   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

Generera auktorisering för att kopiera en anpassad modell till målresursen Formigenkänning.

Detta ska anropas av målresursen (där modellen kopieras till) och utdata kan skickas som målparametern till .begin_copy_document_model_to

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parametrar

model_id: str

Ett unikt ID för den kopierade modellen. Om inget anges skapas ett modell-ID åt dig.

description: str

En valfri beskrivning att lägga till i modellen.

tags: dict[str, str]

Lista över användardefinierade nyckel/värde-taggattribut som är associerade med modellen.

Returer

En ordlista med värden som krävs för kopieringsauktoriseringen.

Returtyp

<xref:azure.ai.formrecognizer.TargetAuthorization>

Undantag

HttpResponseError

get_document_analysis_client

Hämta en instans av en DocumentAnalysisClient från DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Returer

En DocumentAnalysisClient

Returtyp

DocumentAnalysisClient

Undantag

HttpResponseError

get_document_classifier

Hämta en dokumentklassificerare efter dess ID.

Ny i version 2023-07-31: den get_document_classifier klientmetoden.

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

Parametrar

classifier_id: str

Obligatorisk

Identifierare för klassificerare.

Returer

DocumentClassifierDetails

Returtyp

DocumentClassifierDetails

Undantag

HttpResponseError

ResourceNotFoundError

Exempel

Hämta en klassificerare efter dess 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

Hämta en dokumentmodell efter dess ID.

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

Parametrar

model_id: str

Obligatorisk

Modellidentifierare.

Returer

DocumentModelDetails

Returtyp

DocumentModelDetails

Undantag

HttpResponseError

ResourceNotFoundError

Exempel

Hämta en modell efter dess 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

Hämta en åtgärd med dess ID.

Hämta en åtgärd som är associerad med den Formigenkänning resursen. Observera att åtgärdsinformationen bara finns kvar i 24 timmar. Om dokumentmodellåtgärden lyckades kan modellen nås med hjälp av get_document_model API:erna eller list_document_models .

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

Parametrar

operation_id: str

Obligatorisk

Åtgärds-ID: t.

Returer

OperationDetails

Returtyp

OperationDetails

Undantag

HttpResponseError

Exempel

Hämta en dokumentmodellåtgärd med dess 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

Hämta information om modellerna under den Formigenkänning resursen.

get_resource_details(**kwargs: Any) -> ResourceDetails

Returer

Sammanfattning av anpassade modeller under resursen – antal modeller och gränser.

Returtyp

ResourceDetails

Undantag

HttpResponseError

Exempel

Hämta modellantal och gränser under den Formigenkänning resursen.


   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

Visa information för varje dokumentklassificerare, inklusive dess klassificerar-ID, beskrivning och när den skapades.

Ny i version 2023-07-31: list_document_classifiers-klientmetoden.

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

Returer

Pageable of DocumentClassifierDetails.

Returtyp

ItemPaged[DocumentClassifierDetails]

Undantag

HttpResponseError

Exempel

Visa en lista över alla klassificerare som har skapats under den Formigenkänning resursen.


   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

Visa information för varje modell, inklusive dess modell-ID, beskrivning och när den skapades.

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

Returer

Pageable för DocumentModelSummary.

Returtyp

ItemPaged[DocumentModelSummary]

Undantag

HttpResponseError

Exempel

Visa en lista över alla modeller som har skapats under den Formigenkänning resursen.


   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

Lista information för varje åtgärd.

Visar en lista över alla åtgärder som är associerade med den Formigenkänning resursen. Observera att åtgärdsinformationen bara finns kvar i 24 timmar. Om en dokumentmodellåtgärd lyckades kan dokumentmodellen nås med hjälp av get_document_model API:erna eller list_document_models .

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

Returer

En växlingsbar av OperationSummary.

Returtyp

ItemPaged[OperationSummary]

Undantag

HttpResponseError

Exempel

Visa en lista över alla dokumentmodellåtgärder under de senaste 24 timmarna.


   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

Kör en nätverksbegäran med klientens befintliga pipeline.

Begärande-URL:en kan vara relativ till bas-URL:en. Den tjänst-API-version som används för begäran är densamma som klientens om inget annat anges. Att åsidosätta klientens konfigurerade API-version i relativ URL stöds på klienten med API-version 2022-08-31 och senare. Åsidosätter i absolut URL som stöds på klienten med valfri API-version. Den här metoden genererar inte om svaret är ett fel. om du vill skapa ett undantag anropar du raise_for_status() på det returnerade svarsobjektet. Mer information om hur du skickar anpassade begäranden med den här metoden finns i https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametrar

request: HttpRequest

Obligatorisk

Den nätverksbegäran som du vill göra.

stream: bool

Om svarsnyttolasten kommer att strömmas. Standardvärdet är Falskt.

Returer

Svaret på ditt nätverksanrop. Felhantering av ditt svar sker inte.

Returtyp

HttpResponse

Undantag

HttpResponseError

Dela via

DocumentModelAdministrationClient Klass

Konstruktor

Parametrar

Exempel

Metoder

begin_build_document_classifier

Parametrar

Returer

Returtyp

Undantag

Exempel

begin_build_document_model

Parametrar

Returer

Returtyp

Undantag

Exempel

begin_compose_document_model

Parametrar

Returer

Returtyp

Undantag

Exempel

begin_copy_document_model_to

Parametrar

Returer

Returtyp

Undantag

Exempel

close

Undantag

delete_document_classifier

Parametrar

Returer

Returtyp

Undantag

Exempel

delete_document_model

Parametrar

Returer

Returtyp

Undantag

Exempel

get_copy_authorization

Parametrar

Returer

Returtyp

Undantag

get_document_analysis_client

Returer

Returtyp

Undantag

get_document_classifier

Parametrar

Returer

Returtyp

Undantag

Exempel

get_document_model

Parametrar

Returer

Returtyp

Undantag

Exempel

get_operation

Parametrar

Returer

Returtyp

Undantag

Exempel

get_resource_details

Returer

Returtyp

Undantag

Exempel

list_document_classifiers

Returer

Returtyp

Undantag