Share via

Cíl sady SDK: REST API 2024-02-29-preview

  • Článek

Důležité

  • Verze Document Intelligence ve verzi Public Preview poskytují dřívější přístup k funkcím, které jsou aktivní ve vývoji.
  • Funkce, přístupy a procesy se můžou před obecnou dostupností (GA) změnit na základě zpětné vazby uživatelů.
  • Verze Public Preview klientských knihoven Document Intelligence ve výchozím nastavení je rest API verze 2024-02-29-preview.
  • Verze Public Preview 2024-02-29-preview je aktuálně dostupná jenom v následujících oblastech Azure:
  • USA – východ
  • USA – západ 2
  • Západní Evropa

Značka zaškrtnutí funkce Document IntelligenceREST API verze 2024-02-29-preview

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# → 1.0.0-beta.2 (Preview) NuGet 29. 2024 (Preview) Windows, macOS, Linux, Docker
Java → 1.0.0-beta.2 (Preview) Úložiště Maven 29. 2024 (Preview) Windows, macOS, Linux
JavaScript → 1.0.0-beta.2 (Preview) npm 29. 2024 (Preview) Prohlížeč, Windows, macOS, Linux
Python → 1.0.0b2 (Preview) PyPI 29. 2024 (Preview) Windows, macOS, Linux

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

Podporovaní klienti

Následující tabulky představují korelaci mezi každou verzí sady SDK podporovanými verzemi rozhraní API služby Document Intelligence.

Jazyk Alias sady SDK Verze rozhraní API (výchozí) Podporovaní klienti
.NET/C# 1.0.0-beta.2 (Preview) v4.0 (Preview) 2024-02-29-preview DocumentIntelligenceClient
DocumentIntelligence Správa istrationClient
.NET/C# 4.1.0 Nejnovější verze v3.1 (GA) 2023-07-31 DocumentAnalysisClient
DocumentModel Správa istrationClient
.NET/C# 4.0.0 v3.0 (GA) 2022-08-31 DocumentAnalysisClient
DocumentModel Správa istrationClient
.NET/C# 3.1.x v2.1 v2.1 FormRecognizerClient FormTrainingClient
.NET/C# 3.0.x v2.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.DocumentIntelligence --version 1.0.0-beta.2

Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.2

2. Import klientské knihovny SDK do aplikace

using Azure;
using Azure.AI.DocumentIntelligence;

3. Nastavení ověřování

Pro ověřování existují dvě podporované metody:

  • 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 


//set `<your-endpoint>` and `<your-key>` variables with the values from the Azure portal to create your `AzureKeyCredential` and `DocumentIntelligenceClient` instance
string key = "<your-key>";
string endpoint = "<your-endpoint>";
AzureKeyCredential credential = new AzureKeyCredential(key);
DocumentIntelligenceClient client = new DocumentIntelligenceClient(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 instanciDocumentIntelligenceClient, včetně:DefaultAzureCredential

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

Další informace najdete v tématuOvěř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 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 funkcí Document Intelligence a dalších služeb Azure AI. Microsoft monitoruje fóra a odpovídá na otázky, na které má komunita odpověď. Abyste měli jistotu, použijte následující značky, abychom viděli vaši otázku.

  • Microsoft Q&A: Azure AI Document Intelligence. .

  • Stack Overflow: azure-ai-document-intelligence.

Další kroky

Prozkoumejte operace REST API funkce Document Intelligence 2023-10-31-rest .