Aracılığıyla paylaş


@azure/ai-form-recognizer package

Sınıflar

AzureKeyCredential

Temel anahtar değerinin güncelleştirilmesini destekleyen statik anahtar tabanlı kimlik bilgileri.

DocumentAnalysisClient

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

modelleri oluşturma, okuma, listeleme, silme ve kopyalama gibi Form Tanıma hizmetinin model yönetimi özellikleriyle etkileşime yönelik bir istemci.

Örnekler:

Azure Active Directory

import { DocumentModelAdministrationClient } 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 DocumentModelAdministrationClient(endpoint, credential);

API Anahtarı (Abonelik Anahtarı)

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

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

const client = new DocumentModelAdministrationClient(endpoint, credential);

Arabirimler

AddressValue

Adres alanı değeri.

AnalyzeDocumentOptions

Belge çözümleme işlemi için seçenekler.

AnalyzeResult

Analiz işleminin sonucu. Belgenin türü, analizi gerçekleştirmek için kullanılan model tarafından belirlenebilir.

AnalyzeResultCommon

LayoutResult, ReadResult ve GeneralDocumentResult gibi tüm AnalyzeResult benzeri türlerin ortak alanları.

AnalyzedDocument

Ayıklanan belge nesnesi.

AnalyzedDocument, model içindeki belge türlerinden birinin örneğidir. Alanları, belge türünün alan şemasına karşılık gelir.

AzureBlobFileListSource

Azure Blob Kapsayıcısı ve kapsayıcı içindeki bir JSONL dosya listesi tarafından tanımlanan eğitim veri kaynağı.

AzureBlobFileListSourceDetails

Azure Blob Depolama dosya listesi.

AzureBlobSource

Azure Blob Kapsayıcısı tarafından tanımlanan eğitim veri kaynağı.

AzureBlobSourceDetails

İçeriği Azure Blob Depolama.

BeginBuildDocumentClassifierOptions

Belge sınıflandırıcı derleme işlemi için seçenekler.

BeginBuildDocumentModelOptions

Model derleme işlemi için seçenekler.

BeginComposeDocumentModelOptions

Model oluşturma işlemi için seçenekler.

BeginCopyModelOptions

Modeli kopyalama işlemi için seçenekler.

BoundingRegion

Girişin belirli bir sayfasında sınırlayıcı çokgen.

ClassifierDocumentTypeDetails

Sınıflandırıcı belge türü bilgileri.

ClassifyDocumentOptions

Belge sınıflandırma işlemi için seçenekler.

CommonModelCreationOptions

, beginComposeDocumentModelve getCopyAuthorizationgibi beginBuildDocumentModelyeni modelleri tanımlayan tüm işlemlerde ortak olan seçenekler.

CopyAuthorization

Belge modelini belirtilen hedef kaynağa ve model kimliğine kopyalama yetkisi.

CreateDocumentModelOptions

Model oluşturma işlemi için seçenekler.

CurrencyValue

Para birimi alan değeri.

CustomDocumentModelsDetails

Özel belge modelleriyle ilgili ayrıntılar.

DeleteDocumentModelOptions

Model silme seçenekleri.

DocumentAddressField

Yapılandırılmış bir fiziksel adresi açıklayan belge alanı.

DocumentAnalysisClientOptions

DocumentAnalysisClient için yapılandırılabilir seçenekler.

DocumentAnalysisPollOperationState

Analiz işleminin durumu, sonunda modele karşılık gelen sonuç türünü üretir.

DocumentAnnotation

Belgedeki onay işareti veya çapraz gibi görsel bir ek açıklama öğesi.

DocumentArrayField

İç içe bir alan dizisini içeren bir DocumentField. Dizideki tüm alanlar aynı türe sahip olur.

DocumentBarcode

Ayıklanmış barkod.

DocumentBooleanField

Boole değeri olan bir DocumentField.

DocumentCaption

Tablonun konumunu ve içeriğini temsil eden nesne başlık.

DocumentClassifierBuildOperationDetails

İşlem yanıt nesnesini alma.

DocumentClassifierDetails

Belge sınıflandırıcı bilgileri.

DocumentClassifierDocumentTypeSources

