FormRecognizerClient Classe

Riferimento

FormRecognizerClient estrae informazioni da moduli e immagini in dati strutturati. È l'interfaccia da usare per l'analisi con modelli predefiniti (ricevute, biglietti da visita, fatture, documenti di identità), riconoscimento di contenuto/layout da moduli e analisi di moduli personalizzati da modelli sottoposti a training. Fornisce metodi diversi in base agli input di un URL e agli input di un flusso.

Nota

FormRecognizerClient deve essere usato con le versioni <dell'API =v2.1.

Per usare le versioni API 2022-08-31 e successive, creare un'istanza di DocumentAnalysisClient.

Ereditarietà: azure.ai.formrecognizer.aio._form_base_client_async.FormRecognizerClientBaseAsync

FormRecognizerClient

Costruttore

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

Parametri

endpoint: str

Necessario

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus2.api.cognitive.microsoft.com).

credential: AzureKeyCredential oppure AsyncTokenCredential

Necessario

Credenziali necessarie per la connessione del client ad Azure. Si tratta di un'istanza di AzureKeyCredential se si usa una chiave API o una credenziale di token da identity.

api_version: str oppure FormRecognizerApiVersion

Versione API del servizio da usare per le richieste. Per impostazione predefinita, viene usata la versione 2.1 dell'API. L'impostazione su una versione precedente può comportare una riduzione della compatibilità delle funzionalità. Per usare la versione e le funzionalità dell'API supportate più recenti, creare invece un'istanza di DocumentAnalysisClient.

Esempio

Creazione di FormRecognizerClient con un endpoint e una chiave API.


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

   form_recognizer_client = FormRecognizerClient(endpoint, AzureKeyCredential(key))

Creazione di FormRecognizerClient con credenziali del token.


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

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

   form_recognizer_client = FormRecognizerClient(endpoint, credential)

Metodi

