DocumentModelAdministrationClient class

Een DocumentModelAdministrationClient-exemplaar maken op basis van een resource-eindpunt en een statische API-sleutel (KeyCredential),

Voorbeeld:

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

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

Parameters

Maak een DocumentModelAdministrationClient-exemplaar op basis van een resource-eindpunt en een Azure Identity TokenCredential.

Zie het @azure/identity-pakket voor meer informatie over verificatie met Azure Active Directory.

Voorbeeld:

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

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

Parameters

Bouw een nieuwe documentclassificatie met de opgegeven classificatie-id en documenttypen.

De classificatie-id moet uniek zijn tussen classificaties binnen de resource.

De documenttypen worden opgegeven als een object waarmee de naam van het documenttype wordt toegewezen aan de trainingsgegevensset voor dat documenttype. Er worden twee invoermethoden voor trainingsgegevens ondersteund:

• azureBlobSource, waarmee een classificatie wordt getraind met behulp van de gegevens in de opgegeven Azure Blob Storage-container.
• azureBlobFileListSource, die vergelijkbaar is met azureBlobSource, maar biedt meer gedetailleerde controle over de bestanden die zijn opgenomen in de set met trainingsgegevens met behulp van een lijst met JSONL-bestandsindelingen.

De Form Recognizer-service leest de trainingsgegevensset uit een Azure Storage-container, die wordt opgegeven als EEN URL naar de container met een SAS-token waarmee de back-end van de service kan communiceren met de container. Minimaal zijn de machtigingen 'lezen' en 'lijst' vereist. Bovendien moeten de gegevens in de opgegeven container worden ingedeeld volgens een bepaalde conventie, die wordt gedocumenteerd in de documentatie van de service voor het bouwen van aangepaste documentclassificaties.

Voorbeeld

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

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

