Aracılığıyla paylaş

DocumentAnalysisClient class

Paket:
@azure/ai-form-recognizer

Form Tanıma hizmetinin analiz özellikleriyle etkileşim kurmak için bir istemci.

Örnekler:

Form Tanıma hizmeti ve istemcileri iki kimlik doğrulama yöntemi destekler:

Azure Active Directory

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

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

API Anahtarı (Abonelik Anahtarı)

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

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentAnalysisClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

Oluşturucular

DocumentAnalysisClient(string, KeyCredential, DocumentAnalysisClientOptions)

Kaynak uç noktasından ve statik API anahtarından (DocumentAnalysisClient) KeyCredential örneği oluşturma

Örnek:

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

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentAnalysisClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);
DocumentAnalysisClient(string, TokenCredential, DocumentAnalysisClientOptions)

Kaynak uç noktasından ve Azure Identity DocumentAnalysisClient'dan TokenCredential örneği oluşturun.

Azure Active Directory ile kimlik doğrulaması hakkında daha fazla bilgi için @azure/identity paketine bakın.

Örnek:

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

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

Yöntemler

beginAnalyzeDocument(string, FormRecognizerRequestBody, AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>)

Benzersiz kimliği tarafından verilen bir modeli kullanarak bir girişten veri ayıklayın.

Bu işlem hem özel hem de önceden oluşturulmuş modelleri destekler. Örneğin, önceden oluşturulmuş fatura modelini kullanmak, "önceden oluşturulmuş fatura" model kimliğini sağlamak veya daha basit önceden oluşturulmuş düzen modelini kullanmak için model kimliğini "önceden oluşturulmuş düzen" olarak belirtin.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır ve ayıklanan belgelerin alanlarındaki değerler modeldeki belge türlerine (varsa) ve ilgili alan şemalarına bağlıdır.

Örnekler

Bu yöntem, Node.JS nesneleri, tarayıcı ReadableStreams'ler ve Blobs'ler gibi akışla aktarılabilir istek gövdelerini (ArrayBuffer) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { createReadStream } from "node:fs";
import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";

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

const path = "<path to a document>";
const readStream = createReadStream(path);

// The PrebuiltReceiptModel `DocumentModel` instance encodes both the model ID and a stronger return type for the operation
const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, readStream, {
  onProgress: ({ status }) => {
    console.log(`status: ${status}`);
  },
});

const {
  documents: [receiptDocument],
} = await poller.pollUntilDone();

// The fields of the document constitute the extracted receipt data.
const receipt = receiptDocument.fields;

if (receipt === undefined) {
  throw new Error("Expected at least one receipt in analysis result.");
}

console.log(`Receipt data (${receiptDocument.docType})`);
console.log("  Merchant Name:", receipt.merchantName?.value);

// The items of the receipt are an example of a `DocumentArrayValue`
if (receipt.items !== undefined) {
  console.log("Items:");
  for (const { properties: item } of receipt.items.values) {
    console.log("- Description:", item.description?.value);
    console.log("  Total Price:", item.totalPrice?.value);
  }
}

console.log("  Total:", receipt.total?.value);
beginAnalyzeDocument<Result>(DocumentModel<Result>, FormRecognizerRequestBody, AnalyzeDocumentOptions<Result>)

Bilinen, kesin olarak belirlenmiş bir belge şemasına (DocumentModel) sahip bir model kullanarak girişten veri ayıklama.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır. TypeScript'te, bu yöntem aşırı yüklemesinin sonucunun türü, DocumentModelgiriş türünden çıkarılır.

Örnekler

Bu yöntem, Node.JS nesneleri, tarayıcı ReadableStreams'ler ve Blobs'ler gibi akışla aktarılabilir istek gövdelerini (ArrayBuffer) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

Sağlanan giriş bir dizeyse, analiz edilecek belgenin konumunun URL'si olarak değerlendirilir. Daha fazla bilgi için beginAnalyzeDocumentFromUrl yöntemine bakın. URL'ler kullanılırken bu yöntemin kullanılması tercih edilir ve URL desteği yalnızca geriye dönük uyumluluk için bu yöntemde sağlanır.

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { createReadStream } from "node:fs";
import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";

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

