DocumentModelAdministrationClient الفصل

‏‏المرجع

DocumentModelAdministrationClient هي واجهة Form Recognizer لاستخدامها لإنشاء النماذج وإدارتها.

يوفر أساليب لبناء النماذج والمصنفات، بالإضافة إلى أساليب لعرض النماذج والمصنفات وحذفها، وعرض عمليات النموذج والمصنف، والوصول إلى معلومات الحساب، ونسخ النماذج إلى مورد Form Recognizer آخر، وإنشاء نموذج جديد من مجموعة من النماذج الموجودة.

ملاحظة

يجب استخدام DocumentModelAdministrationClient مع إصدارات واجهة برمجة التطبيقات

2022-08-31 وما فوق. لاستخدام إصدارات <واجهة برمجة التطبيقات =v2.1، قم بإنشاء مثيل FormTrainingClient.

جديد في الإصدار 2022-08-31: DocumentModelAdministrationClient وأساليب العميل الخاصة به.

توريث: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

DocumentModelAdministrationClient

الدالمنشئ

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

المعلمات

endpoint: str

مطلوب

نقاط نهاية الخدمات المعرفية المدعومة (البروتوكول واسم المضيف، على سبيل المثال: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential أو TokenCredential

مطلوب

بيانات الاعتماد اللازمة للعميل للاتصال ب Azure. هذا مثيل من AzureKeyCredential إذا كنت تستخدم مفتاح API أو بيانات اعتماد رمز مميز من identity.

api_version: str أو DocumentAnalysisApiVersion

إصدار واجهة برمجة التطبيقات للخدمة لاستخدامه للطلبات. يتم تعيينه افتراضيا إلى أحدث إصدار من الخدمة. قد يؤدي الإعداد إلى إصدار أقدم إلى تقليل توافق الميزات. لاستخدام إصدارات <واجهة برمجة التطبيقات =v2.1، قم بإنشاء مثيل FormTrainingClient.

أمثلة

إنشاء DocumentModelAdministrationClient بنقطة نهاية ومفتاح 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)
   )

إنشاء DocumentModelAdministrationClient باستخدام بيانات اعتماد الرمز المميز.


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

الأساليب

