@azure/ai-form-recognizer package

بيانات اعتماد مستندة إلى مفتاح ثابت تدعم تحديث قيمة المفتاح الأساسي.

عميل للتفاعل مع ميزات تحليل خدمة Form Recognizer.

امثله:

تدعم خدمة Form Recognizer والعملاء وسيلتين للمصادقة:

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 (مفتاح الاشتراك)

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

عميل للتفاعل مع ميزات إدارة نموذج خدمة Form Recognizer، مثل إنشاء النماذج وقراءتها وإدراجها وحذفها ونسخها.

امثله:

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 (مفتاح الاشتراك)

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

قيمة حقل العنوان.

خيارات لعملية تحليل المستند.

نتيجة عملية التحليل. قد يتم تحديد نوع المستند بواسطة النموذج المستخدم لإجراء التحليل.

الحقول المشتركة لجميع أنواع AnalyzeResult مثل LayoutResult و ReadResult و GeneralDocumentResult.

كائن مستند مستخرج.

AnalyzedDocument هو مثيل لأحد أنواع المستندات داخل نموذج. تتوافق حقوله مع مخطط الحقل الخاص بنوع المستند.

مصدر بيانات تدريب تم تعريفه بواسطة حاوية Azure Blob وقائمة ملفات JSONL داخل الحاوية.

قائمة الملفات في Azure Blob Storage.

مصدر بيانات التدريب المحدد بواسطة حاوية Azure Blob.

محتوى Azure Blob Storage.

خيارات لعملية إنشاء مصنف المستند.

خيارات لعملية بناء النموذج.

خيارات لعملية إنشاء النموذج.

خيارات لعملية نموذج النسخ.

مضلع إحاطة في صفحة معينة من الإدخال.

معلومات نوع مستند المصنف.

خيارات لعملية تصنيف المستند.

الخيارات الشائعة لجميع العمليات التي تحدد نماذج جديدة، مثل beginBuildDocumentModelbeginComposeDocumentModelgetCopyAuthorization.

تخويل لنسخ نموذج مستند إلى المورد الهدف المحدد ومعرف النموذج.

خيارات لعملية إنشاء النموذج.

قيمة حقل العملة.

تفاصيل تتعلق بنماذج المستندات المخصصة.

خيارات حذف النموذج.

حقل مستند يصف عنوانا ماديا منظما.

خيارات قابلة للتكوين ل DocumentAnalysisClient.

حالة عملية التحليل، والتي ستنتج في النهاية نوع النتيجة الذي يتوافق مع النموذج.

عنصر تعليق توضيحي مرئي في المستند، مثل علامة اختيار أو علامة تقاطع.

DocumentField يتكون من صفيف من الحقول المتداخلة. سيكون لكل الحقول في الصفيف نفس النوع.

رمز شريطي مستخرج.

DocumentField له قيمة منطقية.

كائن يمثل موقع التسمية التوضيحية للجدول ومحتواها.

الحصول على كائن استجابة العملية.

معلومات مصنف المستند.

مجموعة من المصادر المستخدمة لإنشاء مصنف مستند. هذه خريطة لأسماء أنواع المستندات إلى المصادر التي سيتم استخدامها لتدريب النموذج لتصنيف المستندات من نوع المصدر المقابل.

حالة عملية إنشاء نموذج.

DocumentField له قيمة تشير إلى بلد أو منطقة، ممثلة كسلسلة.

DocumentField الذي يصف مبلغ عملة معينة.

DocumentField الذي يحتوي على قيمة Date.

الحقول الشائعة في كافة متغيرات DocumentField.

وصف المخطط الدلالي للحقل باستخدام بناء جملة نمط مخطط JSON.

كائن يمثل موقع ومحتوى حاشية سفلية للجدول.

صيغة مستخرجة.

DocumentField له قيمة عدد صحيح.

كائن يمثل مفتاح الحقل أو القيمة في زوج قيم المفاتيح.

كائن يمثل حقل نموذج مع تسمية حقل مميزة (مفتاح) وقيمة حقل (قد يكون فارغا).

كائن يمثل اللغة المكتشفة لنص معين.

كائن سطر محتوى يتكون من تسلسل متجاورة من عناصر المحتوى، مثل الكلمات وعلامات التحديد.

