DocumentModelAdministrationClient class

Создайте экземпляр 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)

Параметры

Создайте экземпляр 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)

Параметры

Создайте новый классификатор документов с заданным идентификатором классификатора и типами документов.

Идентификатор классификатора должен быть уникальным среди классификаторов в ресурсе.

Типы документов задаются в виде объекта , который сопоставляет имя типа документа с набором обучающих данных для этого типа документа. Поддерживаются два метода ввода данных для обучения:

• azureBlobSource, который обучает классификатор с использованием данных в заданном контейнере Хранилище BLOB-объектов Azure.
• azureBlobFileListSource, который похож на azureBlobSource , но обеспечивает более точный контроль над файлами, включенными в набор данных для обучения, с помощью списка файлов в формате JSONL.

Служба Распознаватель документов считывает обучающий набор данных из контейнера службы хранилища Azure, предоставленный в качестве 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>

Параметры

Возвращаемое значение

длительная операция (опрашиватель), которая в конечном итоге создаст сведения о созданном классификаторе или ошибку

Создание новой модели с заданным идентификатором из источника содержимого модели.

Идентификатор модели может состоять из любого текста, если он не начинается с "prebuilt-" (так как эти модели относятся к предварительно созданным Распознаватель документов моделям, которые являются общими для всех ресурсов), и если он еще не существует в ресурсе.

Источник контента описывает механизм, который служба будет использовать для чтения входных обучающих данных. Дополнительные сведения см. в <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>

Параметры

Возвращаемое значение

длительная операция (опрашиватель), которая в конечном итоге создаст сведения о созданной модели или ошибку

Создайте новую модель с заданным идентификатором из набора входных документов и полей с метками.

Идентификатор модели может состоять из любого текста, если он не начинается с "prebuilt-" (так как эти модели относятся к предварительно созданным Распознаватель документов моделям, которые являются общими для всех ресурсов), и если он еще не существует в ресурсе.

Служба Распознаватель документов считывает обучающий набор данных из контейнера службы хранилища Azure, предоставленный в качестве 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>

Параметры

Возвращаемое значение

долго выполняющаяся операция (средство опроса), которая в конечном итоге создает сведения о созданной модели или ошибку;

Создает единую составную модель из нескольких существующих подмоделей.

Результирующая составная модель объединяет типы документов ее составных моделей и вставляет шаг классификации в конвейер извлечения, чтобы определить, какие из ее подмоделей компонентов наиболее подходили для заданных входных данных.

Пример

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>

Параметры

Возвращаемое значение

долго выполняющаяся операция (средство опроса), которая в конечном итоге создает сведения о созданной модели или ошибку;

Копирует модель с заданным идентификатором в ресурс и идентификатор модели, закодированный с помощью заданной авторизации копирования.

См. раздел 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>

Параметры

Возвращаемое значение

долго выполняющаяся операция (средство опроса), которая в конечном итоге создает скопированные сведения о модели или ошибку.

Удаляет классификатор с заданным идентификатором из ресурса клиента, если он существует. Эта операция не может быть отменена.

Пример

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

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

Параметры

Возвращаемое значение

Удаляет модель с заданным идентификатором из ресурса клиента, если он существует. Эта операция не может быть отменена.

Пример

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

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

Параметры

Возвращаемое значение

Создает авторизацию для копирования модели в ресурс, используемый с методом beginCopyModelTo .

Предоставляет CopyAuthorization другому ресурсу cognitive service право создавать модель в ресурсе этого клиента с идентификатором модели и необязательным описанием, которые кодируются в авторизацию.

Пример

// 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>

Параметры

Возвращаемое значение

авторизация копирования, которая кодирует заданный modelId и необязательное описание.

Извлекает сведения о классификаторе (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>

Параметры

Возвращаемое значение

сведения о классификаторе с заданным идентификатором

Извлекает сведения о модели (DocumentModelDetails) по идентификатору.

Этот метод может получать сведения о пользовательских и предварительно созданных моделях.

Критическое изменение

В предыдущих версиях Распознаватель документов REST API и пакета SDK getModel метод мог возвращать любую модель, даже ту, которую не удалось создать из-за ошибок. В новых версиях getDocumentModel службы и listDocumentModelsсоздают только успешно созданные модели (т. е. модели, которые "готовы" к использованию). Неудачные модели теперь извлекаются с помощью API операций, см. в разделах getOperation и 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>

Параметры

Возвращаемое значение

сведения о модели с заданным идентификатором

Извлекает сведения об операции (OperationDetails) по ее идентификатору.

Операции представляют задачи, не относящиеся к анализу, такие как создание, создание или копирование модели.

function getOperation(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);

Получение основных сведений о ресурсе этого клиента.

Пример

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>

Параметры

Возвращаемое значение

основные сведения о ресурсе этого клиента

Список сведений о классификаторах в ресурсе. Эта операция поддерживает разбиение по страницам.

Примеры

Асинхронная итерация

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>

Параметры

Возвращаемое значение

асинхронный итератор сведений классификатора, поддерживающий разбиение по страницам

Вывод сводки по моделям в ресурсе. Будут включены как пользовательские, так и предварительно созданные модели. Эта операция поддерживает разбиение по страницам.

Сводка по модели (DocumentModelSummary) содержит только основные сведения о модели и не содержит сведения о типах документов в модели (например, схемы полей и значения доверия).

Чтобы получить доступ к полной информации о модели, используйте getDocumentModel.

Критическое изменение

В предыдущих версиях Распознаватель документов REST API и пакета SDK listModels метод возвращал все модели, даже те, которые не удалось создать из-за ошибок. В новых версиях listDocumentModels службы и getDocumentModelсоздают только успешно созданные модели (т. е. модели, которые "готовы" к использованию). Неудачные модели теперь извлекаются с помощью API операций, см. в разделах getOperation и 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>

Параметры

Возвращаемое значение

асинхронная итерируемая сводка моделей, поддерживающая разбиение по страницам

Вывод списка операций создания модели в ресурсе. Это приведет к созданию всех операций, включая операции, которые не смогли успешно создать модели. Эта операция поддерживает разбиение по страницам.

Примеры

Асинхронная итерация

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>

Параметры

Возвращаемое значение

асинхронный итерируемый объект сведений об операциях, поддерживающий разбиение по страницам