FormRecognizerClient 類別

參考

FormRecognizerClient 會將表單和影像中的資訊擷取到結構化資料中。介面可用來分析預先建置的模型， (收據、名片、發票、身分識別檔) 、辨識表單的內容/配置，以及從定型模型分析自訂表單。它會根據 URL 的輸入和來自資料流程的輸入，提供不同的方法。

注意

FormRecognizerClient 應該與 API 版本 < =v2.1 搭配使用。

若要使用 API 版本 2022-08-31 和更新版本，請具現化 DocumentAnalysisClient。

繼承: azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase

FormRecognizerClient

建構函式

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

參數

endpoint: str

必要

支援的認知服務端點 (通訊協定和主機名稱，例如： https://westus2.api.cognitive.microsoft.com) 。

credential: AzureKeyCredential 或 TokenCredential

必要

用戶端連線至 Azure 所需的認證。如果使用來自的 API 金鑰或權杖認證 identity ，這是 AzureKeyCredential 的實例。

api_version: str 或 FormRecognizerApiVersion

要用於要求的 API 服務版本。預設為 API 2.1 版。將設定為較舊版本可能會導致功能相容性降低。若要使用最新支援的 API 版本和功能，請改為具現化 DocumentAnalysisClient。

範例

使用端點和 API 金鑰建立 FormRecognizerClient。


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer import FormRecognizerClient
   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]

   form_recognizer_client = FormRecognizerClient(endpoint, AzureKeyCredential(key))

使用權杖認證建立 FormRecognizerClient。


   """DefaultAzureCredential will use the values from these environment
   variables: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
   """
   from azure.ai.formrecognizer import FormRecognizerClient
   from azure.identity import DefaultAzureCredential

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   credential = DefaultAzureCredential()

   form_recognizer_client = FormRecognizerClient(endpoint, credential)

方法