مواصفات نموذج معروفة تدعم استخراج المستندات المنظمة.

راجع الأسلوب beginAnalyzeDocumentDocumentAnalysisClient، والذي يدعم استهلاك هذه الكائنات DocumentModel بدلا من سلاسل معرف النموذج لتوفير أنواع نتائج أقوى.

خيارات قابلة للتكوين ل DocumentModelAdministrationClient.

الحصول على كائن استجابة العملية.

الحصول على كائن استجابة العملية.

الحصول على كائن استجابة العملية.

معلومات نموذج المستند.

حالة عملية إنشاء نموذج.

ملخص نموذج المستند.

DocumentField يحتوي على قيمة رقمية.

DocumentField يتكون من عدة خصائص مسماة لها قيم DocumentField الخاصة بها.

عناصر المحتوى والتخطيط المستخرجة من صفحة من الإدخال.

كائن فقرة يتكون من أسطر متقاربة بشكل عام مع محاذاة وتباعد مشتركين.

DocumentField يحتوي على قيمة رقم هاتف، ممثلة كسلسلة.

كائن علامة تحديد يمثل خانات الاختيار والأزرار التبادلية والعناصر الأخرى التي تشير إلى تحديد.

DocumentField الذي يحتوي على قيمة تشير إلى حالة علامة التحديد (مثل خانة اختيار أو زر تبادلي)، ممثلة كسلسلة.

DocumentField يشير إلى حالة التوقيع، ممثل كسلسلة.

منطقة متجاورة لخاصية المحتوى المتسلسلة، المحددة كإزاحة وطول.

DocumentField يحتوي على قيمة سلسلة.

كائن يمثل أنماط النص التي تمت ملاحظتها.

كائن جدول يتكون من خلايا جدول مرتبة في تخطيط مستطيل.

كائن يمثل موقع خلية جدول ومحتواها.

DocumentField له قيمة زمنية، ممثلة كسلسلة.

معلومات نوع المستند.

حقل بسيط له قيمة بدائية، مثل سلسلة ورقم وما إلى ذلك.

كائن كلمة يتكون من تسلسل متقارب من الأحرف. بالنسبة للغات المحددة غير الفضائية، مثل الصينية واليابانية والكورية، يتم تمثيل كل حرف ككلمة خاصة به.

معلومات الخطأ.

خيارات لأسلوب الحصول على تخويل النسخ.

خيارات لاسترداد معلومات النموذج.

خيارات لاسترداد حالة عملية.

خيارات لاسترداد معلومات مورد Form Recognizer.

يتم ربط عناصر المستند البسيطة مثل الكلمات وعلامات التحديد والخطوط بالمضلع.

خطأ مفصل.

خيارات لإدراج النماذج.

خيارات لإدراج العمليات.

مجموعة الحقول المشتركة في جميع عمليات الإدارة.

الحصول على كائن استجابة العملية.

معلومات العملية.

يمثل نقطة تستخدم لتعريف المضلعات المحيطة. الوحدة إما "بكسل" أو "بوصة" (راجع LengthUnit).

خيارات العمليات طويلة الأمد (الاستقصاءات) في عملاء Form Recognizer.

الحصة النسبية المستخدمة والحد من تاريخ/وقت إعادة التعيين التالي.

معلومات عامة حول المورد الحالي.

عملية طويلة الأمد (poller) تتعقب حالة عملية التحليل، وتنتج في النهاية نوع النتيجة الذي يتوافق مع النموذج.

تعريف قيم AnalyzeResultOperationStatus.

تعريف قيم DocumentBarcodeKind.
KnownDocumentBarcodeKind يمكن استخدامها بالتبادل مع DocumentBarcodeKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

