DocumentModelAdministrationClient Sınıf

Başvuru

DocumentModelAdministrationClient, modelleri oluşturmak ve yönetmek için kullanılacak Form Tanıma arabirimidir.

Model ve sınıflandırıcı oluşturma yöntemlerinin yanı sıra modelleri ve sınıflandırıcıları görüntüleme ve silme, model ve sınıflandırıcı işlemlerini görüntüleme, hesap bilgilerine erişme, modelleri başka bir Form Tanıma kaynağına kopyalama ve mevcut model koleksiyonundan yeni bir model oluşturma yöntemlerini sağlar.

Not

DocumentModelAdministrationClient API sürümleriyle kullanılmalıdır

2022-08-31 ve yukarısı. =v2.1 API sürümlerini <kullanmak için FormTrainingClient örneği oluşturun.

Sürüm 2022-08-31'de yeni: DocumentModelAdministrationClient ve istemci yöntemleri.

Devralma: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Oluşturucu

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

Parametreler

endpoint: str

Gerekli

Desteklenen Bilişsel Hizmetler uç noktaları (protokol ve ana bilgisayar adı, örneğin: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential veya TokenCredential

Gerekli

İstemcinin Azure'a bağlanması için gereken kimlik bilgileri. Bu, bir API anahtarı veya belirteç identitykimlik bilgisi kullanıyorsanız AzureKeyCredential örneğidir.

api_version: str veya DocumentAnalysisApiVersion

İstekler için kullanılacak hizmetin API sürümü. Varsayılan olarak en son hizmet sürümünü kullanır. Eski bir sürüme ayarlamak özellik uyumluluğunu azaltabilir. =v2.1 API sürümlerini <kullanmak için bir FormTrainingClient örneği oluşturun.

Örnekler

DocumentModelAdministrationClient'ı bir uç nokta ve API anahtarıyla oluşturma.


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

Belirteç kimlik bilgileriyle DocumentModelAdministrationClient oluşturma.


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

Yöntemler

begin_build_document_classifier	Belge sınıflandırıcısı oluşturma. Özel sınıflandırıcı modeli oluşturma ve eğitme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. . Sürüm 2023-07-31'de yeni: begin_build_document_classifier istemci yöntemi.
begin_build_document_model	Özel bir belge modeli oluşturun. İstek, dışarıdan erişilebilir bir Azure depolama blob kapsayıcısı URI'sine (tercihen Paylaşılan Erişim İmzası URI'sine) sahip bir blob_container_url anahtar sözcük parametresi içermelidir. Kapsayıcı URI'sinin (SAS olmadan) yalnızca kapsayıcı genel olduğunda veya yönetilen kimliği yapılandırıldığında kabul edilir. Yönetilen kimlikleri Form Tanıma çalışacak şekilde yapılandırma hakkında daha fazla bilgi için bkz. https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modeller şu içerik türünde belgeler kullanılarak oluşturulur: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' veya 'image/heif'. Kapsayıcıdaki diğer içerik türleri yoksayılır. Sürüm 2023-07-31'de yeni eklendi: file_list anahtar sözcük bağımsız değişkeni.
begin_compose_document_model	Mevcut modeller koleksiyonundan oluşturulmuş bir belge modeli oluşturur. Oluşturulan model, tek bir model kimliğiyle birden çok modelin çağrılmasını sağlar. Oluşturulan model kimliğiyle analiz edilecek bir belge gönderildiğinde, önce doğru özel modele yönlendirmek için bir sınıflandırma adımı gerçekleştirilir.
begin_copy_document_model_to	Bu kaynakta depolanan bir belge modelini (kaynak) kullanıcı tarafından belirtilen hedef Form Tanıma kaynağına kopyalayın. Bu, kaynak Form Tanıma kaynağıyla (kopyalanması amaçlanan modelle) çağrılmalıdır. Hedef parametre, hedef kaynağın yöntemi çağrılırken get_copy_authorization çıkışından sağlanmalıdır.
close	DocumentModelAdministrationClient Oturumu kapatın.
delete_document_classifier	Belge sınıflandırıcıyı silin. Sürüm 2023-07-31'de yeni eklendi: delete_document_classifier istemci yöntemi.
delete_document_model	Özel belge modelini silme.
get_copy_authorization	Özel modeli hedef Form Tanıma kaynağına kopyalamak için yetkilendirme oluşturun. Bu hedef kaynak tarafından çağrılmalıdır (modelin kopyalandığı yer) ve çıkış hedef parametresi olarak içine begin_copy_document_model_togeçirilebilir.
get_document_analysis_client	DocumentModelAdministrationClient'tan DocumentAnalysisClient örneğini alın.
get_document_classifier	Kimliğine göre bir belge sınıflandırıcısı alın. Sürüm 2023-07-31'de yeni eklendi: get_document_classifier istemci yöntemi.
get_document_model	Kimliğine göre bir belge modeli alın.
get_operation	Kimliğine göre bir işlem alın. Form Tanıma kaynağıyla ilişkilendirilmiş bir işlem alın. İşlem bilgilerinin yalnızca 24 saat boyunca devam ettiğini unutmayın. Belge modeli işlemi başarılı olursa, modele veya list_document_models API'leri get_document_model kullanılarak erişilebilir.
get_resource_details	Form Tanıma kaynağı altındaki modeller hakkında bilgi edinin.
list_document_classifiers	Sınıflandırıcı kimliği, açıklaması ve oluşturulduğu zaman dahil olmak üzere her belge sınıflandırıcısı için bilgileri listeleyin. Sürüm 2023-07-31'de yeni: list_document_classifiers istemci yöntemi.
list_document_models	Model kimliği, açıklaması ve ne zaman oluşturulduğu dahil olmak üzere her model için bilgileri listeleyin.
list_operations	Her işlem için bilgileri listeleyin. Form Tanıma kaynağıyla ilişkili tüm işlemleri listeler. İşlem bilgilerinin yalnızca 24 saat boyunca devam ettiğini unutmayın. Belge modeli işlemi başarılı olursa, belge modeline veya list_document_models API'leri get_document_model kullanılarak erişilebilir.
send_request	İstemcinin mevcut işlem hattını kullanarak bir ağ isteği çalıştırır. İstek URL'si temel URL'ye göre olabilir. İstek için kullanılan hizmet API'sinin sürümü, aksi belirtilmedikçe istemcinin sürümüyle aynıdır. İstemcinin yapılandırılmış API sürümünü göreli URL'de geçersiz kılma, 2022-08-31 ve üzeri API sürümüne sahip istemcide desteklenir. Herhangi bir API sürümüyle istemcide desteklenen mutlak URL'de geçersiz kılma. Yanıt bir hataysa bu yöntem tetiklenmez; özel durum tetiklemek için döndürülen yanıt nesnesinde raise_for_status() öğesini çağırın. Bu yöntemle özel istek gönderme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/dpcodegen/python/send_request. .