Belge sınıflandırıcısı oluşturmak için kullanılan bir kaynak kümesi. Bu, modeli ilgili kaynak türüne ait belgeleri sınıflandırmak üzere eğitmek için kullanılacak kaynaklarla belge türü adlarının bir haritasıdır.

DocumentClassifierOperationState

Model oluşturma işleminin durumu.

DocumentCountryRegionField

Bir ülkeyi veya bölgeyi belirten bir değere sahip olan ve dize olarak temsil edilen DocumentField.

DocumentCurrencyField

Belirli bir para birimi miktarını açıklayan bir DocumentField.

DocumentDateField

Tarih değeri olan bir DocumentField.

DocumentFieldCommon

Tüm DocumentField varyantları için ortak olan alanlar.

DocumentFieldSchema

JSON Şeması stili söz dizimi kullanan alan anlam şemasının açıklaması.

DocumentFootnote

Tablo dipnotunun konumunu ve içeriğini temsil eden nesne.

DocumentFormula

Ayıklanan formül.

DocumentIntegerField

Tamsayı değerine sahip bir DocumentField.

DocumentKeyValueElement

Bir anahtar-değer çiftinde alan anahtarını veya değerini temsil eden nesne.

DocumentKeyValuePair

Ayrı alan etiketi (anahtar) ve alan değeri (boş olabilir) olan bir form alanını temsil eden nesne.

DocumentLanguage

Belirli bir metin aralığı için algılanan dili temsil eden nesne.

DocumentLine

Sözcükler ve seçim işaretleri gibi bitişik bir içerik öğesi dizisini içeren bir içerik satırı nesnesi.

DocumentModel

Yapılandırılmış belgeleri ayıklamayı destekleyen iyi bilinen bir model belirtimi.

beginAnalyzeDocument Daha güçlü sonuç türleri sağlamak için model kimliği dizeleri yerine bu DocumentModel nesnelerin tüketilmesine destek olan DocumentAnalysisClient yöntemine bakın.

DocumentModelAdministrationClientOptions

DocumentModelAdministrationClient için yapılandırılabilir seçenekler.

DocumentModelBuildOperationDetails

İşlem yanıt nesnesini alma.

DocumentModelComposeOperationDetails

İşlem yanıt nesnesini alma.

DocumentModelCopyToOperationDetails

İşlem yanıt nesnesini alma.

DocumentModelDetails

Belge modeli bilgileri.

DocumentModelOperationState

Model oluşturma işleminin durumu.

DocumentModelSummary

Belge modeli özeti.

DocumentNumberField

Sayı değeri olan bir DocumentField.

DocumentObjectField

Kendi DocumentField değerlerine sahip çeşitli adlandırılmış özelliklerden oluşan bir DocumentField.

DocumentPage

Girişten bir sayfadan ayıklanan içerik ve düzen öğeleri.

DocumentParagraph

Genellikle ortak hizalama ve aralıklarla bitişik çizgilerden oluşan bir paragraf nesnesi.

DocumentPhoneNumberField

Dize olarak temsil edilen telefon numarası değerine sahip bir DocumentField.

DocumentSelectionMark

Onay kutularını, radyo düğmelerini ve seçimi gösteren diğer öğeleri temsil eden bir seçim işareti nesnesi.

DocumentSelectionMarkField

Bir dize olarak temsil edilen seçim işareti durumunu (onay kutusu veya radyo düğmesi gibi) gösteren bir değere sahip bir DocumentField.

DocumentSignatureField

Dize olarak temsil edilen bir imzanın durumunu gösteren DocumentField.

DocumentSpan

Uzaklık ve uzunluk olarak belirtilen, birleştirilmiş içerik özelliğinin bitişik bölgesi.

DocumentStringField

Dize değeri olan bir DocumentField.

DocumentStyle

Gözlemlenen metin stillerini temsil eden bir nesne.

DocumentTable

Dikdörtgen düzende düzenlenmiş tablo hücrelerinden oluşan bir tablo nesnesi.

DocumentTableCell

Tablo hücresinin konumunu ve içeriğini temsil eden nesne.

DocumentTimeField

Dize olarak temsil edilen bir zaman değerine sahip DocumentField.

DocumentTypeDetails

