DocumentModelAdministrationClient class

Skapa en DocumentModelAdministrationClient-instans från en resursslutpunkt och en statisk API-nyckel (KeyCredential),

Exempel:

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)

Parametrar

Skapa en DocumentModelAdministrationClient-instans från en resursslutpunkt och en Azure Identity TokenCredential.

Mer information om autentisering med Azure Active Directory finns i @azure/identity paketet.

Exempel:

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)

Parametrar

Skapa en ny dokumentklassificerare med angivet klassificerar-ID och dokumenttyper.

Klassificerarens ID måste vara unikt bland klassificerare i resursen.

Dokumenttyperna anges som ett objekt som mappar namnet på dokumenttypen till träningsdatauppsättningen för den dokumenttypen. Två metoder för inmatning av träningsdata stöds:

• azureBlobSource, som tränar en klassificerare med hjälp av data i den angivna Azure Blob Storage containern.
• azureBlobFileListSource, vilket liknar azureBlobSource men ger mer detaljerad kontroll över de filer som ingår i träningsdatauppsättningen med hjälp av en JSONL-formaterad fillista.

Formigenkänning-tjänsten läser träningsdatauppsättningen från en Azure Storage-container, som anges som en URL till containern med en SAS-token som gör att tjänstserverdelen kan kommunicera med containern. Behörigheterna "read" och "list" krävs som minst. Dessutom måste data i den angivna containern ordnas enligt en viss konvention, som dokumenteras i tjänstens dokumentation för att skapa anpassade dokumentklassificerare.

Exempel

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>

Parametrar

Returer

en tidskrävande åtgärd (poller) som så småningom kommer att generera den skapade klassificerarens information eller ett fel

Skapa en ny modell med ett visst ID från en modellinnehållskälla.

Modell-ID:t kan bestå av valfri text, så länge den inte börjar med "prebuilt-" (eftersom dessa modeller refererar till fördefinierade Formigenkänning modeller som är gemensamma för alla resurser) och så länge det inte redan finns i resursen.

Innehållskällan beskriver den mekanism som tjänsten använder för att läsa träningsdata för indata. Mer information finns i typen <xref:DocumentModelContentSource> .

Exempel

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>

Parametrar

Returer

en långvarig åtgärd (poller) som så småningom skapar den skapade modellinformationen eller ett fel

Skapa en ny modell med ett visst ID från en uppsättning indatadokument och märkta fält.

Modell-ID:t kan bestå av valfri text, så länge den inte börjar med "prebuilt-" (eftersom dessa modeller refererar till fördefinierade Formigenkänning modeller som är gemensamma för alla resurser) och så länge det inte redan finns i resursen.

Formigenkänning-tjänsten läser träningsdatauppsättningen från en Azure Storage-container, som anges som en URL till containern med en SAS-token som gör att tjänstserverdelen kan kommunicera med containern. Behörigheterna "read" och "list" krävs som minst. Dessutom måste data i den angivna containern ordnas enligt en viss konvention, som dokumenteras i tjänstens dokumentation för att skapa anpassade modeller.

Exempel

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>

Parametrar

Returer

en långvarig åtgärd (poller) som så småningom skapar den skapade modellinformationen eller ett fel

Skapar en enda sammansatt modell från flera befintliga undermodeller.

Den resulterande sammansatta modellen kombinerar dokumenttyperna för dess komponentmodeller och infogar ett klassificeringssteg i extraheringspipelinen för att avgöra vilken av dess komponentundermodeller som passar bäst för angivna indata.

Exempel

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>

Parametrar

Returer

en långvarig åtgärd (poller) som så småningom skapar den skapade modellinformationen eller ett fel

Kopierar en modell med det angivna ID:t till resurs- och modell-ID:t som kodas av en viss kopieringsauktorisering.

Se CopyAuthorization och getCopyAuthorization.

Exempel

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

Parametrar

Returer

en långvarig åtgärd (poller) som så småningom genererar den kopierade modellinformationen eller ett fel

Tar bort en klassificerare med det angivna ID:t från klientens resurs, om den finns. Det går inte att återställa den här åtgärden.

Exempel

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

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

Parametrar

Returer

Tar bort en modell med det angivna ID:t från klientens resurs, om den finns. Det går inte att återställa den här åtgärden.

Exempel

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

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

Parametrar

Returer

Skapar en auktorisering för att kopiera en modell till resursen som används med beginCopyModelTo metoden .

CopyAuthorization Ger en annan kognitiv tjänstresurs rätt att skapa en modell i klientens resurs med modell-ID och valfri beskrivning som är kodade i auktoriseringen.

Exempel

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

Parametrar

Returer

en kopieringsauktorisering som kodar det angivna modelId:et och valfri beskrivning

Hämtar information om en klassificerare (DocumentClassifierDetails) efter ID.

Exempel

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>

Parametrar

Returer

information om klassificeraren med det angivna ID:t

Hämtar information om en modell (DocumentModelDetails) efter ID.

Den här metoden kan hämta information om anpassade och fördefinierade modeller.

Icke-bakåtkompatibel ändring

I tidigare versioner av Formigenkänning REST API och SDK getModel kan metoden returnera vilken modell som helst, även en modell som inte kunde skapas på grund av fel. I de nya tjänstversionerna getDocumentModel och listDocumentModelsskapar endast modeller som skapats korrekt (dvs. modeller som är "redo" för användning). Misslyckade modeller hämtas nu via "åtgärder"-API:erna, se getOperation och listOperations.

Exempel

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

Parametrar

Returer

information om modellen med det angivna ID:t

Hämtar information om en åtgärd (OperationDetails) med dess ID.

Åtgärder representerar icke-analysaktiviteter, till exempel att skapa, skapa eller kopiera en modell.

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

Parametrar

Returer

information om åtgärden med det angivna ID:t

Exempel

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

Hämta grundläggande information om klientens resurs.

Exempel

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>

Parametrar

Returer

grundläggande information om klientens resurs

Visa information om klassificerare i resursen. Den här åtgärden stöder växling.

Exempel

Async Iteration

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

Efter sida

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

Parametrar

Returer

en asynkron iterbar klassificeringsinformation som stöder växling

Lista sammanfattningar av modeller i resursen. Anpassade och fördefinierade modeller kommer att ingå. Den här åtgärden stöder växling.

Modellsammanfattningen (DocumentModelSummary) innehåller endast grundläggande information om modellen och innehåller inte information om dokumenttyperna i modellen (till exempel fältscheman och konfidensvärden).

Om du vill komma åt den fullständiga informationen om modellen använder du getDocumentModel.

Icke-bakåtkompatibel ändring

I tidigare versioner av Formigenkänning REST API och SDK listModels returnerar metoden alla modeller, även de som inte kunde skapas på grund av fel. I de nya tjänstversionerna listDocumentModels och getDocumentModelskapar endast modeller som skapats korrekt (dvs. modeller som är "redo" för användning). Misslyckade modeller hämtas nu via "åtgärder"-API:erna, se getOperation och listOperations.

Exempel

Async Iteration

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

Efter sida

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

Parametrar

Returer

en asynkron iterbar modellsammanfattning som stöder växling

Lista modellskapande åtgärder i resursen. Detta skapar alla åtgärder, inklusive åtgärder som inte kunde skapa modeller. Den här åtgärden stöder växling.

Exempel

Async Iteration

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

Efter sida

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

Parametrar

Returer

en asynkron iterbar åtgärdsinformationsobjekt som stöder växling