begin_build_document_classifier	إنشاء مصنف مستند. لمزيد من المعلومات حول كيفية إنشاء نموذج مصنف مخصص وتدريبه، راجع https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. جديد في الإصدار 2023-07-31: أسلوب العميل begin_build_document_classifier .
begin_build_document_model	إنشاء نموذج مستند مخصص. يجب أن يتضمن الطلب معلمة كلمة أساسية blob_container_url وهي معرف URI لحاوية تخزين Azure blob يمكن الوصول إليه خارجيا (يفضل أن يكون عنوان URI توقيع الوصول المشترك). لاحظ أن عنوان URI للحاوية (بدون SAS) يتم قبوله فقط عندما تكون الحاوية عامة أو يكون لها هوية مدارة تم تكوينها، راجع المزيد حول تكوين الهويات المدارة للعمل مع Form Recognizer هنا: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. يتم إنشاء النماذج باستخدام مستندات من نوع المحتوى التالي - "application/pdf" أو "image/jpeg" أو "image/png" أو "image/tiff" أو "image/bmp" أو "image/heif". يتم تجاهل أنواع أخرى من المحتوى في الحاوية. جديد في الإصدار 2023-07-31: وسيطة الكلمة الأساسية file_list .
begin_compose_document_model	إنشاء نموذج مستند مكون من مجموعة من النماذج الموجودة. يسمح النموذج المكون لاستدعاء نماذج متعددة بمعرف نموذج واحد. عند إرسال مستند ليتم تحليله بمعرف نموذج مكون، يتم أولا تنفيذ خطوة تصنيف لتوجيهه إلى النموذج المخصص الصحيح.
begin_copy_document_model_to	انسخ نموذج مستند مخزن في هذا المورد (المصدر) إلى مورد Form Recognizer الهدف المحدد للمستخدم. يجب استدعاء هذا مع مورد Form Recognizer المصدر (مع النموذج المراد نسخه). يجب توفير المعلمة الهدف من إخراج المورد الهدف من استدعاء get_copy_authorization الأسلوب .
close	DocumentModelAdministrationClient أغلق جلسة العمل.
delete_document_classifier	حذف مصنف مستند. جديد في الإصدار 2023-07-31: أسلوب العميل delete_document_classifier .
delete_document_model	حذف نموذج مستند مخصص.
get_copy_authorization	إنشاء تخويل لنسخ نموذج مخصص إلى مورد Form Recognizer الهدف. يجب استدعاء هذا بواسطة المورد الهدف (حيث سيتم نسخ النموذج إلى) ويمكن تمرير الإخراج كمعلمة الهدف إلى begin_copy_document_model_to.
get_document_analysis_client	احصل على مثيل DocumentAnalysisClient من DocumentModelAdministrationClient.
get_document_classifier	احصل على مصنف مستند بواسطة معرفه. جديد في الإصدار 2023-07-31: أسلوب العميل get_document_classifier .
get_document_model	احصل على نموذج مستند بواسطة معرفه.
get_operation	احصل على عملية بواسطة معرفها. احصل على عملية مقترنة بمورد Form Recognizer. لاحظ أن معلومات العملية تستمر لمدة 24 ساعة فقط. إذا كانت عملية نموذج المستند ناجحة، يمكن الوصول إلى النموذج باستخدام get_document_model واجهات برمجة التطبيقات أو list_document_models .
get_resource_details	احصل على معلومات حول النماذج ضمن مورد Form Recognizer.
list_document_classifiers	سرد معلومات لكل مصنف مستند، بما في ذلك معرف المصنف والوصف ووقت إنشائه. جديد في الإصدار 2023-07-31: أسلوب العميل list_document_classifiers .
list_document_models	سرد المعلومات لكل نموذج، بما في ذلك معرف النموذج والوصف ومتى تم إنشاؤه.
list_operations	سرد المعلومات لكل عملية. يسرد جميع العمليات المقترنة بمورد Form Recognizer. لاحظ أن معلومات العملية تستمر لمدة 24 ساعة فقط. إذا نجحت عملية نموذج المستند، يمكن الوصول إلى نموذج المستند باستخدام get_document_model واجهات برمجة التطبيقات أو list_document_models .
send_request	تشغيل طلب شبكة باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية الحالية للعميل. يمكن أن يكون عنوان URL للطلب مرتبطا بعنوان URL الأساسي. إصدار واجهة برمجة تطبيقات الخدمة المستخدم للطلب هو نفسه إصدار العميل ما لم يتم تحديد خلاف ذلك. يتم دعم تجاوز إصدار واجهة برمجة التطبيقات المكون للعميل في عنوان URL النسبي على العميل مع إصدار واجهة برمجة التطبيقات 2022-08-31 والإصدارات الأحدث. التجاوز في عنوان URL المطلق المدعوم على العميل مع أي إصدار من واجهة برمجة التطبيقات. لا يرفع هذا الأسلوب إذا كانت الاستجابة خطأ؛ لرفع استثناء، قم باستدعاء raise_for_status() على كائن الاستجابة الذي تم إرجاعه. لمزيد من المعلومات حول كيفية إرسال طلبات مخصصة باستخدام هذا الأسلوب، راجع https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_build_document_classifier

إنشاء مصنف مستند. لمزيد من المعلومات حول كيفية إنشاء نموذج مصنف مخصص وتدريبه، راجع https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

جديد في الإصدار 2023-07-31: أسلوب العميل 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]

المعلمات

doc_types: Mapping[str, ClassifierDocumentTypeDetails]

مطلوب

تعيين أنواع المستندات للتصنيف مقابلها.

classifier_id: str

اسم مصنف المستند الفريد. إذا لم يتم تحديده، فسيتم إنشاء معرف مصنف لك.

description: str

وصف مصنف المستند.

المرتجعات

مثيل DocumentModelAdministrationLROPoller. استدعاء result() على كائن الاستقصاء لإرجاع DocumentClassifierDetails.

نوع الإرجاع

DocumentModelAdministrationLROPoller[DocumentClassifierDetails]

استثناءات

HttpResponseError

أمثلة

إنشاء مصنف مستند.


   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

إنشاء نموذج مستند مخصص.