begin_build_document_classifier

Belge sınıflandırıcısı oluşturma. Özel sınıflandırıcı modeli oluşturma ve eğitme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. .

Sürüm 2023-07-31'de yeni: begin_build_document_classifier istemci yöntemi.

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

Parametreler

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

Gerekli

Sınıflandıracak belge türlerinin eşlemesi.

classifier_id: str

Benzersiz belge sınıflandırıcı adı. Belirtilmezse, sizin için bir sınıflandırıcı kimliği oluşturulur.

description: str

Belge sınıflandırıcı açıklaması.

Döndürülenler

DocumentModelAdministrationLROPoller örneği. Bir DocumentClassifierDetailsdöndürmek için poller nesnesinde result() öğesini çağırın.

Dönüş türü

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Özel durumlar

HttpResponseError

Örnekler

Belge sınıflandırıcısı oluşturma.


   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

Özel bir belge modeli oluşturun.

İstek, dışarıdan erişilebilir bir Azure depolama blob kapsayıcısı URI'sine (tercihen Paylaşılan Erişim İmzası URI'sine) sahip bir blob_container_url anahtar sözcük parametresi içermelidir. Kapsayıcı URI'sinin (SAS olmadan) yalnızca kapsayıcı genel olduğunda veya yönetilen kimliği yapılandırıldığında kabul edilir. Yönetilen kimlikleri Form Tanıma çalışacak şekilde yapılandırma hakkında daha fazla bilgi için bkz. https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Modeller şu içerik türünde belgeler kullanılarak oluşturulur: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp' veya 'image/heif'. Kapsayıcıdaki diğer içerik türleri yoksayılır.