const poller = await client.beginBuildDocumentClassifier(
  newClassifiedId,
  {
    // 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>

Parameters

Retouren

een langlopende bewerking (poller) die uiteindelijk de gemaakte classificatiedetails of een fout produceert

Bouw een nieuw model met een bepaalde id van een modelinhoudsbron.

De model-id kan bestaan uit alle tekst, zolang deze niet begint met 'vooraf samengesteld-' (zoals deze modellen verwijzen naar vooraf gedefinieerde Form Recognizer-modellen die voor alle resources gelden), en zolang deze nog niet in de resource bestaat.

De inhoudsbron beschrijft het mechanisme dat door de service wordt gebruikt om de invoertrainingsgegevens te lezen. Zie het <xref:DocumentModelContentSource> type voor meer informatie.

Voorbeeld

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

const containerSasUrl = "<SAS url to the blob container storing training documents>";

// You must provide the model ID. It can be any text that does not start with "prebuilt-".
// For example, you could provide a randomly generated GUID using the "uuid" package.
// The second parameter is the SAS-encoded URL to an Azure Storage container with the training documents.
// The third parameter is the build mode: one of "template" (the only mode prior to 4.0.0-beta.3) or "neural".
// See https://aka.ms/azsdk/formrecognizer/buildmode for more information about build modes.
const poller = await client.beginBuildDocumentModel(
  "<model ID>",
  { azureBlobSource: { containerUrl: containerSasUrl } },
  "template",
  {
    // The model description is optional and can be any text.
    description: "This is my new model!",
    onProgress: ({ status }) => {
      console.log(`operation status: ${status}`);
    },
  },
);
const model = await poller.pollUntilDone();

console.log(`Model ID: ${model.modelId}`);
console.log(`Description: ${model.description}`);
console.log(`Created: ${model.createdOn}`);

// A model may contain several document types, which describe the possible object structures of fields extracted using
// this model

console.log("Document Types:");
for (const [docType, { description, fieldSchema: schema }] of Object.entries(
  model.docTypes ?? {},
)) {
  console.log(`- Name: "${docType}"`);
  console.log(`  Description: "${description}"`);

  // For simplicity, this example will only show top-level field names
  console.log("  Fields:");

  for (const [fieldName, fieldSchema] of Object.entries(schema)) {
    console.log(`  - "${fieldName}" (${fieldSchema.type})`);
    console.log(`    ${fieldSchema.description ?? "<no description>"}`);
  }
}

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

Parameters

Retouren

een langlopende bewerking (poller) die uiteindelijk de gemaakte modelgegevens of een fout produceert

Bouw een nieuw model met een bepaalde id uit een set invoerdocumenten en gelabelde velden.

De model-id kan bestaan uit alle tekst, zolang deze niet begint met 'vooraf samengesteld-' (zoals deze modellen verwijzen naar vooraf gedefinieerde Form Recognizer-modellen die voor alle resources gelden), en zolang deze nog niet in de resource bestaat.

De Form Recognizer-service leest de trainingsgegevensset uit een Azure Storage-container, die wordt opgegeven als EEN URL naar de container met een SAS-token waarmee de back-end van de service kan communiceren met de container. Minimaal zijn de machtigingen 'lezen' en 'lijst' vereist. Bovendien moeten de gegevens in de opgegeven container worden ingedeeld volgens een bepaalde conventie, die wordt beschreven in de documentatie van de service voor het bouwen van aangepaste modellen.

Voorbeeld

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

const containerSasUrl = "<SAS url to the blob container storing training documents>";

// You must provide the model ID. It can be any text that does not start with "prebuilt-".
// For example, you could provide a randomly generated GUID using the "uuid" package.
// The second parameter is the SAS-encoded URL to an Azure Storage container with the training documents.
// The third parameter is the build mode: one of "template" (the only mode prior to 4.0.0-beta.3) or "neural".
// See https://aka.ms/azsdk/formrecognizer/buildmode for more information about build modes.
const poller = await client.beginBuildDocumentModel("<model ID>", containerSasUrl, "template", {
  // The model description is optional and can be any text.
  description: "This is my new model!",
  onProgress: ({ status }) => {
    console.log(`operation status: ${status}`);
  },
});
const model = await poller.pollUntilDone();

console.log(`Model ID: ${model.modelId}`);
console.log(`Description: ${model.description}`);
console.log(`Created: ${model.createdOn}`);

// A model may contain several document types, which describe the possible object structures of fields extracted using
// this model

console.log("Document Types:");
for (const [docType, { description, fieldSchema: schema }] of Object.entries(
  model.docTypes ?? {},
)) {
  console.log(`- Name: "${docType}"`);
  console.log(`  Description: "${description}"`);

  // For simplicity, this example will only show top-level field names
  console.log("  Fields:");

  for (const [fieldName, fieldSchema] of Object.entries(schema)) {
    console.log(`  - "${fieldName}" (${fieldSchema.type})`);
    console.log(`    ${fieldSchema.description ?? "<no description>"}`);
  }
}

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

Parameters

Retouren

een langlopende bewerking (poller) die uiteindelijk de gemaakte modelgegevens of een fout produceert

Hiermee maakt u één samengesteld model op basis van verschillende bestaande submodellen.

Het resulterende samengestelde model combineert de documenttypen van de onderdeelmodellen en voegt een classificatiestap in de extractiepijplijn in om te bepalen welke submodellen van het onderdeel het meest geschikt zijn voor de opgegeven invoer.

Voorbeeld

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

const composeModelId = "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(composeModelId, 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>

Parameters

Retouren

een langlopende bewerking (poller) die uiteindelijk de gemaakte modelgegevens of een fout produceert

Kopieert een model met de opgegeven id naar de resource en model-id die is gecodeerd door een bepaalde kopieerautorisatie.

Zie CopyAuthorization en getCopyAuthorization.

Voorbeeld

import { DefaultAzureCredential } from "@azure/identity";
import { DocumentModelAdministrationClient, AzureKeyCredential } from "@azure/ai-form-recognizer";

const credential = new DefaultAzureCredential();
const client = new DocumentModelAdministrationClient(
  "https://<resource name>.cognitiveservices.azure.com",
  credential,
);

// 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
// 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);
const poller = await sourceClient.beginCopyModelTo("<source model ID>", copyAuthorization);

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

Parameters

Retouren

een langdurige bewerking (poller) die uiteindelijk de gekopieerde modelgegevens of een fout produceert

Hiermee verwijdert u een classificatie met de opgegeven id uit de resource van de client, indien aanwezig. Deze bewerking kan niet worden teruggezet.

Voorbeeld

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

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

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

Parameters

Retouren

Hiermee verwijdert u een model met de opgegeven id uit de resource van de client, indien aanwezig. Deze bewerking kan niet worden teruggezet.

Voorbeeld

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

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

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

Parameters

Retouren

Hiermee maakt u een autorisatie voor het kopiëren van een model naar de resource, die wordt gebruikt met de beginCopyModelTo methode.

De CopyAuthorization verleent een andere Cognitive Service-resource het recht om een model in de resource van deze client te maken met de model-id en optionele beschrijving die in de autorisatie zijn gecodeerd.

Voorbeeld

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

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

Parameters

Retouren

een kopieerautorisatie waarmee de opgegeven modelId en optionele beschrijving worden gecodeerd

Hiermee wordt informatie opgehaald over een classificatie (DocumentClassifierDetails) op id.

Voorbeeld

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

const foundClassifier = "<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(foundClassifier);

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

Parameters

Retouren

informatie over de classificatie met de opgegeven id

Hiermee wordt informatie opgehaald over een model (DocumentModelDetails) op id.

Met deze methode kunt u informatie over aangepaste en vooraf samengestelde modellen ophalen.

wijziging die fouten veroorzaken

In eerdere versies van de Form Recognizer REST API en SDK kunnen met de getModel methode elk model worden geretourneerd, zelfs als er geen model is gemaakt vanwege fouten. In de nieuwe serviceversies produceren getDocumentModel en listDocumentModelsalleen met succes gemaakte modellen (d.w.w. modellen die 'gereed' zijn voor gebruik). Mislukte modellen worden nu opgehaald via de API's voor bewerkingen. Zie getOperation en listOperations.

Voorbeeld

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

// The ID of the prebuilt business card model
const prebuiltModelId = "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: businessCardDescription,
      // 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(prebuiltModelId);

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

Parameters

Retouren

informatie over het model met de opgegeven id

Hiermee wordt informatie opgehaald over een bewerking (OperationDetails) op basis van de id.

Bewerkingen vertegenwoordigen niet-analysetaken, zoals het bouwen, opstellen of kopiëren van een model.

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

Parameters

Retouren

informatie over de bewerking met de opgegeven id

Voorbeeld

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

// The ID of the operation, which should be a GUID
const findOperationId = "<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(findOperationId);

Basisinformatie over de resource van deze client ophalen.

Voorbeeld

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

const {
  // Information about the custom models in the current resource
  customDocumentModels: {
    // 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>

Parameters

Retouren

basisinformatie over de resource van deze client

Geef details weer over classificaties in de resource. Deze bewerking ondersteunt paging.

Voorbeelden

Asynchrone iteratie

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

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>

Parameters

Retouren

asynchroon itereerbaar van classificatiedetails die paginering ondersteunen

Lijst met samenvattingen van modellen in de resource. Aangepaste en vooraf samengestelde modellen worden opgenomen. Deze bewerking ondersteunt paging.

De modelsamenvatting (DocumentModelSummary) bevat alleen de basisinformatie over het model en bevat geen informatie over de documenttypen in het model (zoals de veldschema's en betrouwbaarheidswaarden).

Gebruik getDocumentModelom toegang te krijgen tot de volledige informatie over het model.

wijziging die fouten veroorzaken

In eerdere versies van de Form Recognizer REST API en SDK retourneert de listModels methode alle modellen, zelfs modellen die niet konden worden gemaakt vanwege fouten. In de nieuwe serviceversies produceren listDocumentModels en getDocumentModelalleen met succes gemaakte modellen (d.w.w. modellen die 'gereed' zijn voor gebruik). Mislukte modellen worden nu opgehaald via de API's voor bewerkingen. Zie getOperation en listOperations.

Voorbeelden

Asynchrone iteratie

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

// Iterate over all models in the current resource
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 summary 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>

Parameters

Retouren

asynchrone itereerbaar van modelsamenvattingen die paging ondersteunen

Maakbewerkingen voor het maken van modellen in de resource weer. Hiermee worden alle bewerkingen geproduceerd, inclusief bewerkingen die geen modellen met succes kunnen maken. Deze bewerking ondersteunt paging.

Voorbeelden

Asynchrone iteratie

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

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>

Parameters

Retouren

asynchroon itereerbaar van bewerkingsgegevensobjecten die paging ondersteunen