DocumentModelAdministrationClient Kelas

DocumentModelAdministrationClient adalah antarmuka Form Recognizer yang digunakan untuk membangun dan mengelola model.

Ini menyediakan metode untuk membangun model dan pengklasifikasi, serta metode untuk melihat dan menghapus model dan pengklasifikasi, melihat operasi model dan pengklasifikasi, mengakses informasi akun, menyalin model ke sumber daya Form Recognizer lain, dan menyusun model baru dari kumpulan model yang ada.

Catatan

DocumentModelAdministrationClient harus digunakan dengan versi API

2022-08-31 ke atas. Untuk menggunakan versi <API =v2.1, buat instans FormTrainingClient.

Baru dalam versi 2022-08-31: DocumentModelAdministrationClient dan metode kliennya.

Warisan

azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

Konstruktor

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

Parameter

endpoint

str

Diperlukan

Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://westus2.api.cognitive.microsoft.com).

credential

AzureKeyCredential atau TokenCredential

Diperlukan

Kredensial yang diperlukan agar klien terhubung ke Azure. Ini adalah instans AzureKeyCredential jika menggunakan kunci API atau kredensial token dari identity.

api_version

str atau DocumentAnalysisApiVersion

Versi API layanan yang akan digunakan untuk permintaan. Ini default ke versi layanan terbaru. Pengaturan ke versi yang lebih lama dapat mengakibatkan berkurangnya kompatibilitas fitur. Untuk menggunakan versi <API =v2.1, buat instans FormTrainingClient.

Contoh

Membuat DocumentModelAdministrationClient dengan titik akhir dan kunci API.

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

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

   document_model_admin_client = DocumentModelAdministrationClient(
       endpoint, AzureKeyCredential(key)
   )

Membuat DocumentModelAdministrationClient dengan kredensial token.

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

Metode

begin_build_document_classifier	Membangun pengklasifikasi dokumen. Untuk informasi selengkapnya tentang cara membangun dan melatih model pengklasifikasi kustom, lihat https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. Baru dalam versi 2023-07-31: Metode klien begin_build_document_classifier .
begin_build_document_model	Buat model dokumen kustom. Permintaan harus menyertakan parameter kata kunci blob_container_url yang merupakan URI kontainer blob penyimpanan Azure yang dapat diakses secara eksternal (sebaiknya URI Tanda Tangan Akses Bersama). Perhatikan bahwa URI kontainer (tanpa SAS) hanya diterima ketika kontainer bersifat publik atau memiliki identitas terkelola yang dikonfigurasi, lihat selengkapnya tentang mengonfigurasi identitas terkelola untuk bekerja dengan Form Recognizer di sini: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Model dibangun menggunakan dokumen yang merupakan jenis konten berikut - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp', atau 'image/heif'. Jenis konten lain dalam kontainer diabaikan. Baru dalam versi 2023-07-31: Argumen kata kunci file_list .
begin_compose_document_model	Membuat model dokumen yang dibuat dari kumpulan model yang ada. Model yang disusam memungkinkan beberapa model dipanggil dengan SATU ID model. Saat dokumen dikirimkan untuk dianalisis dengan ID model yang disusupi, langkah klasifikasi pertama kali dilakukan untuk merutekannya ke model kustom yang benar.
begin_copy_document_model_to	Salin model dokumen yang disimpan dalam sumber daya ini (sumber) ke sumber daya Form Recognizer target yang ditentukan pengguna. Ini harus dipanggil dengan sumber daya Form Recognizer sumber daya (dengan model yang dimaksudkan untuk disalin). Parameter target harus disediakan dari output sumber daya target dari memanggil get_copy_authorization metode .
close	DocumentModelAdministrationClient Tutup sesi.
delete_document_classifier	Menghapus pengklasifikasi dokumen. Baru dalam versi 2023-07-31: Metode klien delete_document_classifier .
delete_document_model	Menghapus model dokumen kustom.
get_copy_authorization	Hasilkan otorisasi untuk menyalin model kustom ke sumber daya Form Recognizer target. Ini harus dipanggil oleh sumber daya target (tempat model akan disalin) dan output dapat diteruskan sebagai parameter target ke dalam begin_copy_document_model_to.
get_document_analysis_client	Dapatkan instans DocumentAnalysisClient dari DocumentModelAdministrationClient.
get_document_classifier	Dapatkan pengklasifikasi dokumen dengan ID-nya. Baru dalam versi 2023-07-31: Metode klien get_document_classifier .
get_document_model	Dapatkan model dokumen dengan ID-nya.
get_operation	Dapatkan operasi dengan ID-nya. Dapatkan operasi yang terkait dengan sumber daya Form Recognizer. Perhatikan bahwa informasi operasi hanya bertahan selama 24 jam. Jika operasi model dokumen berhasil, model dapat diakses menggunakan get_document_model API atau list_document_models .
get_resource_details	Dapatkan informasi tentang model di bawah sumber daya Form Recognizer.
list_document_classifiers	Mencantumkan informasi untuk setiap pengklasifikasi dokumen, termasuk ID pengklasifikasi, deskripsi, dan kapan dibuat. Baru dalam versi 2023-07-31: Metode klien list_document_classifiers .
list_document_models	Mencantumkan informasi untuk setiap model, termasuk ID model, deskripsi, dan kapan dibuat.
list_operations	Mencantumkan informasi untuk setiap operasi. Mencantumkan semua operasi yang terkait dengan sumber daya Form Recognizer. Perhatikan bahwa informasi operasi hanya bertahan selama 24 jam. Jika operasi model dokumen berhasil, model dokumen dapat diakses menggunakan get_document_model API atau list_document_models .
send_request	Menjalankan permintaan jaringan menggunakan alur klien yang ada. URL permintaan dapat relatif terhadap URL dasar. Versi API layanan yang digunakan untuk permintaan sama dengan klien kecuali ditentukan lain. Mengambil alih versi API klien yang dikonfigurasi di URL relatif didukung pada klien dengan API versi 2022-08-31 dan yang lebih baru. Mengambil alih URL absolut yang didukung pada klien dengan versi API apa pun. Metode ini tidak menaikkan jika responsnya adalah kesalahan; untuk menaikkan pengecualian, panggil raise_for_status() pada objek respons yang dikembalikan. Untuk informasi selengkapnya tentang cara mengirim permintaan kustom dengan metode ini, lihat https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

