Biblioteca de cliente REST do Azure DocumentIntelligence (anteriormente FormRecognizer) para JavaScript - versão 1.0.0-beta.2

Extrai conteúdo, esquema e dados estruturados de documentos.

Confie fortemente nos nossos documentos de cliente REST para utilizar esta biblioteca

NOTA: Reconhecedor de Formulários foi renomeado para Document Intelligence. Verifique o Guia de Migração de @azure/ai-form-recognizer para @azure-rest/ai-document-intelligence.

Ligações principais:

• Código fonte
• Pacote (NPM)
• Documentação de referência da API
• Amostras
• Registo de alterações
• Guia de Migração do Reconhecedor de Formulários

Esta versão da biblioteca de cliente é predefinida para a "2024-02-29-preview" versão do serviço.

Esta tabela mostra a relação entre as versões do SDK e as versões de API suportadas do serviço:

Confie na biblioteca mais antiga @azure/ai-form-recognizer através das versões mais antigas da API de serviço para modelos descontinuados, como "prebuilt-businessCard" e "prebuilt-document". Para obter mais informações, veja Registo de alterações.

A tabela abaixo descreve a relação de cada cliente e as respetivas versões de API suportadas:

Introdução

Ambientes atualmente suportados

• Versões LTS do Node.js

Pré-requisitos

• Tem de ter uma subscrição do Azure para utilizar este pacote.

Instalar o pacote @azure-rest/ai-document-intelligence

Instale a biblioteca de cliente REST do cliente REST do Azure DocumentIntelligence(anteriormenteFormRecognizer) para JavaScript com npm:

npm install @azure-rest/ai-document-intelligence

Criar e autenticar um DocumentIntelligenceClient

Para utilizar uma credencial de token do Azure Active Directory (AAD), forneça uma instância do tipo de credencial pretendido obtido a partir da biblioteca de identidades/@azure .

Para autenticar com o AAD, primeiro tem de npm instalar @azure/identity

Após a configuração, pode escolher o tipo de credencial a utilizar @azure/identity . Por exemplo, DefaultAzureCredential pode ser utilizado para autenticar o cliente.

Defina os valores do ID do cliente, do ID do inquilino e do segredo do cliente da aplicação do AAD como variáveis de ambiente: AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET

Utilizar uma Credencial de Token

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

const client = DocumentIntelligence(
  process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"],
  new DefaultAzureCredential()
);

Utilizar uma CHAVE de API

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

const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"], {
  key: process.env["DOCUMENT_INTELLIGENCE_API_KEY"],
});

Modelos de Documentos

Analisar o esquema pré-criado (urlSource)

const initialResponse = await client
  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
  .post({
    contentType: "application/json",
    body: {
      urlSource:
        "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/6704eff082aaaf2d97c1371a28461f512f8d748a/sdk/formrecognizer/ai-form-recognizer/assets/forms/Invoice_1.pdf",
    },
    queryParameters: { locale: "en-IN" },
  });

Analisar esquema pré-criado (base64Source)

import fs from "fs";
import path from "path";

const filePath = path.join(ASSET_PATH, "forms", "Invoice_1.pdf");
const base64Source = fs.readFileSync(filePath, { encoding: "base64" });
const initialResponse = await client
  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
  .post({
    contentType: "application/json",
    body: {
      base64Source,
    },
    queryParameters: { locale: "en-IN" },
  });

Continuar a criar o poller a partir da resposta inicial

import {
  getLongRunningPoller,
  AnalyzeResultOperationOutput,
  isUnexpected,
} from "@azure-rest/ai-document-intelligence";

if (isUnexpected(initialResponse)) {
  throw initialResponse.body.error;
}
const poller = await getLongRunningPoller(client, initialResponse);
const result = (await poller.pollUntilDone()).body as AnalyzeResultOperationOutput;
console.log(result);
// {
//   status: 'succeeded',
//   createdDateTime: '2023-11-10T13:31:31Z',
//   lastUpdatedDateTime: '2023-11-10T13:31:34Z',
//   analyzeResult: {
//     apiVersion: '2023-10-31-preview',
//     .
//     .
//     .
//     contentFormat: 'text'
//   }
// }

Formato de conteúdo markdown

Suporta a saída com o formato de conteúdo Markdown juntamente com o texto simples predefinido. Por enquanto, isto só é suportado para "esquema pré-criado". O formato de conteúdo markdown é considerado um formato mais amigável para o consumo de LLM num cenário de utilização de chat ou automatização.

O serviço segue a especificação GFM (GitHub Flavored Markdown) para o formato Markdown. Também introduz uma nova propriedade contentFormat com o valor "texto" ou "markdown" para indicar o formato de conteúdo do resultado.

