@azure/ai-form-recognizer package

الفصول

AzureKeyCredential	بيانات اعتماد مستندة إلى مفتاح ثابت تدعم تحديث قيمة المفتاح الأساسي.
DocumentAnalysisClient	عميل للتفاعل مع ميزات تحليل خدمة Form Recognizer. أمثلة: تدعم خدمة Form Recognizer والعملاء وسيلتين للمصادقة: 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); مفتاح واجهة برمجة التطبيقات (مفتاح الاشتراك) 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	عميل للتفاعل مع ميزات إدارة النموذج لخدمة Form Recognizer، مثل إنشاء النماذج وقراءتها وإدراجها وحذفها ونسخها. أمثلة: 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); مفتاح واجهة برمجة التطبيقات (مفتاح الاشتراك) 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);

الواجهات

AddressValue	قيمة حقل العنوان.
AnalyzeDocumentOptions	خيارات لعملية تحليل المستند.
AnalyzeResult	نتيجة عملية التحليل. يمكن تحديد نوع المستند بواسطة النموذج المستخدم لإجراء التحليل.
AnalyzeResultCommon	الحقول الشائعة لجميع الأنواع الشبيهة ب AnalyzeResult، مثل LayoutResult وReadResult و GeneralDocumentResult.
AnalyzedDocument	عنصر مستند مستخرج. AnalyzedDocument هو مثيل لأحد أنواع المستندات داخل نموذج. تتوافق حقوله مع مخطط الحقل لنوع المستند.
AzureBlobFileListSource	مصدر بيانات التدريب المحدد بواسطة حاوية Azure Blob وقائمة ملفات JSONL داخل الحاوية.
AzureBlobFileListSourceDetails	قائمة الملفات في Azure Blob Storage.
AzureBlobSource	مصدر بيانات تدريب تم تعريفه بواسطة حاوية Azure Blob.
AzureBlobSourceDetails	محتوى Azure Blob Storage.
BeginBuildDocumentClassifierOptions	خيارات لعملية إنشاء مصنف المستند.
BeginBuildDocumentModelOptions	خيارات لعملية بناء النموذج.
BeginComposeDocumentModelOptions	خيارات لعملية إنشاء النموذج.
BeginCopyModelOptions	خيارات عملية نموذج النسخ.
BoundingRegion	مضلع الإحاطة في صفحة معينة من الإدخال.
ClassifierDocumentTypeDetails	معلومات نوع مستند المصنف.
ClassifyDocumentOptions	خيارات لعملية تصنيف المستند.
CommonModelCreationOptions	الخيارات الشائعة لجميع العمليات التي تحدد نماذج جديدة، مثل beginBuildDocumentModelو beginComposeDocumentModelو.getCopyAuthorization
CopyAuthorization	تخويل لنسخ نموذج مستند إلى المورد الهدف المحدد و modelId.
CreateDocumentModelOptions	خيارات لعملية إنشاء النموذج.
CurrencyValue	قيمة حقل العملة.
CustomDocumentModelsDetails	التفاصيل المتعلقة بنماذج المستندات المخصصة.
DeleteDocumentModelOptions	خيارات حذف النموذج.
DocumentAddressField	حقل مستند يصف عنوانا ماديا منظما.
DocumentAnalysisClientOptions	خيارات قابلة للتكوين ل DocumentAnalysisClient.
DocumentAnalysisPollOperationState	حالة عملية التحليل، والتي ستنتج في النهاية نوع النتيجة الذي يتوافق مع النموذج.
DocumentAnnotation	عنصر تعليق توضيحي مرئي في المستند، مثل علامة اختيار أو علامة تقاطع.
DocumentArrayField	DocumentField الذي يتكون من صفيف من الحقول المتداخلة. سيكون لجميع الحقول في الصفيف نفس النوع.
DocumentBarcode	رمز شريطي مستخرج.
DocumentBooleanField	DocumentField له قيمة منطقية.
DocumentCaption	كائن يمثل موقع ومحتوى تسمية توضيحية للجدول.
DocumentClassifierBuildOperationDetails	الحصول على كائن استجابة العملية.
DocumentClassifierDetails	معلومات مصنف المستند.
DocumentClassifierDocumentTypeSources	مجموعة من المصادر المستخدمة لإنشاء مصنف مستند. هذه خريطة لأسماء أنواع المستندات إلى المصادر التي سيتم استخدامها لتدريب النموذج لتصنيف المستندات من نوع المصدر المقابل.
DocumentClassifierOperationState	حالة عملية إنشاء نموذج.
DocumentCountryRegionField	DocumentField له قيمة تشير إلى بلد أو منطقة، ممثلة كسلسلة.
DocumentCurrencyField	DocumentField الذي يصف مبلغا من عملة معينة.
DocumentDateField	DocumentField الذي يحتوي على قيمة التاريخ.
DocumentFieldCommon	الحقول الشائعة في كافة متغيرات DocumentField.
DocumentFieldSchema	وصف المخطط الدلالي للحقل باستخدام بناء جملة نمط مخطط JSON.
DocumentFootnote	كائن يمثل موقع ومحتوى حاشية سفلية للجدول.
DocumentFormula	صيغة مستخرجة.
DocumentIntegerField	DocumentField له قيمة عدد صحيح.
DocumentKeyValueElement	كائن يمثل مفتاح الحقل أو القيمة في زوج قيم المفاتيح.
DocumentKeyValuePair	كائن يمثل حقل نموذج مع تسمية حقل مميزة (مفتاح) وقيمة حقل (قد يكون فارغا).
DocumentLanguage	كائن يمثل اللغة المكتشفة لنص معين.
DocumentLine	عنصر سطر محتوى يتكون من تسلسل متجاورة من عناصر المحتوى، مثل الكلمات وعلامات التحديد.
DocumentModel	مواصفات نموذج معروفة تدعم استخراج المستندات المنظمة. beginAnalyzeDocument راجع أسلوب DocumentAnalysisClient، الذي يدعم استهلاك هذه DocumentModel الكائنات بدلا من سلاسل معرف النموذج لتوفير أنواع نتائج أقوى.
DocumentModelAdministrationClientOptions	خيارات قابلة للتكوين ل DocumentModelAdministrationClient.
DocumentModelBuildOperationDetails	الحصول على كائن استجابة العملية.
DocumentModelComposeOperationDetails	الحصول على كائن استجابة العملية.
DocumentModelCopyToOperationDetails	الحصول على كائن استجابة العملية.
DocumentModelDetails	معلومات نموذج المستند.
DocumentModelOperationState	حالة عملية إنشاء نموذج.
DocumentModelSummary	ملخص نموذج المستند.
DocumentNumberField	DocumentField له قيمة رقم.
DocumentObjectField	DocumentField الذي يتكون من العديد من الخصائص المسماة التي لها قيم DocumentField الخاصة بها.
DocumentPage	عناصر المحتوى والتخطيط المستخرجة من صفحة من الإدخال.
DocumentParagraph	عنصر فقرة يتكون من أسطر متجاورة بشكل عام مع محاذاة وتباعد مشتركين.
DocumentPhoneNumberField	DocumentField يحتوي على قيمة رقم هاتف، ممثلة كسلسلة.
DocumentSelectionMark	كائن علامة تحديد يمثل خانات الاختيار والأزرار التبادلية والعناصر الأخرى التي تشير إلى تحديد.
DocumentSelectionMarkField	حقل المستند الذي يحتوي على قيمة تشير إلى حالة علامة التحديد (مثل خانة الاختيار أو الزر التبادلي)، ممثلة كسلسلة.
DocumentSignatureField	DocumentField الذي يشير إلى حالة التوقيع، ممثل كسلسلة.
DocumentSpan	المنطقة المتجاورة لخاصية المحتوى المتسلسلة، المحددة كإزاحة وطول.
DocumentStringField	DocumentField له قيمة سلسلة.
DocumentStyle	كائن يمثل أنماط النص المرصودة.
DocumentTable	عنصر جدول يتكون من خلايا جدول مرتبة في تخطيط مستطيل.
DocumentTableCell	كائن يمثل موقع ومحتوى خلية جدول.
DocumentTimeField	DocumentField له قيمة زمنية، ممثلة كسلسلة.
DocumentTypeDetails	معلومات نوع المستند.
DocumentValueField	حقل بسيط له قيمة بدائية، مثل سلسلة ورقم وما إلى ذلك.
DocumentWord	كائن كلمة يتكون من تسلسل متجاورة من الأحرف. بالنسبة للغات المحددة غير الفضائية، مثل الصينية واليابانية والكورية، يتم تمثيل كل حرف ككلمة خاصة به.
ErrorModel	معلومات الخطأ.
GetCopyAuthorizationOptions	خيارات لأسلوب الحصول على تخويل النسخ.
GetModelOptions	خيارات لاسترداد معلومات النموذج.
GetOperationOptions	خيارات لاسترداد حالة عملية.
GetResourceDetailsOptions	خيارات لاسترداد معلومات مورد Form Recognizer.
HasBoundingPolygon	يتم ربط عناصر المستند البسيطة مثل الكلمات وعلامات التحديد والخطوط بالمضلع.
InnerError	خطأ مفصل.
ListModelsOptions	خيارات لإدراج النماذج.
ListOperationsOptions	خيارات لإدراج العمليات.
ModelAdministrationOperationStateCommon	مجموعة الحقول المشتركة في جميع عمليات الإدارة.
OperationDetails	الحصول على كائن استجابة العملية.
OperationSummary	معلومات العملية.
Point2D	يمثل نقطة تستخدم لتعريف المضلعات المحيطة. الوحدة إما "بكسل" أو "بوصة" (راجع LengthUnit).
PollerOptions	خيارات العمليات طويلة الأمد (الاستقصاءات) في عملاء Form Recognizer.
QuotaDetails	الحصة النسبية المستخدمة والحد من تاريخ/وقت إعادة التعيين التالي.
ResourceDetails	معلومات عامة حول المورد الحالي.

