DocumentModelAdministrationClient class

‏‏المرجع

الحزمة:: @azure/ai-form-recognizer

عميل للتفاعل مع ميزات إدارة النموذج لخدمة 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);

المنشئون

DocumentModelAdministrationClient(string, KeyCredential, DocumentModelAdministrationClientOptions)

إنشاء مثيل DocumentModelAdministrationClient من نقطة نهاية مورد ومفتاح API ثابت (KeyCredential)،

مثال:

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

DocumentModelAdministrationClient(string, TokenCredential, DocumentModelAdministrationClientOptions)

إنشاء مثيل DocumentModelAdministrationClient من نقطة نهاية مورد وهوية TokenCredentialAzure .

راجع الحزمة @azure/identity لمزيد من المعلومات حول المصادقة باستخدام 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);

الأساليب

beginBuildDocumentClassifier(string, DocumentClassifierDocumentTypeSources, BeginBuildDocumentClassifierOptions)	إنشاء مصنف مستند جديد باستخدام معرف المصنف المحدد وأنواع المستندات. يجب أن يكون معرف المصنف فريدا بين المصنفات داخل المورد. يتم إعطاء أنواع المستندات ككائن يقوم بتعيين اسم نوع المستند إلى مجموعة بيانات التدريب لنوع المستند هذا. يتم دعم طريقتين لإدخال بيانات التدريب: `azureBlobSource`، الذي يدرب مصنفا باستخدام البيانات في حاوية Azure Blob Storage المحددة. `azureBlobFileListSource`، وهو مشابه `azureBlobSource` ولكنه يسمح بمزيد من التحكم الدقيق في الملفات المضمنة في مجموعة بيانات التدريب باستخدام قائمة ملفات بتنسيق JSONL. تقرأ خدمة Form Recognizer مجموعة بيانات التدريب من حاوية Azure Storage، والتي يتم منحها كعنون URL للحاوية برمز SAS المميز الذي يسمح للواجهة الخلفية للخدمة بالاتصال بالحاوية. كحد أدنى، أذونات "القراءة" و"القائمة" مطلوبة. بالإضافة إلى ذلك، يجب تنظيم البيانات الموجودة في الحاوية المحددة وفقا لاصطلاح معين، والذي تم توثيقه في وثائق الخدمة لإنشاء مصنفات مستندات مخصصة. مثال const classifierId = "aNewClassifier"; const containerUrl1 = "<training data container SAS URL 1>"; const containerUrl2 = "<training data container SAS URL 2>"; const poller = await client.beginBuildDocumentClassifier( classifierId, { // The document types. Each entry in this object should map a document type name to a // `ClassifierDocumentTypeDetails` object "formX": { azureBlobSource: { containerUrl: containerUrl1, } }, "formY": { azureBlobFileListSource: { containerUrl: containerUrl2, fileList: "path/to/fileList.jsonl" } }, }, { // Optionally, a text description may be attached to the classifier description: "This is an example classifier!" } ); // Classifier building, like model creation operations, returns a poller that eventually produces a // DocumentClassifierDetails object const classifierDetails = await poller.pollUntilDone(); const { classifierId, // identical to the classifierId given when creating the classifier description, // identical to the description given when creating the classifier (if any) createdOn, // the Date (timestamp) that the classifier was created docTypes // information about the document types in the classifier and their details } = classifierDetails;
beginBuildDocumentModel(string, DocumentModelSource, DocumentModelBuildMode, BeginBuildDocumentModelOptions)	إنشاء نموذج جديد بمعرف معين من مصدر محتوى نموذج. يمكن أن يتكون معرف النموذج من أي نص، طالما أنه لا يبدأ ب "تم إنشاؤه مسبقا" (حيث تشير هذه النماذج إلى نماذج Form Recognizer التي تم إنشاؤها مسبقا والمشتركة في جميع الموارد)، وطالما أنها غير موجودة بالفعل داخل المورد. يصف مصدر المحتوى الآلية التي ستستخدمها الخدمة لقراءة بيانات تدريب الإدخال. <xref:DocumentModelContentSource> راجع النوع لمزيد من المعلومات. مثال const modelId = "aNewModel"; const poller = await client.beginBuildDocumentModel(modelId, { containerUrl: "<SAS-encoded blob container URL>" }, { // Optionally, a text description may be attached to the model description: "This is an example model!" }); // Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails // object const modelDetails = await poller.pollUntilDone(); const { modelId, // identical to the modelId given when creating the model description, // identical to the description given when creating the model createdOn, // the Date (timestamp) that the model was created docTypes // information about the document types in the model and their field schemas } = modelDetails;
beginBuildDocumentModel(string, string, DocumentModelBuildMode, BeginBuildDocumentModelOptions)	إنشاء نموذج جديد بمعرف معين من مجموعة من مستندات الإدخال والحقول المسماة. يمكن أن يتكون معرف النموذج من أي نص، طالما أنه لا يبدأ ب "تم إنشاؤه مسبقا" (حيث تشير هذه النماذج إلى نماذج Form Recognizer التي تم إنشاؤها مسبقا والمشتركة في جميع الموارد)، وطالما أنها غير موجودة بالفعل داخل المورد. تقرأ خدمة Form Recognizer مجموعة بيانات التدريب من حاوية Azure Storage، والتي يتم منحها كعنون URL للحاوية برمز SAS المميز الذي يسمح للواجهة الخلفية للخدمة بالاتصال بالحاوية. كحد أدنى، أذونات "القراءة" و"القائمة" مطلوبة. بالإضافة إلى ذلك، يجب تنظيم البيانات الموجودة في الحاوية المحددة وفقا لاصطلاح معين، وهو موثق في وثائق الخدمة لبناء نماذج مخصصة. مثال const modelId = "aNewModel"; const containerUrl = "<training data container SAS URL>"; const poller = await client.beginBuildDocumentModel(modelId, containerUrl, { // Optionally, a text description may be attached to the model description: "This is an example model!" }); // Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails // object const modelDetails = await poller.pollUntilDone(); const { modelId, // identical to the modelId given when creating the model description, // identical to the description given when creating the model createdOn, // the Date (timestamp) that the model was created docTypes // information about the document types in the model and their field schemas } = modelDetails;
beginComposeDocumentModel(string, Iterable<string>, BeginComposeDocumentModelOptions)	إنشاء نموذج واحد مكون من عدة نماذج فرعية موجودة مسبقا. يجمع النموذج المكون الناتج بين أنواع المستندات لنماذج المكونات الخاصة به، ويدرج خطوة تصنيف في مسار الاستخراج لتحديد أي من نماذجه الفرعية المكونة هو الأنسب للإدخال المحدد. مثال const modelId = "aNewComposedModel"; const subModelIds = [ "documentType1Model", "documentType2Model", "documentType3Model" ]; // The resulting composed model can classify and extract data from documents // conforming to any of the above document types const poller = await client.beginComposeDocumentModel(modelId, subModelIds, { description: "This is a composed model that can handle several document types." }); // Model composition, like all other model creation operations, returns a poller that eventually produces a // ModelDetails object const modelDetails = await poller.pollUntilDone(); const { modelId, // identical to the modelId given when creating the model description, // identical to the description given when creating the model createdOn, // the Date (timestamp) that the model was created docTypes // information about the document types of the composed submodels } = modelDetails;
beginCopyModelTo(string, CopyAuthorization, BeginCopyModelOptions)	نسخ نموذج مع المعرف المحدد في المورد ومعرف النموذج المشفر بواسطة تخويل نسخ معين. راجع CopyAuthorization و getCopyAuthorization. مثال // We need a client for the source model's resource const sourceEndpoint = "https://<source resource name>.cognitiveservices.azure.com"; const sourceCredential = new AzureKeyCredential("<source api key>"); const sourceClient = new DocumentModelAdministrationClient(sourceEndpoint, sourceCredential); // We create the copy authorization using a client authenticated with the destination resource. Note that these two // resources can be the same (you can copy a model to a new ID in the same resource). const copyAuthorization = await client.getCopyAuthorization("<destination model ID>"); // Finally, use the _source_ client to copy the model and await the copy operation const poller = await sourceClient.beginCopyModelTo("<source model ID>"); // Model copying, like all other model creation operations, returns a poller that eventually produces a ModelDetails // object const modelDetails = await poller.pollUntilDone(); const { modelId, // identical to the modelId given when creating the copy authorization description, // identical to the description given when creating the copy authorization createdOn, // the Date (timestamp) that the model was created docTypes // information about the document types of the model (identical to the original, source model) } = modelDetails;
deleteDocumentClassifier(string, OperationOptions)	يحذف مصنفا بالمعرف المحدد من مورد العميل، إذا كان موجودا. لا يمكن إرجاع هذه العملية. مثال `await client.deleteDocumentClassifier("<classifier ID to delete>"));`
deleteDocumentModel(string, DeleteDocumentModelOptions)	حذف نموذج بالمعرف المحدد من مورد العميل، إذا كان موجودا. لا يمكن إرجاع هذه العملية. مثال `await client.deleteDocumentModel("<model ID to delete>"));`
getCopyAuthorization(string, GetCopyAuthorizationOptions)	إنشاء تخويل لنسخ نموذج إلى المورد، المستخدم مع `beginCopyModelTo` الأسلوب . يمنح `CopyAuthorization` مورد خدمة معرفية آخر الحق في إنشاء نموذج في مورد هذا العميل مع معرف النموذج والوصف الاختياري الذي يتم ترميزه في التخويل. مثال `// The copyAuthorization data structure stored below grants any cognitive services resource the right to copy a // model into the client's resource with the given destination model ID. const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");`
getDocumentClassifier(string, OperationOptions)	استرداد معلومات حول مصنف (DocumentClassifierDetails) حسب المعرف. مثال const classifierId = "<classifier ID"; const { classifierId, // identical to the ID given when calling `getDocumentClassifier` description, // a textual description of the classifier, if provided during classifier creation createdOn, // the Date (timestamp) that the classifier was created // information about the document types in the classifier and their corresponding traning data docTypes } = await client.getDocumentClassifier(classifierId); // The `docTypes` property is a map of document type names to information about the training data // for that document type. for (const [docTypeName, classifierDocTypeDetails] of Object.entries(docTypes)) { console.log(`- '${docTypeName}': `, classifierDocTypeDetails); }
getDocumentModel(string, GetModelOptions)	استرداد معلومات حول نموذج (DocumentModelDetails) حسب المعرف. يمكن لهذا الأسلوب استرداد معلومات حول النماذج المخصصة بالإضافة إلى النماذج التي تم إنشاؤها مسبقا. كسر التغيير في الإصدارات السابقة من Form Recognizer REST API وSDK، `getModel` يمكن للأسلوب إرجاع أي نموذج، حتى النموذج الذي فشل في الإنشاء بسبب الأخطاء. في إصدارات الخدمة الجديدة، `getDocumentModel` وإنتاج `listDocumentModels`نماذج تم إنشاؤها بنجاح فقط (أي النماذج "الجاهزة" للاستخدام). يتم الآن استرداد النماذج الفاشلة من خلال واجهات برمجة التطبيقات "العمليات"، راجع getOperation and listOperations. مثال // The ID of the prebuilt business card model const modelId = "prebuilt-businessCard"; const { modelId, // identical to the modelId given when calling `getDocumentModel` description, // a textual description of the model, if provided during model creation createdOn, // the Date (timestamp) that the model was created // information about the document types in the model and their field schemas docTypes: { // the document type of the prebuilt business card model "prebuilt:businesscard": { // an optional, textual description of this document type description, // the schema of the fields in this document type, see the FieldSchema type fieldSchema, // the service's confidences in the fields (an object with field names as properties and numeric confidence // values) fieldConfidence } } } = await client.getDocumentModel(modelId);
getOperation(string, GetOperationOptions)	استرداد معلومات حول عملية (`OperationDetails`) بواسطة معرفها. تمثل العمليات مهاما غير تحليلية، مثل إنشاء نموذج أو إنشاؤه أو نسخه.
getResourceDetails(GetResourceDetailsOptions)	استرداد المعلومات الأساسية حول مورد هذا العميل. مثال `const { // Information about the custom models in the current resource customDocumentModelDetails: { // The number of custom models in the current resource count, // The maximum number of models that the current resource can support limit } } = await client.getResourceDetails();`
listDocumentClassifiers(ListModelsOptions)	سرد تفاصيل حول المصنفات في المورد. تدعم هذه العملية الترحيل. أمثلة تكرار غير متزامن `for await (const details of client.listDocumentClassifiers()) { const { classifierId, // The classifier's unique ID description, // a textual description of the classifier, if provided during creation docTypes, // information about the document types in the classifier and their corresponding traning data } = details; }` حسب الصفحة // The listDocumentClassifiers method is paged, and you can iterate by page using the `byPage` method. const pages = client.listDocumentClassifiers().byPage(); for await (const page of pages) { // Each page is an array of classifiers and can be iterated synchronously for (const details of page) { const { classifierId, // The classifier's unique ID description, // a textual description of the classifier, if provided during creation docTypes, // information about the document types in the classifier and their corresponding traning data } = details; } }
listDocumentModels(ListModelsOptions)	سرد ملخصات النماذج في المورد. سيتم تضمين النماذج المخصصة بالإضافة إلى النماذج التي تم إنشاؤها مسبقا. تدعم هذه العملية الترحيل. يتضمن ملخص النموذج (DocumentModelSummary) المعلومات الأساسية حول النموذج فقط، ولا يتضمن معلومات حول أنواع المستندات في النموذج (مثل مخططات الحقول وقيم الثقة). للوصول إلى المعلومات الكاملة حول النموذج، استخدم getDocumentModel. كسر التغيير في الإصدارات السابقة من واجهة برمجة تطبيقات REST ل Form Recognizer وSDK، `listModels` سيعيد الأسلوب جميع النماذج، حتى تلك التي فشلت في الإنشاء بسبب الأخطاء. في إصدارات الخدمة الجديدة، `listDocumentModels` وإنتاج `getDocumentModel`نماذج تم إنشاؤها بنجاح فقط (أي النماذج "الجاهزة" للاستخدام). يتم الآن استرداد النماذج الفاشلة من خلال واجهات برمجة التطبيقات "العمليات"، راجع getOperation and listOperations. أمثلة تكرار غير متزامن for await (const summary of client.listDocumentModels()) { const { modelId, // The model's unique ID description, // a textual description of the model, if provided during model creation } = summary; // You can get the full model info using `getDocumentModel` const model = await client.getDocumentModel(modelId); } حسب الصفحة // The listDocumentModels method is paged, and you can iterate by page using the `byPage` method. const pages = client.listDocumentModels().byPage(); for await (const page of pages) { // Each page is an array of models and can be iterated synchronously for (const model of page) { const { modelId, // The model's unique ID description, // a textual description of the model, if provided during model creation } = summary; // You can get the full model info using `getDocumentModel` const model = await client.getDocumentModel(modelId); } }
listOperations(ListOperationsOptions)	سرد عمليات إنشاء النموذج في المورد. سيؤدي ذلك إلى إنتاج جميع العمليات، بما في ذلك العمليات التي فشلت في إنشاء النماذج بنجاح. تدعم هذه العملية الترحيل. أمثلة تكرار غير متزامن `for await (const operation of client.listOperations()) { const { operationId, // the operation's GUID status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled" percentCompleted // the progress of the operation, from 0 to 100 } = operation; }` حسب الصفحة // The listOperations method is paged, and you can iterate by page using the `byPage` method. const pages = client.listOperations().byPage(); for await (const page of pages) { // Each page is an array of operation info objects and can be iterated synchronously for (const operation of page) { const { operationId, // the operation's GUID status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled" percentCompleted // the progress of the operation, from 0 to 100 } = operation; } }

تفاصيل المنشئ

DocumentModelAdministrationClient(string, KeyCredential, DocumentModelAdministrationClientOptions)

إنشاء مثيل DocumentModelAdministrationClient من نقطة نهاية مورد ومفتاح API ثابت (KeyCredential)،

مثال:

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

new DocumentModelAdministrationClient(endpoint: string, credential: KeyCredential, options?: DocumentModelAdministrationClientOptions)

المعلمات

endpoint: string

عنوان URL لنقطة النهاية لمثيل Azure Cognitive Services

credential: KeyCredential

KeyCredential يحتوي على مفتاح اشتراك مثيل الخدمات المعرفية

options: DocumentModelAdministrationClientOptions

الإعدادات الاختيارية لتكوين جميع الأساليب في العميل

DocumentModelAdministrationClient(string, TokenCredential, DocumentModelAdministrationClientOptions)

إنشاء مثيل DocumentModelAdministrationClient من نقطة نهاية مورد وهوية TokenCredentialAzure .

راجع الحزمة @azure/identity لمزيد من المعلومات حول المصادقة باستخدام 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);

new DocumentModelAdministrationClient(endpoint: string, credential: TokenCredential, options?: DocumentModelAdministrationClientOptions)

المعلمات

endpoint: string

عنوان URL لنقطة النهاية لمثيل Azure Cognitive Services

credential: TokenCredential

مثيل TokenCredential من الحزمة @azure/identity

options: DocumentModelAdministrationClientOptions

الإعدادات الاختيارية لتكوين جميع الأساليب في العميل

تفاصيل الأسلوب

beginBuildDocumentClassifier(string, DocumentClassifierDocumentTypeSources, BeginBuildDocumentClassifierOptions)

إنشاء مصنف مستند جديد باستخدام معرف المصنف المحدد وأنواع المستندات.

يجب أن يكون معرف المصنف فريدا بين المصنفات داخل المورد.

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

azureBlobSource، الذي يدرب مصنفا باستخدام البيانات في حاوية Azure Blob Storage المحددة.
azureBlobFileListSource، وهو مشابه azureBlobSource ولكنه يسمح بمزيد من التحكم الدقيق في الملفات المضمنة في مجموعة بيانات التدريب باستخدام قائمة ملفات بتنسيق JSONL.

تقرأ خدمة Form Recognizer مجموعة بيانات التدريب من حاوية Azure Storage، والتي يتم منحها كعنون URL للحاوية برمز SAS المميز الذي يسمح للواجهة الخلفية للخدمة بالاتصال بالحاوية. كحد أدنى، أذونات "القراءة" و"القائمة" مطلوبة. بالإضافة إلى ذلك، يجب تنظيم البيانات الموجودة في الحاوية المحددة وفقا لاصطلاح معين، والذي تم توثيقه في وثائق الخدمة لإنشاء مصنفات مستندات مخصصة.

مثال

const classifierId = "aNewClassifier";
const containerUrl1 = "<training data container SAS URL 1>";
const containerUrl2 = "<training data container SAS URL 2>";

const poller = await client.beginBuildDocumentClassifier(
  classifierId,
  {
    // The document types. Each entry in this object should map a document type name to a
    // `ClassifierDocumentTypeDetails` object
    "formX": {
      azureBlobSource: {
        containerUrl: containerUrl1,
      }
    },
    "formY": {
      azureBlobFileListSource: {
        containerUrl: containerUrl2,
        fileList: "path/to/fileList.jsonl"
      }
    },
  },
  {
    // Optionally, a text description may be attached to the classifier
    description: "This is an example classifier!"
  }
);

// Classifier building, like model creation operations, returns a poller that eventually produces a
// DocumentClassifierDetails object
const classifierDetails = await poller.pollUntilDone();

const {
  classifierId, // identical to the classifierId given when creating the classifier
  description, // identical to the description given when creating the classifier (if any)
  createdOn, // the Date (timestamp) that the classifier was created
  docTypes // information about the document types in the classifier and their details
} = classifierDetails;

function beginBuildDocumentClassifier(classifierId: string, docTypeSources: DocumentClassifierDocumentTypeSources, options?: BeginBuildDocumentClassifierOptions): Promise<DocumentClassifierPoller>

المعلمات

classifierId: string

المعرف الفريد للمصنف المراد إنشاؤه

docTypeSources: DocumentClassifierDocumentTypeSources

أنواع المستندات المراد تضمينها في المصنف ومصادرها (خريطة لأسماء أنواع المستندات إلى ClassifierDocumentTypeDetails)

options: BeginBuildDocumentClassifierOptions

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

المرتجعات

Promise<DocumentClassifierPoller>

عملية طويلة الأمد (poller) التي ستنتج في النهاية تفاصيل المصنف الذي تم إنشاؤه أو خطأ

beginBuildDocumentModel(string, DocumentModelSource, DocumentModelBuildMode, BeginBuildDocumentModelOptions)

إنشاء نموذج جديد بمعرف معين من مصدر محتوى نموذج.

يمكن أن يتكون معرف النموذج من أي نص، طالما أنه لا يبدأ ب "تم إنشاؤه مسبقا" (حيث تشير هذه النماذج إلى نماذج Form Recognizer التي تم إنشاؤها مسبقا والمشتركة في جميع الموارد)، وطالما أنها غير موجودة بالفعل داخل المورد.

يصف مصدر المحتوى الآلية التي ستستخدمها الخدمة لقراءة بيانات تدريب الإدخال. <xref:DocumentModelContentSource> راجع النوع لمزيد من المعلومات.

مثال

const modelId = "aNewModel";

const poller = await client.beginBuildDocumentModel(modelId, { containerUrl: "<SAS-encoded blob container URL>" }, {
  // Optionally, a text description may be attached to the model
  description: "This is an example model!"
});

// Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
// object
const modelDetails = await poller.pollUntilDone();

const {
  modelId, // identical to the modelId given when creating the model
  description, // identical to the description given when creating the model
  createdOn, // the Date (timestamp) that the model was created
  docTypes // information about the document types in the model and their field schemas
} = modelDetails;

function beginBuildDocumentModel(modelId: string, contentSource: DocumentModelSource, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>

المعلمات

modelId: string

المعرف الفريد للنموذج المراد إنشاؤه

contentSource: DocumentModelSource

مصدر محتوى يوفر بيانات التدريب لهذا النموذج

buildMode: DocumentModelBuildMode

الوضع الذي يجب استخدامه عند إنشاء النموذج (راجع DocumentModelBuildMode)

options: BeginBuildDocumentModelOptions

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

المرتجعات

Promise<DocumentModelPoller>

عملية طويلة الأمد (poller) التي ستنتج في النهاية معلومات النموذج التي تم إنشاؤها أو خطأ

beginBuildDocumentModel(string, string, DocumentModelBuildMode, BeginBuildDocumentModelOptions)

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

تقرأ خدمة Form Recognizer مجموعة بيانات التدريب من حاوية Azure Storage، والتي يتم منحها كعنون URL للحاوية برمز SAS المميز الذي يسمح للواجهة الخلفية للخدمة بالاتصال بالحاوية. كحد أدنى، أذونات "القراءة" و"القائمة" مطلوبة. بالإضافة إلى ذلك، يجب تنظيم البيانات الموجودة في الحاوية المحددة وفقا لاصطلاح معين، وهو موثق في وثائق الخدمة لبناء نماذج مخصصة.

مثال

const modelId = "aNewModel";
const containerUrl = "<training data container SAS URL>";

const poller = await client.beginBuildDocumentModel(modelId, containerUrl, {
  // Optionally, a text description may be attached to the model
  description: "This is an example model!"
});

// Model building, like all other model creation operations, returns a poller that eventually produces a ModelDetails
// object
const modelDetails = await poller.pollUntilDone();

const {
  modelId, // identical to the modelId given when creating the model
  description, // identical to the description given when creating the model
  createdOn, // the Date (timestamp) that the model was created
  docTypes // information about the document types in the model and their field schemas
} = modelDetails;

function beginBuildDocumentModel(modelId: string, containerUrl: string, buildMode: DocumentModelBuildMode, options?: BeginBuildDocumentModelOptions): Promise<DocumentModelPoller>

المعلمات

modelId: string

المعرف الفريد للنموذج المراد إنشاؤه

containerUrl: string

عنوان URL المشفر بواسطة SAS إلى حاوية تخزين Azure التي تحتوي على مجموعة بيانات التدريب

buildMode: DocumentModelBuildMode

الوضع الذي يجب استخدامه عند إنشاء النموذج (راجع DocumentModelBuildMode)

options: BeginBuildDocumentModelOptions

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

المرتجعات

Promise<DocumentModelPoller>

عملية طويلة الأمد (الاستقصاء) التي ستنتج في النهاية معلومات النموذج التي تم إنشاؤها أو خطأ

beginComposeDocumentModel(string, Iterable<string>, BeginComposeDocumentModelOptions)

إنشاء نموذج واحد مكون من عدة نماذج فرعية موجودة مسبقا.

يجمع النموذج المكون الناتج بين أنواع المستندات لنماذج المكونات الخاصة به، ويدرج خطوة تصنيف في مسار الاستخراج لتحديد أي من نماذجه الفرعية المكونة هو الأنسب للإدخال المحدد.

مثال

const modelId = "aNewComposedModel";
const subModelIds = [
  "documentType1Model",
  "documentType2Model",
  "documentType3Model"
];

// The resulting composed model can classify and extract data from documents
// conforming to any of the above document types
const poller = await client.beginComposeDocumentModel(modelId, subModelIds, {
  description: "This is a composed model that can handle several document types."
});

// Model composition, like all other model creation operations, returns a poller that eventually produces a
// ModelDetails object
const modelDetails = await poller.pollUntilDone();

const {
  modelId, // identical to the modelId given when creating the model
  description, // identical to the description given when creating the model
  createdOn, // the Date (timestamp) that the model was created
  docTypes // information about the document types of the composed submodels
} = modelDetails;

function beginComposeDocumentModel(modelId: string, componentModelIds: Iterable<string>, options?: BeginComposeDocumentModelOptions): Promise<DocumentModelPoller>

المعلمات

modelId: string

المعرف الفريد للنموذج المراد إنشاؤه

componentModelIds: Iterable<string>

قابل للنسخ من السلاسل التي تمثل معرفات النموذج الفريدة للنماذج المراد إنشاؤها

options: BeginComposeDocumentModelOptions

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

المرتجعات

Promise<DocumentModelPoller>

عملية طويلة الأمد (الاستقصاء) التي ستنتج في النهاية معلومات النموذج التي تم إنشاؤها أو خطأ

beginCopyModelTo(string, CopyAuthorization, BeginCopyModelOptions)

نسخ نموذج مع المعرف المحدد في المورد ومعرف النموذج المشفر بواسطة تخويل نسخ معين.

راجع CopyAuthorization و getCopyAuthorization.

مثال

// We need a client for the source model's resource
const sourceEndpoint = "https://<source resource name>.cognitiveservices.azure.com";
const sourceCredential = new AzureKeyCredential("<source api key>");
const sourceClient = new DocumentModelAdministrationClient(sourceEndpoint, sourceCredential);

// We create the copy authorization using a client authenticated with the destination resource. Note that these two
// resources can be the same (you can copy a model to a new ID in the same resource).
const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");

// Finally, use the _source_ client to copy the model and await the copy operation
const poller = await sourceClient.beginCopyModelTo("<source model ID>");

// Model copying, like all other model creation operations, returns a poller that eventually produces a ModelDetails
// object
const modelDetails = await poller.pollUntilDone();

const {
  modelId, // identical to the modelId given when creating the copy authorization
  description, // identical to the description given when creating the copy authorization
  createdOn, // the Date (timestamp) that the model was created
  docTypes // information about the document types of the model (identical to the original, source model)
} = modelDetails;

function beginCopyModelTo(sourceModelId: string, authorization: CopyAuthorization, options?: BeginCopyModelOptions): Promise<DocumentModelPoller>

المعلمات

sourceModelId: string

المعرف الفريد للنموذج المصدر الذي سيتم نسخه

authorization: CopyAuthorization

تخويل لنسخ النموذج، الذي تم إنشاؤه باستخدام getCopyAuthorization

options: BeginCopyModelOptions

الإعدادات الاختيارية ل

المرتجعات

Promise<DocumentModelPoller>

عملية طويلة الأمد (poller) التي ستنتج في النهاية معلومات النموذج المنسخة أو خطأ

deleteDocumentClassifier(string, OperationOptions)

يحذف مصنفا بالمعرف المحدد من مورد العميل، إذا كان موجودا. لا يمكن إرجاع هذه العملية.

مثال

await client.deleteDocumentClassifier("<classifier ID to delete>"));

function deleteDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<void>

المعلمات

classifierId: string

المعرف الفريد للمصنف المراد حذفه من المورد

options: OperationOptions

الإعدادات الاختيارية للطلب

المرتجعات

Promise<void>

deleteDocumentModel(string, DeleteDocumentModelOptions)

حذف نموذج بالمعرف المحدد من مورد العميل، إذا كان موجودا. لا يمكن إرجاع هذه العملية.

مثال

await client.deleteDocumentModel("<model ID to delete>"));

function deleteDocumentModel(modelId: string, options?: DeleteDocumentModelOptions): Promise<void>

المعلمات

modelId: string

المعرف الفريد للنموذج المراد حذفه من المورد

options: DeleteDocumentModelOptions

الإعدادات الاختيارية للطلب

المرتجعات

Promise<void>

getCopyAuthorization(string, GetCopyAuthorizationOptions)

إنشاء تخويل لنسخ نموذج إلى المورد، المستخدم مع beginCopyModelTo الأسلوب .

يمنح CopyAuthorization مورد خدمة معرفية آخر الحق في إنشاء نموذج في مورد هذا العميل مع معرف النموذج والوصف الاختياري الذي يتم ترميزه في التخويل.

مثال

// The copyAuthorization data structure stored below grants any cognitive services resource the right to copy a
// model into the client's resource with the given destination model ID.
const copyAuthorization = await client.getCopyAuthorization("<destination model ID>");

function getCopyAuthorization(destinationModelId: string, options?: GetCopyAuthorizationOptions): Promise<CopyAuthorization>

المعلمات

destinationModelId: string

المعرف الفريد لنموذج الوجهة (المعرف المراد نسخ النموذج إليه)

options: GetCopyAuthorizationOptions

الإعدادات الاختيارية لإنشاء تخويل النسخ

المرتجعات

Promise<CopyAuthorization>

تخويل نسخ يقوم بترميز modelId المحدد والوصف الاختياري

getDocumentClassifier(string, OperationOptions)

استرداد معلومات حول مصنف (DocumentClassifierDetails) حسب المعرف.

مثال

const classifierId = "<classifier ID";

const {
  classifierId, // identical to the ID given when calling `getDocumentClassifier`
  description, // a textual description of the classifier, if provided during classifier creation
  createdOn, // the Date (timestamp) that the classifier was created
  // information about the document types in the classifier and their corresponding traning data
  docTypes
} = await client.getDocumentClassifier(classifierId);

// The `docTypes` property is a map of document type names to information about the training data
// for that document type.
for (const [docTypeName, classifierDocTypeDetails] of Object.entries(docTypes)) {
 console.log(`- '${docTypeName}': `, classifierDocTypeDetails);
}

function getDocumentClassifier(classifierId: string, options?: OperationOptions): Promise<DocumentClassifierDetails>

المعلمات

classifierId: string

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

options: OperationOptions

الإعدادات الاختيارية للطلب

المرتجعات

Promise<DocumentClassifierDetails>

معلومات حول المصنف مع المعرف المحدد

getDocumentModel(string, GetModelOptions)

استرداد معلومات حول نموذج (DocumentModelDetails) حسب المعرف.

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

كسر التغيير

في الإصدارات السابقة من Form Recognizer REST API وSDK، getModel يمكن للأسلوب إرجاع أي نموذج، حتى النموذج الذي فشل في الإنشاء بسبب الأخطاء. في إصدارات الخدمة الجديدة، getDocumentModel وإنتاج listDocumentModelsنماذج تم إنشاؤها بنجاح فقط (أي النماذج "الجاهزة" للاستخدام). يتم الآن استرداد النماذج الفاشلة من خلال واجهات برمجة التطبيقات "العمليات"، راجع getOperation and listOperations.

مثال

// The ID of the prebuilt business card model
const modelId = "prebuilt-businessCard";

const {
  modelId, // identical to the modelId given when calling `getDocumentModel`
  description, // a textual description of the model, if provided during model creation
  createdOn, // the Date (timestamp) that the model was created
  // information about the document types in the model and their field schemas
  docTypes: {
    // the document type of the prebuilt business card model
    "prebuilt:businesscard": {
      // an optional, textual description of this document type
      description,
      // the schema of the fields in this document type, see the FieldSchema type
      fieldSchema,
      // the service's confidences in the fields (an object with field names as properties and numeric confidence
      // values)
      fieldConfidence
    }
  }
} = await client.getDocumentModel(modelId);

function getDocumentModel(modelId: string, options?: GetModelOptions): Promise<DocumentModelDetails>

المعلمات

modelId: string

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

options: GetModelOptions

الإعدادات الاختيارية للطلب

المرتجعات

Promise<DocumentModelDetails>

معلومات حول النموذج مع المعرف المحدد

getOperation(string, GetOperationOptions)

استرداد معلومات حول عملية (OperationDetails) بواسطة معرفها.

تمثل العمليات مهاما غير تحليلية، مثل إنشاء نموذج أو إنشاؤه أو نسخه.

function getOperation(operationId: string, options?: GetOperationOptions): Promise<OperationDetails>

المعلمات

operationId: string

معرف عملية الاستعلام

options: GetOperationOptions

الإعدادات الاختيارية للطلب

المرتجعات

Promise<OperationDetails>

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

مثال

// The ID of the operation, which should be a GUID
const operationId = "<operation GUID>";

const {
  operationId, // identical to the operationId given when calling `getOperation`
  kind, // the operation kind, one of "documentModelBuild", "documentModelCompose", or "documentModelCopyTo"
  status, // the status of the operation, one of "notStarted", "running", "failed", "succeeded", or "canceled"
  percentCompleted, // a number between 0 and 100 representing the progress of the operation
  createdOn, // a Date object that reflects the time when the operation was started
  lastUpdatedOn, // a Date object that reflects the time when the operation state was last modified
} = await client.getOperation(operationId);

getResourceDetails(GetResourceDetailsOptions)

استرداد المعلومات الأساسية حول مورد هذا العميل.

مثال

const {
  // Information about the custom models in the current resource
  customDocumentModelDetails: {
    // The number of custom models in the current resource
    count,
    // The maximum number of models that the current resource can support
    limit
  }
} = await client.getResourceDetails();

function getResourceDetails(options?: GetResourceDetailsOptions): Promise<ResourceDetails>

المعلمات

options: GetResourceDetailsOptions

الإعدادات الاختيارية للطلب

المرتجعات

Promise<ResourceDetails>

معلومات أساسية حول مورد هذا العميل

listDocumentClassifiers(ListModelsOptions)

سرد تفاصيل حول المصنفات في المورد. تدعم هذه العملية الترحيل.

أمثلة

تكرار غير متزامن

for await (const details of client.listDocumentClassifiers()) {
  const {
    classifierId, // The classifier's unique ID
    description, // a textual description of the classifier, if provided during creation
    docTypes, // information about the document types in the classifier and their corresponding traning data
  } = details;
}

حسب الصفحة

// The listDocumentClassifiers method is paged, and you can iterate by page using the `byPage` method.
const pages = client.listDocumentClassifiers().byPage();

for await (const page of pages) {
  // Each page is an array of classifiers and can be iterated synchronously
  for (const details of page) {
    const {
      classifierId, // The classifier's unique ID
      description, // a textual description of the classifier, if provided during creation
      docTypes, // information about the document types in the classifier and their corresponding traning data
    } = details;
  }
}

function listDocumentClassifiers(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentClassifierDetails, DocumentClassifierDetails[], PageSettings>

المعلمات

options: ListModelsOptions

الإعدادات الاختيارية لطلبات المصنف

المرتجعات

PagedAsyncIterableIterator<DocumentClassifierDetails, DocumentClassifierDetails[], PageSettings>

غير متزامنة من تفاصيل المصنف التي تدعم ترحيل الصفحات

listDocumentModels(ListModelsOptions)

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

يتضمن ملخص النموذج (DocumentModelSummary) المعلومات الأساسية حول النموذج فقط، ولا يتضمن معلومات حول أنواع المستندات في النموذج (مثل مخططات الحقول وقيم الثقة).

للوصول إلى المعلومات الكاملة حول النموذج، استخدم getDocumentModel.

كسر التغيير

في الإصدارات السابقة من واجهة برمجة تطبيقات REST ل Form Recognizer وSDK، listModels سيعيد الأسلوب جميع النماذج، حتى تلك التي فشلت في الإنشاء بسبب الأخطاء. في إصدارات الخدمة الجديدة، listDocumentModels وإنتاج getDocumentModelنماذج تم إنشاؤها بنجاح فقط (أي النماذج "الجاهزة" للاستخدام). يتم الآن استرداد النماذج الفاشلة من خلال واجهات برمجة التطبيقات "العمليات"، راجع getOperation and listOperations.

أمثلة

تكرار غير متزامن

for await (const summary of client.listDocumentModels()) {
  const {
    modelId, // The model's unique ID
    description, // a textual description of the model, if provided during model creation
  } = summary;

  // You can get the full model info using `getDocumentModel`
  const model = await client.getDocumentModel(modelId);
}

حسب الصفحة

// The listDocumentModels method is paged, and you can iterate by page using the `byPage` method.
const pages = client.listDocumentModels().byPage();

for await (const page of pages) {
  // Each page is an array of models and can be iterated synchronously
  for (const model of page) {
    const {
      modelId, // The model's unique ID
      description, // a textual description of the model, if provided during model creation
    } = summary;

    // You can get the full model info using `getDocumentModel`
    const model = await client.getDocumentModel(modelId);
  }
}

function listDocumentModels(options?: ListModelsOptions): PagedAsyncIterableIterator<DocumentModelSummary, DocumentModelSummary[], PageSettings>

المعلمات

options: ListModelsOptions

الإعدادات الاختيارية لطلبات النموذج

المرتجعات

PagedAsyncIterableIterator<DocumentModelSummary, DocumentModelSummary[], PageSettings>

غير متزامن لملخصات النموذج التي تدعم الترحيل

listOperations(ListOperationsOptions)

سرد عمليات إنشاء النموذج في المورد. سيؤدي ذلك إلى إنتاج جميع العمليات، بما في ذلك العمليات التي فشلت في إنشاء النماذج بنجاح. تدعم هذه العملية الترحيل.

أمثلة

تكرار غير متزامن

for await (const operation of client.listOperations()) {
  const {
    operationId, // the operation's GUID
    status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled"
    percentCompleted // the progress of the operation, from 0 to 100
  } = operation;
}

حسب الصفحة

// The listOperations method is paged, and you can iterate by page using the `byPage` method.
const pages = client.listOperations().byPage();

for await (const page of pages) {
  // Each page is an array of operation info objects and can be iterated synchronously
  for (const operation of page) {
    const {
      operationId, // the operation's GUID
      status, // the operation status, one of "notStarted", "running", "succeeded", "failed", or "canceled"
      percentCompleted // the progress of the operation, from 0 to 100
    } = operation;
  }
}

function listOperations(options?: ListOperationsOptions): PagedAsyncIterableIterator<OperationSummary, OperationSummary[], PageSettings>

المعلمات

options: ListOperationsOptions

الإعدادات الاختيارية لطلبات العملية

المرتجعات

PagedAsyncIterableIterator<OperationSummary, OperationSummary[], PageSettings>

غير متزامن لعناصر معلومات العملية التي تدعم الترحيل