const path = "<path to a document>";
const readStream = createReadStream(path);

// The PrebuiltReceiptModel `DocumentModel` instance encodes both the model ID and a stronger return type for the operation
const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, readStream, {
  onProgress: ({ status }) => {
    console.log(`status: ${status}`);
  },
});

const {
  documents: [receiptDocument],
} = await poller.pollUntilDone();

// The fields of the document constitute the extracted receipt data.
const receipt = receiptDocument.fields;

if (receipt === undefined) {
  throw new Error("Expected at least one receipt in analysis result.");
}

console.log(`Receipt data (${receiptDocument.docType})`);
console.log("  Merchant Name:", receipt.merchantName?.value);

// The items of the receipt are an example of a `DocumentArrayValue`
if (receipt.items !== undefined) {
  console.log("Items:");
  for (const { properties: item } of receipt.items.values) {
    console.log("- Description:", item.description?.value);
    console.log("  Total Price:", item.totalPrice?.value);
  }
}

console.log("  Total:", receipt.total?.value);
beginAnalyzeDocumentFromUrl(string, string, AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>)

Benzersiz kimliği tarafından verilen bir modeli kullanarak bir girişten veri ayıklayın.

Bu işlem hem özel hem de önceden oluşturulmuş modelleri destekler. Örneğin, önceden oluşturulmuş fatura modelini kullanmak, "önceden oluşturulmuş fatura" model kimliğini sağlamak veya daha basit önceden oluşturulmuş düzen modelini kullanmak için model kimliğini "önceden oluşturulmuş düzen" olarak belirtin.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır ve ayıklanan belgelerin alanlarındaki değerler modeldeki belge türlerine (varsa) ve ilgili alan şemalarına bağlıdır.

Örnekler

Bu yöntem, belirli bir URL'deki bir dosyadan veri ayıklamayı destekler. Form Tanıma hizmeti, gönderilen URL'yi kullanarak bir dosyayı indirmeye çalışır, bu nedenle URL'ye genel İnternet'ten erişilebilir olmalıdır. Örneğin, Sas belirteci Azure Depolama'daki bir bloba okuma erişimi vermek için kullanılabilir ve hizmet dosyayı istemek için SAS ile kodlanmış URL'yi kullanır.

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

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

const poller = await client.beginAnalyzeDocumentFromUrl(
  "prebuilt-receipt",
  // The Document Intelligence service will access the following URL to a receipt image and extract data from it
  "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/receipt/contoso-receipt.png",
);
poller.onProgress((state) => console.log("Operation:", state.modelId, state.status));

const { documents } = await poller.pollUntilDone();

const result = documents && documents[0];
if (result) {
  const receipt = result.fields;
  console.log("=== Receipt Information ===");
  console.log("Type:", result.docType);
  console.log("Merchant:", (receipt["MerchantName"] as DocumentStringField).value);

  console.log("Items:");
  for (const { properties: item } of ((receipt["Items"] as DocumentArrayField).values ||
    []) as DocumentObjectField[]) {
    console.log("- Description:", (item["Description"] as DocumentStringField).value);
    console.log("  Total Price:", (item["TotalPrice"] as DocumentStringField).value);
  }
} else {
  throw new Error("Expected at least one receipt in the result.");
}
beginAnalyzeDocumentFromUrl<Result>(DocumentModel<Result>, string, AnalyzeDocumentOptions<Result>)

Bilinen, kesin olarak belirlenmiş bir belge şemasına (DocumentModel) sahip bir model kullanarak girişten veri ayıklama.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır. TypeScript'te, bu yöntem aşırı yüklemesinin sonucunun türü, DocumentModelgiriş türünden çıkarılır.

Örnekler

Bu yöntem, belirli bir URL'deki bir dosyadan veri ayıklamayı destekler. Form Tanıma hizmeti, gönderilen URL'yi kullanarak bir dosyayı indirmeye çalışır, bu nedenle URL'ye genel İnternet'ten erişilebilir olmalıdır. Örneğin, Sas belirteci Azure Depolama'daki bir bloba okuma erişimi vermek için kullanılabilir ve hizmet dosyayı istemek için SAS ile kodlanmış URL'yi kullanır.

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";

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