begin_recognize_business_cards	Estrarre il testo del campo e i valori semantici da un biglietto da visita specificato. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'. Vedere i campi trovati in un biglietto da visita qui: https://aka.ms/formrecognizer/businesscardfields Novità della versione 2.1: metodo client begin_recognize_business_cards
begin_recognize_business_cards_from_url	Estrarre il testo del campo e i valori semantici da un biglietto da visita specificato. Il documento di input deve essere il percorso (URL) della scheda da analizzare. Vedere i campi trovati in un biglietto da visita qui: https://aka.ms/formrecognizer/businesscardfields Novità della versione 2.1: metodo client begin_recognize_business_cards_from_url
begin_recognize_content	Estrarre informazioni di testo e contenuto/layout da un determinato documento. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'. Novità della versione 2.1: pagine, linguaggio e argomenti di parole chiave reading_order e supporto per il contenuto image/bmp
begin_recognize_content_from_url	Estrarre informazioni sul testo e sul layout da un determinato documento. Il documento di input deve essere il percorso (URL) del documento da analizzare. Novità della versione 2.1: pagine, linguaggio e argomenti di parole chiave reading_order e supporto per il contenuto image/bmp
begin_recognize_custom_forms	Analizzare un modulo personalizzato con un modello sottoposto a training con o senza etichette. Il modulo da analizzare deve essere dello stesso tipo dei moduli usati per eseguire il training del modello. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.
begin_recognize_custom_forms_from_url	Analizzare un modulo personalizzato con un modello sottoposto a training con o senza etichette. Il modulo da analizzare deve essere dello stesso tipo dei moduli usati per eseguire il training del modello. Il documento di input deve essere il percorso (URL) del documento da analizzare.
begin_recognize_identity_documents	Estrarre il testo del campo e i valori semantici da un determinato documento di identità. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'. Vedere i campi trovati in un documento di identità qui: https://aka.ms/formrecognizer/iddocumentfields Novità nella versione 2.1: metodo client begin_recognize_identity_documents
begin_recognize_identity_documents_from_url	Estrarre il testo del campo e i valori semantici da un determinato documento di identità. Il documento di input deve essere il percorso (URL) del documento di identità da analizzare. Vedere i campi trovati in un documento di identità qui: https://aka.ms/formrecognizer/iddocumentfields Novità nella versione 2.1: metodo client begin_recognize_identity_documents_from_url
begin_recognize_invoices	Estrarre il testo del campo e i valori semantici da una determinata fattura. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'. Vedere i campi trovati in una fattura qui: https://aka.ms/formrecognizer/invoicefields Novità nella versione 2.1: metodo client begin_recognize_invoices
begin_recognize_invoices_from_url	Estrarre il testo del campo e i valori semantici da una determinata fattura. Il documento di input deve essere il percorso (URL) della fattura da analizzare. Vedere i campi disponibili in una carta fattura qui: https://aka.ms/formrecognizer/invoicefields Novità nella versione 2.1: metodo client begin_recognize_invoices_from_url
begin_recognize_receipts	Estrarre il testo del campo e i valori semantici da una determinata ricevuta di vendita. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'. Vedere i campi trovati in una ricevuta qui: https://aka.ms/formrecognizer/receiptfields Novità nella versione 2.1: argomento della parola chiave delle impostazioni locali e supporto per il contenuto image/bmp
begin_recognize_receipts_from_url	Estrarre il testo del campo e i valori semantici da una determinata ricevuta di vendita. Il documento di input deve essere il percorso (URL) della ricevuta da analizzare. Vedere i campi trovati in una ricevuta qui: https://aka.ms/formrecognizer/receiptfields Novità nella versione 2.1: argomento della parola chiave delle impostazioni locali e supporto per il contenuto image/bmp
close	Chiudere la FormRecognizerClient sessione.
send_request	Esegue una richiesta di rete usando la pipeline esistente del client. L'URL della richiesta può essere relativo all'URL di base. La versione dell'API del servizio usata per la richiesta è uguale a quella del client, se non diversamente specificato. L'override della versione dell'API configurata del client nell'URL relativo è supportata nel client con l'API versione 2022-08-31 e successive. Override dell'URL assoluto supportato nel client con qualsiasi versione dell'API. Questo metodo non genera se la risposta è un errore; per generare un'eccezione, chiamare raise_for_status() sull'oggetto risposta restituito. Per altre informazioni su come inviare richieste personalizzate con questo metodo, vedere https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_recognize_business_cards

Estrarre il testo del campo e i valori semantici da un biglietto da visita specificato. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.

Vedere i campi trovati in un biglietto da visita qui: https://aka.ms/formrecognizer/businesscardfields

Novità della versione 2.1: metodo client begin_recognize_business_cards

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

Parametri

business_card: bytes oppure IO[bytes]

Necessario

Flusso o byte di file di tipo JPEG, PNG, PDF, TIFF o BMP.

locale: str

Impostazioni locali del biglietto da visita. Le impostazioni locali supportate includono: en-US, en-AU, en-CA, en-GB e en-IN.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

content_type: str oppure FormContentType

Tipo di contenuto del corpo inviato all'API. Il tipo di contenuto viene rilevato automaticamente, ma può essere sottoposto a override passando questo argomento di parola chiave. Per le opzioni, vedere FormContentType.

pages: list[str]

Numeri di pagina personalizzati per documenti a più pagine (PDF/TIFF). Immettere i numeri di pagina e/o gli intervalli di pagine che si desidera ottenere nel risultato. Per un intervallo di pagine, usare un trattino, ad esempio pages=["1-3", "5-6"]. Separare ogni numero di pagina o intervallo con una virgola.

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

Esempio

Riconoscere i biglietti da visita da un file.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio 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)
   )
   async with form_recognizer_client:
       with open(path_to_sample_forms, "rb") as f:
           poller = await form_recognizer_client.begin_recognize_business_cards(business_card=f, locale="en-US")
       business_cards = await 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

Estrarre il testo del campo e i valori semantici da un biglietto da visita specificato. Il documento di input deve essere il percorso (URL) della scheda da analizzare.