Membangun pengklasifikasi dokumen. Untuk informasi selengkapnya tentang cara membangun dan melatih model pengklasifikasi kustom, lihat https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Baru dalam versi 2023-07-31: Metode klien begin_build_document_classifier .

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

Parameter

doc_types

Mapping[str, ClassifierDocumentTypeDetails]

Diperlukan

Pemetaan jenis dokumen yang akan diklasifikasikan.

classifier_id

str

Nama pengklasifikasi dokumen unik. Jika tidak ditentukan, ID pengklasifikasi akan dibuat untuk Anda.

description

str

Deskripsi klasifikasi dokumen.

Mengembalikan

Instans DocumentModelAdministrationLROPoller. Panggil result() pada objek poller untuk mengembalikan DocumentClassifierDetails.

Tipe hasil

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

Pengecualian

HttpResponseError

Contoh

Membangun pengklasifikasi dokumen.

   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

Buat model dokumen kustom.

Permintaan harus menyertakan parameter kata kunci blob_container_url yang merupakan URI kontainer blob penyimpanan Azure yang dapat diakses secara eksternal (sebaiknya URI Tanda Tangan Akses Bersama). Perhatikan bahwa URI kontainer (tanpa SAS) hanya diterima ketika kontainer bersifat publik atau memiliki identitas terkelola yang dikonfigurasi, lihat selengkapnya tentang mengonfigurasi identitas terkelola untuk bekerja dengan Form Recognizer di sini: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. Model dibangun menggunakan dokumen yang merupakan jenis konten berikut - 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff', 'image/bmp', atau 'image/heif'. Jenis konten lain dalam kontainer diabaikan.

Baru dalam versi 2023-07-31: Argumen kata kunci 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]

Parameter

build_mode

ModelBuildMode

Diperlukan

Mode build model kustom. Nilai yang mungkin termasuk: "template", "neural". Untuk informasi selengkapnya tentang mode build, lihat: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url

str

URI SAS kontainer blob Azure Storage. URI kontainer (tanpa SAS) dapat digunakan jika kontainer bersifat publik atau memiliki identitas terkelola yang dikonfigurasi. Untuk informasi selengkapnya tentang menyiapkan himpunan data pelatihan, lihat: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id

str

ID unik untuk model Anda. Jika tidak ditentukan, ID model akan dibuat untuk Anda.

description

str

Deskripsi opsional untuk ditambahkan ke model.

prefix

str

String awalan peka huruf besar/kecil untuk memfilter dokumen di jalur url kontainer blob. Misalnya, saat menggunakan URI blob penyimpanan Azure, gunakan awalan untuk membatasi sub folder. awalan harus diakhiri dengan '/' untuk menghindari kasus di mana nama file berbagi awalan yang sama.

