@azure/ai-form-recognizer package

Sınıflar

AzureKeyCredential	Temel alınan anahtar değerinin güncelleştirilmesini destekleyen statik anahtar tabanlı kimlik bilgileri.
DocumentAnalysisClient	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, );
DocumentModelAdministrationClient	Form Tanıma hizmetinin model oluşturma, okuma, listeleme, silme ve kopyalama gibi model yönetimi özellikleriyle etkileşim kurmak için bir istemci. Örnekler: Azure Active Directory import { DefaultAzureCredential } from "@azure/identity"; import { DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); API Anahtarı (Abonelik Anahtarı) import { AzureKeyCredential, DocumentModelAdministrationClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentModelAdministrationClient( "https://<resource name>.cognitiveservices.azure.com", 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'daki dosya listesi.
AzureBlobSource	Azure Blob Kapsayıcısı tarafından tanımlanan eğitim veri kaynağı.
AzureBlobSourceDetails	Azure Blob Depolama içeriği.
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	Kopyalama modeli 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	beginBuildDocumentModel, beginComposeDocumentModelve getCopyAuthorizationgibi yeni 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 alanlardan oluşan bir diziden oluşan bir DocumentField. Dizideki tüm alanlar aynı türe sahip olur.
DocumentBarcode	Ayıklanmış barkod.
DocumentBooleanField	Boole değeri olan bir DocumentField.
DocumentCaption	Tablo resim yazısının konumunu ve içeriğini temsil eden nesne.
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 kaynak kümesi. Bu, belge türü adlarının, modeli ilgili kaynak türündeki belgeleri sınıflandırmak üzere eğitmek için kullanılacak kaynaklarla eşlemini oluşturur.
DocumentClassifierOperationState	Model oluşturma işleminin durumu.
DocumentCountryRegionField	Dize olarak temsil edilen bir ülkeyi veya bölgeyi gösteren bir değere sahip bir DocumentField.
DocumentCurrencyField	Belirli bir para biriminin miktarını açıklayan bir DocumentField.
DocumentDateField	Tarih değerine sahip bir DocumentField.
DocumentFieldCommon	Tüm DocumentField değişkenlerinde ortak olan alanlar.
DocumentFieldSchema	JSON Şeması stili söz dizimi kullanılarak 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 çiftindeki 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. Daha güçlü sonuç türleri sağlamak için model kimliği dizeleri yerine bu beginAnalyzeDocument nesnelerinin tüketilmesine destek olan DocumentAnalysisClientDocumentModel 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ğerine sahip 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 ilkel bir değere sahip basit bir alan.
DocumentWord	Bitişik karakter dizisini içeren 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 yetkilendirmesi alma yöntemi için seçenekler.
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. Code39: ISO/IEC 16388:2007'de tanımlandığı gibi Kod 39 barkodu. Code128: 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. Code93: ANSI/AIM BC5-1995'te tanımlandığı gibi Kod 93 barkodu. 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 2'sini araya ekleme. 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 şablonu: Benzer görsel şablonları olan belgeleri hedefle. sinir: Çeşitli görsel şablonları olan belgeleri destekleyin.
DocumentClassifierPoller	Özel sınıflandırıcı oluşturma işleminin durumunu izleyen ve sonunda DocumentClassifierDetailsoluş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: Blob Kaynağı BlobFileListSource
DocumentField	Ayıklanan alan. kind özelliği, DocumentFieldtürünü tanımlar (ayırt eder).
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 dize: Düz metin. tarih: Tarih, ISO 8601 (YYYY-MM-DD) biçiminde normalleştirilmiştir. saat: Iso 8601 (ss:dd:ss) biçimine normalleştirilmiş zaman. phoneNumber: Telefon numarası, E.164 (+{CountryCode}{SubscriberNumber}) biçiminde normalleştirilmiş. sayı: Kayan nokta sayısı, çift duyarlıklı kayan nokta olarak normalleştirilir. tamsayı: 64 bit işaretli tamsayıya normalleştirilmiş tamsayı. mark: Alan seçili mi? ülkeBölge: Ülke/bölge, ISO 3166-1 alfa-3 biçimine (örn. ABD) normalleştirilmiştir. imza: İmza var mı? dizi: Aynı türdeki alt alanlar listesi. nesne : Olası 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ı. adres: Ayrıştırılan adres. boole : 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. görüntüleme: Görüntüleme modunda bir satırın tamamını kaplayan 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 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 DocumentModelDetailsoluşturan uzun süre çalışan bir işlem (poller).
DocumentModelSource	Belge modeli oluşturmak için kullanılabilecek içerik kaynağı. Bunlardan biri: Blob Kaynağı 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. açıklama: Tablonun içindeki (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 birlikte 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. kalın: Karakterler daha kalın vuruşlarla gösterilir.
FormRecognizerFeature	İstek için etkinleştirilebilen eklenti özellikleri (özellikler). Form Tanıma'daki ö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ıyıcı string girişleri URL'ler olarak kabul eder, bu nedenle bir dizeyi ikili girişi 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 birlikte 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ı. başlık: 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 bir 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, genellikle seçim işaretinin içinde bir onay işaretiyle () veya X işaretiyle gösterilir. seçilmemiş: 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	Hizmetin kabul DocumentBarcodeKind bilinen değerleri.
KnownDocumentBuildMode	Hizmetin kabul DocumentBuildMode bilinen değerleri.
KnownDocumentFieldType	DocumentFieldType'ın bilinen değerleri, hizmetin kabul.
KnownDocumentFormulaKind	DocumentFormulaKind'in bilinen değerleri, hizmetin kabul.
KnownDocumentSignatureType	DocumentSignatureType'ın bilinen değerleri, hizmetin kabul.
KnownDocumentTableCellKind	DocumentTableCellKind'in bilinen değerleri, hizmetin kabul.
KnownFontStyle	hizmetin kabul FontStyle'ın bilinen değerleri.
KnownFontWeight	Hizmetin kabul FontWeight'ın bilinen değerleri.
KnownFormRecognizerAudience	Form Tanıma için bilinen bulut hedef kitlelerini tanımlar. TokenCredential ortamında Entra Id ile (a ) kimlik doğrulaması yapmak için, bir audience veya DocumentAnalysisClientoluştururken seçenek olarak DocumentModelAdministrationClient aşağıdaki uygun değeri sağlayın. Varsayılan değer, Azure Genel Bulutu'nda oluşturulan Form Tanıma kaynakları için uygundur, bu nedenle bu değer yalnızca Form Tanıma'yı farklı bir bulut ortamında kullanmak için gereklidir.
KnownLengthUnit	Hizmetin kabul bilinen LengthUnit değerleri.
KnownOperationKind	OperationKind'in bilinen değerleri, hizmetin kabul.
KnownParagraphRole	Hizmetin kabul ParagraphRole bilinen değerleri.
KnownSelectionMarkState	Hizmetin kabul SelectionMarkState bilinen değerleri.