Vedere i campi trovati in un biglietto da visita qui: https://aka.ms/formrecognizer/businesscardfields

Novità della versione 2.1: metodo client begin_recognize_business_cards_from_url

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

Parametri

business_card_url: str

Necessario

URL del biglietto da visita da analizzare. L'input deve essere un URL valido e codificato di uno dei formati supportati: JPEG, PNG, PDF, TIFF o BMP.

locale: str

Impostazioni locali del biglietto da visita. Le impostazioni locali supportate includono: en-US, en-AU, en-CA, en-GB e en-IN.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

pages: list[str]

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

begin_recognize_content

Estrarre informazioni di testo e contenuto/layout da un determinato documento. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.

Novità della versione 2.1: pagine, linguaggio e argomenti di parole chiave reading_order e supporto per il contenuto image/bmp

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

Parametri

form: bytes oppure IO[bytes]

Necessario

Flusso o byte di file di tipo JPEG, PNG, PDF, TIFF o BMP.

pages: list[str]

language: str

Codice della lingua BCP-47 del testo nel documento. Vedere i codici di lingua supportati qui: https://docs.microsoft.com/azure/cognitive-services/form-recognizer/language-support. Il contenuto supporta l'identificazione automatica della lingua e i documenti multilanguage, quindi fornire solo un codice linguistico se si vuole forzare l'elaborazione del documento come tale lingua specifica.

reading_order: str

Algoritmo di lettura per ordinare le righe di testo restituite. Gli ordini di lettura supportati includono: basic (impostazione predefinita), naturale. Impostare "basic" per ordinare le righe da sinistra a destra e dall'alto verso il basso, anche se in alcuni casi la prossimità viene trattata con priorità più alta. Impostare "natural" per ordinare le righe usando le informazioni posizionale per mantenere le righe vicine insieme.

content_type: str oppure FormContentType

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[FormPage].

Tipo restituito

AsyncLROPoller[list[FormPage]]

Eccezioni

HttpResponseError

Esempio

Riconoscere le informazioni di testo e contenuto/layout da un modulo.


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

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

   async with FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   ) as form_recognizer_client:

       with open(path_to_sample_forms, "rb") as f:
           poller = await form_recognizer_client.begin_recognize_content(form=f)

       form_pages = await 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

Estrarre informazioni sul testo e sul layout da un determinato documento. Il documento di input deve essere il percorso (URL) del documento da analizzare.

Novità della versione 2.1: pagine, linguaggio e argomenti di parole chiave reading_order e supporto per il contenuto image/bmp

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

Parametri

form_url: str

Necessario

URL del modulo da analizzare. L'input deve essere un URL valido e codificato di uno dei formati supportati: JPEG, PNG, PDF, TIFF o BMP.

pages: list[str]

language: str

reading_order: str

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[FormPage].

Tipo restituito

AsyncLROPoller[list[FormPage]]

Eccezioni

HttpResponseError

begin_recognize_custom_forms

Analizzare un modulo personalizzato con un modello sottoposto a training con o senza etichette. Il modulo da analizzare deve essere dello stesso tipo dei moduli usati per eseguire il training del modello. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.

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

Parametri

model_id: str

Necessario

Identificatore del modello personalizzato.

form: bytes oppure IO[bytes]

Necessario

Flusso o byte di file di tipo JPEG, PNG, PDF, TIFF o BMP.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

content_type: str oppure FormContentType

pages: list[str]

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

Esempio

Riconoscere campi e valori da un modulo personalizzato.


   from azure.core.credentials import AzureKeyCredential
   from azure.ai.formrecognizer.aio 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)

   async with FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   ) as form_recognizer_client:

       # 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 = await form_recognizer_client.begin_recognize_custom_forms(
               model_id=model_id, form=f, include_field_elements=True
           )
       forms = await 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

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

Parametri

model_id: str

Necessario

Identificatore del modello personalizzato.

form_url: str

Necessario