Sürüm 2023-07-31'de yeni eklendi: file_list anahtar sözcük bağımsız değişkeni.

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]

Parametreler

build_mode: ModelBuildMode

Gerekli

Özel model derleme modu. Olası değerler şunlardır: "template", "nöral". Derleme modları hakkında daha fazla bilgi için bkz. https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

Azure Depolama blob kapsayıcısı SAS URI'si. Kapsayıcı genel ise veya yönetilen kimliği yapılandırılmışsa kapsayıcı URI'sini (SAS olmadan) kullanabilirsiniz. Eğitim veri kümesi ayarlama hakkında daha fazla bilgi için bkz: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

Modeliniz için benzersiz bir kimlik. Belirtilmezse, sizin için bir model kimliği oluşturulur.

description: str

Modele eklenecek isteğe bağlı bir açıklama.

prefix: str

Blob kapsayıcı url yolundaki belgeleri filtrelemek için büyük/küçük harfe duyarlı ön ek dizesi. Örneğin, Azure depolama blobu URI'sini kullanırken, alt klasörleri kısıtlamak için ön eki kullanın. dosya adlarının aynı ön eki paylaştığı durumlardan kaçınmak için ön ek '/' ile bitmelidir.

file_list: str

Eğitim için belgelerin bir alt kümesini belirten kapsayıcı içindeki bir JSONL dosyasının yolu.

tags: dict[str, str]

Modelle ilişkili kullanıcı tanımlı anahtar-değer etiketi özniteliklerinin listesi.

Döndürülenler

DocumentModelAdministrationLROPoller örneği. Bir DocumentModelDetailsdöndürmek için poller nesnesinde result() öğesini çağırın.

Dönüş türü

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Özel durumlar

HttpResponseError

Örnekler

Eğitim dosyalarından model oluşturma.


   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

Mevcut modeller koleksiyonundan oluşturulmuş bir belge modeli oluşturur.

Oluşturulan model, tek bir model kimliğiyle birden çok modelin çağrılmasını sağlar. Oluşturulan model kimliğiyle analiz edilecek bir belge gönderildiğinde, önce doğru özel modele yönlendirmek için bir sınıflandırma adımı gerçekleştirilir.

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

Parametreler

component_model_ids: list[str]

Gerekli

Oluşturulan modelde kullanılacak model kimliklerinin listesi.

model_id: str

Oluşturulan modeliniz için benzersiz bir kimlik. Belirtilmezse, sizin için bir model kimliği oluşturulur.

description: str

Modele eklenecek isteğe bağlı bir açıklama.

tags: dict[str, str]

Modelle ilişkili kullanıcı tanımlı anahtar-değer etiketi özniteliklerinin listesi.

Döndürülenler

DocumentModelAdministrationLROPoller örneği. Bir DocumentModelDetailsdöndürmek için poller nesnesinde result() öğesini çağırın.

Dönüş türü

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Özel durumlar

HttpResponseError

Örnekler

Mevcut modellerle oluşturulmuş bir model oluşturma.


   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

Bu kaynakta depolanan bir belge modelini (kaynak) kullanıcı tarafından belirtilen hedef Form Tanıma kaynağına kopyalayın.

Bu, kaynak Form Tanıma kaynağıyla (kopyalanması amaçlanan modelle) çağrılmalıdır. Hedef parametre, hedef kaynağın yöntemi çağrılırken get_copy_authorization çıkışından sağlanmalıdır.

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