const poller = await client.beginAnalyzeDocumentFromUrl(
  PrebuiltReceiptModel,
  // The Document Intelligence service will access the following URL to a receipt image and extract data from it
  "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/receipt/contoso-receipt.png",
);

const {
  documents: [document],
} = await poller.pollUntilDone();

// Use of PrebuiltModels.Receipt above (rather than the raw model ID), as it adds strong typing of the model's output
if (document) {
  const { merchantName, items, total } = document.fields;

  console.log("=== Receipt Information ===");
  console.log("Type:", document.docType);
  console.log("Merchant:", merchantName && merchantName.value);

  console.log("Items:");
  for (const item of (items && items.values) || []) {
    const { description, totalPrice } = item.properties;

    console.log("- Description:", description && description.value);
    console.log("  Total Price:", totalPrice && totalPrice.value);
  }

  console.log("Total:", total && total.value);
} else {
  throw new Error("Expected at least one receipt in the result.");
}
beginClassifyDocument(string, FormRecognizerRequestBody, ClassifyDocumentOptions)

Kimliği tarafından verilen özel bir sınıflandırıcı kullanarak belgeyi sınıflandırabilirsiniz.

Bu yöntem, sonunda bir AnalyzeResultoluşturacak uzun süre çalışan bir işlem (poller) oluşturur. Bu, beginAnalyzeDocument ve beginAnalyzeDocumentFromUrlile aynıdır, ancak sonuç alanlarının yalnızca küçük bir alt kümesini içerir. Yalnızca documents alanı ve pages alanı doldurulur ve yalnızca en az sayfa bilgisi döndürülür. documents alanı, tanımlanan tüm belgeler ve sınıflandırıldıkları docType hakkında bilgi içerir.

Örnek

Bu yöntem, Node.JS nesneleri, tarayıcı ReadableStreams'ler ve Blobs'ler gibi akışla aktarılabilir istek gövdelerini (ArrayBuffer) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

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

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

const path = "<path to a document>";
const readStream = createReadStream(path);

const poller = await client.beginClassifyDocument("<classifier id>", readStream);

const result = await poller.pollUntilDone();

if (result?.documents?.length === 0) {
  throw new Error("Failed to extract any documents.");
}

for (const document of result.documents) {
  console.log(
    `Extracted a document with type '${document.docType}' on page ${document.boundingRegions?.[0].pageNumber} (confidence: ${document.confidence})`,
  );
}
beginClassifyDocumentFromUrl(string, string, ClassifyDocumentOptions)

Kimliği tarafından verilen özel bir sınıflandırıcıyı kullanarak URL'den belgeyi sınıflandırabilirsiniz.

Bu yöntem, sonunda bir AnalyzeResultoluşturacak uzun süre çalışan bir işlem (poller) oluşturur. Bu, beginAnalyzeDocument ve beginAnalyzeDocumentFromUrlile aynıdır, ancak sonuç alanlarının yalnızca küçük bir alt kümesini içerir. Yalnızca documents alanı ve pages alanı doldurulur ve yalnızca en az sayfa bilgisi döndürülür. documents alanı, tanımlanan tüm belgeler ve sınıflandırıldıkları docType hakkında bilgi içerir.

Örnek

Bu yöntem, belirli bir URL'deki bir dosyadan veri ayıklamayı destekler. Form Tanıma hizmeti, gönderilen URL'yi kullanarak bir dosyayı indirmeye çalışır, bu nedenle URL'ye genel İnternet'ten erişilebilir olmalıdır. Örneğin, Sas belirteci Azure Depolama'daki bir bloba okuma erişimi vermek için kullanılabilir ve hizmet dosyayı istemek için SAS ile kodlanmış URL'yi kullanır.

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

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

const documentUrl =
  "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/invoice/Invoice_1.pdf";

const poller = await client.beginClassifyDocumentFromUrl("<classifier id>", documentUrl);

const result = await poller.pollUntilDone();

