Sdílet prostřednictvím


Cíl sady SDK: REST API v2.1 (GA)

Značka zaškrtnutí funkce Document IntelligenceRozhraní REST API verze 2.1 (GA) 21.06-08

Azure AI Document Intelligence je cloudová služba, která používá strojové učení k analýze textu a strukturovaných dat z dokumentů. Sada SDK (Document Intelligence Software Development Kit) je sada knihoven a nástrojů, které umožňují snadno integrovat modely a funkce Document Intelligence do vašich aplikací. Sada Document Intelligence SDK je k dispozici na různých platformách v programovacích jazycích C#/.NET, Java, JavaScript a Python.

Podporované programovací jazyky

Sada Document Intelligence SDK podporuje následující jazyky a platformy:

Verze sady Language → Document Intelligence SDK Balíček Podporovaná verze rozhraní API Podpora platformy
.NET/C# → 3.1.x (GA) NuGet v2.1 Windows, macOS, Linux, Docker
Java → 3.1.x (GA) Úložiště Maven v2.1 Windows, macOS, Linux
JavaScript → 3.1.0 (GA) npm v2.1 Prohlížeč, Windows, macOS, Linux
Python → 3.1.0 (GA) PyPI v2.1
Windows, macOS, Linux

Další informace o dalších verzích sady SDK najdete tady:

Podporovaní klienti

Jazyk Verze sady SDK Verze rozhraní API Podporovaní klienti
JavaScript pro .NET/C#


3.1.x v2.1 (výchozí)
v2.0
FormRecognizerClient FormTrainingClient
JavaScript pro .NET/C#


3.0.x v2.0 FormRecognizerClient FormTrainingClient
Python 3.1.x v2.1 (výchozí)
v2.0
FormRecognizerClient FormTrainingClient
Python 3.0.0 v2.0 FormRecognizerClient FormTrainingClient

Použití sady Document Intelligence SDK v aplikacích

Sada Document Intelligence SDK umožňuje ve vaší aplikaci používat a spravovat službu Document Intelligence. Sada SDK vychází ze základního rozhraní REST API pro analýzu dokumentů, které vám umožní snadno používat tato rozhraní API v rámci paradigmatu programovacího jazyka. Tady je postup, jak používat sadu Document Intelligence SDK pro preferovaný jazyk:

1. Instalace klientské knihovny SDK

dotnet add package Azure.AI.FormRecognizer --version 3.1.0
Install-Package Azure.AI.FormRecognizer -Version 3.1.0

2. Import klientské knihovny SDK do aplikace

using Azure;
using Azure.AI.FormRecognizer.Models;

3. Nastavení ověřování

Existují dvě podporované metody ověřování.

  • Použijte klíč rozhraní Document Intelligence API s AzureKeyCredential z azure.core.credentials.

  • K ověření pomocí ID Microsoft Entra použijte přihlašovací údaje tokenu z azure-identity.

Použití klíče rozhraní API

Tady najdete klíč rozhraní DOCUMENT Intelligence API na webu Azure Portal:

Snímek obrazovky s klíči a umístěním koncového bodu na webu Azure Portal

Důležité

Doporučujeme ověřování Microsoft Entra ID se spravovanými identitami pro prostředky Azure, abyste se vyhnuli ukládání přihlašovacích údajů s aplikacemi, které běží v cloudu.

Pokud používáte klíč rozhraní API, uložte ho bezpečně někam jinam, například ve službě Azure Key Vault. Nezahrnujte klíč rozhraní API přímo do kódu a nikdy ho nevštěvujte veřejně.

Další informace o zabezpečení služeb AI najdete v tématu Ověřování požadavků na služby Azure AI.


//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `FormRecognizerClient` instance
  string key = "<your-key>";
  string endpoint = "<your-endpoint>";
  FormRecognizerClient client = new FormRecognizerClient(new Uri(endpoint), new AzureKeyCredential(key));

Použití přihlašovacích údajů tokenu Microsoft Entra

Poznámka:

Regionální koncové body nepodporují ověřování Microsoft Entra. Vytvořte pro prostředek vlastní subdoménu, abyste mohli tento typ ověřování použít.

Autorizace se nejsnadněji používá .DefaultAzureCredential Poskytuje výchozí přihlašovací údaje tokenu založené na spuštěném prostředí, které dokáže zpracovat většinu scénářů ověřování Azure.

Tady je postup, jak získat a použít DefaultAzureCredential pro aplikace .NET:

  1. Nainstalujte knihovnu identit Azure pro .NET:

        dotnet add package Azure.Identity
    
        Install-Package Azure.Identity
    
  2. Zaregistrujte aplikaci Microsoft Entra a vytvořte nový instanční objekt.

  3. Udělení přístupu k funkci Document Intelligence přiřazením Cognitive Services User role k instančnímu objektu.

  4. Nastavte hodnoty ID klienta, ID tenanta a tajného klíče klienta v aplikaci Microsoft Entra jako proměnné prostředí: AZURE_CLIENT_ID, AZURE_TENANT_IDa AZURE_CLIENT_SECRETv uvedeném pořadí.

  5. Vytvořte instanciFormRecognizerClient, včetně:DefaultAzureCredential

    string endpoint = "<your-endpoint>";
    var client = new FormRecognizerClient(new Uri(endpoint), new DefaultAzureCredential());
    

Další informace najdete v tématu Ověření klienta.

4. Sestavení aplikace

Vytvořte objekt klienta pro interakci se sadou Document Intelligence SDK a potom volejte metody na daném objektu klienta pro interakci se službou. Sady SDK poskytují synchronní i asynchronní metody. Další přehled najdete v rychlém startu v jazyce podle vašeho výběru.

Možnosti nápovědy

Fóra Microsoft Q &A a Stack Overflow jsou k dispozici pro komunitu vývojářů, kde se můžete ptát a odpovídat na otázky týkající se funkce Document Intelligence a dalších služeb Azure AI. Microsoft monitoruje fóra a odpovídá na otázky, na které má komunita odpověď. Abychom měli jistotu, že vidíte vaši otázku, označte ji značkou azure-form-recognizer.

Další kroky