Parametreler

model_id: str

Gerekli

Hedef kaynağa kopyalanacak modelin model tanımlayıcısı.

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

Gerekli

Hedef kaynağın çağrısından oluşturulan kopyalama yetkilendirmesi get_copy_authorization.

Döndürülenler

DocumentModelAdministrationLROPoller örneği. Bir DocumentModelDetailsdöndürmek için poller nesnesinde result() öğesini çağırın.

Dönüş türü

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Özel durumlar

HttpResponseError

Örnekler

Kaynak kaynaktan hedef kaynağa model kopyalama


   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 Oturumu kapatın.

close() -> None

Özel durumlar

HttpResponseError

delete_document_classifier

Belge sınıflandırıcıyı silin.

Sürüm 2023-07-31'de yeni eklendi: delete_document_classifier istemci yöntemi.

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

Parametreler

classifier_id: str

Gerekli

Sınıflandırıcı tanımlayıcısı.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Örnekler

Sınıflandırıcıyı silin.


   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

Özel belge modelini silme.

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

Parametreler

model_id: str

Gerekli

Model tanımlayıcısı.

Döndürülenler

Hiçbiri

Dönüş türü

None

Özel durumlar

HttpResponseError

ResourceNotFoundError

Örnekler

Modeli silme.


   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

Özel modeli hedef Form Tanıma kaynağına kopyalamak için yetkilendirme oluşturun.

Bu hedef kaynak tarafından çağrılmalıdır (modelin kopyalandığı yer) ve çıkış hedef parametresi olarak içine begin_copy_document_model_togeçirilebilir.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parametreler

model_id: str

Kopyalanan modeliniz için benzersiz bir kimlik. Belirtilmezse, sizin için bir model kimliği oluşturulur.

description: str

Modele eklenecek isteğe bağlı bir açıklama.

tags: dict[str, str]

Modelle ilişkili kullanıcı tanımlı anahtar-değer etiketi özniteliklerinin listesi.

Döndürülenler

Kopyalama yetkilendirmesi için gereken değerleri içeren bir sözlük.

Dönüş türü

<xref:azure.ai.formrecognizer.TargetAuthorization>

Özel durumlar

HttpResponseError

get_document_analysis_client

DocumentModelAdministrationClient'tan DocumentAnalysisClient örneğini alın.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Döndürülenler

A DocumentAnalysisClient

Dönüş türü

DocumentAnalysisClient

Özel durumlar

HttpResponseError

get_document_classifier

Kimliğine göre bir belge sınıflandırıcısı alın.

Sürüm 2023-07-31'de yeni eklendi: get_document_classifier istemci yöntemi.

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

Parametreler

classifier_id: str

Gerekli

Sınıflandırıcı tanımlayıcısı.

Döndürülenler

DocumentClassifierDetails

Dönüş türü

DocumentClassifierDetails

Özel durumlar

HttpResponseError

ResourceNotFoundError

Örnekler

Kimliğine göre bir sınıflandırıcı alı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

Kimliğine göre bir belge modeli alın.

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

Parametreler

model_id: str

Gerekli

Model tanımlayıcısı.

Döndürülenler

DocumentModelDetails

Dönüş türü

DocumentModelDetails

Özel durumlar

HttpResponseError

ResourceNotFoundError

Örnekler

Modeli kimliğine göre alı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

Kimliğine göre bir işlem alın.

Form Tanıma kaynağıyla ilişkilendirilmiş bir işlem alın. İşlem bilgilerinin yalnızca 24 saat boyunca devam ettiğini unutmayın. Belge modeli işlemi başarılı olursa, modele veya list_document_models API'leri get_document_model kullanılarak erişilebilir.

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

Parametreler

operation_id: str

Gerekli

İşlem kimliği.

Döndürülenler

OperationDetails

Dönüş türü

OperationDetails

Özel durumlar

HttpResponseError

Örnekler

Kimliğine göre bir belge modeli işlemi alı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

Form Tanıma kaynağı altındaki modeller hakkında bilgi edinin.