import DocumentIntelligence from "@azure-rest/ai-document-intelligence";
const client = DocumentIntelligence(process.env["DOCUMENT_INTELLIGENCE_ENDPOINT"], {
  key: process.env["DOCUMENT_INTELLIGENCE_API_KEY"],
});

const initialResponse = await client
  .path("/documentModels/{modelId}:analyze", "prebuilt-layout")
  .post({
    contentType: "application/json",
    body: {
      urlSource:
        "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/6704eff082aaaf2d97c1371a28461f512f8d748a/sdk/formrecognizer/ai-form-recognizer/assets/forms/Invoice_1.pdf",
    },
    queryParameters: { outputContentFormat: "markdown" }, // <-- new query parameter
  });

Campos de Consulta

Quando este sinalizador de funcionalidade é especificado, o serviço extrairá ainda mais os valores dos campos especificados através do parâmetro de consulta queryFields para complementar todos os campos existentes definidos pelo modelo como contingência.

await client.path("/documentModels/{modelId}:analyze", "prebuilt-layout").post({
  contentType: "application/json",
  body: { urlSource: "..." },
  queryParameters: {
    features: ["queryFields"],
    queryFields: ["NumberOfGuests", "StoreNumber"],
  }, // <-- new query parameter
});

Opções de Divisão

Nas versões anteriores da API suportadas pela biblioteca mais antiga @azure/ai-form-recognizer , a operação de divisão e classificação de documentos ("/documentClassifiers/{classifierId}:analyze") sempre tentou dividir o ficheiro de entrada em vários documentos.

Para ativar um conjunto mais amplo de cenários, o serviço introduz um parâmetro de consulta "split" com a nova versão do serviço "2023-10-31-preview". São suportados os seguintes valores:

• split: "auto"

  Permitir que o serviço determine onde dividir.

• split: "none"

  Todo o ficheiro é tratado como um único documento. Não é efetuada nenhuma divisão.

• split: "perPage"

  Cada página é tratada como um documento separado. Cada página vazia é mantida como o seu próprio documento.

Classificadores de Documentos #Build

import {
  DocumentClassifierBuildOperationDetailsOutput,
  getLongRunningPoller,
  isUnexpected,
} from "@azure-rest/ai-document-intelligence";

const containerSasUrl = (): string =>
  process.env["DOCUMENT_INTELLIGENCE_TRAINING_CONTAINER_SAS_URL"];
const initialResponse = await client.path("/documentClassifiers:build").post({
  body: {
    classifierId: `customClassifier${getRandomNumber()}`,
    description: "Custom classifier description",
    docTypes: {
      foo: {
        azureBlobSource: {
          containerUrl: containerSasUrl(),
        },
      },
      bar: {
        azureBlobSource: {
          containerUrl: containerSasUrl(),
        },
      },
    },
  },
});

if (isUnexpected(initialResponse)) {
  throw initialResponse.body.error;
}
const poller = await getLongRunningPoller(client, initialResponse);
const response = (await poller.pollUntilDone())
  .body as DocumentClassifierBuildOperationDetailsOutput;
console.log(response);
//  {
//    operationId: '31466834048_f3ee629e-73fb-48ab-993b-1d55d73ca460',
//    kind: 'documentClassifierBuild',
//    status: 'succeeded',
//    .
//    .
//    result: {
//      classifierId: 'customClassifier10978',
//      createdDateTime: '2023-11-09T12:45:56Z',
//      .
//      .
//      description: 'Custom classifier description'
//    },
//    apiVersion: '2023-10-31-preview'
//  }

Obter Informações

const response = await client.path("/info").get();
if (isUnexpected(response)) {
  throw response.body.error;
}
console.log(response.body.customDocumentModels.limit);
// 20000

Listar Modelos de Documentos

import { paginate } from "@azure-rest/ai-document-intelligence";
const response = await client.path("/documentModels").get();
if (isUnexpected(response)) {
  throw response.body.error;
}

const modelsInAccount: string[] = [];
for await (const model of paginate(client, response)) {
  console.log(model.modelId);
}

Resolução de problemas

Registo

Ativar o registo pode ajudar a descobrir informações úteis sobre falhas. Para ver um registo de pedidos HTTP e respostas, defina a variável de AZURE_LOG_LEVEL ambiente como info. Em alternativa, o registo pode ser ativado no runtime ao chamar setLogLevel no @azure/logger:

const { setLogLevel } = require("@azure/logger");

setLogLevel("info");

Para obter instruções mais detalhadas sobre como ativar registos, pode ver os documentos do pacote de @azure/logger.