SDK 대상: REST API 2022–08–31(GA)

REST API version 2022–08–31(GA)

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

지원되는 프로그래밍 언어

문서 인텔리전스 SDK는 다음 언어와 플랫폼을 지원합니다.

언어 → 문서 인텔리전스 SDK 버전	Package(패키지)	지원되는 API 버전	플랫폼 지원
.NET/C# → 4.0.0(GA)	NuGet	v3.0 v2.1 v2.0	Windows, macOS, Linux, Docker
Java → 4.0.6(GA)	MVN 리포지토리	v3.0 v2.1 v2.0	Windows, macOS, Linux
JavaScript → 4.0.0(GA)	npm	v3.0 v2.1 v2.0	Browser, Windows, macOS, Linux
Python → 3.2.0(GA)	PyPI	v3.0 v2.1 v2.0	Windows, macOS, Linux

지원되는 클라이언트

언어	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 사용

문서 인텔리전스 SDK를 사용하면 애플리케이션에서 문서 인텔리전스 서비스를 사용하고 관리할 수 있습니다. SDK는 기본 문서 인텔리전스 REST API를 기반으로 구축되어 프로그래밍 언어 패러다임 내에서 해당 API를 쉽게 사용할 수 있습니다. 원하는 언어로 문서 인텔리전스 SDK를 사용하는 방법은 다음과 같습니다.

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

C#/.NET

dotnet add package Azure.AI.FormRecognizer --version 4.0.0

Install-Package Azure.AI.FormRecognizer -Version 4.0.0

Java

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-formrecognizer</artifactId>
<version>4.0.6</version>
</dependency>

implementation("com.azure:azure-ai-formrecognizer:4.0.6")

JavaScript

npm i @azure/ai-form-recognizer@4.0.0

Python

pip install azure-ai-formrecognizer==3.2.0

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

C#/.NET

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

Java

import com.azure.ai.formrecognizer.*;
import com.azure.ai.formrecognizer.models.*;
import com.azure.ai.formrecognizer.DocumentAnalysisClient.*;

import com.azure.core.credential.AzureKeyCredential;

JavaScript

const { AzureKeyCredential, DocumentAnalysisClient } = require("@azure/ai-form-recognizer");

Python

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

3. 인증 설정

인증에는 다음 두 가지 방법을 지원합니다.

• azure.core.credentials의 AzureKeyCredential과 함께 문서 인텔리전스 API 키를 사용하세요.

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

API key 사용

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

C#/.NET

//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);

Java

// create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
DocumentAnalysisClient client = new DocumentAnalysisClientBuilder()
            .credential(new AzureKeyCredential("<your-key>"))
            .endpoint("<your-endpoint>")
            .buildClient();

JavaScript

// create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
async function main() {
    const client = new DocumentAnalysisClient("<your-endpoint>", new AzureKeyCredential("<your-key>"));

Python

# create your `DocumentAnalysisClient` instance and `AzureKeyCredential` variable
    document_analysis_client = DocumentAnalysisClient(endpoint="<your-endpoint>", credential=AzureKeyCredential("<your-key>"))

Microsoft Entra 토큰 자격 증명 사용

참고 항목

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

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

C#/.NET

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

1. .NET용 Azure ID 라이브러리를 설치합니다.

       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. DefaultAzureCredential을 포함하여 DocumentAnalysisClient 인스턴스를 만듭니다.

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

자세한 정보는 클라이언트 인증을 참조하세요.

Java

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

1. Java용 Azure ID 라이브러리를 설치합니다.

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.5.3</version>
   </dependency>
   

2. Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다.

3. 서비스 주체에 Cognitive Services User 역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.

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

5. DocumentAnalysisClient 인스턴스 및 TokenCredential 변수를 만듭니다.

   TokenCredential credential = new DefaultAzureCredentialBuilder().build();
   DocumentAnalysisClient documentAnalysisClient = new DocumentAnalysisClientBuilder()
       .endpoint("{your-endpoint}")
       .credential(credential)
       .buildClient();
   

자세한 정보는 클라이언트 인증을 참조하세요.

JavaScript

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

1. JavaScript용 Azure ID 라이브러리를 설치합니다.

   npm install @azure/identity
   

2. Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다.

3. 서비스 주체에 Cognitive Services User 역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.

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

5. DefaultAzureCredential을 포함하여 DocumentAnalysisClient 인스턴스를 만듭니다.

   const { DocumentAnalysisClient } = require("@azure/ai-form-recognizer");
   const { DefaultAzureCredential } = require("@azure/identity");
   
   const client = new DocumentAnalysisClient("<your-endpoint>", new DefaultAzureCredential());
   

자세한 정보는 클라이언트 만들기 및 인증을 참조하세요.

Python

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

1. Python용 Azure ID 라이브러리를 설치합니다.

   pip install azure-identity
   

2. Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다.

3. 서비스 주체에 Cognitive Services User 역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.

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

5. DefaultAzureCredential을 포함하여 DocumentAnalysisClient 인스턴스를 만듭니다.

   from azure.identity import DefaultAzureCredential
   from azure.ai.formrecognizer import DocumentAnalysisClient
   
   credential = DefaultAzureCredential()
   document_analysis_client = DocumentAnalysisClient(
       endpoint="https://<my-custom-subdomain>.cognitiveservices.azure.com/",
       credential=credential
   )
   

자세한 정보는 클라이언트 인증을 참조하세요.

4. 애플리케이션 빌드

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

도움말 옵션

개발자 커뮤니티에서는 Microsoft Q&A 및 Stack Overflow 포럼을 통해 Azure AI 문서 인텔리전스 및 기타 서비스에 대해 질문하고 답변할 수 있습니다. Microsoft는 포럼을 모니터링하고 커뮤니티에서 아직 답변하지 않은 질문에 답변합니다. 사용자의 질문을 확인하려면 azure-form-recognizer 태그를 지정합니다.

다음 단계

Document Intelligence REST API v3.0 살펴보기

Document Intelligence 빠른 시작 사용해 보기