Delen via


DocumentAnalysisClient Klas

DocumentAnalysisClient analyseert informatie uit documenten en afbeeldingen en classificeert documenten. Het is de interface die moet worden gebruikt voor het analyseren van vooraf samengestelde modellen (onder andere ontvangstbewijzen, visitekaartjes, facturen, identiteitsdocumenten), het analyseren van de indeling van documenten, het analyseren van algemene documenttypen en het analyseren van aangepaste documenten met ingebouwde modellen (zie voor een volledige lijst met modellen die door de service worden ondersteund: https://aka.ms/azsdk/formrecognizer/models). Het biedt verschillende methoden op basis van invoer van een URL en invoer uit een stroom.

Notitie

DocumentAnalysisClient moet worden gebruikt met API-versies

2022-08-31 en hoger. Als u API-versies <=v2.1 wilt gebruiken, maakt u een FormRecognizerClient.

Nieuw in versie 31-08-2022: De DocumentAnalysisClient en de bijbehorende clientmethoden.

Overname
azure.ai.formrecognizer._form_base_client.FormRecognizerClientBase
DocumentAnalysisClient

Constructor

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

Parameters

endpoint
str
Vereist

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus2.api.cognitive.microsoft.com).

credential
AzureKeyCredential of TokenCredential
Vereist

Referenties die nodig zijn voor de client om verbinding te maken met Azure. Dit is een exemplaar van AzureKeyCredential als u een API-sleutel of een tokenreferentie van identitygebruikt.

api_version
str of DocumentAnalysisApiVersion

De API-versie van de service die moet worden gebruikt voor aanvragen. De standaardinstelling is de nieuwste serviceversie. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies. Als u API-versies <=v2.1 wilt gebruiken, instantiƫert u een FormRecognizerClient.

Voorbeelden

DocumentAnalysisClient maken met een eindpunt en API-sleutel.


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

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

   document_analysis_client = DocumentAnalysisClient(endpoint, AzureKeyCredential(key))

DocumentAnalysisClient maken met een tokenreferentie.


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

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

   document_analysis_client = DocumentAnalysisClient(endpoint, credential)

Methoden

begin_analyze_document

Veldtekst en semantische waarden uit een bepaald document analyseren.

Nieuw in versie 2023-07-31: Het sleutelwoordargument functies .

begin_analyze_document_from_url

Veldtekst en semantische waarden uit een bepaald document analyseren. De invoer moet de locatie (URL) zijn van het document dat moet worden geanalyseerd.

Nieuw in versie 2023-07-31: Het sleutelwoordargument functies .

begin_classify_document

Een document classificeren met behulp van een documentclassificatie. Zie voor meer informatie over het bouwen van een aangepast classificatiemodel https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Nieuw in versie 2023-07-31: De begin_classify_document-clientmethode .

begin_classify_document_from_url

Een bepaald document classificeren met een documentclassificatie. Zie voor meer informatie over het bouwen van een aangepast classificatiemodel https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. De invoer moet de locatie (URL) zijn van het document dat moet worden geclassificeerd.

Nieuw in versie 2023-07-31: de clientmethode begin_classify_document_from_url .

close

Sluit de DocumentAnalysisClient sessie.

send_request

Hiermee wordt een netwerkaanvraag uitgevoerd met behulp van de bestaande pijplijn van de client.

De aanvraag-URL kan relatief zijn ten opzichte van de basis-URL. De service-API-versie die voor de aanvraag wordt gebruikt, is dezelfde als die van de client, tenzij anders opgegeven. Het overschrijven van de geconfigureerde API-versie van de client in relatieve URL wordt ondersteund op de client met API-versie 2022-08-31 en hoger. Overschrijven in absolute URL die wordt ondersteund op client met elke API-versie. Deze methode wordt niet gegenereerd als het antwoord een fout is; als u een uitzondering wilt maken, roept u raise_for_status() aan op het geretourneerde antwoordobject. Zie voor meer informatie over het verzenden van aangepaste aanvragen met deze methode https://aka.ms/azsdk/dpcodegen/python/send_request.

begin_analyze_document

Veldtekst en semantische waarden uit een bepaald document analyseren.

Nieuw in versie 2023-07-31: Het sleutelwoordargument functies .

begin_analyze_document(model_id: str, document: bytes | IO[bytes], **kwargs: Any) -> LROPoller[AnalyzeResult]

