DocumentAnalysisClient class

Creare un'istanza DocumentAnalysisClient da un endpoint della risorsa e una chiave API statica (KeyCredential),

Esempio:

import { DocumentAnalysisClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new AzureKeyCredential("<api key>");

const client = new DocumentAnalysisClient(endpoint, credential);

new DocumentAnalysisClient(endpoint: string, credential: KeyCredential, options?: DocumentAnalysisClientOptions)

Parametri

Creare un'istanza DocumentAnalysisClient da un endpoint della risorsa e un'identità TokenCredentialdi Azure.

Per altre informazioni sull'autenticazione con Azure Active Directory, vedere il @azure/identity pacchetto.

Esempio:

import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { DefaultAzureCredential } from "@azure/identity";

const endpoint = "https://<resource name>.cognitiveservices.azure.com";
const credential = new DefaultAzureCredential();

const client = new DocumentAnalysisClient(endpoint, credential);

new DocumentAnalysisClient(endpoint: string, credential: TokenCredential, options?: DocumentAnalysisClientOptions)

Parametri

Estrarre dati da un input usando un modello specificato dall'ID univoco.

Questa operazione supporta modelli personalizzati e predefiniti. Ad esempio, per usare il modello di fattura predefinito, specificare l'ID modello "precompilt-invoice" o per usare il modello di layout predefinito più semplice, specificare l'ID modello "precompilt-layout".

I campi prodotti nell'oggetto dipendono dal modello utilizzato per l'analisi AnalyzeResult e i valori nei campi dei documenti estratti dipendono dai tipi di documento nel modello (se presenti) e dai relativi schemi di campo.

Esempio

Questo metodo supporta corpi di richiesta trasmessi (FormRecognizerRequestBody), ad esempio oggetti Node.JS ReadableStream , browser Blobe ArrayBuffers. Il contenuto del corpo verrà caricato nel servizio per l'analisi.

import * as fs from "fs";

const file = fs.createReadStream("path/to/receipt.pdf");

// The model that is passed to the following function call determines the type of the eventual result. In the
// example, we will use the prebuilt receipt model, but you could use a custom model ID/name instead.
const poller = await client.beginAnalyzeDocument("prebuilt-receipt", file);

// The result is a long-running operation (poller), which must itself be polled until the operation completes
const {
  pages, // pages extracted from the document, which contain lines and words
  tables, // extracted tables, organized into cells that contain their contents
  styles, // text styles (ex. handwriting) that were observed in the document
  keyValuePairs, // extracted pairs of elements  (directed associations from one element in the input to another)
  entities, // extracted entities in the input's content, which are categorized (ex. "Location" or "Organization")
  documents // extracted documents (instances of one of the model's document types and its field schema)
} = await poller.pollUntilDone();

// Extract the fields of the first document. These fields constitute a receipt, because we used the receipt model
const [{ fields: receipt }] = documents;

// The fields correspond to the model's document types and their field schemas. Refer to the Form Recognizer
// documentation for information about the document types and field schemas within a model, or use the `getModel`
// operation to view this information programmatically.
console.log("The type of this receipt is:", receipt?.["ReceiptType"]?.value);

function beginAnalyzeDocument(modelId: string, document: FormRecognizerRequestBody, options?: AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>): Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

Parametri

Restituisce

un'operazione a esecuzione prolungata (poller) che alla fine produrrà un AnalyzeResult

Estrarre dati da un input usando un modello con uno schema di documento noto fortemente tipizzato ( DocumentModel).

I campi prodotti nell'oggetto dipendono dal modello utilizzato per l'analisi AnalyzeResult . In TypeScript, il tipo del risultato per questo overload del metodo viene dedotto dal tipo dell'input DocumentModel.

Esempio

Questo metodo supporta corpi di richiesta trasmessi (FormRecognizerRequestBody), ad esempio oggetti Node.JS ReadableStream , browser Blobe ArrayBuffers. Il contenuto del corpo verrà caricato nel servizio per l'analisi.

Se l'input fornito è una stringa, verrà considerato come URL per la posizione di un documento da analizzare. Per altre informazioni, vedere il metodo beginAnalyzeDocumentFromUrl . L'uso di questo metodo è preferibile quando si usano GLI URL e il supporto degli URL viene fornito solo in questo metodo per garantire la compatibilità con le versioni precedenti.

import * as fs from "fs";

// See the `prebuilt` folder in the SDK samples (http://aka.ms/azsdk/formrecognizer/js/samples) for examples of
// DocumentModels for known prebuilts.
import { PrebuiltReceiptModel } from "./prebuilt-receipt.ts";

const file = fs.createReadStream("path/to/receipt.pdf");

// The model that is passed to the following function call determines the type of the eventual result. In the
// example, we will use the prebuilt receipt model.
const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, file);

