Aracılığıyla paylaş

DocumentAnalysisClient class

  • Başvuru
Paket:
@azure/ai-form-recognizer

Form Tanıma hizmetinin analiz özellikleriyle etkileşime yönelik bir istemci.

Örnekler:

Form Tanıma hizmeti ve istemcileri iki kimlik doğrulama aracı destekler:

Azure Active Directory

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);

API Anahtarı (Abonelik Anahtarı)

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);

Oluşturucular

DocumentAnalysisClient(string, KeyCredential, DocumentAnalysisClientOptions)

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

Örnek:

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);
DocumentAnalysisClient(string, TokenCredential, DocumentAnalysisClientOptions)

DocumentAnalysisClient Kaynak uç noktasından ve Azure Kimliği'nden TokenCredentialbir örnek oluşturun.

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

Örnek:

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);

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 özel ve ö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 "önceden oluşturulmuş düzen" model kimliğini sağlayın.

içinde 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 ReadableStream nesneleri, tarayıcı Blobs'leri ve ArrayBuffers'ler gibi akışla aktarılabilir istek gövdelerini (FormRecognizerRequestBody) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

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);
beginAnalyzeDocument<Result>(DocumentModel<Result>, FormRecognizerRequestBody, AnalyzeDocumentOptions<Result>)

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

içinde 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ü giriş DocumentModeltüründen çıkarılır.

Örnekler

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

Sağlanan giriş bir dizeyse, analiz edilecek belgenin konumunun URL'si olarak kabul edilir. 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 * 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);
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 özel ve ö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 "önceden oluşturulmuş düzen" model kimliğini sağlayın.

içinde 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.

// 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);
beginAnalyzeDocumentFromUrl<Result>(DocumentModel<Result>, string, AnalyzeDocumentOptions<Result>)

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

içinde 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ü giriş DocumentModeltü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.

// 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);
beginClassifyDocument(string, FormRecognizerRequestBody, ClassifyDocumentOptions)

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

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

Örnek

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

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);
}
beginClassifyDocumentFromUrl(string, string, ClassifyDocumentOptions)

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

Bu yöntem, sonunda bir üretecek uzun süre çalışan bir AnalyzeResultişlem (poller) üretir. Bu, ve beginAnalyzeDocumentFromUrlile beginAnalyzeDocument aynı türdür, ancak sonuç alanlarının yalnızca küçük bir alt kümesini içerir. documents Yalnızca alan ve pages alan doldurulur ve yalnızca en az sayfa bilgisi döndürülür. alanı, documents tanımlanan tüm belgeler ve docType olarak sınıflandırıldıkları belgeler 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.

// 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);
}

Oluşturucu Ayrıntıları

DocumentAnalysisClient(string, KeyCredential, DocumentAnalysisClientOptions)

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

Örnek:

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)

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)

DocumentAnalysisClient Kaynak uç noktasından ve Azure Kimliği'nden TokenCredentialbir örnek oluşturun.

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

Örnek:

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)

Parametreler

endpoint

string

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

credential
TokenCredential

paketten @azure/identity bir 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 özel ve ö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 "önceden oluşturulmuş düzen" model kimliğini sağlayın.

içinde 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 ReadableStream nesneleri, tarayıcı Blobs'leri ve ArrayBuffers'ler gibi akışla aktarılabilir istek gövdelerini (FormRecognizerRequestBody) destekler. Gövdenin içeriği analiz için hizmete yüklenir.

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>>>

Parametreler

modelId

string

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

document
FormRecognizerRequestBody

İstekle 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>>>

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

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

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

içinde 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ü giriş DocumentModeltüründen çıkarılır.

Örnekler

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

Sağlanan giriş bir dizeyse, analiz edilecek belgenin konumunun URL'si olarak kabul edilir. 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 * 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>>

Parametreler

model

DocumentModel<Result>

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

document
FormRecognizerRequestBody

İstekle 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şkilendirilmiş sonuç türüne sahip belgelerle bir oluşturan uzun süre çalışan bir AnalyzeResult 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 özel ve ö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 "önceden oluşturulmuş düzen" model kimliğini sağlayın.

içinde 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.

// 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>>>

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>>>

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

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

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

içinde 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ü giriş DocumentModeltü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.

// 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>>

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>>

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

beginClassifyDocument(string, FormRecognizerRequestBody, ClassifyDocumentOptions)

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

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

Örnek

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

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>>>

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>>>

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

beginClassifyDocumentFromUrl(string, string, ClassifyDocumentOptions)

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

Bu yöntem, sonunda bir üretecek uzun süre çalışan bir AnalyzeResultişlem (poller) üretir. Bu, ve beginAnalyzeDocumentFromUrlile beginAnalyzeDocument aynı türdür, ancak sonuç alanlarının yalnızca küçük bir alt kümesini içerir. documents Yalnızca alan ve pages alan doldurulur ve yalnızca en az sayfa bilgisi döndürülür. alanı, documents tanımlanan tüm belgeler ve docType olarak sınıflandırıldıkları belgeler 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.

// 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>>>

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>>>