Parameters

model_id
str
Vereist

Een unieke model-id kan worden doorgegeven als een tekenreeks. Gebruik deze optie om de aangepaste model-id of vooraf gemaakte model-id op te geven. Ondersteunde vooraf gemaakte model-id's vindt u hier: https://aka.ms/azsdk/formrecognizer/models

document
bytes of IO[bytes]
Vereist

Bestandsstroom of bytes. Zie voor door de service ondersteunde bestandstypen: https://aka.ms/azsdk/formrecognizer/supportedfiles.

pages
str

Aangepaste paginanummers voor documenten met meerdere pagina's (PDF/TIFF). Voer de paginanummers en/of paginabereiken in die u in het resultaat wilt ophalen. Gebruik voor een reeks pagina's een afbreekstreepje, zoals pages="1-3, 5-6". Scheid elk paginanummer of elk paginabereik met een komma.

locale
str

Landinstellingshint van het invoerdocument. Bekijk hier ondersteunde landinstellingen: https://aka.ms/azsdk/formrecognizer/supportedlocales.

features
list[str]

Functies voor documentanalyse die moeten worden ingeschakeld.

Retouren

Een exemplaar van een LROPoller. Roep result() aan op het poller-object om een AnalyzeResultte retourneren.

Retourtype

Uitzonderingen

Voorbeelden

Een factuur analyseren. Zie de map voorbeelden voor meer voorbeelden.


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

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

   document_analysis_client = DocumentAnalysisClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   with open(path_to_sample_documents, "rb") as f:
       poller = document_analysis_client.begin_analyze_document(
           "prebuilt-invoice", document=f, locale="en-US"
       )
   invoices = poller.result()

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

Een aangepast document analyseren. Zie de map voorbeelden voor meer voorbeelden.


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

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

   document_analysis_client = DocumentAnalysisClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   # Make sure your document's type is included in the list of document types the custom model can analyze
   with open(path_to_sample_documents, "rb") as f:
       poller = document_analysis_client.begin_analyze_document(
           model_id=model_id, document=f
       )
   result = poller.result()

   for idx, document in enumerate(result.documents):
       print(f"--------Analyzing document #{idx + 1}--------")
       print(f"Document has type {document.doc_type}")
       print(f"Document has document type confidence {document.confidence}")
       print(f"Document was analyzed with model with ID {result.model_id}")
       for name, field in document.fields.items():
           field_value = field.value if field.value else field.content
           print(
               f"......found field of type '{field.value_type}' with value '{field_value}' and with confidence {field.confidence}"
           )

   # iterate over tables, lines, and selection marks on each page
   for page in result.pages:
       print(f"\nLines found on page {page.page_number}")
       for line in page.lines:
           print(f"...Line '{line.content}'")
       for word in page.words:
           print(f"...Word '{word.content}' has a confidence of {word.confidence}")
       if page.selection_marks:
           print(f"\nSelection marks found on page {page.page_number}")
           for selection_mark in page.selection_marks:
               print(
                   f"...Selection mark is '{selection_mark.state}' and has a confidence of {selection_mark.confidence}"
               )

   for i, table in enumerate(result.tables):
       print(f"\nTable {i + 1} can be found on page:")
       for region in table.bounding_regions:
           print(f"...{region.page_number}")
       for cell in table.cells:
           print(
               f"...Cell[{cell.row_index}][{cell.column_index}] has text '{cell.content}'"
           )
   print("-----------------------------------")

begin_analyze_document_from_url

Veldtekst en semantische waarden uit een bepaald document analyseren. De invoer moet de locatie (URL) zijn van het document dat moet worden geanalyseerd.

Nieuw in versie 2023-07-31: Het sleutelwoordargument functies .

begin_analyze_document_from_url(model_id: str, document_url: str, **kwargs: Any) -> LROPoller[AnalyzeResult]

Parameters

model_id
str
Vereist

Een unieke model-id kan worden doorgegeven als een tekenreeks. Gebruik deze optie om de aangepaste model-id of vooraf gemaakte model-id op te geven. Ondersteunde vooraf gemaakte model-id's vindt u hier: https://aka.ms/azsdk/formrecognizer/models

document_url
str
Vereist