// The result is a long-running operation (poller), which must itself be polled until the operation completes
const {
  pages, // pages extracted from the document, which contain lines and words
  tables, // extracted tables, organized into cells that contain their contents
  styles, // text styles (ex. handwriting) that were observed in the document
  keyValuePairs, // extracted pairs of elements  (directed associations from one element in the input to another)

  documents // extracted documents (instances of one of the model's document types and its field schema)
} = await poller.pollUntilDone();

// Extract the fields of the first document. These fields constitute a receipt, because we used the receipt model
const [{ fields: receipt }] = documents;

// Since we used the strongly-typed PrebuiltReceiptModel object instead of the "prebuilt-receipt" model ID
// string, the fields of the receipt are strongly-typed and have camelCase names (as opposed to PascalCase).
console.log("The type of this receipt is:", receipt.receiptType?.value);

function beginAnalyzeDocument<Result>(model: DocumentModel<Result>, document: FormRecognizerRequestBody, options?: AnalyzeDocumentOptions<Result>): Promise<AnalysisPoller<Result>>

Parametri

Restituisce

operazione a esecuzione prolungata (poller) che genererà alla fine un AnalyzeResult oggetto con documenti con il tipo di risultato associato al modello di input

Estrarre dati da un input usando un modello specificato dall'ID univoco.

Questa operazione supporta modelli personalizzati e predefiniti. Ad esempio, per usare il modello di fattura predefinito, specificare l'ID modello "precompilt-invoice" o per usare il modello di layout predefinito più semplice, specificare l'ID modello "precompilt-layout".

I campi prodotti nell'oggetto dipendono dal modello utilizzato per l'analisi AnalyzeResult e i valori nei campi dei documenti estratti dipendono dai tipi di documento nel modello (se presenti) e dai relativi schemi di campo.

Esempio

Questo metodo supporta l'estrazione di dati da un file in un determinato URL. Il servizio Riconoscimento modulo tenterà di scaricare un file usando l'URL inviato, quindi l'URL deve essere accessibile dalla rete Internet pubblica. Ad esempio, è possibile usare un token di firma di accesso condiviso per concedere l'accesso in lettura a un BLOB in Archiviazione di Azure e il servizio userà l'URL con codifica sas per richiedere il file.

// the URL must be publicly accessible
const url = "<receipt document url>";

// The model that is passed to the following function call determines the type of the eventual result. In the
// example, we will use the prebuilt receipt model, but you could use a custom model ID/name instead.
const poller = await client.beginAnalyzeDocument("prebuilt-receipt", url);

// The result is a long-running operation (poller), which must itself be polled until the operation completes
const {
  pages, // pages extracted from the document, which contain lines and words
  tables, // extracted tables, organized into cells that contain their contents
  styles, // text styles (ex. handwriting) that were observed in the document
  keyValuePairs, // extracted pairs of elements  (directed associations from one element in the input to another)

  documents // extracted documents (instances of one of the model's document types and its field schema)
} = await poller.pollUntilDone();

// Extract the fields of the first document. These fields constitute a receipt, because we used the receipt model
const [{ fields: receipt }] = documents;

// The fields correspond to the model's document types and their field schemas. Refer to the Form Recognizer
// documentation for information about the document types and field schemas within a model, or use the `getModel`
// operation to view this information programmatically.
console.log("The type of this receipt is:", receipt?.["ReceiptType"]?.value);

function beginAnalyzeDocumentFromUrl(modelId: string, documentUrl: string, options?: AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>): Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

Parametri

Restituisce

un'operazione a esecuzione prolungata (poller) che alla fine produrrà un AnalyzeResult

Estrarre dati da un input usando un modello con uno schema di documento noto fortemente tipizzato ( DocumentModel).

I campi prodotti nell'oggetto dipendono dal modello utilizzato per l'analisi AnalyzeResult . In TypeScript, il tipo del risultato per questo overload del metodo viene dedotto dal tipo dell'input DocumentModel.

Esempio

Questo metodo supporta l'estrazione di dati da un file in un determinato URL. Il servizio Riconoscimento modulo tenterà di scaricare un file usando l'URL inviato, quindi l'URL deve essere accessibile dalla rete Internet pubblica. Ad esempio, è possibile usare un token di firma di accesso condiviso per concedere l'accesso in lettura a un BLOB in Archiviazione di Azure e il servizio userà l'URL con codifica sas per richiedere il file.

// See the `prebuilt` folder in the SDK samples (http://aka.ms/azsdk/formrecognizer/js/samples) for examples of
// DocumentModels for known prebuilts.
import { PrebuiltReceiptModel } from "./prebuilt-receipt.ts";

