DocumentModelAdministrationClient 클래스

DocumentModelAdministrationClient는 모델을 빌드하고 관리하는 데 사용할 Form Recognizer 인터페이스입니다.

모델 및 분류자를 빌드하는 방법뿐만 아니라 모델 및 분류자를 보고 삭제하고, 모델 및 분류자 작업을 보고, 계정 정보에 액세스하고, 모델을 다른 Form Recognizer 리소스로 복사하고, 기존 모델 컬렉션에서 새 모델을 구성하는 방법을 제공합니다.

참고

DocumentModelAdministrationClient를 API 버전과 함께 사용해야 합니다.

2022-08-31 이상. API 버전 <=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

필수

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름( 예: https://westus2.api.cognitive.microsoft.com).

credential

AzureKeyCredential 또는 TokenCredential

필수

클라이언트가 Azure에 연결하는 데 필요한 자격 증명입니다. API 키 또는 의 토큰 자격 증명identity을 사용하는 경우 AzureKeyCredential의 instance.

api_version

str 또는 DocumentAnalysisApiVersion

요청에 사용할 서비스의 API 버전입니다. 기본값은 최신 서비스 버전입니다. 이전 버전으로 설정하면 기능 호환성이 저하될 수 있습니다. API 버전 <=v2.1을 사용하려면 FormTrainingClient를 인스턴스화합니다.

예제

엔드포인트 및 API 키를 사용하여 DocumentModelAdministrationClient를 만듭니다.

   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	사용자 지정 문서 모델을 빌드합니다. 요청에는 외부에서 액세스할 수 있는 Azure Storage Blob 컨테이너 URI(공유 액세스 서명 URI)인 blob_container_url 키워드(keyword) 매개 변수가 포함되어야 합니다. 컨테이너가 공용이거나 관리 ID가 구성된 경우에만 SAS가 없는 컨테이너 URI가 허용됩니다. Form Recognizer 작동하도록 관리 ID를 구성하는 방법에 대한 자세한 내용은 를 참조하세요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 키워드(keyword) 인수입니다.
begin_compose_document_model	기존 모델 컬렉션에서 구성된 문서 모델을 만듭니다. 구성된 모델을 사용하면 단일 모델 ID를 사용하여 여러 모델을 호출할 수 있습니다. 작성된 모델 ID로 분석하기 위해 문서를 제출하면 먼저 분류 단계를 수행하여 올바른 사용자 지정 모델로 라우팅합니다.
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	DocumentModelAdministrationClient에서 DocumentAnalysisClient의 instance 가져옵니다.
get_document_classifier	ID별로 문서 분류자를 가져옵니다. 버전 2023-07-31의 새로운 기능: get_document_classifier 클라이언트 메서드입니다.
get_document_model	ID로 문서 모델을 가져옵니다.
get_operation	ID로 작업을 가져옵니다. Form Recognizer 리소스와 연결된 작업을 가져옵니다. 작업 정보는 24시간 동안만 유지됩니다. 문서 모델 작업이 성공한 경우 또는 list_document_models API를 사용하여 get_document_model 모델에 액세스할 수 있습니다.
get_resource_details	Form Recognizer 리소스에서 모델에 대한 정보를 가져옵니다.
list_document_classifiers	분류자 ID, 설명 및 생성된 시기를 포함하여 각 문서 분류자에 대한 정보를 나열합니다. 버전 2023-07-31의 새로운 기능: list_document_classifiers 클라이언트 메서드입니다.
list_document_models	모델 ID, 설명 및 모델을 만든 시기를 포함하여 각 모델에 대한 정보를 나열합니다.
list_operations	각 작업에 대한 정보를 나열합니다. Form Recognizer 리소스와 연결된 모든 작업을 나열합니다. 작업 정보는 24시간 동안만 유지됩니다. 문서 모델 작업이 성공한 경우 또는 list_document_models API를 사용하여 get_document_model 문서 모델에 액세스할 수 있습니다.
send_request	클라이언트의 기존 파이프라인을 사용하여 네트워크 요청을 실행합니다. 요청 URL은 기본 URL을 기준으로 할 수 있습니다. 요청에 사용되는 서비스 API 버전은 달리 지정하지 않는 한 클라이언트의 버전과 동일합니다. 상대 URL에서 클라이언트의 구성된 API 버전을 재정의하는 것은 API 버전 2022-08-31 이상을 사용하는 클라이언트에서 지원됩니다. 모든 API 버전으로 클라이언트에서 지원되는 절대 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

고유한 문서 분류자 이름입니다. 지정하지 않으면 분류자 ID가 만들어집니다.

description

str

문서 분류자 설명입니다.

반환

DocumentModelAdministrationLROPoller의 instance. 폴러 개체에서 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

사용자 지정 문서 모델을 빌드합니다.

요청에는 외부에서 액세스할 수 있는 Azure Storage Blob 컨테이너 URI(공유 액세스 서명 URI)인 blob_container_url 키워드(keyword) 매개 변수가 포함되어야 합니다. 컨테이너가 공용이거나 관리 ID가 구성된 경우에만 SAS가 없는 컨테이너 URI가 허용됩니다. Form Recognizer 작동하도록 관리 ID를 구성하는 방법에 대한 자세한 내용은 를 참조하세요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 키워드(keyword) 인수입니다.

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

필수

사용자 지정 모델 빌드 모드입니다. 가능한 값은 "template", "neural"입니다. 빌드 모드에 대한 자세한 내용은 를 https://aka.ms/azsdk/formrecognizer/buildmode참조하세요.

blob_container_url

str

Azure Storage Blob 컨테이너의 SAS URI. 컨테이너가 공용이거나 관리 ID가 구성된 경우 SAS가 없는 컨테이너 URI를 사용할 수 있습니다. 학습 데이터 집합 설정에 대한 자세한 내용은 를 https://aka.ms/azsdk/formrecognizer/buildtrainingset참조하세요.

model_id

str

모델의 고유 ID입니다. 지정하지 않으면 모델 ID가 만들어집니다.

description

str

모델에 추가할 선택적 설명입니다.

prefix

str

Blob 컨테이너 URL 경로에서 문서를 필터링하는 대/소문자 구분 접두사 문자열입니다. 예를 들어 Azure Storage Blob URI를 사용하는 경우 접두사를 사용하여 하위 폴더를 제한합니다. 파일 이름이 동일한 접두사를 공유하는 경우를 방지하기 위해 접두사는 '/'로 끝나야 합니다.

file_list

str

학습을 위해 문서의 하위 집합을 지정하는 컨테이너 내의 JSONL 파일 경로입니다.

tags

dict[str, str]

모델과 연결된 사용자 정의 키-값 태그 특성 목록입니다.

반환

DocumentModelAdministrationLROPoller의 instance. 폴러 개체에서 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

기존 모델 컬렉션에서 구성된 문서 모델을 만듭니다.

구성된 모델을 사용하면 단일 모델 ID를 사용하여 여러 모델을 호출할 수 있습니다. 작성된 모델 ID로 분석하기 위해 문서를 제출하면 먼저 분류 단계를 수행하여 올바른 사용자 지정 모델로 라우팅합니다.

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

매개 변수

component_model_ids

list[str]

필수

구성된 모델에서 사용할 모델 ID 목록입니다.

model_id

str

구성된 모델의 고유 ID입니다. 지정하지 않으면 모델 ID가 만들어집니다.

description

str

모델에 추가할 선택적 설명입니다.

tags

dict[str, str]

모델과 연결된 사용자 정의 키-값 태그 특성 목록입니다.

반환

DocumentModelAdministrationLROPoller의 instance. 폴러 개체에서 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의 instance. 폴러 개체에서 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

복사한 모델의 고유 ID입니다. 지정하지 않으면 모델 ID가 만들어집니다.

description

str

모델에 추가할 선택적 설명입니다.

tags

dict[str, str]

모델과 연결된 사용자 정의 키-값 태그 특성 목록입니다.

반환

복사 권한 부여에 필요한 값이 있는 사전입니다.

반환 형식

<xref:azure.ai.formrecognizer.TargetAuthorization>

예외

HttpResponseError

get_document_analysis_client

DocumentModelAdministrationClient에서 DocumentAnalysisClient의 instance 가져옵니다.

get_document_analysis_client(**kwargs: Any) -> DocumentAnalysisClient

반환

A DocumentAnalysisClient

반환 형식

DocumentAnalysisClient

예외

HttpResponseError

get_document_classifier

ID별로 문서 분류자를 가져옵니다.

버전 2023-07-31의 새로운 기능: get_document_classifier 클라이언트 메서드입니다.

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

매개 변수

classifier_id

str

필수

분류자 식별자입니다.

반환

DocumentClassifierDetails

반환 형식

DocumentClassifierDetails

예외

HttpResponseError

ResourceNotFoundError

예제

ID로 분류자를 가져옵니다.

   my_classifier = document_model_admin_client.get_document_classifier(
       classifier_id=classifier_model.classifier_id
   )
   print(f"\nClassifier ID: {my_classifier.classifier_id}")
   print(f"Description: {my_classifier.description}")
   print(f"Classifier created on: {my_classifier.created_on}")

get_document_model

ID로 문서 모델을 가져옵니다.

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

매개 변수

model_id

str

필수

모델 식별자입니다.

반환

DocumentModelDetails

반환 형식

DocumentModelDetails

예외

HttpResponseError

ResourceNotFoundError

예제

ID로 모델을 가져옵니다.

   my_model = document_model_admin_client.get_document_model(model_id=model.model_id)
   print(f"\nModel ID: {my_model.model_id}")
   print(f"Description: {my_model.description}")
   print(f"Model created on: {my_model.created_on}")
   print(f"Model expires on: {my_model.expires_on}")

get_operation

ID로 작업을 가져옵니다.

Form Recognizer 리소스와 연결된 작업을 가져옵니다. 작업 정보는 24시간 동안만 유지됩니다. 문서 모델 작업이 성공한 경우 또는 list_document_models API를 사용하여 get_document_model 모델에 액세스할 수 있습니다.

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

매개 변수

operation_id

str

필수

작업 ID입니다.

반환

OperationDetails

반환 형식

OperationDetails

예외

HttpResponseError

예제

ID로 문서 모델 작업을 가져옵니다.

   # Get an operation by ID
   if operations:
       print(f"\nGetting operation info by ID: {operations[0].operation_id}")
       operation_info = document_model_admin_client.get_operation(
           operations[0].operation_id
       )
       if operation_info.status == "succeeded":
           print(f"My {operation_info.kind} operation is completed.")
           result = operation_info.result
           if result is not None:
               if operation_info.kind == "documentClassifierBuild":
                   print(f"Classifier ID: {result.classifier_id}")
               else:
                   print(f"Model ID: {result.model_id}")
       elif operation_info.status == "failed":
           print(f"My {operation_info.kind} operation failed.")
           error = operation_info.error
           if error is not None:
               print(f"{error.code}: {error.message}")
       else:
           print(f"My operation status is {operation_info.status}")
   else:
       print("No operations found.")

get_resource_details

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

분류자 ID, 설명 및 생성된 시기를 포함하여 각 문서 분류자에 대한 정보를 나열합니다.

버전 2023-07-31의 새로운 기능: list_document_classifiers 클라이언트 메서드입니다.

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

반환

DocumentClassifierDetails의 Pageable입니다.

반환 형식

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

모델 ID, 설명 및 모델을 만든 시기를 포함하여 각 모델에 대한 정보를 나열합니다.

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

반환

DocumentModelSummary의 Pageable입니다.

반환 형식

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시간 동안만 유지됩니다. 문서 모델 작업이 성공한 경우 또는 list_document_models API를 사용하여 get_document_model 문서 모델에 액세스할 수 있습니다.

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을 기준으로 할 수 있습니다. 요청에 사용되는 서비스 API 버전은 달리 지정하지 않는 한 클라이언트의 버전과 동일합니다. 상대 URL에서 클라이언트의 구성된 API 버전을 재정의하는 것은 API 버전 2022-08-31 이상을 사용하는 클라이언트에서 지원됩니다. 모든 API 버전으로 클라이언트에서 지원되는 절대 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