SDK 대상: REST API 2024-02-29-preview
이 문서의 내용
Important
문서 인텔리전스 공개 미리 보기 릴리스에서는 현재 개발 중인 기능에 대한 조기 액세스를 제공합니다.
기능, 방식 및 프로세스는 GA(일반 공급) 전에 사용자 피드백에 따라 변경될 수 있습니다.
문서 인텔리전스 클라이언트 라이브러리의 공개 미리 보기 버전은 기본적으로 REST API 버전 2024-02-29-미리 보기 로 설정됩니다.
공개 미리 보기 버전 2024-02-29-미리 보기 는 현재 다음 Azure 지역에서만 사용할 수 있습니다.
미국 동부
미국 서부2
서유럽
REST API 버전 2024-02-29-preview
Azure AI 문서 인텔리전스는 기계 학습을 사용하여 문서의 텍스트와 구조화된 데이터를 분석하는 클라우드 서비스입니다. 문서 인텔리전스 소프트웨어 개발 키트(SDK)는 문서 인텔리전스 모델 및 기능을 애플리케이션에 쉽게 통합할 수 있는 라이브러리 및 도구 세트입니다. 문서 인텔리전스 SDK는 C#/.NET, Java, JavaScript 및 Python 프로그래밍 언어의 플랫폼 전반에 걸쳐 사용할 수 있습니다.
지원되는 프로그래밍 언어
문서 인텔리전스 SDK는 다음 언어와 플랫폼을 지원합니다.
언어 → 문서 인텔리전스 SDK 버전
Package(패키지)
지원되는 API 버전
플랫폼 지원
.NET/C# → 1.0.0-beta.2(미리 보기)
NuGet
2024-02-29(미리 보기)
Windows, macOS, Linux, Docker
Java → 1.0.0-beta.2(미리 보기)
Maven 리포지토리
2024-02-29(미리 보기)
Windows, macOS, Linux
JavaScript → 1.0.0-beta.2(미리 보기)
npm
2024-02-29(미리 보기)
Browser, Windows, macOS, Linux
Python → 1.0.0b2(미리 보기)
PyPI
2024-02-29(미리 보기)
Windows, macOS, Linux
다른 SDK 버전에 대한 자세한 내용은 다음을 참조하세요.
지원되는 클라이언트
다음 표에는 문서 인텔리전스 서비스의 각 SDK 버전과 지원되는 API 버전 간의 상관 관계가 나와 있습니다.
언어
SDK 별칭
API 버전(기본값)
지원되는 클라이언트
.NET/C# 1.0.0-beta.2(미리 보기)
v4.0(미리 보기)
2024-02-29-preview
DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
.NET/C# 4.1.0
v3.1 최신(GA)
2023-07-31
DocumentAnalyticClient DocumentModelAdministrationClient
.NET/C# 4.0.0
v3.0(GA)
2022-08-31
DocumentAnalyticClient DocumentModelAdministrationClient
.NET/C# 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
.NET/C# 3.0.x
v2.0
v2.0
FormRecognizerClient FormTrainingClient
언어
SDK 별칭
API 버전(기본값)
지원되는 클라이언트
Java 1.0.0-beta.2(미리 보기)
v4.0(미리 보기)
2024-02-29-preview
DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
Java 4.1.0
v3.1 최신(GA)
2023-07-31
DocumentAnalyticClient DocumentModelAdministrationClient
Java 4.0.0
v3.0(GA)
2022-08-31
DocumentAnalyticClient DocumentModelAdministrationClient
Java 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
Java 3.0.x
v2.0
v2.0
FormRecognizerClient FormTrainingClient
언어
SDK 별칭
API 버전(기본값)
지원되는 클라이언트
JavaScript 1.0.0-beta.2
v4.0(미리 보기)
2024-02-29-preview
DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
JavaScript 5.0.0
v3.1 최신(GA)
2023-07-31
DocumentAnalyticClient DocumentModelAdministrationClient
JavaScript 4.0.0
v3.0(GA)
2022-08-31
DocumentAnalyticClient DocumentModelAdministrationClient
JavaScript 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
JavaScript 3.0.x
v2.0
v2.0
FormRecognizerClient FormTrainingClient
언어
SDK 별칭
API 버전(기본값)
지원되는 클라이언트
Python 1.0.0b2
v4.0(미리 보기)
2024-02-29-preview
DocumentIntelligenceClient DocumentIntelligenceAdministrationClient
Python 3.3.0
v3.1 최신(GA)
2023-07-31
DocumentAnalyticClient DocumentModelAdministrationClient
Python 3.2.x
v3.0(GA)
2022-08-31
DocumentAnalyticClient DocumentModelAdministrationClient
Python 3.1.x
v2.1
v2.1
FormRecognizerClient FormTrainingClient
Python 3.0.0
v2.0
v2.0
FormRecognizerClient FormTrainingClient
애플리케이션에서 문서 인텔리전스 SDK 사용
문서 인텔리전스 SDK를 사용하면 애플리케이션에서 문서 인텔리전스 서비스를 사용하고 관리할 수 있습니다. SDK는 기본 문서 인텔리전스 REST API를 기반으로 구축되어 프로그래밍 언어 패러다임 내에서 해당 API를 쉽게 사용할 수 있습니다. 원하는 언어로 문서 인텔리전스 SDK를 사용하는 방법은 다음과 같습니다.
1. SDK 클라이언트 라이브러리 설치
dotnet add package Azure.AI.DocumentIntelligence --version 1.0.0-beta.2
Install-Package Azure.AI.FormRecognizer -Version 1.0.0-beta.2
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-documentintelligence</artifactId>
<version>1.0.0-beta.2</version>
</dependency>
implementation("com.azure:azure-ai-documentintelligence:1.0.0-beta.2")
npm i @azure-rest/ai-document-intelligence@1.0.0-beta.2
pip install azure-ai-documentintelligence==1.0.0b2
2. SDK 클라이언트 라이브러리를 애플리케이션으로 가져오기
using Azure;
using Azure.AI.DocumentIntelligence;
import com.azure.ai.documentintelligence.*;
import com.azure.ai.documentintelligence.models.*;
import com.azure.core.credential.AzureKeyCredential;
const { AzureKeyCredential, DocumentIntelligence } = require("@azure-rest/ai-document-intelligence@1.0.0-beta.2");
from azure.ai.documentintelligence import DocumentIntelligenceClient
from azure.core.credentials import AzureKeyCredential
3. 인증 설정
인증에는 다음 두 가지 방법을 지원합니다.
API key 사용
Azure portal에서 문서 인텔리전스 API 키를 찾을 수 있는 위치는 다음과 같습니다.
//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));
// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
.credential(new AzureKeyCredential("<your-key>"))
.endpoint("<your-endpoint>")
.buildClient();
// create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
async function main() {
const client = DocumentIntelligence(process.env["your-endpoint>"], {
key: process.env["<your-key>"],
});
# create your `DocumentIntelligenceClient` instance and `AzureKeyCredential` variable
endpoint = "<your-endpoint>"
credential = AzureKeyCredential("<your-key>")
document_analysis_client = DocumentIntelligenceClient(endpoint, credential)
Microsoft Entra 토큰 자격 증명 사용
참고 항목
지역별 엔드포인트는 Microsoft Entra 인증을 지원하지 않습니다. 이러한 유형의 인증을 사용하기 위해 리소스에 대한 사용자 지정 하위 도메인 을 만듭니다.
권한 부여는 DefaultAzureCredential
을 사용하면 가장 쉽습니다. 실행 중인 환경에 따라 기본 토큰 자격 증명을 제공하므로 대부분의 Azure 인증 시나리오를 처리할 수 있습니다.
.NET 애플리케이션용 DefaultAzureCredential 을 획득하고 사용하는 방법은 다음과 같습니다.
.NET용 Azure ID 라이브러리 를 설치합니다.
dotnet add package Azure.Identity
Install-Package Azure.Identity
Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다 .
서비스 주체에 Cognitive Services User
역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.
Microsoft Entra 애플리케이션의 클라이언트 ID, 테넌트 ID 및 클라이언트 암호 값을 각각 환경 변수AZURE_CLIENT_ID
, AZURE_TENANT_ID
및 AZURE_CLIENT_SECRET
으로 설정합니다.
DefaultAzureCredential
을 포함하여 DocumentIntelligenceClient
인스턴스를 만듭니다.
string endpoint = "<your-endpoint>";
var client = new DocumentIntelligenceClient(new Uri(endpoint), new DefaultAzureCredential());
자세한 내용은 클라이언트 인증 을 참조하세요 .
Java 애플리케이션용 DefaultAzureCredential 을 획득하고 사용하는 방법은 다음과 같습니다.
Java용 Azure ID 라이브러리 를 설치합니다.
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.5.3</version>
</dependency>
Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다 .
서비스 주체에 Cognitive Services User
역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.
Microsoft Entra 애플리케이션의 클라이언트 ID, 테넌트 ID 및 클라이언트 암호 값을 각각 환경 변수AZURE_CLIENT_ID
, AZURE_TENANT_ID
및 AZURE_CLIENT_SECRET
으로 설정합니다.
DocumentIntelligenceClient
인스턴스 및 TokenCredential
변수를 만듭니다.
TokenCredential credential = new DefaultAzureCredentialBuilder().build();
DocumentIntelligenceClient documentIntelligenceClient = new DocumentIntelligenceClientBuilder()
.endpoint("{your-endpoint}")
.credential(credential)
.buildClient();
자세한 내용은 인증 을 참조하세요 .
JavaScript 애플리케이션용 DefaultAzureCredential 을 획득하고 사용하는 방법은 다음과 같습니다.
JavaScript용 Azure ID 라이브러리 를 설치합니다.
npm install @azure/identity
Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다 .
서비스 주체에 Cognitive Services User
역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.
Microsoft Entra 애플리케이션의 클라이언트 ID, 테넌트 ID 및 클라이언트 암호 값을 각각 환경 변수AZURE_CLIENT_ID
, AZURE_TENANT_ID
및 AZURE_CLIENT_SECRET
으로 설정합니다.
DefaultAzureCredential
을 포함하여 DocumentIntelligenceClient
인스턴스를 만듭니다.
const { DocumentIntelligenceClient } = require("@azure-rest/ai-document-intelligence@1.0.0-beta.2");
const { DefaultAzureCredential } = require("@azure/identity");
const client = new DocumentIntelligenceClient("<your-endpoint>", new DefaultAzureCredential());
자세한 내용은 클라이언트 만들기 및 인증 을 참조하세요 .
Python 애플리케이션용 DefaultAzureCredential 을 획득하고 사용하는 방법은 다음과 같습니다.
Python용 Azure ID 라이브러리 를 설치합니다.
pip install azure-identity
Microsoft Entra 애플리케이션을 등록하고 새 서비스 주체를 만듭니다 .
서비스 주체에 Cognitive Services User
역할을 할당하여 문서 인텔리전스에 대한 액세스 권한을 부여하세요.
Microsoft Entra 애플리케이션의 클라이언트 ID, 테넌트 ID 및 클라이언트 암호 값을 각각 환경 변수AZURE_CLIENT_ID
, AZURE_TENANT_ID
및 AZURE_CLIENT_SECRET
으로 설정합니다.
DefaultAzureCredential
을 포함하여 DocumentIntelligenceClient
인스턴스를 만듭니다.
from azure.identity import DefaultAzureCredential
from azure.ai.documentintelligence import DocumentIntelligenceClient
credential = DefaultAzureCredential()
client = DocumentIntelligenceClient(
endpoint="<your-endpoint>",
credential=credential
)
자세한 내용은 클라이언트 인증 을 참조하세요 .
4. 애플리케이션 빌드
문서 인텔리전스 SDK와 상호 작용할 클라이언트 개체를 만든 다음 해당 클라이언트 개체에 대한 메서드를 호출하여 서비스와 상호 작용합니다. SDK는 동기 메서드와 비동기 메서드를 모두 제공합니다. 더 많은 인사이트를 얻으려면 원하는 언어의 빠른 시작 을 시도해 보세요.
도움말 옵션
Developer Community에서는 Microsoft Q&A
및 Stack Overflow 포럼에서 Azure AI 문서 인텔리전스 및 기타 서비스에 대해 질문하고 답변할 수 있습니다. Microsoft는 포럼을 모니터링하고 커뮤니티에서 아직 답변하지 않은 질문에 답변합니다. 질문을 볼 수 있도록 다음 태그를 사용하세요.
다음 단계