النوع أسماء مستعارة

AnalysisPoller	عملية طويلة الأمد (poller) تتعقب حالة عملية التحليل، وتنتج في النهاية نوع النتيجة الذي يتوافق مع النموذج.
AnalyzeResultOperationStatus	يحدد قيم AnalyzeResultOperationStatus.
DocumentBarcodeKind	يحدد قيم DocumentBarcodeKind. يمكن استخدام KnownDocumentBarcodeKind بالتبادل مع DocumentBarcodeKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة QRCode: رمز الاستجابة السريعة، كما هو محدد في ISO/IEC 18004:2015. PDF417: PDF417، كما هو محدد في ISO 15438. UPCA: GS1 من 12 رقما رمز المنتج العالمي. UPCE: GS1 من 6 أرقام Universal Product Code. Code39: الرمز الشريطي 39، كما هو محدد في ISO/IEC 16388:2007. Code128: الرمز الشريطي 128، كما هو محدد في ISO/IEC 15417:2007. EAN8: GS1 رقم المقالة الدولية المكون من 8 أرقام (رقم المقالة الأوروبية). EAN13: رقم المقالة الدولية من رقم GS1 المكون من 13 رقما (رقم المقالة الأوروبية). DataBar: رمز شريط بيانات GS1. Code93: الرمز الشريطي Code 93، كما هو محدد في ANSI/AIM BC5-1995. Codabar: كود شريطي Codabar، كما هو محدد في ANSI/AIM BC3-1995. DataBarExpanded: GS1 DataBar Expanded bar barcode. ITF: Interleaved 2 من 5 رمز شريطي، كما هو محدد في ANSI/AIM BC2-1995. MicroQRCode: رمز الاستجابة السريعة الصغير، كما هو محدد في ISO/IEC 23941:2022. Aztec: رمز Aztec، كما هو محدد في ISO/IEC 24778:2008. DataMatrix: رمز مصفوفة البيانات، كما هو محدد في ISO/IEC 16022:2006. MaxiCode: MaxiCode، كما هو محدد في ISO/IEC 16023:2000.
DocumentBuildMode	يحدد قيم DocumentBuildMode. يمكن استخدام KnownDocumentBuildMode بالتبادل مع DocumentBuildMode، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة القالب: المستندات الهدف مع قوالب مرئية مماثلة. العصبية: دعم المستندات باستخدام قوالب مرئية متنوعة.
DocumentClassifierPoller	عملية طويلة الأمد (poller) تتعقب حالة عملية إنشاء مصنف مخصص، وتنتج في النهاية DocumentClassifierDetails.
DocumentClassifierSource	مصدر محتوى يمكن استخدامه لإنشاء مصنف مستند. واحد من: BlobSource BlobFileListSource
DocumentField	حقل مستخرج. kind تحدد الخاصية (تميز) نوع DocumentField.
DocumentFieldType	يحدد قيم DocumentFieldType. يمكن استخدام KnownDocumentFieldType بالتبادل مع DocumentFieldType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة سلسلة: نص عادي. التاريخ: تاريخ، تمت تسويته بتنسيق ISO 8601 (YYYY-MM-DD). الوقت: الوقت، تمت تسويته بتنسيق ISO 8601 (hh:mm:ss). رقم الهاتف: رقم الهاتف، الذي تمت تسويته بتنسيق E.164 (+{CountryCode}{SubscriberNumber}). number: رقم النقطة العائمة، تمت تسويته إلى نقطة عائمة مزدوجة الدقة. عدد صحيح: عدد صحيح، تمت تسويته إلى عدد صحيح موقع 64 بت. علامة التحديد: هل تم تحديد الحقل؟ countryRegion: البلد/المنطقة، التي تمت تسويتها إلى تنسيق ISO 3166-1 alpha-3 (على سبيل المثال، الولايات المتحدة الأمريكية). التوقيع: هل التوقيع موجود؟ صفيف: قائمة الحقول الفرعية من نفس النوع. الكائن: قائمة مسماة من الحقول الفرعية من الأنواع المختلفة المحتملة. العملة: مبلغ العملة مع رمز عملة اختياري ووحدة. العنوان: العنوان الموزع. قيمة منطقية: قيمة منطقية، تمت تسويتها إلى صواب أو خطأ.
DocumentFormulaKind	يحدد قيم DocumentFormulaKind. يمكن استخدام KnownDocumentFormulaKind بالتبادل مع DocumentFormulaKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة مضمن: صيغة مضمنة في محتوى فقرة. العرض: صيغة في وضع العرض تأخذ سطرا كاملا.
DocumentModelBuildMode	أوضاع بناء النموذج المدعومة. يحدد وضع بناء النموذج المحرك الذي تستخدمه الخدمة لتدريب النموذج استنادا إلى بيانات التدريب المسماة. الخيارات هي: "عصبي"، الذي ينتج عنه أعلى جودة للنموذج القادر على استخراج البيانات من فئات المستندات التي لها نفس بنية البيانات، ولكن التخطيطات المختلفة (على سبيل المثال، نماذج ضريبة W2، والتي قد تختلف من شركة إلى أخرى، ولكنها تحتوي دائما على نفس المعلومات). "قالب"، والذي يتطلب أن يكون لكل المستندات نفس التخطيط الثابت (قالب). يرجى الاطلاع على الارتباط التالي لمزيد من المعلومات: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	عملية طويلة الأمد (poller) تتعقب حالة عملية إنشاء نموذج، وتنتج في النهاية DocumentModelDetails.
DocumentModelSource	مصدر محتوى يمكن استخدامه لإنشاء نموذج مستند. واحد من: BlobSource BlobFileListSource
DocumentSignatureType	يحدد قيم DocumentSignatureType. يمكن استخدام KnownDocumentSignatureType بالتبادل مع DocumentSignatureType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة الموقع: تم الكشف عن توقيع. غير موقع: لم يتم الكشف عن أي توقيعات.
DocumentTableCellKind	يحدد قيم DocumentTableCellKind. يمكن استخدام KnownDocumentTableCellKind بالتبادل مع DocumentTableCellKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة المحتوى: يحتوي على المحتوى/البيانات الرئيسية. rowHeader: يصف محتوى الصف. columnHeader: يصف محتوى العمود. stubHead: يصف رؤوس الصفوف، الموجودة عادة في الزاوية العلوية اليمنى من الجدول. الوصف: يصف المحتوى في (أجزاء) الجدول.
FontStyle	يحدد قيم FontStyle. يمكن استخدام KnownFontStyle بالتبادل مع FontStyle، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة عادي: يتم تمثيل الأحرف بشكل طبيعي. مائلة: الأحرف مائلة بصريا إلى اليمين.
FontWeight	يحدد قيم FontWeight. يمكن استخدام KnownFontWeight بالتبادل مع FontWeight، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة عادي: يتم تمثيل الأحرف بشكل طبيعي. غامق: يتم تمثيل الأحرف بسكتات أكثر سمكا.
FormRecognizerFeature	إمكانات الوظيفة الإضافية (الميزات) التي يمكن تمكينها للطلب. لمزيد من المعلومات حول الميزات المتوفرة في Form Recognizer، راجع وثائق الخدمة: https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	إدخال طلب يمكن تحميله كبيانات ثنائية إلى خدمة Form Recognizer. يعامل Form Recognizer المدخلات string كعناوين URL، لذلك لإرسال سلسلة كإدخل ثنائي ، قم أولا بتحويل السلسلة إلى أحد أنواع الإدخال التالية.
LengthUnit	يحدد قيم LengthUnit. يمكن استخدام KnownLengthUnit بالتبادل مع LengthUnit، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة بكسل: وحدة الطول لملفات الصور. بوصة: وحدة الطول لملفات PDF.
OperationDetailsUnion	تفاصيل حول أي من عدة أنواع مختلفة من عمليات إدارة Form Recognizer.
OperationKind	يحدد قيم OperationKind. يمكن استخدام KnownOperationKind بالتبادل مع OperationKind، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة documentModelBuild: إنشاء نموذج مستند مخصص جديد. documentModelCompose: إنشاء نموذج مستند مخصص جديد من النماذج الموجودة. documentModelCopyTo: انسخ نموذج مستند موجود إلى مورد أو منطقة أو اشتراك مختلف محتمل. documentClassifierBuild: إنشاء نموذج مصنف مخصص جديد.
OperationStatus	يحدد قيم OperationStatus.
ParagraphRole	تعريف قيم ParagraphRole. يمكن استخدام KnownParagraphRole بالتبادل مع ParagraphRole، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة pageHeader: نص بالقرب من الحافة العلوية للصفحة. pageFooter: نص بالقرب من الحافة السفلية للصفحة. pageNumber: رقم الصفحة. العنوان: عنوان المستوى الأعلى الذي يصف المستند بأكمله. sectionHeading: عنوان فرعي يصف مقطعا من المستند. الحاشية السفلية: عادة ما يتم وضع ملاحظة بعد المحتوى الرئيسي على الصفحة. formulaBlock: كتلة من الصيغ، غالبا مع محاذاة مشتركة.
SelectionMarkState	يحدد قيم SelectionMarkState. يمكن استخدام KnownSelectionMarkState بالتبادل مع SelectionMarkState، ويحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة. القيم المعروفة التي تدعمها الخدمة محدد: يتم تحديد علامة التحديد، وغالبا ما يشار إليها بواسطة فحص ✓ أو عبر X داخل علامة التحديد. غير محدد: لم يتم تحديد علامة التحديد.
StringIndexType	أنواع فهرس السلسلة الصالحة التي تدعمها خدمة Form Recognizer وعملاء SDK.