De URL van het document dat moet worden geanalyseerd. De invoer moet een geldige, correct gecodeerde url (d.w.w. speciale tekens, zoals lege spaties coderen) en openbaar toegankelijke URL zijn. Zie voor door de service ondersteunde bestandstypen: https://aka.ms/azsdk/formrecognizer/supportedfiles.

pages
str

Aangepaste paginanummers voor documenten met meerdere pagina's (PDF/TIFF). Voer de paginanummers en/of paginabereiken in die u in het resultaat wilt ophalen. Gebruik voor een reeks pagina's een afbreekstreepje, zoals pages="1-3, 5-6". Scheid elk paginanummer of elk paginabereik met een komma.

locale
str

Landinstellingshint van het invoerdocument. Bekijk hier ondersteunde landinstellingen: https://aka.ms/azsdk/formrecognizer/supportedlocales.

features
list[str]

Functies voor documentanalyse die moeten worden ingeschakeld.

Retouren

Een exemplaar van een LROPoller. Roep result() aan op het poller-object om een AnalyzeResultte retourneren.

Retourtype

Uitzonderingen

Voorbeelden

Een ontvangstbewijs analyseren. Zie de map voorbeelden voor meer voorbeelden.


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

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

   document_analysis_client = DocumentAnalysisClient(
       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 = document_analysis_client.begin_analyze_document_from_url(
       "prebuilt-receipt", document_url=url
   )
   receipts = poller.result()

   for idx, receipt in enumerate(receipts.documents):
       print(f"--------Analysis of receipt #{idx + 1}--------")
       print(f"Receipt type: {receipt.doc_type if receipt.doc_type else 'N/A'}")
       merchant_name = receipt.fields.get("MerchantName")
       if merchant_name:
           print(
               f"Merchant Name: {merchant_name.value} has confidence: "
               f"{merchant_name.confidence}"
           )
       transaction_date = receipt.fields.get("TransactionDate")
       if transaction_date:
           print(
               f"Transaction Date: {transaction_date.value} has confidence: "
               f"{transaction_date.confidence}"
           )
       if receipt.fields.get("Items"):
           print("Receipt items:")
           for idx, item in enumerate(receipt.fields.get("Items").value):
               print(f"...Item #{idx + 1}")
               item_description = item.value.get("Description")
               if item_description:
                   print(
                       f"......Item Description: {item_description.value} has confidence: "
                       f"{item_description.confidence}"
                   )
               item_quantity = item.value.get("Quantity")
               if item_quantity:
                   print(
                       f"......Item Quantity: {item_quantity.value} has confidence: "
                       f"{item_quantity.confidence}"
                   )
               item_price = item.value.get("Price")
               if item_price:
                   print(
                       f"......Individual Item Price: {item_price.value} has confidence: "
                       f"{item_price.confidence}"
                   )
               item_total_price = item.value.get("TotalPrice")
               if item_total_price:
                   print(
                       f"......Total Item Price: {item_total_price.value} has confidence: "
                       f"{item_total_price.confidence}"
                   )
       subtotal = receipt.fields.get("Subtotal")
       if subtotal:
           print(f"Subtotal: {subtotal.value} has confidence: {subtotal.confidence}")
       tax = receipt.fields.get("TotalTax")
       if tax:
           print(f"Total tax: {tax.value} has confidence: {tax.confidence}")
       tip = receipt.fields.get("Tip")
       if tip:
           print(f"Tip: {tip.value} has confidence: {tip.confidence}")
       total = receipt.fields.get("Total")
       if total:
           print(f"Total: {total.value} has confidence: {total.confidence}")
       print("--------------------------------------")

begin_classify_document

Een document classificeren met behulp van een documentclassificatie. Zie voor meer informatie over het bouwen van een aangepast classificatiemodel https://aka.ms/azsdk/formrecognizer/buildclassifiermodel.

Nieuw in versie 2023-07-31: De begin_classify_document-clientmethode .

begin_classify_document(classifier_id: str, document: bytes | IO[bytes], **kwargs: Any) -> LROPoller[AnalyzeResult]

Parameters

classifier_id
str
Vereist

Een unieke documentclassificatie-id kan worden doorgegeven als een tekenreeks.

document
bytes of IO[bytes]
Vereist

Bestandsstroom of bytes. Zie voor door de service ondersteunde bestandstypen: https://aka.ms/azsdk/formrecognizer/supportedfiles.

Retouren

Een exemplaar van een LROPoller. Roep result() aan op het poller-object om een AnalyzeResultte retourneren.

Retourtype

Uitzonderingen

Voorbeelden

Een document classificeren. Zie de map voorbeelden voor meer voorbeelden.


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

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   classifier_id = os.getenv("CLASSIFIER_ID", classifier_id)

   document_analysis_client = DocumentAnalysisClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )
   with open(path_to_sample_documents, "rb") as f:
       poller = document_analysis_client.begin_classify_document(
           classifier_id, document=f
       )
   result = poller.result()

   print("----Classified documents----")
   for doc in result.documents:
       print(
           f"Found document of type '{doc.doc_type or 'N/A'}' with a confidence of {doc.confidence} contained on "
           f"the following pages: {[region.page_number for region in doc.bounding_regions]}"
       )