Belge türü bilgileri.

DocumentValueField

Dize, sayı vb. gibi temel bir değere sahip basit bir alan.

DocumentWord

Bitişik karakter dizisinden oluşan bir sözcük nesnesi. Çince, Japonca ve Korece gibi boşlukla sınırlandırılmamış diller için her karakter kendi sözcüğü olarak temsil edilir.

ErrorModel

Hata bilgileri.

GetCopyAuthorizationOptions

Kopyalama yetkilendirme yöntemini alma seçenekleri.

GetModelOptions

Model bilgilerini alma seçenekleri.

GetOperationOptions

İşlem durumunu alma seçenekleri.

GetResourceDetailsOptions

Form Tanıma kaynak bilgilerini alma seçenekleri.

HasBoundingPolygon

Sözcükler, seçim işaretleri ve çizgiler gibi basit belge öğeleri çokgenle sınırlanır.

InnerError

Ayrıntılı hata.

ListModelsOptions

Modelleri listeleme seçenekleri.

ListOperationsOptions

İşlemleri listeleme seçenekleri.

ModelAdministrationOperationStateCommon

Tüm yönetim işlemleri için ortak olan alan kümesi.

OperationDetails

İşlem yanıt nesnesini alma.

OperationSummary

İşlem bilgileri.

Point2D

Sınırlayıcı çokgenleri tanımlamak için kullanılan bir noktayı temsil eder. Birim 'piksel' veya 'inç' (Bkz . LengthUnit).

PollerOptions

Form Tanıma istemcilerinde uzun süre çalışan işlemler (yoklamalar) için seçenekler.

QuotaDetails

Kullanılan kota, sınır ve sonraki sıfırlama tarihi/saati.

ResourceDetails

Geçerli kaynakla ilgili genel bilgiler.

Tür Diğer Adları

AnalysisPoller

Analiz işleminin durumunu izleyen ve sonunda modele karşılık gelen sonuç türünü üreten uzun süre çalışan bir işlem (poller).

AnalyzeResultOperationStatus

AnalyzeResultOperationStatus değerlerini tanımlar.

DocumentBarcodeKind

DocumentBarcodeKind değerlerini tanımlar.
KnownDocumentBarcodeKind , DocumentBarcodeKind ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

QRCode: ISO/IEC 18004:2015'te tanımlandığı gibi QR kodu.
PDF417: ISO 15438'de tanımlandığı gibi PDF417.
UPCA: GS1 12 basamaklı Evrensel Ürün Kodu.
UPCE: GS1 6 basamaklı Evrensel Ürün Kodu.
Kod39: ISO/IEC 16388:2007'de tanımlandığı gibi Kod 39 barkod.
Kod128: ISO/IEC 15417:2007'de tanımlandığı gibi kod 128 barkod.
EAN8: GS1 8 basamaklı Uluslararası Makale Numarası (Avrupa Makale Numarası).
EAN13: GS1 13 basamaklı Uluslararası Makale Numarası (Avrupa Makale Numarası).
DataBar: GS1 DataBar barkodu.
Kod93: ANSI/AIM BC5-1995'te tanımlandığı gibi kod 93 barkod.
Codabar: ANSI/AIM BC3-1995'te tanımlandığı gibi Codabar barkodu.
DataBarExpanded: GS1 DataBar Genişletilmiş barkod.
ITF: ANSI/AIM BC2-1995'te tanımlandığı gibi 5 barkodun birbirine katılmış 2'i.
MicroQRCode: ISO/IEC 23941:2022'de tanımlanan mikro QR kodu.
Aztec: ISO/IEC 24778:2008'de tanımlanan Aztec kodu.
DataMatrix: ISO/IEC 16022:2006'da tanımlanan veri matrisi kodu.
MaxiCode: ISO/IEC 16023:2000'de tanımlandığı gibi MaxiCode.

DocumentBuildMode

DocumentBuildMode değerlerini tanımlar.
KnownDocumentBuildMode , DocumentBuildMode ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

şablon: Benzer görsel şablonlara sahip belgeleri hedefle.
nöral: Belgeleri çeşitli görsel şablonlarıyla destekleyin.

DocumentClassifierPoller