// the URL must be publicly accessible
const url = "<receipt document url>";

// The model that is passed to the following function call determines the type of the eventual result. In the
// example, we will use the prebuilt receipt model.
const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, url);

// The result is a long-running operation (poller), which must itself be polled until the operation completes
const {
  pages, // pages extracted from the document, which contain lines and words
  tables, // extracted tables, organized into cells that contain their contents
  styles, // text styles (ex. handwriting) that were observed in the document
  keyValuePairs, // extracted pairs of elements  (directed associations from one element in the input to another)

  documents // extracted documents (instances of one of the model's document types and its field schema)
} = await poller.pollUntilDone();

// Extract the fields of the first document. These fields constitute a receipt, because we used the receipt model
const [{ fields: receipt }] = documents;

// Since we used the strongly-typed PrebuiltReceiptModel object instead of the "prebuilt-receipt" model ID
// string, the fields of the receipt are strongly-typed and have camelCase names (as opposed to PascalCase).
console.log("The type of this receipt is:", receipt.receiptType?.value);

function beginAnalyzeDocumentFromUrl<Result>(model: DocumentModel<Result>, documentUrl: string, options?: AnalyzeDocumentOptions<Result>): Promise<AnalysisPoller<Result>>

Parametri

Restituisce

un'operazione a esecuzione prolungata (poller) che alla fine produrrà un AnalyzeResult

Classificare un documento usando un classificatore personalizzato specificato dal relativo ID.

Questo metodo produce un'operazione a esecuzione prolungata (poller) che genererà infine un oggetto AnalyzeResult. Si tratta dello stesso tipo di beginAnalyzeDocument e beginAnalyzeDocumentFromUrl, ma il risultato conterrà solo un piccolo subset dei relativi campi. Verrà popolato solo il campo e pages il documents campo e verranno restituite solo informazioni minime sulla pagina. Il documents campo conterrà informazioni su tutti i documenti identificati e sull'oggetto docType classificato come .

Esempio

Questo metodo supporta corpi di richiesta trasmessi (FormRecognizerRequestBody), ad esempio oggetti Node.JS ReadableStream , browser Blobe ArrayBuffers. Il contenuto del corpo verrà caricato nel servizio per l'analisi.

import * as fs from "fs";

const file = fs.createReadStream("path/to/file.pdf");

const poller = await client.beginClassifyDocument("<classifier ID>", file);

// The result is a long-running operation (poller), which must itself be polled until the operation completes
const {
  pages, // pages extracted from the document, which contain only basic information for classifiers
  documents // extracted documents and their types
} = await poller.pollUntilDone();

// We'll print the documents and their types
for (const { docType } of documents) {
  console.log("The type of this document is:", docType);
}

function beginClassifyDocument(classifierId: string, document: FormRecognizerRequestBody, options?: ClassifyDocumentOptions): Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

Parametri

Restituisce

un'operazione a esecuzione prolungata (poller) che alla fine produrrà un AnalyzeResult

Classificare un documento da un URL usando un classificatore personalizzato specificato dal relativo ID.

Questo metodo produce un'operazione a esecuzione prolungata (poller) che genererà infine un oggetto AnalyzeResult. Si tratta dello stesso tipo di beginAnalyzeDocument e beginAnalyzeDocumentFromUrl, ma il risultato conterrà solo un piccolo subset dei relativi campi. Verrà popolato solo il campo e pages il documents campo e verranno restituite solo informazioni minime sulla pagina. Il documents campo conterrà informazioni su tutti i documenti identificati e sull'oggetto docType classificato come .

Esempio

Questo metodo supporta l'estrazione di dati da un file in un determinato URL. Il servizio Riconoscimento modulo tenterà di scaricare un file usando l'URL inviato, quindi l'URL deve essere accessibile dalla rete Internet pubblica. Ad esempio, è possibile usare un token di firma di accesso condiviso per concedere l'accesso in lettura a un BLOB in Archiviazione di Azure e il servizio userà l'URL con codifica sas per richiedere il file.

// the URL must be publicly accessible
const url = "<file url>";

const poller = await client.beginClassifyDocument("<classifier ID>", url);

// The result is a long-running operation (poller), which must itself be polled until the operation completes
const {
  pages, // pages extracted from the document, which contain only basic information for classifiers
  documents // extracted documents and their types
} = await poller.pollUntilDone();

// We'll print the documents and their types
for (const { docType } of documents) {
  console.log("The type of this document is:", docType);
}

function beginClassifyDocumentFromUrl(classifierId: string, documentUrl: string, options?: ClassifyDocumentOptions): Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

Parametri

Restituisce