التعدادات

KnownDocumentBarcodeKind	القيم المعروفة ل DocumentBarcodeKind التي تقبلها الخدمة.
KnownDocumentBuildMode	القيم المعروفة ل DocumentBuildMode التي تقبلها الخدمة.
KnownDocumentFieldType	القيم المعروفة ل DocumentFieldType التي تقبلها الخدمة.
KnownDocumentFormulaKind	القيم المعروفة ل DocumentFormulaKind التي تقبلها الخدمة.
KnownDocumentSignatureType	القيم المعروفة ل DocumentSignatureType التي تقبلها الخدمة.
KnownDocumentTableCellKind	القيم المعروفة ل DocumentTableCellKind التي تقبلها الخدمة.
KnownFontStyle	القيم المعروفة ل FontStyle التي تقبلها الخدمة.
KnownFontWeight	القيم المعروفة ل FontWeight التي تقبلها الخدمة.
KnownLengthUnit	القيم المعروفة ل LengthUnit التي تقبلها الخدمة.
KnownOperationKind	القيم المعروفة ل OperationKind التي تقبلها الخدمة.
KnownParagraphRole	القيم المعروفة ل ParagraphRole التي تقبلها الخدمة.
KnownSelectionMarkState	القيم المعروفة ل SelectionMarkState التي تقبلها الخدمة.