file_list

str

Jalur ke file JSONL dalam kontainer yang menentukan subset dokumen untuk pelatihan.

tags

dict[str, str]

Daftar atribut tag nilai kunci yang ditentukan pengguna yang terkait dengan model.

Mengembalikan

Instans DocumentModelAdministrationLROPoller. Panggil result() pada objek poller untuk mengembalikan DocumentModelDetails.

Tipe hasil

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Pengecualian

HttpResponseError

Contoh

Membangun model dari file pelatihan.

   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

Membuat model dokumen yang dibuat dari kumpulan model yang ada.

Model yang disusam memungkinkan beberapa model dipanggil dengan SATU ID model. Saat dokumen dikirimkan untuk dianalisis dengan ID model yang disusupi, langkah klasifikasi pertama kali dilakukan untuk merutekannya ke model kustom yang benar.

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

Parameter

component_model_ids

list[str]

Diperlukan

Daftar ID model yang akan digunakan dalam model yang disusur.

model_id

str

ID unik untuk model yang Anda buat. Jika tidak ditentukan, ID model akan dibuat untuk Anda.

description

str

Deskripsi opsional untuk ditambahkan ke model.

tags

dict[str, str]

Daftar atribut tag nilai kunci yang ditentukan pengguna yang terkait dengan model.

Mengembalikan

Instans DocumentModelAdministrationLROPoller. Panggil result() pada objek poller untuk mengembalikan DocumentModelDetails.

Tipe hasil

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Pengecualian

HttpResponseError

Contoh

Membuat model yang dibuat dengan model yang ada.

   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

Salin model dokumen yang disimpan dalam sumber daya ini (sumber) ke sumber daya Form Recognizer target yang ditentukan pengguna.

Ini harus dipanggil dengan sumber daya Form Recognizer sumber daya (dengan model yang dimaksudkan untuk disalin). Parameter target harus disediakan dari output sumber daya target dari memanggil get_copy_authorization metode .

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

Parameter

model_id

str

Diperlukan

Pengidentifikasi model untuk disalin ke sumber daya target.

target

<xref:azure.ai.formrecognizer.TargetAuthorization>

Diperlukan

Otorisasi salinan yang dihasilkan dari panggilan sumber daya target ke get_copy_authorization.

Mengembalikan

Instans DocumentModelAdministrationLROPoller. Panggil result() pada objek poller untuk mengembalikan DocumentModelDetails.

Tipe hasil

DocumentModelAdministrationLROPoller[DocumentModelDetails]

Pengecualian

HttpResponseError

Contoh

Menyalin model dari sumber daya sumber ke sumber daya target

   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 Tutup sesi.

close() -> None

Pengecualian

HttpResponseError

delete_document_classifier

Menghapus pengklasifikasi dokumen.

Baru dalam versi 2023-07-31: Metode klien delete_document_classifier .

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

Parameter

classifier_id

str

Diperlukan

Pengidentifikasi pengklasifikasi.

Mengembalikan

Tidak ada

Tipe hasil

None

Pengecualian

HttpResponseError

ResourceNotFoundError

Contoh

Menghapus pengklasifikasi.

   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

Menghapus model dokumen kustom.

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

Parameter

model_id

str

Diperlukan

Pengidentifikasi model.

Mengembalikan

Tidak ada

Tipe hasil

None

Pengecualian

HttpResponseError

ResourceNotFoundError

Contoh

Menghapus model.

   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

Hasilkan otorisasi untuk menyalin model kustom ke sumber daya Form Recognizer target.

Ini harus dipanggil oleh sumber daya target (tempat model akan disalin) dan output dapat diteruskan sebagai parameter target ke dalam begin_copy_document_model_to.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

Parameter

model_id

str

ID unik untuk model anda yang disalin. Jika tidak ditentukan, ID model akan dibuat untuk Anda.

description

str

Deskripsi opsional untuk ditambahkan ke model.

tags

dict[str, str]

Daftar atribut tag nilai kunci yang ditentukan pengguna yang terkait dengan model.

Mengembalikan

Kamus dengan nilai yang diperlukan untuk otorisasi salinan.

Tipe hasil

<xref:azure.ai.formrecognizer.TargetAuthorization>

Pengecualian

HttpResponseError

get_document_analysis_client

Dapatkan instans DocumentAnalysisClient dari DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

Mengembalikan

A DocumentAnalysisClient

Tipe hasil

DocumentAnalysisClient

Pengecualian