if (result?.documents?.length === 0) {
  throw new Error("Failed to extract any documents.");
}

for (const document of result.documents) {
  console.log(
    `Extracted a document with type '${document.docType}' on page ${document.boundingRegions?.[0].pageNumber} (confidence: ${document.confidence})`,
  );
}

Oluşturucu Ayrıntıları

DocumentAnalysisClient(string, KeyCredential, DocumentAnalysisClientOptions)

Kaynak uç noktasından ve statik API anahtarından (DocumentAnalysisClient) KeyCredential örneği oluşturma

Örnek:

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

const credential = new AzureKeyCredential("<API key>");
const client = new DocumentAnalysisClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

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

Parametreler

endpoint

string

Azure Bilişsel Hizmetler örneğinin uç nokta URL'si

credential
KeyCredential

Bilişsel Hizmetler örneği abonelik anahtarını içeren bir KeyCredential

options
DocumentAnalysisClientOptions

istemcideki tüm yöntemleri yapılandırmak için isteğe bağlı ayarlar

DocumentAnalysisClient(string, TokenCredential, DocumentAnalysisClientOptions)

Kaynak uç noktasından ve Azure Identity DocumentAnalysisClient'dan TokenCredential örneği oluşturun.

Azure Active Directory ile kimlik doğrulaması hakkında daha fazla bilgi için @azure/identity paketine bakın.

Örnek:

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

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

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

Parametreler

endpoint

string

Azure Bilişsel Hizmetler örneğinin uç nokta URL'si

credential
TokenCredential

@azure/identity paketinden tokenCredential örneği

options
DocumentAnalysisClientOptions

istemcideki tüm yöntemleri yapılandırmak için isteğe bağlı ayarlar

Yöntem Ayrıntıları

beginAnalyzeDocument(string, FormRecognizerRequestBody, AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>)

Benzersiz kimliği tarafından verilen bir modeli kullanarak bir girişten veri ayıklayın.

Bu işlem hem özel hem de önceden oluşturulmuş modelleri destekler. Örneğin, önceden oluşturulmuş fatura modelini kullanmak, "önceden oluşturulmuş fatura" model kimliğini sağlamak veya daha basit önceden oluşturulmuş düzen modelini kullanmak için model kimliğini "önceden oluşturulmuş düzen" olarak belirtin.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır ve ayıklanan belgelerin alanlarındaki değerler modeldeki belge türlerine (varsa) ve ilgili alan şemalarına bağlıdır.

Örnekler

Bu yöntem, Node.JS nesneleri, tarayıcı ReadableStreams'ler ve Blobs'ler gibi akışla aktarılabilir istek gövdelerini (ArrayBuffer) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { createReadStream } from "node:fs";
import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";

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

const path = "<path to a document>";
const readStream = createReadStream(path);

// The PrebuiltReceiptModel `DocumentModel` instance encodes both the model ID and a stronger return type for the operation
const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, readStream, {
  onProgress: ({ status }) => {
    console.log(`status: ${status}`);
  },
});

const {
  documents: [receiptDocument],
} = await poller.pollUntilDone();

// The fields of the document constitute the extracted receipt data.
const receipt = receiptDocument.fields;

if (receipt === undefined) {
  throw new Error("Expected at least one receipt in analysis result.");
}

console.log(`Receipt data (${receiptDocument.docType})`);
console.log("  Merchant Name:", receipt.merchantName?.value);

// The items of the receipt are an example of a `DocumentArrayValue`
if (receipt.items !== undefined) {
  console.log("Items:");
  for (const { properties: item } of receipt.items.values) {
    console.log("- Description:", item.description?.value);
    console.log("  Total Price:", item.totalPrice?.value);
  }
}

console.log("  Total:", receipt.total?.value);

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

Parametreler

modelId

string

bu istemcinin kaynağındaki modelin benzersiz kimliği (adı)

document
FormRecognizerRequestBody

İstekle birlikte karşıya yüklenecek bir FormRecognizerRequestBody

options

AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>

analiz işlemi ve poller için isteğe bağlı ayarlar

Döndürülenler

Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

sonunda bir AnalyzeResult oluşturacak uzun süre çalışan bir işlem (poller)