Özel sınıflandırıcı oluşturma işleminin durumunu izleyen ve sonunda documentclassifierDetails oluşturan uzun süre çalışan bir işlem (poller).

DocumentClassifierSource

Belge sınıflandırıcısı oluşturmak için kullanılabilecek içerik kaynağı.

Bunlardan biri:

  • BlobSource
  • BlobFileListSource
DocumentField

Ayıklanan alan. özelliği, kind türünü tanımlar (ayırt eder).DocumentField

DocumentFieldType

DocumentFieldType değerlerini tanımlar.
KnownDocumentFieldType , DocumentFieldType ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

string: Düz metin.
tarih: Tarih, ISO 8601 (YYYY-AA-GG) biçimine normalleştirilmiştir.
time: Iso 8601 (ss:dd:ss) biçiminde normalleştirilmiş zaman.
phoneNumber: E.164 (+{CountryCode}{SubscriberNumber}) biçiminde normalleştirilmiş telefon numarası.
sayı: Kayan nokta sayısı, çift duyarlıklı kayan nokta olarak normalleştirilmiş.
integer: 64 bit işaretli tamsayıya normalleştirilmiş tamsayı.
selectionMark: Alan seçili mi?
countryRegion: Ülke/bölge, ISO 3166-1 alfa-3 biçimine (örn. ABD) normalleştirilmiştir.
imza: İmza var mı?
array: Aynı türdeki alt alan listesi.
object: Potansiyel olarak farklı türlerdeki alt alanları içeren adlandırılmış liste.
para birimi: İsteğe bağlı para birimi simgesi ve birimi olan para birimi tutarı.
address: Ayrıştırılmış adres.
boolean: True veya false olarak normalleştirilmiş Boole değeri.

DocumentFormulaKind

DocumentFormulaKind değerlerini tanımlar.
KnownDocumentFormulaKind , DocumentFormulaKind ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

satır içi: Paragrafın içeriğine eklenmiş formül.
display: Görüntü modunda bir satırın tamamını kaplayan bir formül.

DocumentModelBuildMode

Desteklenen model derleme modları. Model derleme modu, hizmetin etiketlenmiş eğitim verilerine göre modeli eğitmek için kullandığı altyapıyı seçer.

Seçenekler şunlardır:

  • Aynı veri yapısına sahip ancak farklı düzenlere (örneğin, şirketten şirkete farklılık gösterebilen ancak her zaman aynı bilgileri içeren W2 vergi formları) belge sınıflarından veri ayıklayabilen en yüksek model kalitesini sunan "nöral".
  • Tüm belgelerin aynı sabit düzene (şablon) sahip olmasını gerektiren "şablon".

Daha fazla bilgi için lütfen aşağıdaki bağlantıya bakın: https://aka.ms/azsdk/formrecognizer/buildmode

DocumentModelPoller

Model oluşturma işleminin durumunu izleyen ve sonunda DocumentModelDetails üreten uzun süre çalışan bir işlem (poller).

DocumentModelSource

Belge modeli oluşturmak için kullanılabilecek bir içerik kaynağı.

Bunlardan biri:

  • BlobSource
  • BlobFileListSource
DocumentSignatureType

DocumentSignatureType değerlerini tanımlar.
KnownDocumentSignatureType , DocumentSignatureType ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

imzalı: bir imza algılandı.
imzasız: İmza algılanmadı.

DocumentTableCellKind

DocumentTableCellKind değerlerini tanımlar.
KnownDocumentTableCellKind , DocumentTableCellKind ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

içerik: Ana içeriği/verileri içerir.
rowHeader: Satırın içeriğini açıklar.
columnHeader: Sütunun içeriğini açıklar.
stubHead: Genellikle tablonun sol üst köşesinde bulunan satır üst bilgilerini açıklar.
description: Tablodaki (bölümleri) içeriği açıklar.

FontStyle

FontStyle değerlerini tanımlar.
KnownFontStyle , FontStyle ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

normal: Karakterler normal olarak temsil edilir.
italik: Karakterler görsel olarak sağa doğru eğimli.

FontWeight

FontWeight değerlerini tanımlar.
KnownFontWeight , FontWeight ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