get_resource_details(**kwargs: Any) -> ResourceDetails

Döndürülenler

Kaynak altındaki özel modellerin özeti - model sayısı ve sınırı.

Dönüş türü

ResourceDetails

Özel durumlar

HttpResponseError

Örnekler

Form Tanıma kaynağı altında model sayılarını ve sınırlarını alın.


   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

Sınıflandırıcı kimliği, açıklaması ve oluşturulduğu zaman dahil olmak üzere her belge sınıflandırıcısı için bilgileri listeleyin.

Sürüm 2023-07-31'de yeni: list_document_classifiers istemci yöntemi.

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

Döndürülenler

DocumentClassifierDetails pageable.

Dönüş türü

ItemPaged[DocumentClassifierDetails]

Özel durumlar

HttpResponseError

Örnekler

Form Tanıma kaynağı altında başarıyla oluşturulmuş tüm sınıflandırıcıları listeleyin.


   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

Model kimliği, açıklaması ve ne zaman oluşturulduğu dahil olmak üzere her model için bilgileri listeleyin.

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

Döndürülenler

DocumentModelSummary pageable.

Dönüş türü

ItemPaged[DocumentModelSummary]

Özel durumlar

HttpResponseError

Örnekler

Form Tanıma kaynağı altında başarıyla oluşturulmuş tüm modelleri listeleyin.


   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

Her işlem için bilgileri listeleyin.

Form Tanıma kaynağıyla ilişkili tüm işlemleri listeler. İşlem bilgilerinin yalnızca 24 saat boyunca devam ettiğini unutmayın. Belge modeli işlemi başarılı olursa, belge modeline veya list_document_models API'leri get_document_model kullanılarak erişilebilir.

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

Döndürülenler

OperationSummary'nin sayfalanabilir bir örneği.

Dönüş türü

ItemPaged[OperationSummary]

Özel durumlar

HttpResponseError

Örnekler

Son 24 saat içindeki tüm belge modeli işlemlerini listeleyin.


   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

İstemcinin mevcut işlem hattını kullanarak bir ağ isteği çalıştırır.

İstek URL'si temel URL'ye göre olabilir. İstek için kullanılan hizmet API'sinin sürümü, aksi belirtilmedikçe istemcinin sürümüyle aynıdır. İstemcinin yapılandırılmış API sürümünü göreli URL'de geçersiz kılma, 2022-08-31 ve üzeri API sürümüne sahip istemcide desteklenir. Herhangi bir API sürümüyle istemcide desteklenen mutlak URL'de geçersiz kılma. Yanıt bir hataysa bu yöntem tetiklenmez; özel durum tetiklemek için döndürülen yanıt nesnesinde raise_for_status() öğesini çağırın. Bu yöntemle özel istek gönderme hakkında daha fazla bilgi için bkz https://aka.ms/azsdk/dpcodegen/python/send_request. .

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

Parametreler

request: HttpRequest

Gerekli

Yapmak istediğiniz ağ isteği.

stream: bool

Yanıt yükünün akışla aktarılıp aktarılmayacağı. Varsayılan değer False'tur.

Döndürülenler

Ağ çağrınızın yanıtı. Yanıtınızda hata işleme yapmaz.

Dönüş türü

HttpResponse

Özel durumlar

HttpResponseError

Aracılığıyla paylaş

DocumentModelAdministrationClient Sınıf

Oluşturucu

Parametreler

Örnekler

Yöntemler

begin_build_document_classifier

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

begin_build_document_model

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

begin_compose_document_model

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

begin_copy_document_model_to

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

close

Özel durumlar

delete_document_classifier

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

delete_document_model

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

get_copy_authorization

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

get_document_analysis_client

Döndürülenler

Dönüş türü

Özel durumlar

get_document_classifier

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

get_document_model

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

get_operation

Parametreler

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

get_resource_details

Döndürülenler

Dönüş türü

Özel durumlar

Örnekler

list_document_classifiers

Döndürülenler

Dönüş türü

Özel durumlar