QRCode: رمز الاستجابة السريعة، كما هو محدد في ISO/IEC 18004:2015.
PDF417: PDF417، كما هو محدد في ISO 15438.
UPCA: رمز المنتج العالمي المكون من 12 رقما GS1.
UPCE: رمز المنتج العالمي المكون من 6 أرقام GS1.
Code39: الرمز الشريطي 39، كما هو محدد في ISO/IEC 16388:2007.
Code128: الرمز الشريطي 128، كما هو محدد في ISO/IEC 15417:2007.
EAN8: رقم المقالة الدولية المكون من 8 أرقام GS1 (رقم المقالة الأوروبية).
EAN13: رقم المقالة الدولية المكون من 13 رقما GS1 (رقم المقالة الأوروبية).
DataBar: رمز شريط بيانات GS1.
Code93: الرمز الشريطي 93، كما هو محدد في ANSI/AIM BC5-1995.
Codabar: كود Codabar الشريطي، كما هو محدد في ANSI/AIM BC3-1995.
DataBarExpanded: الباركود الموسع ل GS1 DataBar.
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.
يمكن استخدام KnownDocumentBuildMode بالتبادل مع DocumentBuildMode، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

قالب: استهداف المستندات بقوالب مرئية مماثلة.
العصبية: دعم المستندات باستخدام قوالب مرئية متنوعة.

عملية طويلة الأمد (poller) تتعقب حالة عملية إنشاء مصنف مخصص، وتنتج في النهاية DocumentClassifierDetails.

مصدر محتوى يمكن استخدامه لإنشاء مصنف مستند.

أحد:

• مصدر البيانات الثنائية الكبيرة
• BlobFileListSource

حقل مستخرج. تحدد الخاصية kind (تميز) نوع DocumentField.

تعريف قيم DocumentFieldType.
KnownDocumentFieldType يمكن استخدامها بالتبادل مع DocumentFieldType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

سلسلة: نص عادي.
التاريخ: التاريخ، تمت تسويته بتنسيق ISO 8601 (YYYY-MM-DD).
الوقت: الوقت، تمت تسويته بتنسيق ISO 8601 (hh:mm:ss).
phoneNumber: رقم الهاتف، تمت تسويته بتنسيق E.164 (+{CountryCode}{SubscriberNumber}).
رقم: رقم الفاصلة العائمة، تمت تسويته إلى نقطة عائمة مزدوجة الدقة.
عدد صحيح: عدد صحيح، تمت تسويته إلى عدد صحيح موقع 64 بت.
selectMark: هل الحقل محدد؟
countryRegion: Country/region، تمت تسويتها إلى تنسيق ISO 3166-1 alpha-3 (على سبيل المثال، USA).
التوقيع : هل التوقيع موجود؟
صفيف: قائمة الحقول الفرعية من نفس النوع.
الكائن: قائمة مسماة من الحقول الفرعية من أنواع مختلفة محتملة.
العملة: مبلغ العملة برمز عملة اختياري ووحدة.
عنوان : عنوان تم تحليله.
المنطقية: قيمة منطقية، تمت تسويتها إلى صواب أو خطأ.

تعريف قيم DocumentFormulaKind.
KnownDocumentFormulaKind يمكن استخدامها بالتبادل مع DocumentFormulaKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

مضمنة: صيغة مضمنة في محتوى فقرة.
عرض: صيغة في وضع العرض تأخذ سطرا كاملا.

عملية طويلة الأمد (poller) تتعقب حالة عملية إنشاء نموذج، وتنتج في النهاية DocumentModelDetails.

مصدر محتوى يمكن استخدامه لإنشاء نموذج مستند.

أحد:

• مصدر البيانات الثنائية الكبيرة
• BlobFileListSource

تعريف قيم DocumentSignatureType.
KnownDocumentSignatureType يمكن استخدامها بالتبادل مع DocumentSignatureType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

توقيع: يتم الكشف عن توقيع.
غير موقعة: لم يتم الكشف عن أي تواقيع.

تعريف قيم DocumentTableCellKind.
KnownDocumentTableCellKind يمكن استخدامها بالتبادل مع DocumentTableCellKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

المحتوى: يحتوي على المحتوى/البيانات الرئيسية.
rowHeader: يصف محتوى الصف.
columnHeader: يصف محتوى العمود.
stubHead: يصف رؤوس الصفوف، الموجودة عادة في الزاوية العلوية اليمنى من الجدول.
الوصف: يصف المحتوى في (أجزاء) الجدول.

تعريف قيم FontStyle.
يمكن استخدام KnownFontStyle بالتبادل مع FontStyle، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

العادي : يتم تمثيل الأحرف بشكل طبيعي.
مائل: الأحرف مائلة بصريا إلى اليمين.