normal: Karakterler normal olarak temsil edilir.
bold: Karakterler daha kalın vuruşlarla gösterilir.

FormRecognizerFeature

İstek için etkinleştirilebilen eklenti özellikleri (özellikler).

Form Tanıma'da bulunan özellikler hakkında daha fazla bilgi için hizmet belgelerine bakın:

https://aka.ms/azsdk/formrecognizer/features

FormRecognizerRequestBody

Form Tanıma hizmetine ikili veri olarak yüklenebilen bir istek girişi. Form Tanıma girişleri URL'ler olarak ele alırstring, bu nedenle bir dizeyi ikili giriş olarak göndermek için önce dizeyi aşağıdaki giriş türlerinden birine dönüştürün.

LengthUnit

LengthUnit değerlerini tanımlar.
KnownLengthUnit , LengthUnit ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

piksel: Görüntü dosyaları için uzunluk birimi.
inç: PDF dosyaları için uzunluk birimi.

OperationDetailsUnion

Birkaç farklı Form Tanıma yönetim işlemi türüyle ilgili ayrıntılar.

OperationKind

OperationKind değerlerini tanımlar.
KnownOperationKind, OperationKind ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

documentModelBuild: Yeni bir özel belge modeli oluşturun.
documentModelCompose: Mevcut modellerden yeni bir özel belge modeli oluşturma.
documentModelCopyTo: Var olan bir belge modelini farklı bir kaynağa, bölgeye veya aboneliğe kopyalayın.
documentClassifierBuild: Yeni bir özel sınıflandırıcı modeli oluşturun.

OperationStatus

OperationStatus değerlerini tanımlar.

ParagraphRole

ParagraphRole değerlerini tanımlar.
KnownParagraphRole, ParagraphRole ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

pageHeader: Sayfanın üst kenarına yakın metin.
pageFooter: Sayfanın alt kenarına yakın metin.
pageNumber: Sayfa numarası.
title: Belgenin tamamını açıklayan üst düzey başlık.
sectionHeading: Belgenin bir bölümünü açıklayan alt başlık.
dipnot: Genellikle sayfadaki ana içeriğin arkasına yerleştirilmiş bir not.
formulaBlock: Genellikle paylaşılan hizalamaya sahip formül bloğu.

SelectionMarkState

SelectionMarkState değerlerini tanımlar.
KnownSelectionMarkState , SelectionMarkState ile birbirinin yerine kullanılabilir, bu sabit listesi hizmetin desteklediği bilinen değerleri içerir.

Hizmet tarafından desteklenen bilinen değerler

seçili: Seçim işareti seçilir, çoğunlukla seçim işaretinin içinde onay işaretiyle () veya X işaretiyle gösterilir.
seçili değil: Seçim işareti seçili değil.

StringIndexType

Form Tanıma hizmeti ve SDK istemcileri tarafından desteklenen geçerli dize dizini türleri.

Numaralandırmalar

KnownDocumentBarcodeKind

DocumentBarcodeKind'in hizmetin kabul verdiği bilinen değerler.

KnownDocumentBuildMode

Hizmetin kabul edildiği DocumentBuildMode'un bilinen değerleri.

KnownDocumentFieldType

Hizmetin kabul edildiği DocumentFieldType'ın bilinen değerleri.

KnownDocumentFormulaKind

Hizmetin kabul edildiği DocumentFormulaKind'in bilinen değerleri.

KnownDocumentSignatureType

Hizmetin kabul edildiği DocumentSignatureType'ın bilinen değerleri.

KnownDocumentTableCellKind

Hizmetin kabul verdiği DocumentTableCellKind'in bilinen değerleri.

KnownFontStyle

Hizmetin kabul ettiğini bilinen FontStyle değerleri.

KnownFontWeight

Hizmetin kabul edildiği FontWeight'ın bilinen değerleri.

KnownLengthUnit

Hizmetin kabul edildiği Bilinen LengthUnit değerleri.

KnownOperationKind

Hizmetin kabul verdiği OperationKind'in bilinen değerleri.

KnownParagraphRole

Hizmetin kabul edildiği ParagraphRole'un bilinen değerleri.

KnownSelectionMarkState

Hizmetin kabul edildiği SelectionMarkState'in bilinen değerleri.