URL del modulo da analizzare. L'input deve essere un URL valido e codificato di uno dei formati supportati: JPEG, PNG, PDF, TIFF o BMP.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

pages: list[str]

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

begin_recognize_identity_documents

Estrarre il testo del campo e i valori semantici da un determinato documento di identità. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.

Vedere i campi trovati in un documento di identità qui: https://aka.ms/formrecognizer/iddocumentfields

Novità nella versione 2.1: metodo client begin_recognize_identity_documents

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

Parametri

identity_document: bytes oppure IO[bytes]

Necessario

Flusso o byte di file di tipo JPEG, PNG, PDF, TIFF o BMP.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

content_type: str oppure FormContentType

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

pages: list[str]

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

Esempio

Riconoscere i documenti di identità da un file.


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

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

   async with FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   ) as form_recognizer_client:
       
       with open(path_to_sample_forms, "rb") as f:
           poller = await form_recognizer_client.begin_recognize_identity_documents(identity_document=f)
       
       id_documents = await 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

Estrarre il testo del campo e i valori semantici da un determinato documento di identità. Il documento di input deve essere il percorso (URL) del documento di identità da analizzare.

Vedere i campi trovati in un documento di identità qui: https://aka.ms/formrecognizer/iddocumentfields

Novità nella versione 2.1: metodo client begin_recognize_identity_documents_from_url

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

Parametri

identity_document_url: str

Necessario

URL del documento di identità da analizzare. L'input deve essere un URL valido e codificato di uno dei formati supportati: JPEG, PNG, PDF, TIFF o BMP.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

pages: list[str]

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

begin_recognize_invoices

Estrarre il testo del campo e i valori semantici da una determinata fattura. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.

Vedere i campi trovati in una fattura qui: https://aka.ms/formrecognizer/invoicefields

Novità nella versione 2.1: metodo client begin_recognize_invoices

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

Parametri

invoice: bytes oppure IO[bytes]

Necessario

Flusso o byte di file di tipo JPEG, PNG, PDF, TIFF o BMP.

locale: str

Impostazioni locali della fattura. Le impostazioni locali supportate includono: en-US

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

content_type: str oppure FormContentType

pages: list[str]

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

Esempio

Riconoscere le fatture da un file.


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

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

   async with FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   ) as form_recognizer_client:
       with open(path_to_sample_forms, "rb") as f:
           poller = await form_recognizer_client.begin_recognize_invoices(invoice=f, locale="en-US")
       invoices = await 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

Estrarre il testo del campo e i valori semantici da una determinata fattura. Il documento di input deve essere il percorso (URL) della fattura da analizzare.

Vedere i campi disponibili in una carta fattura qui: https://aka.ms/formrecognizer/invoicefields

Novità nella versione 2.1: metodo client begin_recognize_invoices_from_url

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

Parametri

invoice_url: str

Necessario

URL della fattura da analizzare. L'input deve essere un URL valido e codificato di uno dei formati supportati: JPEG, PNG, PDF, TIFF o BMP.

locale: str

Impostazioni locali della fattura. Le impostazioni locali supportate includono: en-US

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

pages: list[str]

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

begin_recognize_receipts

Estrarre il testo del campo e i valori semantici da una determinata ricevuta di vendita. Il documento di input deve essere di uno dei tipi di contenuto supportati: 'application/pdf', 'image/jpeg', 'image/png', 'image/tiff' o 'image/bmp'.

Vedere i campi trovati in una ricevuta qui: https://aka.ms/formrecognizer/receiptfields

Novità nella versione 2.1: argomento della parola chiave delle impostazioni locali e supporto per il contenuto image/bmp

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

Parametri

receipt: bytes oppure IO[bytes]

Necessario

Flusso o byte di file di tipo JPEG, PNG, PDF, TIFF o BMP.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

content_type: str oppure FormContentType

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

locale: str

Impostazioni locali della ricevuta. Le impostazioni locali supportate includono: en-US, en-AU, en-CA, en-GB e en-IN.