HttpResponseError

get_document_classifier

Dapatkan pengklasifikasi dokumen dengan ID-nya.

Baru dalam versi 2023-07-31: Metode klien get_document_classifier .

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

Parameter

classifier_id

str

Diperlukan

Pengidentifikasi pengklasifikasi.

Mengembalikan

DocumentClassifierDetails

Tipe hasil

DocumentClassifierDetails

Pengecualian

HttpResponseError

ResourceNotFoundError

Contoh

Dapatkan pengklasifikasi dengan ID-nya.

   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

Dapatkan model dokumen dengan ID-nya.

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

Parameter

model_id

str

Diperlukan

Pengidentifikasi model.

Mengembalikan

DocumentModelDetails

Tipe hasil

DocumentModelDetails

Pengecualian

HttpResponseError

ResourceNotFoundError

Contoh

Dapatkan model dengan ID-nya.

   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

Dapatkan operasi dengan ID-nya.

Dapatkan operasi yang terkait dengan sumber daya Form Recognizer. Perhatikan bahwa informasi operasi hanya bertahan selama 24 jam. Jika operasi model dokumen berhasil, model dapat diakses menggunakan get_document_model API atau list_document_models .

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

Parameter

operation_id

str

Diperlukan

ID operasi.

Mengembalikan

OperationDetails

Tipe hasil

OperationDetails

Pengecualian

HttpResponseError

Contoh

Dapatkan operasi model dokumen dengan ID-nya.

   # 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

Dapatkan informasi tentang model di bawah sumber daya Form Recognizer.

get_resource_details(**kwargs: Any) -> ResourceDetails

Mengembalikan

Ringkasan model kustom di bawah sumber daya - jumlah dan batas model.

Tipe hasil

ResourceDetails

Pengecualian

HttpResponseError

Contoh

Dapatkan jumlah dan batasan model di bawah sumber daya Form Recognizer.

   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

Mencantumkan informasi untuk setiap pengklasifikasi dokumen, termasuk ID pengklasifikasi, deskripsi, dan kapan dibuat.

Baru dalam versi 2023-07-31: Metode klien list_document_classifiers .

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

Mengembalikan

Dapat di-pageable dari DocumentClassifierDetails.

Tipe hasil

ItemPaged[DocumentClassifierDetails]

Pengecualian

HttpResponseError

Contoh

Cantumkan semua pengklasifikasi yang berhasil dibangun di bawah sumber daya Form Recognizer.

   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

Mencantumkan informasi untuk setiap model, termasuk ID model, deskripsi, dan kapan dibuat.

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

Mengembalikan

Dapat di-pageable dari DocumentModelSummary.

Tipe hasil

ItemPaged[DocumentModelSummary]

Pengecualian

HttpResponseError

Contoh

Cantumkan semua model yang berhasil dibangun di bawah sumber daya Form Recognizer.

   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

Mencantumkan informasi untuk setiap operasi.

Mencantumkan semua operasi yang terkait dengan sumber daya Form Recognizer. Perhatikan bahwa informasi operasi hanya bertahan selama 24 jam. Jika operasi model dokumen berhasil, model dokumen dapat diakses menggunakan get_document_model API atau list_document_models .

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

Mengembalikan

Satu halaman OperationSummary.

Tipe hasil

ItemPaged[OperationSummary]

Pengecualian

HttpResponseError

Contoh

Cantumkan semua operasi model dokumen dalam 24 jam terakhir.

   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

Menjalankan permintaan jaringan menggunakan alur klien yang ada.

URL permintaan dapat relatif terhadap URL dasar. Versi API layanan yang digunakan untuk permintaan sama dengan klien kecuali ditentukan lain. Mengambil alih versi API klien yang dikonfigurasi di URL relatif didukung pada klien dengan API versi 2022-08-31 dan yang lebih baru. Mengambil alih URL absolut yang didukung pada klien dengan versi API apa pun. Metode ini tidak menaikkan jika responsnya adalah kesalahan; untuk menaikkan pengecualian, panggil raise_for_status() pada objek respons yang dikembalikan. Untuk informasi selengkapnya tentang cara mengirim permintaan kustom dengan metode ini, lihat https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parameter

request

HttpRequest

Diperlukan

Permintaan jaringan yang ingin Anda buat.

stream

bool

Apakah payload respons akan dialirkan. Default ke False.

Mengembalikan

Respons panggilan jaringan Anda. Tidak melakukan penanganan kesalahan pada respons Anda.

Tipe hasil

HttpResponse

Pengecualian

HttpResponseError