beginAnalyzeDocument<Result>(DocumentModel<Result>, FormRecognizerRequestBody, AnalyzeDocumentOptions<Result>)

Bilinen, kesin olarak belirlenmiş bir belge şemasına (DocumentModel) sahip bir model kullanarak girişten veri ayıklama.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır. TypeScript'te, bu yöntem aşırı yüklemesinin sonucunun türü, DocumentModelgiriş türünden çıkarılır.

Örnekler

Bu yöntem, Node.JS nesneleri, tarayıcı ReadableStreams'ler ve Blobs'ler gibi akışla aktarılabilir istek gövdelerini (ArrayBuffer) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

Sağlanan giriş bir dizeyse, analiz edilecek belgenin konumunun URL'si olarak değerlendirilir. Daha fazla bilgi için beginAnalyzeDocumentFromUrl yöntemine bakın. URL'ler kullanılırken bu yöntemin kullanılması tercih edilir ve URL desteği yalnızca geriye dönük uyumluluk için bu yöntemde sağlanır.

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { createReadStream } from "node:fs";
import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";

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

const path = "<path to a document>";
const readStream = createReadStream(path);

// The PrebuiltReceiptModel `DocumentModel` instance encodes both the model ID and a stronger return type for the operation
const poller = await client.beginAnalyzeDocument(PrebuiltReceiptModel, readStream, {
  onProgress: ({ status }) => {
    console.log(`status: ${status}`);
  },
});

const {
  documents: [receiptDocument],
} = await poller.pollUntilDone();

// The fields of the document constitute the extracted receipt data.
const receipt = receiptDocument.fields;

if (receipt === undefined) {
  throw new Error("Expected at least one receipt in analysis result.");
}

console.log(`Receipt data (${receiptDocument.docType})`);
console.log("  Merchant Name:", receipt.merchantName?.value);

// The items of the receipt are an example of a `DocumentArrayValue`
if (receipt.items !== undefined) {
  console.log("Items:");
  for (const { properties: item } of receipt.items.values) {
    console.log("- Description:", item.description?.value);
    console.log("  Total Price:", item.totalPrice?.value);
  }
}

console.log("  Total:", receipt.total?.value);

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

Parametreler

model

DocumentModel<Result>

Analiz için kullanılacak modeli ve beklenen çıkış türünü temsil eden bir DocumentModel

document
FormRecognizerRequestBody

İstekle birlikte karşıya yüklenecek bir FormRecognizerRequestBody

options

AnalyzeDocumentOptions<Result>

analiz işlemi ve poller için isteğe bağlı ayarlar

Döndürülenler

Promise<AnalysisPoller<Result>>

sonunda giriş modeliyle ilişkili sonuç türüne sahip belgelerle bir AnalyzeResult oluşturacak uzun süre çalışan bir işlem (poller)

beginAnalyzeDocumentFromUrl(string, string, AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>)

Benzersiz kimliği tarafından verilen bir modeli kullanarak bir girişten veri ayıklayın.

Bu işlem hem özel hem de önceden oluşturulmuş modelleri destekler. Örneğin, önceden oluşturulmuş fatura modelini kullanmak, "önceden oluşturulmuş fatura" model kimliğini sağlamak veya daha basit önceden oluşturulmuş düzen modelini kullanmak için model kimliğini "önceden oluşturulmuş düzen" olarak belirtin.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır ve ayıklanan belgelerin alanlarındaki değerler modeldeki belge türlerine (varsa) ve ilgili alan şemalarına bağlıdır.

Örnekler

Bu yöntem, belirli bir URL'deki bir dosyadan veri ayıklamayı destekler. Form Tanıma hizmeti, gönderilen URL'yi kullanarak bir dosyayı indirmeye çalışır, bu nedenle URL'ye genel İnternet'ten erişilebilir olmalıdır. Örneğin, Sas belirteci Azure Depolama'daki bir bloba okuma erişimi vermek için kullanılabilir ve hizmet dosyayı istemek için SAS ile kodlanmış URL'yi kullanır.

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

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