begin_recognize_business_cards	從指定的名片擷取欄位文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。請參閱在名片上找到的欄位：這裡： https://aka.ms/formrecognizer/businesscardfields v2.1 版的新功能： begin_recognize_business_cards 用戶端方法
begin_recognize_business_cards_from_url	從指定的名片擷取欄位文字和語意值。輸入檔必須是要分析卡片) (URL 的位置。請參閱在名片上找到的欄位：這裡： https://aka.ms/formrecognizer/businesscardfields 2.1 版的新功能： begin_recognize_business_cards_from_url 用戶端方法
begin_recognize_content	從指定的檔擷取文字和內容/版面配置資訊。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。 2.1 版的新功能：頁面、語言和reading_order關鍵字引數和支援 image/bmp 內容
begin_recognize_content_from_url	擷取指定文件的文字和版面配置資訊。輸入檔必須是要分析的檔) 位置 (URL。 2.1 版的新功能：頁面、語言和reading_order關鍵字引數和支援 image/bmp 內容
begin_recognize_custom_forms	使用或不使用標籤定型的模型分析自訂表單。要分析的表單應該與用來定型模型的表單類型相同。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'或 'image/bmp'。
begin_recognize_custom_forms_from_url	使用或不使用標籤定型的模型分析自訂表單。要分析的表單應該與用來定型模型的表單類型相同。輸入檔必須是要分析的檔) 位置 (URL。
begin_recognize_identity_documents	從指定的識別檔擷取域文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。請參閱此處的身分識別檔上找到的欄位： https://aka.ms/formrecognizer/iddocumentfields 2.1 版的新功能： begin_recognize_identity_documents 用戶端方法
begin_recognize_identity_documents_from_url	從指定的識別檔擷取域文字和語意值。輸入檔必須是要分析之識別檔的位置 (URL) 。請參閱此處的身分識別檔上找到的欄位： https://aka.ms/formrecognizer/iddocumentfields v2.1 版的新功能： begin_recognize_identity_documents_from_url 用戶端方法
begin_recognize_invoices	從指定的發票擷取欄位文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。請參閱以下發票上的欄位： https://aka.ms/formrecognizer/invoicefields 2.1 版的新功能： begin_recognize_invoices 用戶端方法
begin_recognize_invoices_from_url	從指定的發票擷取欄位文字和語意值。輸入檔必須是要分析發票) (URL 的位置。請參閱在發票卡片上找到的欄位：這裡： https://aka.ms/formrecognizer/invoicefields v2.1 版的新功能： begin_recognize_invoices_from_url 用戶端方法
begin_recognize_receipts	從指定的銷售收據擷取欄位文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。請參閱這裡在收據上找到的欄位： https://aka.ms/formrecognizer/receiptfields 2.1 版的新功能：地區設定和頁面關鍵字引數，並支援 image/bmp 內容
begin_recognize_receipts_from_url	從指定的銷售收據擷取欄位文字和語意值。輸入檔必須是要分析收據) (URL 的位置。請參閱這裡在收據上找到的欄位： https://aka.ms/formrecognizer/receiptfields 2.1 版的新功能：地區設定和頁面關鍵字引數，並支援 image/bmp 內容
close	FormRecognizerClient關閉會話。
send_request	使用用戶端的現有管線執行網路要求。要求 URL 可以相對於基底 URL。除非另有指定，否則用於要求的服務 API 版本與用戶端的版本相同。使用 API 2022-08-31 版和更新版本，支援在相對 URL 中覆寫用戶端的已設定 API 版本。以任何 API 版本在用戶端上支援的絕對 URL 中覆寫。如果回應為錯誤，則這個方法不會引發;若要引發例外狀況，請在傳回的回應物件上呼叫 raise_for_status () 。如需如何使用此方法傳送自訂要求的詳細資訊，請參閱 https://aka.ms/azsdk/dpcodegen/python/send_request 。

begin_recognize_business_cards

從指定的名片擷取欄位文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。

請參閱在名片上找到的欄位：這裡： https://aka.ms/formrecognizer/businesscardfields

v2.1 版的新功能： begin_recognize_business_cards 用戶端方法

begin_recognize_business_cards(business_card: bytes | IO[bytes], **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

business_card: bytes 或 IO[bytes]

必要

JPEG、PNG、PDF、TIFF 或 BMP 類型檔案資料流程或位元組。

locale: str

名片的地區設定。支援的地區設定包括：en-US、en-AU、en-CA、en-GB 和 en-IN。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

pages: list[str]

多頁檔的自訂頁碼 (PDF/TIFF) 。輸入您想要在結果中取得的頁面號碼和/或範圍。對於某個範圍的頁面，請使用連字號，例如pages=[「1-3」、「5-6」]。 以逗號分隔每個頁碼或範圍。

content_type: str 或 FormContentType

傳送至 API 的本文內容類型。內容類型會自動偵測，但可藉由傳遞此關鍵字引數來覆寫。如需選項，請參閱 FormContentType 。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

範例

辨識檔案中的名片。


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

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

   form_recognizer_client = FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   with open(path_to_sample_forms, "rb") as f:
       poller = form_recognizer_client.begin_recognize_business_cards(business_card=f, locale="en-US")
   business_cards = poller.result()

   for idx, business_card in enumerate(business_cards):
       print("--------Recognizing business card #{}--------".format(idx+1))
       contact_names = business_card.fields.get("ContactNames")
       if contact_names:
           for contact_name in contact_names.value:
               print("Contact First Name: {} has confidence: {}".format(
                   contact_name.value["FirstName"].value, contact_name.value["FirstName"].confidence
               ))
               print("Contact Last Name: {} has confidence: {}".format(
                   contact_name.value["LastName"].value, contact_name.value["LastName"].confidence
               ))
       company_names = business_card.fields.get("CompanyNames")
       if company_names:
           for company_name in company_names.value:
               print("Company Name: {} has confidence: {}".format(company_name.value, company_name.confidence))
       departments = business_card.fields.get("Departments")
       if departments:
           for department in departments.value:
               print("Department: {} has confidence: {}".format(department.value, department.confidence))
       job_titles = business_card.fields.get("JobTitles")
       if job_titles:
           for job_title in job_titles.value:
               print("Job Title: {} has confidence: {}".format(job_title.value, job_title.confidence))
       emails = business_card.fields.get("Emails")
       if emails:
           for email in emails.value:
               print("Email: {} has confidence: {}".format(email.value, email.confidence))
       websites = business_card.fields.get("Websites")
       if websites:
           for website in websites.value:
               print("Website: {} has confidence: {}".format(website.value, website.confidence))
       addresses = business_card.fields.get("Addresses")
       if addresses:
           for address in addresses.value:
               print("Address: {} has confidence: {}".format(address.value, address.confidence))
       mobile_phones = business_card.fields.get("MobilePhones")
       if mobile_phones:
           for phone in mobile_phones.value:
               print("Mobile phone number: {} has confidence: {}".format(phone.value, phone.confidence))
       faxes = business_card.fields.get("Faxes")
       if faxes:
           for fax in faxes.value:
               print("Fax number: {} has confidence: {}".format(fax.value, fax.confidence))
       work_phones = business_card.fields.get("WorkPhones")
       if work_phones:
           for work_phone in work_phones.value:
               print("Work phone number: {} has confidence: {}".format(work_phone.value, work_phone.confidence))
       other_phones = business_card.fields.get("OtherPhones")
       if other_phones:
           for other_phone in other_phones.value:
               print("Other phone number: {} has confidence: {}".format(other_phone.value, other_phone.confidence))

begin_recognize_business_cards_from_url

從指定的名片擷取欄位文字和語意值。輸入檔必須是要分析卡片) (URL 的位置。

請參閱在名片上找到的欄位：這裡： https://aka.ms/formrecognizer/businesscardfields

2.1 版的新功能： begin_recognize_business_cards_from_url 用戶端方法

begin_recognize_business_cards_from_url(business_card_url: str, **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

business_card_url: str

必要

要分析之名片的 URL。輸入必須是其中一種支援格式的有效編碼 URL：JPEG、PNG、PDF、TIFF 或 BMP。

locale: str

名片的地區設定。支援的地區設定包括：en-US、en-AU、en-CA、en-GB 和 en-IN。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

pages: list[str]

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

begin_recognize_content

從指定的檔擷取文字和內容/版面配置資訊。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。

2.1 版的新功能：頁面、語言和reading_order關鍵字引數和支援 image/bmp 內容

begin_recognize_content(form: bytes | IO[bytes], **kwargs: Any) -> LROPoller[List[FormPage]]

參數

form: bytes 或 IO[bytes]

必要

JPEG、PNG、PDF、TIFF 或 BMP 類型檔案資料流程或位元組。

pages: list[str]

language: str

檔中文字的 BCP-47 語言代碼。請參閱這裡支援的語言代碼： https://docs.microsoft.com/azure/cognitive-services/form-recognizer/language-support 。內容支援自動語言識別和多語言檔，因此，如果您想要強制將記載為該特定語言，則只提供語言代碼。

reading_order: str

讀取循序演算法，以排序傳回的文字行。支援的讀取順序包括：基本 (預設) ，自然。將 'basic' 設定為以左至右和由上至下排序行，但在某些情況下，會以較高的優先順序來處理鄰近性。設定 'natural' 以使用位置資訊來排序線條，以將附近的線條保持在一起。

content_type: str 或 FormContentType

傳送至 API 的本文內容類型。內容類型會自動偵測，但可藉由傳遞此關鍵字引數來覆寫。如需選項，請參閱 FormContentType 。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ FormPage ]。

傳回類型

LROPoller[list[FormPage]]

例外狀況

HttpResponseError

範例

從表單辨識文字和內容/版面配置資訊。


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

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

   form_recognizer_client = FormRecognizerClient(endpoint=endpoint, credential=AzureKeyCredential(key))
   with open(path_to_sample_forms, "rb") as f:
       poller = form_recognizer_client.begin_recognize_content(form=f)
   form_pages = poller.result()

   for idx, content in enumerate(form_pages):
       print("----Recognizing content from page #{}----".format(idx+1))
       print("Page has width: {} and height: {}, measured with unit: {}".format(
           content.width,
           content.height,
           content.unit
       ))
       for table_idx, table in enumerate(content.tables):
           print("Table # {} has {} rows and {} columns".format(table_idx, table.row_count, table.column_count))
           print("Table # {} location on page: {}".format(table_idx, format_bounding_box(table.bounding_box)))
           for cell in table.cells:
               print("...Cell[{}][{}] has text '{}' within bounding box '{}'".format(
                   cell.row_index,
                   cell.column_index,
                   cell.text,
                   format_bounding_box(cell.bounding_box)
               ))

       for line_idx, line in enumerate(content.lines):
           print("Line # {} has word count '{}' and text '{}' within bounding box '{}'".format(
               line_idx,
               len(line.words),
               line.text,
               format_bounding_box(line.bounding_box)
           ))
           if line.appearance:
               if line.appearance.style_name == "handwriting" and line.appearance.style_confidence > 0.8:
                   print("Text line '{}' is handwritten and might be a signature.".format(line.text))
           for word in line.words:
               print("...Word '{}' has a confidence of {}".format(word.text, word.confidence))

       for selection_mark in content.selection_marks:
           print("Selection mark is '{}' within bounding box '{}' and has a confidence of {}".format(
               selection_mark.state,
               format_bounding_box(selection_mark.bounding_box),
               selection_mark.confidence
           ))
       print("----------------------------------------")

begin_recognize_content_from_url

擷取指定文件的文字和版面配置資訊。輸入檔必須是要分析的檔) 位置 (URL。

2.1 版的新功能：頁面、語言和reading_order關鍵字引數和支援 image/bmp 內容

begin_recognize_content_from_url(form_url: str, **kwargs: Any) -> LROPoller[List[FormPage]]

參數

form_url: str

必要

要分析之表單的 URL。輸入必須是其中一種支援格式的有效編碼 URL：JPEG、PNG、PDF、TIFF 或 BMP。

pages: list[str]

language: str

reading_order: str

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ FormPage ]。

傳回類型

LROPoller[list[FormPage]]

例外狀況

HttpResponseError

begin_recognize_custom_forms

使用或不使用標籤定型的模型分析自訂表單。要分析的表單應該與用來定型模型的表單類型相同。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff'或 'image/bmp'。

begin_recognize_custom_forms(model_id: str, form: bytes | IO[bytes], **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

model_id: str

必要

自訂模型識別碼。

form: bytes 或 IO[bytes]

必要

JPEG、PNG、PDF、TIFF 或 BMP 類型檔案資料流程或位元組。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

content_type: str 或 FormContentType

傳送至 API 的本文內容類型。內容類型會自動偵測，但可藉由傳遞此關鍵字引數來覆寫。如需選項，請參閱 FormContentType 。

pages: list[str]

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

範例

辨識自訂表單中的欄位和值。


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

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   model_id = os.getenv("CUSTOM_TRAINED_MODEL_ID", custom_model_id)

   form_recognizer_client = FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   # Make sure your form's type is included in the list of form types the custom model can recognize
   with open(path_to_sample_forms, "rb") as f:
       poller = form_recognizer_client.begin_recognize_custom_forms(
           model_id=model_id, form=f, include_field_elements=True
       )
   forms = poller.result()

   for idx, form in enumerate(forms):
       print("--------Recognizing Form #{}--------".format(idx+1))
       print("Form has type {}".format(form.form_type))
       print("Form has form type confidence {}".format(form.form_type_confidence))
       print("Form was analyzed with model with ID {}".format(form.model_id))
       for name, field in form.fields.items():
           # each field is of type FormField
           # label_data is populated if you are using a model trained without labels,
           # since the service needs to make predictions for labels if not explicitly given to it.
           if field.label_data:
               print("...Field '{}' has label '{}' with a confidence score of {}".format(
                   name,
                   field.label_data.text,
                   field.confidence
               ))

           print("...Label '{}' has value '{}' with a confidence score of {}".format(
               field.label_data.text if field.label_data else name, field.value, field.confidence
           ))

       # iterate over tables, lines, and selection marks on each page
       for page in form.pages:
           for i, table in enumerate(page.tables):
               print("\nTable {} on page {}".format(i+1, table.page_number))
               for cell in table.cells:
                   print("...Cell[{}][{}] has text '{}' with confidence {}".format(
                       cell.row_index, cell.column_index, cell.text, cell.confidence
                   ))
           print("\nLines found on page {}".format(page.page_number))
           for line in page.lines:
               print("...Line '{}' is made up of the following words: ".format(line.text))
               for word in line.words:
                   print("......Word '{}' has a confidence of {}".format(
                       word.text,
                       word.confidence
                   ))
           if page.selection_marks:
               print("\nSelection marks found on page {}".format(page.page_number))
               for selection_mark in page.selection_marks:
                   print("......Selection mark is '{}' and has a confidence of {}".format(
                       selection_mark.state,
                       selection_mark.confidence
                   ))

       print("-----------------------------------")

begin_recognize_custom_forms_from_url

使用或不使用標籤定型的模型分析自訂表單。要分析的表單應該與用來定型模型的表單類型相同。輸入檔必須是要分析的檔) 位置 (URL。

begin_recognize_custom_forms_from_url(model_id: str, form_url: str, **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

model_id: str

必要

自訂模型識別碼。

form_url: str

必要

要分析之表單的 URL。輸入必須是其中一種支援格式的有效編碼 URL：JPEG、PNG、PDF、TIFF 或 BMP。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

pages: list[str]

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

begin_recognize_identity_documents

從指定的識別檔擷取域文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。

請參閱此處的身分識別檔上找到的欄位： https://aka.ms/formrecognizer/iddocumentfields

2.1 版的新功能： begin_recognize_identity_documents 用戶端方法

begin_recognize_identity_documents(identity_document: bytes | IO[bytes], **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

identity_document: bytes 或 IO[bytes]

必要

JPEG、PNG、PDF、TIFF 或 BMP 類型檔案資料流程或位元組。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

content_type: str 或 FormContentType

傳送至 API 的本文內容類型。內容類型會自動偵測，但可藉由傳遞此關鍵字引數來覆寫。如需選項，請參閱 FormContentType 。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

pages: list[str]

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

範例

辨識身分識別檔欄位。


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

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

   form_recognizer_client = FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   with open(path_to_sample_forms, "rb") as f:
       poller = form_recognizer_client.begin_recognize_identity_documents(identity_document=f)
   id_documents = poller.result()

   for idx, id_document in enumerate(id_documents):
       print("--------Recognizing ID document #{}--------".format(idx+1))
       first_name = id_document.fields.get("FirstName")
       if first_name:
           print("First Name: {} has confidence: {}".format(first_name.value, first_name.confidence))
       last_name = id_document.fields.get("LastName")
       if last_name:
           print("Last Name: {} has confidence: {}".format(last_name.value, last_name.confidence))
       document_number = id_document.fields.get("DocumentNumber")
       if document_number:
           print("Document Number: {} has confidence: {}".format(document_number.value, document_number.confidence))
       dob = id_document.fields.get("DateOfBirth")
       if dob:
           print("Date of Birth: {} has confidence: {}".format(dob.value, dob.confidence))
       doe = id_document.fields.get("DateOfExpiration")
       if doe:
           print("Date of Expiration: {} has confidence: {}".format(doe.value, doe.confidence))
       sex = id_document.fields.get("Sex")
       if sex:
           print("Sex: {} has confidence: {}".format(sex.value, sex.confidence))
       address = id_document.fields.get("Address")
       if address:
           print("Address: {} has confidence: {}".format(address.value, address.confidence))
       country_region = id_document.fields.get("CountryRegion")
       if country_region:
           print("Country/Region: {} has confidence: {}".format(country_region.value, country_region.confidence))
       region = id_document.fields.get("Region")
       if region:
           print("Region: {} has confidence: {}".format(region.value, region.confidence))

begin_recognize_identity_documents_from_url

從指定的識別檔擷取域文字和語意值。輸入檔必須是要分析之識別檔的位置 (URL) 。

請參閱此處的身分識別檔上找到的欄位： https://aka.ms/formrecognizer/iddocumentfields

v2.1 版的新功能： begin_recognize_identity_documents_from_url 用戶端方法

begin_recognize_identity_documents_from_url(identity_document_url: str, **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

identity_document_url: str

必要

要分析之身分識別檔的 URL。輸入必須是其中一種支援格式的有效編碼 URL：JPEG、PNG、PDF、TIFF 或 BMP。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

pages: list[str]

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

begin_recognize_invoices

從指定的發票擷取欄位文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。

請參閱以下發票上的欄位： https://aka.ms/formrecognizer/invoicefields

2.1 版的新功能： begin_recognize_invoices 用戶端方法

begin_recognize_invoices(invoice: bytes | IO[bytes], **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

invoice: bytes 或 IO[bytes]

必要

JPEG、PNG、PDF、TIFF 或 BMP 類型檔案資料流程或位元組。

locale: str

發票的地區設定。支援的地區設定包括：en-US

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

pages: list[str]

content_type: str 或 FormContentType

傳送至 API 的本文內容類型。內容類型會自動偵測，但可藉由傳遞此關鍵字引數來覆寫。如需選項，請參閱 FormContentType 。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

範例

辨識檔案中的發票。


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

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

   form_recognizer_client = FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   with open(path_to_sample_forms, "rb") as f:
       poller = form_recognizer_client.begin_recognize_invoices(invoice=f, locale="en-US")
   invoices = poller.result()

   for idx, invoice in enumerate(invoices):
       print("--------Recognizing invoice #{}--------".format(idx+1))
       vendor_name = invoice.fields.get("VendorName")
       if vendor_name:
           print("Vendor Name: {} has confidence: {}".format(vendor_name.value, vendor_name.confidence))
       vendor_address = invoice.fields.get("VendorAddress")
       if vendor_address:
           print("Vendor Address: {} has confidence: {}".format(vendor_address.value, vendor_address.confidence))
       vendor_address_recipient = invoice.fields.get("VendorAddressRecipient")
       if vendor_address_recipient:
           print("Vendor Address Recipient: {} has confidence: {}".format(vendor_address_recipient.value, vendor_address_recipient.confidence))
       customer_name = invoice.fields.get("CustomerName")
       if customer_name:
           print("Customer Name: {} has confidence: {}".format(customer_name.value, customer_name.confidence))
       customer_id = invoice.fields.get("CustomerId")
       if customer_id:
           print("Customer Id: {} has confidence: {}".format(customer_id.value, customer_id.confidence))
       customer_address = invoice.fields.get("CustomerAddress")
       if customer_address:
           print("Customer Address: {} has confidence: {}".format(customer_address.value, customer_address.confidence))
       customer_address_recipient = invoice.fields.get("CustomerAddressRecipient")
       if customer_address_recipient:
           print("Customer Address Recipient: {} has confidence: {}".format(customer_address_recipient.value, customer_address_recipient.confidence))
       invoice_id = invoice.fields.get("InvoiceId")
       if invoice_id:
           print("Invoice Id: {} has confidence: {}".format(invoice_id.value, invoice_id.confidence))
       invoice_date = invoice.fields.get("InvoiceDate")
       if invoice_date:
           print("Invoice Date: {} has confidence: {}".format(invoice_date.value, invoice_date.confidence))
       invoice_total = invoice.fields.get("InvoiceTotal")
       if invoice_total:
           print("Invoice Total: {} has confidence: {}".format(invoice_total.value, invoice_total.confidence))
       due_date = invoice.fields.get("DueDate")
       if due_date:
           print("Due Date: {} has confidence: {}".format(due_date.value, due_date.confidence))
       purchase_order = invoice.fields.get("PurchaseOrder")
       if purchase_order:
           print("Purchase Order: {} has confidence: {}".format(purchase_order.value, purchase_order.confidence))
       billing_address = invoice.fields.get("BillingAddress")
       if billing_address:
           print("Billing Address: {} has confidence: {}".format(billing_address.value, billing_address.confidence))
       billing_address_recipient = invoice.fields.get("BillingAddressRecipient")
       if billing_address_recipient:
           print("Billing Address Recipient: {} has confidence: {}".format(billing_address_recipient.value, billing_address_recipient.confidence))
       shipping_address = invoice.fields.get("ShippingAddress")
       if shipping_address:
           print("Shipping Address: {} has confidence: {}".format(shipping_address.value, shipping_address.confidence))
       shipping_address_recipient = invoice.fields.get("ShippingAddressRecipient")
       if shipping_address_recipient:
           print("Shipping Address Recipient: {} has confidence: {}".format(shipping_address_recipient.value, shipping_address_recipient.confidence))
       print("Invoice items:")
       for idx, item in enumerate(invoice.fields.get("Items").value):
           print("...Item #{}".format(idx+1))
           item_description = item.value.get("Description")
           if item_description:
               print("......Description: {} has confidence: {}".format(item_description.value, item_description.confidence))
           item_quantity = item.value.get("Quantity")
           if item_quantity:
               print("......Quantity: {} has confidence: {}".format(item_quantity.value, item_quantity.confidence))
           unit = item.value.get("Unit")
           if unit:
               print("......Unit: {} has confidence: {}".format(unit.value, unit.confidence))
           unit_price = item.value.get("UnitPrice")
           if unit_price:
               print("......Unit Price: {} has confidence: {}".format(unit_price.value, unit_price.confidence))
           product_code = item.value.get("ProductCode")
           if product_code:
               print("......Product Code: {} has confidence: {}".format(product_code.value, product_code.confidence))
           item_date = item.value.get("Date")
           if item_date:
               print("......Date: {} has confidence: {}".format(item_date.value, item_date.confidence))
           tax = item.value.get("Tax")
           if tax:
               print("......Tax: {} has confidence: {}".format(tax.value, tax.confidence))
           amount = item.value.get("Amount")
           if amount:
               print("......Amount: {} has confidence: {}".format(amount.value, amount.confidence))
       subtotal = invoice.fields.get("SubTotal")
       if subtotal:
           print("Subtotal: {} has confidence: {}".format(subtotal.value, subtotal.confidence))
       total_tax = invoice.fields.get("TotalTax")
       if total_tax:
           print("Total Tax: {} has confidence: {}".format(total_tax.value, total_tax.confidence))
       previous_unpaid_balance = invoice.fields.get("PreviousUnpaidBalance")
       if previous_unpaid_balance:
           print("Previous Unpaid Balance: {} has confidence: {}".format(previous_unpaid_balance.value, previous_unpaid_balance.confidence))
       amount_due = invoice.fields.get("AmountDue")
       if amount_due:
           print("Amount Due: {} has confidence: {}".format(amount_due.value, amount_due.confidence))
       service_start_date = invoice.fields.get("ServiceStartDate")
       if service_start_date:
           print("Service Start Date: {} has confidence: {}".format(service_start_date.value, service_start_date.confidence))
       service_end_date = invoice.fields.get("ServiceEndDate")
       if service_end_date:
           print("Service End Date: {} has confidence: {}".format(service_end_date.value, service_end_date.confidence))
       service_address = invoice.fields.get("ServiceAddress")
       if service_address:
           print("Service Address: {} has confidence: {}".format(service_address.value, service_address.confidence))
       service_address_recipient = invoice.fields.get("ServiceAddressRecipient")
       if service_address_recipient:
           print("Service Address Recipient: {} has confidence: {}".format(service_address_recipient.value, service_address_recipient.confidence))
       remittance_address = invoice.fields.get("RemittanceAddress")
       if remittance_address:
           print("Remittance Address: {} has confidence: {}".format(remittance_address.value, remittance_address.confidence))
       remittance_address_recipient = invoice.fields.get("RemittanceAddressRecipient")
       if remittance_address_recipient:
           print("Remittance Address Recipient: {} has confidence: {}".format(remittance_address_recipient.value, remittance_address_recipient.confidence))

begin_recognize_invoices_from_url

從指定的發票擷取欄位文字和語意值。輸入檔必須是要分析發票) (URL 的位置。

請參閱在發票卡片上找到的欄位：這裡： https://aka.ms/formrecognizer/invoicefields

v2.1 版的新功能： begin_recognize_invoices_from_url 用戶端方法

begin_recognize_invoices_from_url(invoice_url: str, **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

invoice_url: str

必要

要分析之發票的 URL。輸入必須是其中一種支援格式的有效編碼 URL：JPEG、PNG、PDF、TIFF 或 BMP。

locale: str

發票的地區設定。支援的地區設定包括：en-US

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

pages: list[str]

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

begin_recognize_receipts

從指定的銷售收據擷取欄位文字和語意值。輸入檔必須是其中一種支援的內容類型：'application/pdf'、'image/jpeg'、'image/png'、'image/tiff' 或 'image/bmp'。

請參閱這裡在收據上找到的欄位： https://aka.ms/formrecognizer/receiptfields

2.1 版的新功能：地區設定和頁面關鍵字引數，並支援 image/bmp 內容

begin_recognize_receipts(receipt: bytes | IO[bytes], **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

receipt: bytes 或 IO[bytes]

必要

JPEG、PNG、PDF、TIFF 或 BMP 類型檔案資料流程或位元組。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

content_type: str 或 FormContentType

傳送至 API 的本文內容類型。內容類型會自動偵測，但可藉由傳遞此關鍵字引數來覆寫。如需選項，請參閱 FormContentType 。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

locale: str

收據的地區設定。支援的地區設定包括：en-US、en-AU、en-CA、en-GB 和 en-IN。

pages: list[str]

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

範例

辨識銷售收據欄位。


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

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

   form_recognizer_client = FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   with open(path_to_sample_forms, "rb") as f:
       poller = form_recognizer_client.begin_recognize_receipts(receipt=f, locale="en-US")
   receipts = poller.result()

   for idx, receipt in enumerate(receipts):
       print("--------Recognizing receipt #{}--------".format(idx+1))
       receipt_type = receipt.fields.get("ReceiptType")
       if receipt_type:
           print("Receipt Type: {} has confidence: {}".format(receipt_type.value, receipt_type.confidence))
       merchant_name = receipt.fields.get("MerchantName")
       if merchant_name:
           print("Merchant Name: {} has confidence: {}".format(merchant_name.value, merchant_name.confidence))
       transaction_date = receipt.fields.get("TransactionDate")
       if transaction_date:
           print("Transaction Date: {} has confidence: {}".format(transaction_date.value, transaction_date.confidence))
       if receipt.fields.get("Items"):
           print("Receipt items:")
           for idx, item in enumerate(receipt.fields.get("Items").value):
               print("...Item #{}".format(idx+1))
               item_name = item.value.get("Name")
               if item_name:
                   print("......Item Name: {} has confidence: {}".format(item_name.value, item_name.confidence))
               item_quantity = item.value.get("Quantity")
               if item_quantity:
                   print("......Item Quantity: {} has confidence: {}".format(item_quantity.value, item_quantity.confidence))
               item_price = item.value.get("Price")
               if item_price:
                   print("......Individual Item Price: {} has confidence: {}".format(item_price.value, item_price.confidence))
               item_total_price = item.value.get("TotalPrice")
               if item_total_price:
                   print("......Total Item Price: {} has confidence: {}".format(item_total_price.value, item_total_price.confidence))
       subtotal = receipt.fields.get("Subtotal")
       if subtotal:
           print("Subtotal: {} has confidence: {}".format(subtotal.value, subtotal.confidence))
       tax = receipt.fields.get("Tax")
       if tax:
           print("Tax: {} has confidence: {}".format(tax.value, tax.confidence))
       tip = receipt.fields.get("Tip")
       if tip:
           print("Tip: {} has confidence: {}".format(tip.value, tip.confidence))
       total = receipt.fields.get("Total")
       if total:
           print("Total: {} has confidence: {}".format(total.value, total.confidence))
       print("--------------------------------------")

begin_recognize_receipts_from_url

從指定的銷售收據擷取欄位文字和語意值。輸入檔必須是要分析收據) (URL 的位置。

請參閱這裡在收據上找到的欄位： https://aka.ms/formrecognizer/receiptfields

2.1 版的新功能：地區設定和頁面關鍵字引數，並支援 image/bmp 內容

begin_recognize_receipts_from_url(receipt_url: str, **kwargs: Any) -> LROPoller[List[RecognizedForm]]

參數

receipt_url: str

必要

要分析之收據的 URL。輸入必須是其中一種支援格式的有效編碼 URL：JPEG、PNG、PDF、TIFF 或 BMP。

include_field_elements: bool

是否要包含每頁的所有行和欄位元素，例如每一表單欄位的行、單字和選取標記。

continuation_token: str

從已儲存狀態重新開機輪詢器的接續權杖。

locale: str

收據的地區設定。支援的地區設定包括：en-US、en-AU、en-CA、en-GB 和 en-IN。

pages: list[str]

傳回

LROPoller 的實例。在輪詢器物件上呼叫 result () 以傳回 list[ RecognizedForm ]。

傳回類型

LROPoller[list[RecognizedForm]]

例外狀況

HttpResponseError

範例

從 URL 辨識銷售收據欄位。


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

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

   form_recognizer_client = FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   url = "https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/receipt/contoso-receipt.png"
   poller = form_recognizer_client.begin_recognize_receipts_from_url(receipt_url=url)
   receipts = poller.result()

   for idx, receipt in enumerate(receipts):
       print("--------Recognizing receipt #{}--------".format(idx+1))
       receipt_type = receipt.fields.get("ReceiptType")
       if receipt_type:
           print("Receipt Type: {} has confidence: {}".format(receipt_type.value, receipt_type.confidence))
       merchant_name = receipt.fields.get("MerchantName")
       if merchant_name:
           print("Merchant Name: {} has confidence: {}".format(merchant_name.value, merchant_name.confidence))
       transaction_date = receipt.fields.get("TransactionDate")
       if transaction_date:
           print("Transaction Date: {} has confidence: {}".format(transaction_date.value, transaction_date.confidence))
       if receipt.fields.get("Items"):
           print("Receipt items:")
           for idx, item in enumerate(receipt.fields.get("Items").value):
               print("...Item #{}".format(idx+1))
               item_name = item.value.get("Name")
               if item_name:
                   print("......Item Name: {} has confidence: {}".format(item_name.value, item_name.confidence))
               item_quantity = item.value.get("Quantity")
               if item_quantity:
                   print("......Item Quantity: {} has confidence: {}".format(item_quantity.value, item_quantity.confidence))
               item_price = item.value.get("Price")
               if item_price:
                   print("......Individual Item Price: {} has confidence: {}".format(item_price.value, item_price.confidence))
               item_total_price = item.value.get("TotalPrice")
               if item_total_price:
                   print("......Total Item Price: {} has confidence: {}".format(item_total_price.value, item_total_price.confidence))
       subtotal = receipt.fields.get("Subtotal")
       if subtotal:
           print("Subtotal: {} has confidence: {}".format(subtotal.value, subtotal.confidence))
       tax = receipt.fields.get("Tax")
       if tax:
           print("Tax: {} has confidence: {}".format(tax.value, tax.confidence))
       tip = receipt.fields.get("Tip")
       if tip:
           print("Tip: {} has confidence: {}".format(tip.value, tip.confidence))
       total = receipt.fields.get("Total")
       if total:
           print("Total: {} has confidence: {}".format(total.value, total.confidence))
       print("--------------------------------------")

close

FormRecognizerClient關閉會話。

close() -> None

例外狀況

HttpResponseError

send_request

使用用戶端的現有管線執行網路要求。

要求 URL 可以相對於基底 URL。除非另有指定，否則用於要求的服務 API 版本與用戶端的版本相同。使用 API 2022-08-31 版和更新版本，支援在相對 URL 中覆寫用戶端的已設定 API 版本。以任何 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

共用方式為

FormRecognizerClient 類別

建構函式

參數

範例

方法

begin_recognize_business_cards

參數

傳回

傳回類型

例外狀況

範例

begin_recognize_business_cards_from_url

參數

傳回

傳回類型

例外狀況

begin_recognize_content

參數

傳回

傳回類型

例外狀況

範例

begin_recognize_content_from_url

參數

傳回

傳回類型

例外狀況

begin_recognize_custom_forms

參數

傳回

傳回類型

例外狀況

範例

begin_recognize_custom_forms_from_url

參數

傳回

傳回類型

例外狀況

begin_recognize_identity_documents

參數

傳回

傳回類型

例外狀況

範例

begin_recognize_identity_documents_from_url

參數

傳回

傳回類型

例外狀況

begin_recognize_invoices

參數

傳回

傳回類型

例外狀況

範例

begin_recognize_invoices_from_url

參數

傳回

傳回類型

例外狀況

begin_recognize_receipts

參數

傳回

傳回類型

例外狀況

範例

begin_recognize_receipts_from_url

參數

傳回

傳回類型

例外狀況

範例

close

例外狀況

send_request

參數

傳回

傳回類型

例外狀況