begin_classify_document_from_url

Een bepaald document classificeren met een documentclassificatie. Zie voor meer informatie over het bouwen van een aangepast classificatiemodel https://aka.ms/azsdk/formrecognizer/buildclassifiermodel. De invoer moet de locatie (URL) zijn van het document dat moet worden geclassificeerd.

Nieuw in versie 2023-07-31: de clientmethode begin_classify_document_from_url .

begin_classify_document_from_url(classifier_id: str, document_url: str, **kwargs: Any) -> LROPoller[AnalyzeResult]

Parameters

classifier_id
str
Vereist

Een unieke documentclassificatie-id kan worden doorgegeven als een tekenreeks.

document_url
str
Vereist

De URL van het document dat moet worden geclassificeerd. De invoer moet een geldige, correct gecodeerde url zijn (d.w.w. speciale tekens coderen, zoals lege spaties) en openbaar toegankelijke URL van een van de ondersteunde indelingen: https://aka.ms/azsdk/formrecognizer/supportedfiles.

Retouren

Een exemplaar van een LROPoller. Roep result() aan op het poller-object om een AnalyzeResultte retourneren.

Retourtype

Uitzonderingen

Voorbeelden

Een document classificeren. Zie de map voorbeelden voor meer voorbeelden.


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

   endpoint = os.environ["AZURE_FORM_RECOGNIZER_ENDPOINT"]
   key = os.environ["AZURE_FORM_RECOGNIZER_KEY"]
   classifier_id = os.getenv("CLASSIFIER_ID", classifier_id)

   document_analysis_client = DocumentAnalysisClient(
       endpoint=endpoint, credential=AzureKeyCredential(key)
   )

   url = "https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/formrecognizer/azure-ai-formrecognizer/tests/sample_forms/forms/IRS-1040.pdf"

   poller = document_analysis_client.begin_classify_document_from_url(
       classifier_id, document_url=url
   )
   result = poller.result()

   print("----Classified documents----")
   for doc in result.documents:
       print(
           f"Found document of type '{doc.doc_type or 'N/A'}' with a confidence of {doc.confidence} contained on "
           f"the following pages: {[region.page_number for region in doc.bounding_regions]}"
       )

close

Sluit de DocumentAnalysisClient sessie.

close() -> None

Uitzonderingen

send_request

Hiermee wordt een netwerkaanvraag uitgevoerd met behulp van de bestaande pijplijn van de client.

De aanvraag-URL kan relatief zijn ten opzichte van de basis-URL. De service-API-versie die voor de aanvraag wordt gebruikt, is dezelfde als die van de client, tenzij anders opgegeven. Het overschrijven van de geconfigureerde API-versie van de client in relatieve URL wordt ondersteund op de client met API-versie 2022-08-31 en hoger. Overschrijven in absolute URL die wordt ondersteund op client met elke API-versie. Deze methode wordt niet gegenereerd als het antwoord een fout is; als u een uitzondering wilt maken, roept u raise_for_status() aan op het geretourneerde antwoordobject. Zie voor meer informatie over het verzenden van aangepaste aanvragen met deze methode https://aka.ms/azsdk/dpcodegen/python/send_request.

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

Parameters

request
HttpRequest
Vereist

De netwerkaanvraag die u wilt maken.

stream
bool

Of de nettolading van het antwoord wordt gestreamd. Standaard ingesteld op False.

Retouren

Het antwoord van uw netwerkoproep. Er wordt geen foutafhandeling uitgevoerd voor uw antwoord.

Retourtype

Uitzonderingen