const poller = await client.beginAnalyzeDocumentFromUrl(
  "prebuilt-receipt",
  // The Document Intelligence service will access the following URL to a receipt image and extract data from it
  "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/receipt/contoso-receipt.png",
);
poller.onProgress((state) => console.log("Operation:", state.modelId, state.status));

const { documents } = await poller.pollUntilDone();

const result = documents && documents[0];
if (result) {
  const receipt = result.fields;
  console.log("=== Receipt Information ===");
  console.log("Type:", result.docType);
  console.log("Merchant:", (receipt["MerchantName"] as DocumentStringField).value);

  console.log("Items:");
  for (const { properties: item } of ((receipt["Items"] as DocumentArrayField).values ||
    []) as DocumentObjectField[]) {
    console.log("- Description:", (item["Description"] as DocumentStringField).value);
    console.log("  Total Price:", (item["TotalPrice"] as DocumentStringField).value);
  }
} else {
  throw new Error("Expected at least one receipt in the result.");
}

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

Parametreler

modelId

string

bu istemcinin kaynağındaki modelin benzersiz kimliği (adı)

documentUrl

string

genel İnternet'ten erişilebilen bir giriş belgesinin URL'si (dize)

options

AnalyzeDocumentOptions<AnalyzeResult<AnalyzedDocument>>

analiz işlemi ve poller için isteğe bağlı ayarlar

Döndürülenler

Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

sonunda bir AnalyzeResult oluşturacak uzun süre çalışan bir işlem (poller)

beginAnalyzeDocumentFromUrl<Result>(DocumentModel<Result>, string, AnalyzeDocumentOptions<Result>)

Bilinen, kesin olarak belirlenmiş bir belge şemasına (DocumentModel) sahip bir model kullanarak girişten veri ayıklama.

AnalyzeResult üretilen alanlar analiz için kullanılan modele bağlıdır. TypeScript'te, bu yöntem aşırı yüklemesinin sonucunun türü, DocumentModelgiriş türünden çıkarılır.

Örnekler

Bu yöntem, belirli bir URL'deki bir dosyadan veri ayıklamayı destekler. Form Tanıma hizmeti, gönderilen URL'yi kullanarak bir dosyayı indirmeye çalışır, bu nedenle URL'ye genel İnternet'ten erişilebilir olmalıdır. Örneğin, Sas belirteci Azure Depolama'daki bir bloba okuma erişimi vermek için kullanılabilir ve hizmet dosyayı istemek için SAS ile kodlanmış URL'yi kullanır.

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentAnalysisClient } from "@azure/ai-form-recognizer";
import { PrebuiltReceiptModel } from "../samples-dev/prebuilt/prebuilt-receipt.js";

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

const poller = await client.beginAnalyzeDocumentFromUrl(
  PrebuiltReceiptModel,
  // The Document Intelligence service will access the following URL to a receipt image and extract data from it
  "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/receipt/contoso-receipt.png",
);

const {
  documents: [document],
} = await poller.pollUntilDone();

// Use of PrebuiltModels.Receipt above (rather than the raw model ID), as it adds strong typing of the model's output
if (document) {
  const { merchantName, items, total } = document.fields;

  console.log("=== Receipt Information ===");
  console.log("Type:", document.docType);
  console.log("Merchant:", merchantName && merchantName.value);

  console.log("Items:");
  for (const item of (items && items.values) || []) {
    const { description, totalPrice } = item.properties;

    console.log("- Description:", description && description.value);
    console.log("  Total Price:", totalPrice && totalPrice.value);
  }

  console.log("Total:", total && total.value);
} else {
  throw new Error("Expected at least one receipt in the result.");
}

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

Parametreler

model

DocumentModel<Result>

Analiz için kullanılacak modeli ve beklenen çıkış türünü temsil eden bir DocumentModel

documentUrl

string

genel İnternet'ten erişilebilen bir giriş belgesinin URL'si (dize)

options

AnalyzeDocumentOptions<Result>

analiz işlemi ve poller için isteğe bağlı ayarlar

Döndürülenler

Promise<AnalysisPoller<Result>>

sonunda bir AnalyzeResult oluşturacak uzun süre çalışan bir işlem (poller)