يجب أن يتضمن الطلب معلمة كلمة أساسية blob_container_url وهي معرف URI لحاوية تخزين Azure blob يمكن الوصول إليه خارجيا (يفضل أن يكون عنوان URI توقيع الوصول المشترك). لاحظ أن عنوان URI للحاوية (بدون SAS) يتم قبوله فقط عندما تكون الحاوية عامة أو يكون لها هوية مدارة تم تكوينها، راجع المزيد حول تكوين الهويات المدارة للعمل مع Form Recognizer هنا: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/managed-identities. يتم إنشاء النماذج باستخدام مستندات من نوع المحتوى التالي - "application/pdf" أو "image/jpeg" أو "image/png" أو "image/tiff" أو "image/bmp" أو "image/heif". يتم تجاهل أنواع أخرى من المحتوى في الحاوية.

جديد في الإصدار 2023-07-31: وسيطة الكلمة الأساسية 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]

المعلمات

build_mode: ModelBuildMode

مطلوب

وضع إنشاء النموذج المخصص. تتضمن القيم المحتملة: "قالب"، "عصبي". لمزيد من المعلومات حول أوضاع الإنشاء، راجع: https://aka.ms/azsdk/formrecognizer/buildmode.

blob_container_url: str

SAS URI الخاص بحاوية Azure Storage blob. يمكن استخدام URI للحاوية (بدون SAS) إذا كانت الحاوية عامة أو تم تكوين هوية مدارة. لمزيد من المعلومات حول إعداد مجموعة بيانات التدريب، راجع: https://aka.ms/azsdk/formrecognizer/buildtrainingset.

model_id: str

معرف فريد لنموذجك. إذا لم يتم تحديده، فسيتم إنشاء معرف نموذج لك.

description: str

وصف اختياري لإضافته إلى النموذج.

prefix: str

سلسلة بادئة حساسة لحالة الأحرف لتصفية المستندات في مسار عنوان URL لحاوية الكائن الثنائي كبير الحجم. على سبيل المثال، عند استخدام عنوان URI لكائن ثنائي كبير الحجم لتخزين Azure، استخدم البادئة لتقييد المجلدات الفرعية. يجب أن تنتهي البادئة ب '/' لتجنب الحالات التي تشترك فيها أسماء الملفات في نفس البادئة.

file_list: str

المسار إلى ملف JSONL داخل الحاوية يحدد مجموعة فرعية من المستندات للتدريب.

tags: dict[str, str]

قائمة سمات علامة قيمة المفتاح المعرفة من قبل المستخدم المقترنة بالنموذج.

المرتجعات

مثيل DocumentModelAdministrationLROPoller. استدعاء result() على كائن الاستقصاء لإرجاع DocumentModelDetails.

نوع الإرجاع

DocumentModelAdministrationLROPoller[DocumentModelDetails]

استثناءات

HttpResponseError

أمثلة

بناء نموذج من ملفات التدريب.


   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

إنشاء نموذج مستند مكون من مجموعة من النماذج الموجودة.

يسمح النموذج المكون لاستدعاء نماذج متعددة بمعرف نموذج واحد. عند إرسال مستند ليتم تحليله بمعرف نموذج مكون، يتم أولا تنفيذ خطوة تصنيف لتوجيهه إلى النموذج المخصص الصحيح.

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

المعلمات

component_model_ids: list[str]

مطلوب

قائمة معرفات النموذج لاستخدامها في النموذج المكون.

model_id: str

معرف فريد للنموذج المكون. إذا لم يتم تحديده، فسيتم إنشاء معرف نموذج لك.

description: str

وصف اختياري لإضافته إلى النموذج.

tags: dict[str, str]

قائمة سمات علامة قيمة المفتاح المعرفة من قبل المستخدم المقترنة بالنموذج.

المرتجعات

مثيل DocumentModelAdministrationLROPoller. استدعاء result() على كائن الاستقصاء لإرجاع DocumentModelDetails.

نوع الإرجاع

DocumentModelAdministrationLROPoller[DocumentModelDetails]

استثناءات

HttpResponseError

أمثلة

إنشاء نموذج مكون مع نماذج موجودة.


   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

انسخ نموذج مستند مخزن في هذا المورد (المصدر) إلى مورد Form Recognizer الهدف المحدد للمستخدم.

