SDK 타겟: REST API 2022–08-31 v3.0

🟩 REST API 버전 2022–08-31 v3.0

중요

  • Document Intelligence REST API 2022-08-31 v3.0 은 2029년 3월 30일에 지원이 종료됩니다.
  • 프로덕션 중단을 방지하려면 모든 새 개발에 Azure Document Intelligence 2024-11-30 v4.0을 사용하고, 이 날짜 이전에 기존 워크로드를 Azure Document Intelligence 2024-11-30 v4.0으로 마이그레이션합니다. 자세한 내용은 문서 인텔리전스 마이그레이션 가이드를 참조하세요.

Foundry 도구의 문서 인텔리전스 Azure 기계 학습을 사용하여 문서에서 텍스트 및 구조화된 데이터를 분석하는 클라우드 서비스입니다. SDK(Document Intelligence 소프트웨어 개발 키트)는 문서 인텔리전스 모델 및 기능을 애플리케이션에 쉽게 통합할 수 있는 라이브러리 및 도구 집합입니다. Document Intelligence SDK는 C#/.NET, Java, JavaScript 및 Python 프로그래밍 언어의 플랫폼에서 사용할 수 있습니다.

지원되는 프로그래밍 언어

Document Intelligence SDK는 다음 언어 및 플랫폼을 지원합니다.

언어 → Document Intelligence SDK 버전 패키지 지원되는 API 버전 플랫폼 지원
.NET/C# → 4.0.0 (GA) NuGet v3.0 Windows, macOS, Linux, Docker
Java → 4.0.6 (GA) Maven 리포지토리 v3.0 Windows, macOS, Linux
JavaScript → 4.0.0 (GA) Npm v3.0 브라우저, Windows, macOS, Linux
Python → 3.2.0 (GA) PyPI v3.0 Windows, macOS, Linux

다른 SDK 버전에 대한 자세한 내용은 다음을 참조하세요.

지원되는 클라이언트

언어 SDK 버전 API 버전 지원되는 클라이언트
.NET/C#
Java
JavaScript
4.0.0 (GA) v3.0:2022-08-31(기본값) DocumentAnalysisClient
DocumentModelAdministrationClient
.NET/C#
Java
JavaScript
3.1.x v2.1(기본값)
v2.0
FormRecognizerClient
FormTrainingClient
.NET/C#
Java
JavaScript
3.0.x v2.0 FormRecognizerClient
FormTrainingClient
Python 3.2.x(GA) v3.0:2022-08-31(기본값) DocumentAnalysisClient
DocumentModelAdministrationClient
Python 3.1.x v2.1(기본값)
v2.0
FormRecognizerClient
FormTrainingClient
Python 3.0.0 v2.0 FormRecognizerClient
FormTrainingClient

애플리케이션에서 문서 인텔리전스 SDK 사용

Document Intelligence SDK를 사용하면 애플리케이션에서 Document Intelligence 서비스를 사용하고 관리할 수 있습니다. SDK는 프로그래밍 언어 패러다임 내에서 이러한 API를 쉽게 사용할 수 있도록 기본 Document Intelligence REST API를 기반으로 합니다. 기본 설정 언어로 Document Intelligence SDK를 사용하는 방법은 다음과 같습니다.

1. SDK 클라이언트 라이브러리 설치

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

2. SDK 클라이언트 라이브러리를 애플리케이션으로 가져오기

using Azure;
using Azure.AI.FormRecognizer.DocumentAnalysis;

3. 인증 설정

인증에 지원되는 두 가지 방법이 있습니다.

  • azure.core.credentials에서 AzureKeyCredential과 함께 Document Intelligence API 키를 사용합니다.

  • azure-identity의 토큰 자격 증명을 사용하여 Microsoft Entra ID 인증합니다.

API 키 사용

Azure 포털에서 문서 인텔리전스 API 키를 찾을 수 있는 위치는 다음과 같습니다.

Azure 포털에서 키 및 엔드포인트 위치의 스크린샷입니다.

중요

클라우드에서 실행되는 애플리케이션에 자격 증명을 저장하지 않도록 Microsoft Entra ID 인증을 사용하여 Azure 리소스를 위한 관리 ID를 사용하는 것을 권장합니다.

API 키를 사용하는 경우 Azure Key Vault 같은 다른 위치에 안전하게 저장합니다. API 키를 코드에 직접 포함하지 말고 공개적으로 게시하지 마세요.

AI 서비스 보안에 대한 자세한 내용은 Azure AI 서비스 참조하세요.


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

Microsoft Entra 토큰 자격 증명 사용

참고

지역 엔드포인트는 Microsoft Entra 인증을 지원하지 않습니다. 이러한 유형의 인증을 사용하기 위해 리소스에 대한 사용자 지정 하위 도메인 을 만듭니다.

권한 부여는 .를 사용하는 것이 가장 쉽습니다 DefaultAzureCredential. 대부분의 Azure 인증 시나리오를 처리할 수 있는 실행 중인 환경에 따라 기본 토큰 자격 증명을 제공합니다.

.NET 애플리케이션에 DefaultAzureCredential 획득하고 사용하는 방법은 다음과 같습니다.

  1. Azure Identity 라이브러리를 .NET에 설치합니다.

        dotnet add package Azure.Identity
    
        Install-Package Azure.Identity
    
  2. Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체 만듭니다.

  3. 서비스 주체에 Cognitive Services User 역할을 할당함으로써 문서 인텔리전스에 대한 액세스 권한을 부여합니다.

  4. Microsoft Entra 애플리케이션의 클라이언트 ID, 테넌트 ID 및 클라이언트 암호 값을 환경 변수로 설정합니다. 각각 AZURE_CLIENT_ID, AZURE_TENANT_ID 및 AZURE_CLIENT_SECRET.

  5. DocumentAnalysisClient 인스턴스를 만들고 DefaultAzureCredential를 포함합니다.

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

자세한 내용은 클라이언트 인증.

4. 애플리케이션 빌드

Document Intelligence SDK와 상호 작용할 클라이언트 개체를 만든 다음 해당 클라이언트 개체에서 메서드를 호출하여 서비스와 상호 작용합니다. SDK는 동기 메서드와 비동기 메서드를 모두 제공합니다. 더 많은 인사이트를 얻으려면 원하는 언어로 빠른 시작을 시도해 보세요.

도움말 옵션

Microsoft Q & A 및 스택 오버플로 포럼은 개발자 커뮤니티에서 Azure 문서 인텔리전스 및 기타 서비스에 대한 질문을 하고 답변할 수 있습니다. Microsoft 포럼을 모니터링하고 커뮤니티가 아직 대답하지 않은 질문에 답합니다. 질문이 제대로 표시되도록 하려면 azure-form-recognizer으로 태그를 지정하세요.

다음 단계