beginClassifyDocument(string, FormRecognizerRequestBody, ClassifyDocumentOptions)

Kimliği tarafından verilen özel bir sınıflandırıcı kullanarak belgeyi sınıflandırabilirsiniz.

Bu yöntem, sonunda bir AnalyzeResultoluşturacak uzun süre çalışan bir işlem (poller) oluşturur. Bu, beginAnalyzeDocument ve beginAnalyzeDocumentFromUrlile aynıdır, ancak sonuç alanlarının yalnızca küçük bir alt kümesini içerir. Yalnızca documents alanı ve pages alanı doldurulur ve yalnızca en az sayfa bilgisi döndürülür. documents alanı, tanımlanan tüm belgeler ve sınıflandırıldıkları docType hakkında bilgi içerir.

Örnek

Bu yöntem, Node.JS nesneleri, tarayıcı ReadableStreams'ler ve Blobs'ler gibi akışla aktarılabilir istek gövdelerini (ArrayBuffer) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

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

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

const path = "<path to a document>";
const readStream = createReadStream(path);

const poller = await client.beginClassifyDocument("<classifier id>", readStream);

const result = await poller.pollUntilDone();

if (result?.documents?.length === 0) {
  throw new Error("Failed to extract any documents.");
}

for (const document of result.documents) {
  console.log(
    `Extracted a document with type '${document.docType}' on page ${document.boundingRegions?.[0].pageNumber} (confidence: ${document.confidence})`,
  );
}

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

Parametreler

classifierId

string

analiz için kullanılacak özel sınıflandırıcının kimliği

document
FormRecognizerRequestBody

sınıflandırmak için belge

options
ClassifyDocumentOptions

sınıflandırma işlemi seçenekleri

Döndürülenler

Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>

sonunda bir AnalyzeResult oluşturacak uzun süre çalışan bir işlem (poller)

beginClassifyDocumentFromUrl(string, string, ClassifyDocumentOptions)

Kimliği tarafından verilen özel bir sınıflandırıcıyı kullanarak URL'den belgeyi sınıflandırabilirsiniz.

Bu yöntem, sonunda bir AnalyzeResultoluşturacak uzun süre çalışan bir işlem (poller) oluşturur. Bu, beginAnalyzeDocument ve beginAnalyzeDocumentFromUrlile aynıdır, ancak sonuç alanlarının yalnızca küçük bir alt kümesini içerir. Yalnızca documents alanı ve pages alanı doldurulur ve yalnızca en az sayfa bilgisi döndürülür. documents alanı, tanımlanan tüm belgeler ve sınıflandırıldıkları docType hakkında bilgi içerir.

Örnek

Bu yöntem, belirli bir URL'deki bir dosyadan veri ayıklamayı destekler. Form Tanıma hizmeti, gönderilen URL'yi kullanarak bir dosyayı indirmeye çalışır, bu nedenle URL'ye genel İnternet'ten erişilebilir olmalıdır. Örneğin, Sas belirteci Azure Depolama'daki bir bloba okuma erişimi vermek için kullanılabilir ve hizmet dosyayı istemek için SAS ile kodlanmış URL'yi kullanır.

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

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

const documentUrl =
  "https://raw.githubusercontent.com/Azure/azure-sdk-for-js/main/sdk/formrecognizer/ai-form-recognizer/assets/invoice/Invoice_1.pdf";

const poller = await client.beginClassifyDocumentFromUrl("<classifier id>", documentUrl);

const result = await poller.pollUntilDone();

if (result?.documents?.length === 0) {
  throw new Error("Failed to extract any documents.");
}

for (const document of result.documents) {
  console.log(
    `Extracted a document with type '${document.docType}' on page ${document.boundingRegions?.[0].pageNumber} (confidence: ${document.confidence})`,
  );
}

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

Parametreler

classifierId

string

analiz için kullanılacak özel sınıflandırıcının kimliği

documentUrl

string

sınıflandırmak için belgenin URL'si

options
ClassifyDocumentOptions

Döndürülenler

Promise<AnalysisPoller<AnalyzeResult<AnalyzedDocument>>>