تعريف قيم FontWeight.
يمكن استخدام KnownFontWeight بالتبادل مع FontWeight، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

العادي : يتم تمثيل الأحرف بشكل طبيعي.
الغامق: يتم تمثيل الأحرف بضغطات أكثر سمكا.

إدخال طلب يمكن تحميله كبيانات ثنائية إلى خدمة Form Recognizer. تعامل Form Recognizer المدخلات string كعناوين URL، بحيث ترسل سلسلة كإدخل ثنائي، قم أولا بتحويل السلسلة إلى أحد أنواع الإدخال التالية.

تعريف قيم LengthUnit.
يمكن استخدام KnownLengthUnit بالتبادل مع LengthUnit، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

بكسل: وحدة الطول لملفات الصور.
بوصة: وحدة الطول لملفات PDF.

تفاصيل حول أي من عدة أنواع مختلفة من عمليات إدارة Form Recognizer.

تعريف قيم OperationKind.
KnownOperationKind يمكن استخدامها بالتبادل مع OperationKind، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

documentModelBuild: إنشاء نموذج مستند مخصص جديد.
documentModelCompose: إنشاء نموذج مستند مخصص جديد من النماذج الموجودة.
documentModelCopyTo: انسخ نموذج مستند موجود إلى مورد أو منطقة أو اشتراك مختلف محتمل.
documentClassifierBuild: إنشاء نموذج مصنف مخصص جديد.

تعريف قيم OperationStatus.

تعريف قيم ParagraphRole.
يمكن استخدام KnownParagraphRole بالتبادل مع ParagraphRole، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

pageHeader: نص بالقرب من الحافة العلوية للصفحة.
pageFooter: نص بالقرب من الحافة السفلية للصفحة.
pageNumber: رقم الصفحة.
عنوان : عنوان من المستوى الأعلى يصف المستند بأكمله.
القسمعنوان: عنوان فرعي يصف مقطعا من المستند.
الحاشية السفلية: عادة ما يتم وضع ملاحظة بعد المحتوى الرئيسي على الصفحة.
formulaBlock: كتلة من الصيغ، غالبا مع محاذاة مشتركة.

تعريف قيم SelectionMarkState.
يمكن استخدام KnownSelectionMarkState بالتبادل مع SelectionMarkState، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

المحدد: يتم تحديد علامة التحديد، وغالبا ما يشار إليها بواسطة فحص ✓ أو عبر X داخل علامة التحديد.
غير محدد: لم يتم تحديد علامة التحديد.

القيم المعروفة DocumentBarcodeKind التي تقبلها الخدمة.

القيم المعروفة DocumentBuildMode التي تقبلها الخدمة.

القيم المعروفة DocumentFieldType التي تقبلها الخدمة.

القيم المعروفة DocumentFormulaKind تقبلها الخدمة.

القيم المعروفة DocumentSignatureType التي تقبلها الخدمة.

القيم المعروفة DocumentTableCellKind تقبلها الخدمة.

القيم المعروفة FontStyle التي تقبلها الخدمة.

القيم المعروفة FontWeight التي تقبلها الخدمة.

يحدد جماهير السحابة المعروفة ل Form Recognizer.

للمصادقة باستخدام معرف Entra (باستخدام ملف TokenCredential) في بيئة سحابة سيادية ، قم بتوفير القيمة المناسبة أدناه كخيار audience عند إنشاء ملف DocumentAnalysisClient أو DocumentModelAdministrationClient.

القيمة الافتراضية مناسبة لموارد Form Recognizer التي تم إنشاؤها في Azure Public Cloud، لذا فإن هذه القيمة مطلوبة فقط لاستخدام Form Recognizer في بيئة سحابية مختلفة.

القيم المعروفة LengthUnit التي تقبلها الخدمة.

القيم المعروفة OperationKind التي تقبلها الخدمة.

القيم المعروفة ParagraphRole التي تقبلها الخدمة.

القيم المعروفة SelectionMarkState التي تقبلها الخدمة.

القيم المدعومة ل DocumentModelBuildMode.

أعلام الميزات المعروفة التي يدعمها عملاء Form Recognizer.

القيم المدعومة ل StringIndexType.