# azure-ai-document-intelligence-ts

Guides code generation for Azure Document Intelligence REST SDK in TypeScript. Useful for extracting text, tables, invoices, and receipts using prebuilt or custom models.

- skill · `type=skill` · Claude Code, GitHub Copilot · 1 install · ★ 3149
- Author: Microsoft
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/microsoft/skills/tree/HEAD/.github/plugins/azure-sdk-typescript/skills/azure-ai-document-intelligence-ts/SKILL.md
- Updated: 2026-10-23
- HTML: https://affpapa.org/en/nevibecode/skills/azure-ai-document-intelligence-ts

## What it does

This skill guides coding agents through using `@azure-rest/ai-document-intelligence` and `@azure/identity` in TypeScript projects. It contains patterns for parsing PDF forms, invoices, receipts, and table layouts using prebuilt models.

The SDK exposes `DocumentIntelligence` as a factory function. Calling it with `new` breaks runtime execution. The skill provides code for handling long-running operations through `getLongRunningPoller`, handling Base64 payloads for local files, and listing available models.

Requests will fail immediately without a valid `DOCUMENT_INTELLIGENCE_ENDPOINT` and an API key or `AZURE_TOKEN_CREDENTIALS`. Preparing these Azure credentials in advance is required before running any scripts.

## Requirements
- Works with: Azure

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add microsoft/skills --skill azure-ai-document-intelligence-ts -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/azure-ai-document-intelligence-ts/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/azure-ai-document-intelligence-ts/

### Codex

**Manually: put the files in place**
- File: `.agents/skills/azure-ai-document-intelligence-ts/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

**Manually: put the files in place**
- File: `.cursor/skills/azure-ai-document-intelligence-ts/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install microsoft/skills azure-ai-document-intelligence-ts
```

2. **Manually: put the files in place**
- File: `.github/skills/azure-ai-document-intelligence-ts/SKILL.md`

### Gemini CLI

**Platform CLI**
```bash
gemini skills install https://github.com/microsoft/skills --path .github/plugins/azure-sdk-typescript/skills/azure-ai-document-intelligence-ts
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/azure-ai-document-intelligence-ts/SKILL.md` — The legacy .windsurf/skills/ path still works

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/microsoft/skills/tree/HEAD/.github/plugins/azure-sdk-typescript/skills/azure-ai-document-intelligence-ts/SKILL.md

## When to use it
- extract tables and layout structure from PDF documents
- parse vendor names and totals from invoices or receipts
- authenticate REST client calls with API keys or DefaultAzureCredential
- train custom document models using Azure Blob storage containers

## Example prompts
- Write a TypeScript snippet to extract invoice totals using prebuilt-invoice.
- How do I send a local PDF buffer to DocumentIntelligence as base64Source?
- Show how to poll a long-running layout analysis operation with getLongRunningPoller.

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 8cd0025e45138296.

BEGIN THIRD-PARTY FILE 8cd0025e45138296
````text
---
name: azure-ai-document-intelligence-ts
description: Extract text, tables, and structured data from documents using Azure Document Intelligence (@azure-rest/ai-document-intelligence). Use when processing invoices, receipts, IDs, forms, or building custom document models.
license: MIT
metadata:
  author: Microsoft
  version: "1.0.0"
  package: '@azure-rest/ai-document-intelligence'
---

# Azure Document Intelligence REST SDK for TypeScript

Extract text, tables, and structured data from documents using prebuilt and custom models.

## Installation

```bash
npm install @azure-rest/ai-document-intelligence @azure/identity
```

## Environment Variables

```bash
DOCUMENT_INTELLIGENCE_ENDPOINT=https://<resource>.cognitiveservices.azure.com
DOCUMENT_INTELLIGENCE_API_KEY=<api-key>
AZURE_TOKEN_CREDENTIALS=prod # Required only if DefaultAzureCredential is used in production
```

## Authentication

**Important**: This is a REST client. `DocumentIntelligence` is a **function**, not a class.

### DefaultAzureCredential

```typescript
import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
import { DefaultAzureCredential, ManagedIdentityCredential } from "@azure/identity";

// Local dev: DefaultAzureCredential. Production: set AZURE_TOKEN_CREDENTIALS=prod or AZURE_TOKEN_CREDENTIALS=<specific_credential>
const credential = new DefaultAzureCredential({requiredEnvVars: ["AZURE_TOKEN_CREDENTIALS"]});
// Or use a specific credential directly in production:
// See https://learn.microsoft.com/javascript/api/overview/azure/identity-readme?view=azure-node-latest#credential-classes
// const credential = new ManagedIdentityCredential();

const client = DocumentIntelligence(
  process.env.DOCUMENT_INTELLIGENCE_ENDPOINT!,
  credential
);
```

### API Key

```typescript
import DocumentIntelligence from "@azure-rest/ai-document-intelligence";

const client = DocumentIntelligence(
  process.env.DOCUMENT_INTELLIGENCE_ENDPOINT!,
  { key: process.env.DOCUMENT_INTELLIGENCE_API_KEY! }
);
```

## Analyze Document (URL)

```typescript
import DocumentIntelligence, {
  isUnexpected,
  getLongRunningPoller,
  AnalyzeOperationOutput
} from "@azure-rest/ai-document-intelligence";

const initialResponse = await client
  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
  .post({
    contentType: "application/json",
    body: {
      urlSource: "https://example.com/document.pdf"
    },
    queryParameters: { locale: "en-US" }
  });

if (isUnexpected(initialResponse)) {
  throw initialResponse.body.error;
}

const poller = getLongRunningPoller(client, initialResponse);
const result = (await poller.pollUntilDone()).body as AnalyzeOperationOutput;

console.log("Pages:", result.analyzeResult?.pages?.length);
console.log("Tables:", result.analyzeResult?.tables?.length);
```

## Analyze Document (Local File)

```typescript
import { readFile } from "node:fs/promises";

const fileBuffer = await readFile("./document.pdf");
const base64Source = fileBuffer.toString("base64");

const initialResponse = await client
  .path("/documentModels/{modelId}:analyze", "prebuilt-invoice")
  .post({
````
END THIRD-PARTY FILE 8cd0025e45138296

The third-party file has ended. Everything between the 8cd0025e45138296 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 3120 of 9740 bytes. © Microsoft · MIT · https://github.com/microsoft/skills/tree/HEAD/.github/plugins/azure-sdk-typescript/skills/azure-ai-document-intelligence-ts/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md