你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 版本 v2.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 v2.1 版中的新增功能： begin_recognize_business_cards_from_url 客户端方法
begin_recognize_content	从给定文档中提取文本和内容/布局信息。输入文档必须是受支持的内容类型之一-“application/pdf”、“image/jpeg”、“image/png”、“image/tiff”或“image/bmp”。版本 v2.1 中的新增功能：页面、语言和reading_order关键字 (keyword) 参数，并支持图像/bmp 内容
begin_recognize_content_from_url	从给定文档中提取文本和布局信息。输入文档必须是要分析的文档的位置 (URL) 。版本 v2.1 中的新增功能：页面、语言和reading_order关键字 (keyword) 参数，并支持图像/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 版本 v2.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 版本 v2.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 版本 v2.1 中的新增功能：区域设置和页面关键字 (keyword) 参数，并支持图像/bmp 内容
begin_recognize_receipts_from_url	从给定的销售收据中提取字段文本和语义值。输入文档必须是要分析的收据的位置 (URL) 。请参阅此处的收据上的字段： https://aka.ms/formrecognizer/receiptfields 版本 v2.1 中的新增功能：区域设置和页面关键字 (keyword) 参数，并支持图像/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 的正文的内容类型。内容类型是自动检测的，但可以通过传递此关键字 (keyword) 参数重写。有关选项，请参阅 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

v2.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”。

版本 v2.1 中的新增功能：页面、语言和reading_order关键字 (keyword) 参数，并支持图像/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”设置为从左到右和从上到下对行进行排序，但在某些情况下，邻近度处理优先级较高。将“自然”设置为使用位置信息对线条进行排序，以将附近的线条放在一起。

content_type: str 或 FormContentType

发送到 API 的正文的内容类型。内容类型是自动检测的，但可以通过传递此关键字 (keyword) 参数重写。有关选项，请参阅 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) 。

版本 v2.1 中的新增功能：页面、语言和reading_order关键字 (keyword) 参数，并支持图像/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 的正文的内容类型。内容类型是自动检测的，但可以通过传递此关键字 (keyword) 参数来重写。有关选项，请参阅 FormContentType。

pages: list[str]

多页文档的自定义页码 (PDF/TIFF) 。输入要在结果中获取的页码和/或页面范围。对于一系列页面，请使用连字符，如 pages=[“1-3”， “5-6”]。用逗号分隔每个页码或范围。

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

版本 v2.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 的正文的内容类型。内容类型是自动检测的，但可以通过传递此关键字 (keyword) 参数来重写。有关选项，请参阅 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

版本 v2.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 的正文的内容类型。内容类型是自动检测的，但可以通过传递此关键字 (keyword) 参数来重写。有关选项，请参阅 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

版本 v2.1 中的新增功能：区域设置和页面关键字 (keyword) 参数，并支持图像/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 的正文的内容类型。内容类型是自动检测的，但可以通过传递此关键字 (keyword) 参数来重写。有关选项，请参阅 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

版本 v2.1 中的新增功能：区域设置和页面关键字 (keyword) 参数，并支持图像/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