يجب استدعاء هذا مع مورد Form Recognizer المصدر (مع النموذج المراد نسخه). يجب توفير المعلمة الهدف من إخراج المورد الهدف من استدعاء get_copy_authorization الأسلوب .

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

المعلمات

model_id: str

مطلوب

معرف نموذج النموذج المراد نسخه إلى المورد الهدف.

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

مطلوب

تخويل النسخ الذي تم إنشاؤه من استدعاء المورد الهدف إلى get_copy_authorization.

المرتجعات

مثيل DocumentModelAdministrationLROPoller. استدعاء result() على كائن الاستقصاء لإرجاع DocumentModelDetails.

نوع الإرجاع

DocumentModelAdministrationLROPoller[DocumentModelDetails]

استثناءات

HttpResponseError

أمثلة

نسخ نموذج من المورد المصدر إلى المورد الهدف


   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 أغلق جلسة العمل.

close() -> None

استثناءات

HttpResponseError

delete_document_classifier

حذف مصنف مستند.

جديد في الإصدار 2023-07-31: أسلوب العميل delete_document_classifier .

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

المعلمات

classifier_id: str

مطلوب

معرف المصنف.

المرتجعات

بلا

نوع الإرجاع

None

استثناءات

HttpResponseError

ResourceNotFoundError

أمثلة

حذف مصنف.


   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

حذف نموذج مستند مخصص.

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

المعلمات

model_id: str

مطلوب

معرف النموذج.

المرتجعات

بلا

نوع الإرجاع

None

استثناءات

HttpResponseError

ResourceNotFoundError

أمثلة

حذف نموذج.


   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

إنشاء تخويل لنسخ نموذج مخصص إلى مورد Form Recognizer الهدف.

يجب استدعاء هذا بواسطة المورد الهدف (حيث سيتم نسخ النموذج إلى) ويمكن تمرير الإخراج كمعلمة الهدف إلى begin_copy_document_model_to.

get_copy_authorization(**kwargs: Any) -> TargetAuthorization

المعلمات

model_id: str

معرف فريد للنموذج المنسخ. إذا لم يتم تحديده، فسيتم إنشاء معرف نموذج لك.

description: str

وصف اختياري لإضافته إلى النموذج.

tags: dict[str, str]

قائمة سمات علامة قيمة المفتاح المعرفة من قبل المستخدم المقترنة بالنموذج.

المرتجعات

قاموس مع القيم اللازمة لتخويل النسخ.

نوع الإرجاع

<xref:azure.ai.formrecognizer.TargetAuthorization>

استثناءات

HttpResponseError

get_document_analysis_client

احصل على مثيل DocumentAnalysisClient من DocumentModelAdministrationClient.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

المرتجعات

A DocumentAnalysisClient

نوع الإرجاع

DocumentAnalysisClient

استثناءات

HttpResponseError

get_document_classifier

احصل على مصنف مستند بواسطة معرفه.

جديد في الإصدار 2023-07-31: أسلوب العميل get_document_classifier .

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

المعلمات

classifier_id: str

مطلوب

معرف المصنف.

المرتجعات

DocumentClassifierDetails

نوع الإرجاع

DocumentClassifierDetails

استثناءات

HttpResponseError

ResourceNotFoundError

أمثلة

احصل على مصنف بواسطة معرفه.


   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

احصل على نموذج مستند بواسطة معرفه.

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

المعلمات

model_id: str

مطلوب

معرف النموذج.

المرتجعات

DocumentModelDetails

نوع الإرجاع

DocumentModelDetails

استثناءات

HttpResponseError

ResourceNotFoundError

أمثلة

احصل على نموذج بمعرفه.


   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

احصل على عملية بواسطة معرفها.

احصل على عملية مقترنة بمورد Form Recognizer. لاحظ أن معلومات العملية تستمر لمدة 24 ساعة فقط. إذا كانت عملية نموذج المستند ناجحة، يمكن الوصول إلى النموذج باستخدام get_document_model واجهات برمجة التطبيقات أو list_document_models .

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

المعلمات

operation_id: str

مطلوب

معرف العملية.

المرتجعات

تعريفات العملية

نوع الإرجاع

OperationDetails

استثناءات

HttpResponseError

أمثلة