pages: list[str]

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

Esempio

Riconoscere i campi ricevuti di vendita.


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

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

   async with FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   ) as form_recognizer_client:

       with open(path_to_sample_forms, "rb") as f:
           poller = await form_recognizer_client.begin_recognize_receipts(receipt=f, locale="en-US")

       receipts = await 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

Estrarre il testo del campo e i valori semantici da una determinata ricevuta di vendita. Il documento di input deve essere il percorso (URL) della ricevuta da analizzare.

Vedere i campi trovati in una ricevuta qui: https://aka.ms/formrecognizer/receiptfields

Novità nella versione 2.1: argomento della parola chiave delle impostazioni locali e supporto per il contenuto image/bmp

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

Parametri

receipt_url: str

Necessario

URL della ricevuta da analizzare. L'input deve essere un URL valido e codificato di uno dei formati supportati: JPEG, PNG, PDF, TIFF o BMP.

include_field_elements: bool

Indica se includere o meno tutte le righe per pagina e gli elementi di campo, ad esempio righe, parole e segni di selezione per ogni campo modulo.

continuation_token: str

Token di continuazione per riavviare un poller da uno stato salvato.

locale: str

Impostazioni locali della ricevuta. Le impostazioni locali supportate includono: en-US, en-AU, en-CA, en-GB e en-IN.

pages: list[str]

Restituisce

Istanza di AsyncLROPoller. Chiamare result() sull'oggetto poller per restituire un elenco[RecognizedForm].

Tipo restituito

AsyncLROPoller[list[RecognizedForm]]

Eccezioni

HttpResponseError

Esempio

Riconoscere i campi ricevuti di vendita da un URL.


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

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

   async with FormRecognizerClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   ) as form_recognizer_client:
       url = "https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/receipt/contoso-receipt.png"
       poller = await form_recognizer_client.begin_recognize_receipts_from_url(receipt_url=url)
       receipts = await 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

Chiudere la FormRecognizerClient sessione.

async close() -> None

Eccezioni

HttpResponseError

send_request

Esegue una richiesta di rete usando la pipeline esistente del client.

L'URL della richiesta può essere relativo all'URL di base. La versione dell'API del servizio usata per la richiesta è uguale a quella del client, se non diversamente specificato. L'override della versione dell'API configurata del client nell'URL relativo è supportata nel client con l'API versione 2022-08-31 e successive. Override dell'URL assoluto supportato nel client con qualsiasi versione dell'API. Questo metodo non genera se la risposta è un errore; per generare un'eccezione, chiamare raise_for_status() sull'oggetto risposta restituito. Per altre informazioni su come inviare richieste personalizzate con questo metodo, vedere https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parametri

request: HttpRequest

Necessario

Richiesta di rete da effettuare.

Restituisce

Risposta della chiamata di rete. Non esegue la gestione degli errori nella risposta.

Tipo restituito

AsyncHttpResponse

Eccezioni

HttpResponseError

Condividi tramite

FormRecognizerClient Classe

Costruttore

Parametri

Esempio

Metodi

begin_recognize_business_cards

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_recognize_business_cards_from_url

Parametri

Restituisce

Tipo restituito

Eccezioni

begin_recognize_content

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_recognize_content_from_url

Parametri

Restituisce

Tipo restituito

Eccezioni

begin_recognize_custom_forms

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_recognize_custom_forms_from_url

Parametri

Restituisce

Tipo restituito

Eccezioni

begin_recognize_identity_documents

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_recognize_identity_documents_from_url

Parametri

Restituisce

Tipo restituito

Eccezioni

begin_recognize_invoices

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_recognize_invoices_from_url

Parametri

Restituisce

Tipo restituito

Eccezioni

begin_recognize_receipts

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

begin_recognize_receipts_from_url

Parametri

Restituisce

Tipo restituito

Eccezioni

Esempio

close

Eccezioni

send_request

Parametri

Restituisce

Tipo restituito

Eccezioni