احصل على عملية نموذج مستند بواسطة معرفه.


   # 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 Recognizer.

get_resource_details(**kwargs: Any) -> ResourceDetails

المرتجعات

ملخص النماذج المخصصة ضمن المورد - عدد النماذج والحد منها.

نوع الإرجاع

ResourceDetails

استثناءات

HttpResponseError

أمثلة

احصل على عدد النماذج وحدودها ضمن مورد 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

سرد معلومات لكل مصنف مستند، بما في ذلك معرف المصنف والوصف ووقت إنشائه.

جديد في الإصدار 2023-07-31: أسلوب العميل list_document_classifiers .

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

المرتجعات

قابل للصفحة من DocumentClassifierDetails.

نوع الإرجاع

ItemPaged[DocumentClassifierDetails]

استثناءات

HttpResponseError

أمثلة

سرد جميع المصنفات التي تم إنشاؤها بنجاح ضمن مورد 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

سرد المعلومات لكل نموذج، بما في ذلك معرف النموذج والوصف ومتى تم إنشاؤه.

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

المرتجعات

قابل للصفحة من DocumentModelSummary.

نوع الإرجاع

ItemPaged[DocumentModelSummary]

استثناءات

HttpResponseError

أمثلة

سرد جميع النماذج التي تم إنشاؤها بنجاح ضمن مورد 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

سرد المعلومات لكل عملية.

يسرد جميع العمليات المقترنة بمورد Form Recognizer. لاحظ أن معلومات العملية تستمر لمدة 24 ساعة فقط. إذا نجحت عملية نموذج المستند، يمكن الوصول إلى نموذج المستند باستخدام get_document_model واجهات برمجة التطبيقات أو list_document_models .

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

المرتجعات

قابل للصفحة من OperationSummary.

نوع الإرجاع

ItemPaged[OperationSummary]

استثناءات

HttpResponseError

أمثلة

سرد جميع عمليات نموذج المستند في ال 24 ساعة الماضية.


   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

تشغيل طلب شبكة باستخدام البنية الأساسية لبرنامج ربط العمليات التجارية الحالية للعميل.

يمكن أن يكون عنوان URL للطلب مرتبطا بعنوان URL الأساسي. إصدار واجهة برمجة تطبيقات الخدمة المستخدم للطلب هو نفسه إصدار العميل ما لم يتم تحديد خلاف ذلك. يتم دعم تجاوز إصدار واجهة برمجة التطبيقات المكون للعميل في عنوان URL النسبي على العميل مع إصدار واجهة برمجة التطبيقات 2022-08-31 والإصدارات الأحدث. التجاوز في عنوان URL المطلق المدعوم على العميل مع أي إصدار من واجهة برمجة التطبيقات. لا يرفع هذا الأسلوب إذا كانت الاستجابة خطأ؛ لرفع استثناء، قم باستدعاء raise_for_status() على كائن الاستجابة الذي تم إرجاعه. لمزيد من المعلومات حول كيفية إرسال طلبات مخصصة باستخدام هذا الأسلوب، راجع https://aka.ms/azsdk/dpcodegen/python/send_request.

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

المعلمات

request: HttpRequest

مطلوب

طلب الشبكة الذي تريد تقديمه.

stream: bool

ما إذا كان سيتم دفق حمولة الاستجابة. الإعدادات الافتراضية معينة على False.

المرتجعات

استجابة مكالمة الشبكة. لا يقوم بمعالجة الأخطاء في استجابتك.

نوع الإرجاع

HttpResponse

استثناءات

HttpResponseError

مشاركة عبر

DocumentModelAdministrationClient الفصل

الدالمنشئ

المعلمات

أمثلة

الأساليب

begin_build_document_classifier

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

begin_build_document_model

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

begin_compose_document_model

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

begin_copy_document_model_to

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

close

استثناءات

delete_document_classifier

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

delete_document_model

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

get_copy_authorization

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

get_document_analysis_client

المرتجعات

نوع الإرجاع

استثناءات

get_document_classifier

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

get_document_model

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

get_operation

المعلمات

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

get_resource_details

المرتجعات

نوع الإرجاع

استثناءات

أمثلة

list_document_classifiers

المرتجعات

نوع الإرجاع

استثناءات