DocumentModelAdministrationClient class

Csomag:
@azure/ai-form-recognizer

Ügyfél a Form Recognizer szolgáltatás modellkezelési funkcióival való interakcióhoz, például modellek létrehozásához, olvasásához, listázásához, törléséhez és másolásához.

Példák:

Azure Active Directory

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

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

API-kulcs (előfizetési kulcs)

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

Konstruktorok

DocumentModelAdministrationClient(string, KeyCredential, DocumentModelAdministrationClientOptions)

DocumentModelAdministrationClient-példány létrehozása erőforrásvégpontból és statikus API-kulcsból (KeyCredential),

Példa:

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,
);
DocumentModelAdministrationClient(string, TokenCredential, DocumentModelAdministrationClientOptions)

Hozzon létre egy DocumentModelAdministrationClient-példányt egy erőforrásvégpontból és egy Azure Identity TokenCredential.

Az Azure Active Directoryval való hitelesítésről további információt a @azure/identity csomagban talál.

Példa:

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

Módszerek

beginBuildDocumentClassifier(string, DocumentClassifierDocumentTypeSources, BeginBuildDocumentClassifierOptions)

Hozzon létre egy új dokumentumosztályozót a megadott osztályozóazonosítóval és dokumentumtípusokkal.

Az osztályozóazonosítónak egyedinek kell lennie az erőforrás osztályozói között.

A dokumentumtípusok olyan objektumként vannak megadva, amely leképzi a dokumentumtípus nevét az adott dokumentumtípus betanítási adatkészletére. Két betanítási adatbeviteli módszer támogatott:

  • azureBlobSource, amely betanítja az osztályozót az adott Azure Blob Storage-tároló adataival.
  • azureBlobFileListSource, amely hasonló a azureBlobSource, de lehetővé teszi a betanítási adatkészletben szereplő fájlok részletesebb vezérlését egy JSONL formátumú fájllista használatával.

A Form Recognizer szolgáltatás beolvassa a betanítási adatkészletet egy Azure Storage-tárolóból, amely egy SAS-jogkivonattal ellátott TÁROLÓ URL-címeként van megadva, amely lehetővé teszi a szolgáltatás háttérrendszere számára a tárolóval való kommunikációt. Legalább az "olvasás" és a "lista" engedélyekre van szükség. Ezenkívül az adott tárolóban lévő adatokat egy adott konvenció szerint kell rendszerezni, amely a szolgáltatás egyéni dokumentumosztályozókkészítésére vonatkozó dokumentációjában van dokumentálva.

Példa

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;
beginBuildDocumentModel(string, DocumentModelSource, DocumentModelBuildMode, BeginBuildDocumentModelOptions)

Hozzon létre egy új modellt egy adott azonosítóval egy modell tartalomforrásából.

A modellazonosító bármilyen szövegből állhat, amennyiben nem "előre összeállított" szöveggel kezdődik (mivel ezek a modellek az összes erőforrásra jellemző előre összeállított Form Recognizer-modellekre vonatkoznak), és mindaddig, amíg még nem létezik az erőforráson belül.

A tartalomforrás leírja, hogy a szolgáltatás milyen mechanizmussal olvassa be a bemeneti betanítási adatokat. További információt a <xref:DocumentModelContentSource> típusában talál.

Példa

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>"}`);
  }
}
beginBuildDocumentModel(string, string, DocumentModelBuildMode, BeginBuildDocumentModelOptions)

Hozzon létre egy új modellt egy adott azonosítóval a bemeneti dokumentumok és a címkézett mezők készletéből.

A modellazonosító bármilyen szövegből állhat, amennyiben nem "előre összeállított" szöveggel kezdődik (mivel ezek a modellek az összes erőforrásra jellemző előre összeállított Form Recognizer-modellekre vonatkoznak), és mindaddig, amíg még nem létezik az erőforráson belül.

A Form Recognizer szolgáltatás beolvassa a betanítási adatkészletet egy Azure Storage-tárolóból, amely egy SAS-jogkivonattal ellátott TÁROLÓ URL-címeként van megadva, amely lehetővé teszi a szolgáltatás háttérrendszere számára a tárolóval való kommunikációt. Legalább az "olvasás" és a "lista" engedélyekre van szükség. Ezenkívül az adott tárolóban lévő adatokat egy adott konvenció szerint kell rendszerezni, amely a szolgáltatás egyéni modellek készítésére vonatkozó dokumentációjában.

Példa

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>"}`);
  }
}
beginComposeDocumentModel(string, Iterable<string>, BeginComposeDocumentModelOptions)

Egyetlen, már meglévő almodellből álló modellt hoz létre.

Az eredményül kapott összeállítási modell egyesíti az összetevőmodellek dokumentumtípusait, és beszúr egy besorolási lépést a kinyerési folyamatba annak meghatározásához, hogy melyik összetevő-almodell felel meg a legjobban az adott bemenetnek.

Példa

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;
beginCopyModelTo(string, CopyAuthorization, BeginCopyModelOptions)

Egy adott azonosítóval rendelkező modellt másol az erőforrásba és egy adott másolási engedélyezéssel kódolt modellazonosítóba.

Lásd: CopyAuthorization és getCopyAuthorization.

Példa

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;
deleteDocumentClassifier(string, OperationOptions)

Törli a megadott azonosítóval rendelkező osztályozót az ügyfél erőforrásából, ha létezik. Ez a művelet NEM állítható vissza.

Példa

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>");
deleteDocumentModel(string, DeleteDocumentModelOptions)

Törli a megadott azonosítóval rendelkező modellt az ügyfél erőforrásából, ha létezik. Ez a művelet NEM állítható vissza.

Példa

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>");
getCopyAuthorization(string, GetCopyAuthorizationOptions)

Létrehoz egy engedélyt, amely egy modellt másol az erőforrásba, amelyet a beginCopyModelTo metódussal használ.

A CopyAuthorization egy másik cognitive service-erőforrás számára biztosít jogot arra, hogy az ügyfél erőforrásában létrehozzon egy modellt az engedélyezésbe kódolt modellazonosítóval és opcionális leírással.

Példa

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>");
getDocumentClassifier(string, OperationOptions)

Egy osztályozó (DocumentClassifierDetails) adatait kéri le azonosító alapján.

Példa

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);
}
getDocumentModel(string, GetModelOptions)

Egy modell (DocumentModelDetails) adatait kéri le azonosító alapján.

Ez a módszer lekérheti az egyéni és az előre összeállított modellekre vonatkozó információkat.

kompatibilitástörő változás

A Form Recognizer REST API és az SDK korábbi verzióiban a getModel metódus bármilyen modellt visszaadhat, még azokat is, amelyek hiba miatt nem hozhatók létre. Az új szolgáltatásverziókban getDocumentModel és listDocumentModelscsak sikeresen létrehozott modelleket (azaz használatra kész modelleket). A sikertelen modellek lekérése mostantól az "operations" API-kon keresztül történik, lásd: getOperation és listOperations.

Példa

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);
getOperation(string, GetOperationOptions)

Egy művelet (OperationDetails) adatait kéri le az azonosítója alapján.

A műveletek nem elemzési feladatokat jelölnek, például modellek készítését, írását vagy másolását.
getResourceDetails(GetResourceDetailsOptions)

Alapvető információk lekérése az ügyfél erőforrásáról.

Példa

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();
listDocumentClassifiers(ListModelsOptions)

Az erőforrás osztályozóinak adatainak listázása. Ez a művelet támogatja a lapozást.

Példák

Aszinkron iteráció

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;
  }
}
listDocumentModels(ListModelsOptions)

Az erőforrás modelljeinek összefoglalóinak listázása. Az egyéni és az előre összeállított modellek is szerepelni fognak. Ez a művelet támogatja a lapozást.

A modell összefoglalása (DocumentModelSummary) csak a modell alapvető adatait tartalmazza, és nem tartalmaz információkat a modell dokumentumtípusairól (például a mezős sémákról és a megbízhatósági értékekről).

A modellre vonatkozó teljes információk eléréséhez használja getDocumentModel.

kompatibilitástörő változás

A Form Recognizer REST API és az SDK korábbi verzióiban a listModels metódus az összes modellt visszaadja, még azokat is, amelyek hiba miatt nem hozhatók létre. Az új szolgáltatásverziókban listDocumentModels és getDocumentModelcsak sikeresen létrehozott modelleket (azaz használatra kész modelleket). A sikertelen modellek lekérése mostantól az "operations" API-kon keresztül történik, lásd: getOperation és listOperations.

Példák

Aszinkron iteráció

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);
  }
}
listOperations(ListOperationsOptions)

Modelllétrehozási műveletek listázása az erőforrásban. Ez az összes műveletet létrehozza, beleértve azokat a műveleteket is, amelyek nem sikerült modelleket létrehozni. Ez a művelet támogatja a lapozást.

Példák

Aszinkron iteráció

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

Építő részletek

DocumentModelAdministrationClient(string, KeyCredential, DocumentModelAdministrationClientOptions)

DocumentModelAdministrationClient-példány létrehozása erőforrásvégpontból és statikus API-kulcsból (KeyCredential),

Példa:

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)

Paraméterek

endpoint

string

egy Azure Cognitive Services-példány végponti URL-címe

credential
KeyCredential

a Cognitive Services-példány előfizetési kulcsát tartalmazó KeyCredential

options
DocumentModelAdministrationClientOptions

nem kötelező beállítások az ügyfél összes metódusának konfigurálásához

DocumentModelAdministrationClient(string, TokenCredential, DocumentModelAdministrationClientOptions)

Hozzon létre egy DocumentModelAdministrationClient-példányt egy erőforrásvégpontból és egy Azure Identity TokenCredential.

Az Azure Active Directoryval való hitelesítésről további információt a @azure/identity csomagban talál.

Példa:

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)

Paraméterek

endpoint

string

egy Azure Cognitive Services-példány végponti URL-címe

credential
TokenCredential

TokenCredential-példány a @azure/identity csomagból

options
DocumentModelAdministrationClientOptions

nem kötelező beállítások az ügyfél összes metódusának konfigurálásához

Módszer részletei

beginBuildDocumentClassifier(string, DocumentClassifierDocumentTypeSources, BeginBuildDocumentClassifierOptions)

Hozzon létre egy új dokumentumosztályozót a megadott osztályozóazonosítóval és dokumentumtípusokkal.

Az osztályozóazonosítónak egyedinek kell lennie az erőforrás osztályozói között.

A dokumentumtípusok olyan objektumként vannak megadva, amely leképzi a dokumentumtípus nevét az adott dokumentumtípus betanítási adatkészletére. Két betanítási adatbeviteli módszer támogatott:

  • azureBlobSource, amely betanítja az osztályozót az adott Azure Blob Storage-tároló adataival.
  • azureBlobFileListSource, amely hasonló a azureBlobSource, de lehetővé teszi a betanítási adatkészletben szereplő fájlok részletesebb vezérlését egy JSONL formátumú fájllista használatával.

A Form Recognizer szolgáltatás beolvassa a betanítási adatkészletet egy Azure Storage-tárolóból, amely egy SAS-jogkivonattal ellátott TÁROLÓ URL-címeként van megadva, amely lehetővé teszi a szolgáltatás háttérrendszere számára a tárolóval való kommunikációt. Legalább az "olvasás" és a "lista" engedélyekre van szükség. Ezenkívül az adott tárolóban lévő adatokat egy adott konvenció szerint kell rendszerezni, amely a szolgáltatás egyéni dokumentumosztályozókkészítésére vonatkozó dokumentációjában van dokumentálva.

Példa

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>

Paraméterek

classifierId

string

a létrehozandó osztályozó egyedi azonosítója

docTypeSources
DocumentClassifierDocumentTypeSources

az osztályozóban és forrásaikban szerepeltetni kívánt dokumentumtípusok (a dokumentumtípusnevek térképe ClassifierDocumentTypeDetails)

options
BeginBuildDocumentClassifierOptions

az osztályozó buildelési műveletének választható beállításai

Visszatér

Promise<DocumentClassifierPoller>

egy hosszú ideig futó művelet (poller), amely végül létrehozza a létrehozott osztályozó részleteit vagy egy hibát

beginBuildDocumentModel(string, DocumentModelSource, DocumentModelBuildMode, BeginBuildDocumentModelOptions)

Hozzon létre egy új modellt egy adott azonosítóval egy modell tartalomforrásából.

A modellazonosító bármilyen szövegből állhat, amennyiben nem "előre összeállított" szöveggel kezdődik (mivel ezek a modellek az összes erőforrásra jellemző előre összeállított Form Recognizer-modellekre vonatkoznak), és mindaddig, amíg még nem létezik az erőforráson belül.

A tartalomforrás leírja, hogy a szolgáltatás milyen mechanizmussal olvassa be a bemeneti betanítási adatokat. További információt a <xref:DocumentModelContentSource> típusában talál.

Példa

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>

Paraméterek

modelId

string

a létrehozandó modell egyedi azonosítója

contentSource
DocumentModelSource

a modell betanítási adatait biztosító tartalomforrás

buildMode
DocumentModelBuildMode

a modell készítésekor használni kívánt mód (lásd DocumentModelBuildMode)

options
BeginBuildDocumentModelOptions

a modell buildelési műveletének választható beállításai

Visszatér

Promise<DocumentModelPoller>

egy hosszú ideig futó művelet (poller), amely végül létrehozza a létrehozott modellinformációkat vagy egy hibát

beginBuildDocumentModel(string, string, DocumentModelBuildMode, BeginBuildDocumentModelOptions)

Hozzon létre egy új modellt egy adott azonosítóval a bemeneti dokumentumok és a címkézett mezők készletéből.

A modellazonosító bármilyen szövegből állhat, amennyiben nem "előre összeállított" szöveggel kezdődik (mivel ezek a modellek az összes erőforrásra jellemző előre összeállított Form Recognizer-modellekre vonatkoznak), és mindaddig, amíg még nem létezik az erőforráson belül.

A Form Recognizer szolgáltatás beolvassa a betanítási adatkészletet egy Azure Storage-tárolóból, amely egy SAS-jogkivonattal ellátott TÁROLÓ URL-címeként van megadva, amely lehetővé teszi a szolgáltatás háttérrendszere számára a tárolóval való kommunikációt. Legalább az "olvasás" és a "lista" engedélyekre van szükség. Ezenkívül az adott tárolóban lévő adatokat egy adott konvenció szerint kell rendszerezni, amely a szolgáltatás egyéni modellek készítésére vonatkozó dokumentációjában.

Példa

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>

Paraméterek

modelId

string

a létrehozandó modell egyedi azonosítója

containerUrl

string

SAS-kódolt URL-cím a betanítási adatkészletet tartalmazó Azure Storage-tárolóhoz

buildMode
DocumentModelBuildMode

a modell készítésekor használni kívánt mód (lásd DocumentModelBuildMode)

options
BeginBuildDocumentModelOptions

a modell buildelési műveletének választható beállításai

Visszatér

Promise<DocumentModelPoller>

egy hosszú ideig futó művelet (poller), amely végül létrehozza a létrehozott modellinformációkat vagy egy hibát

beginComposeDocumentModel(string, Iterable<string>, BeginComposeDocumentModelOptions)

Egyetlen, már meglévő almodellből álló modellt hoz létre.

Az eredményül kapott összeállítási modell egyesíti az összetevőmodellek dokumentumtípusait, és beszúr egy besorolási lépést a kinyerési folyamatba annak meghatározásához, hogy melyik összetevő-almodell felel meg a legjobban az adott bemenetnek.

Példa

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>

Paraméterek

modelId

string

a létrehozandó modell egyedi azonosítója

componentModelIds

Iterable<string>

a összeállítandó modellek egyedi modellazonosítóit képviselő sztringek Iterable-azonosítója

options
BeginComposeDocumentModelOptions

nem kötelező beállítások a modell létrehozásához

Visszatér

Promise<DocumentModelPoller>

egy hosszú ideig futó művelet (poller), amely végül létrehozza a létrehozott modellinformációkat vagy egy hibát

beginCopyModelTo(string, CopyAuthorization, BeginCopyModelOptions)

Egy adott azonosítóval rendelkező modellt másol az erőforrásba és egy adott másolási engedélyezéssel kódolt modellazonosítóba.

Lásd: CopyAuthorization és getCopyAuthorization.

Példa

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>

Paraméterek

sourceModelId

string

a másolandó forrásmodell egyedi azonosítója

authorization
CopyAuthorization

a getCopyAuthorization használatával létrehozott modell másolásának engedélyezése

options
BeginCopyModelOptions

választható beállítások a következőhöz:

Visszatér

Promise<DocumentModelPoller>

egy hosszú ideig futó művelet (poller), amely végül létrehozza a másolt modell adatait, vagy egy hiba

deleteDocumentClassifier(string, OperationOptions)

Törli a megadott azonosítóval rendelkező osztályozót az ügyfél erőforrásából, ha létezik. Ez a művelet NEM állítható vissza.

Példa

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>

Paraméterek

classifierId

string

az erőforrásból törölni kívánt osztályozó egyedi azonosítója

options
OperationOptions

nem kötelező beállítások a kéréshez

Visszatér

Promise<void>

deleteDocumentModel(string, DeleteDocumentModelOptions)

Törli a megadott azonosítóval rendelkező modellt az ügyfél erőforrásából, ha létezik. Ez a művelet NEM állítható vissza.

Példa

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>

Paraméterek

modelId

string

az erőforrásból törölni kívánt modell egyedi azonosítója

options
DeleteDocumentModelOptions

nem kötelező beállítások a kéréshez

Visszatér

Promise<void>

getCopyAuthorization(string, GetCopyAuthorizationOptions)

Létrehoz egy engedélyt, amely egy modellt másol az erőforrásba, amelyet a beginCopyModelTo metódussal használ.

A CopyAuthorization egy másik cognitive service-erőforrás számára biztosít jogot arra, hogy az ügyfél erőforrásában létrehozzon egy modellt az engedélyezésbe kódolt modellazonosítóval és opcionális leírással.

Példa

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>

Paraméterek

destinationModelId

string

a célmodell egyedi azonosítója (a modell másolásához használt azonosító)

options
GetCopyAuthorizationOptions

nem kötelező beállítások a másolási engedélyezés létrehozásához

Visszatér

Promise<CopyAuthorization>

egy másolati engedélyezés, amely a megadott modelId azonosítót és opcionális leírást kódolja

getDocumentClassifier(string, OperationOptions)

Egy osztályozó (DocumentClassifierDetails) adatait kéri le azonosító alapján.

Példa

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>

Paraméterek

classifierId

string

a lekérdezendő osztályozó egyedi azonosítója

options
OperationOptions

nem kötelező beállítások a kéréshez

Visszatér

Promise<DocumentClassifierDetails>

információk a megadott azonosítóval rendelkező osztályozóról

getDocumentModel(string, GetModelOptions)

Egy modell (DocumentModelDetails) adatait kéri le azonosító alapján.

Ez a módszer lekérheti az egyéni és az előre összeállított modellekre vonatkozó információkat.

kompatibilitástörő változás

A Form Recognizer REST API és az SDK korábbi verzióiban a getModel metódus bármilyen modellt visszaadhat, még azokat is, amelyek hiba miatt nem hozhatók létre. Az új szolgáltatásverziókban getDocumentModel és listDocumentModelscsak sikeresen létrehozott modelleket (azaz használatra kész modelleket). A sikertelen modellek lekérése mostantól az "operations" API-kon keresztül történik, lásd: getOperation és listOperations.

Példa

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>

Paraméterek

modelId

string

a lekérdezendő modell egyedi azonosítója

options
GetModelOptions

nem kötelező beállítások a kéréshez

Visszatér

Promise<DocumentModelDetails>

a modellre vonatkozó információk a megadott azonosítóval

getOperation(string, GetOperationOptions)

Egy művelet (OperationDetails) adatait kéri le az azonosítója alapján.

A műveletek nem elemzési feladatokat jelölnek, például modellek készítését, írását vagy másolását.

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

Paraméterek

operationId

string

a lekérdezéshez szükséges művelet azonosítója

options
GetOperationOptions

nem kötelező beállítások a kéréshez

Visszatér

Promise<OperationDetails>

a művelettel kapcsolatos információk a megadott azonosítóval

Példa

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

getResourceDetails(GetResourceDetailsOptions)

Alapvető információk lekérése az ügyfél erőforrásáról.

Példa

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>

Paraméterek

options
GetResourceDetailsOptions

nem kötelező beállítások a kéréshez

Visszatér

Promise<ResourceDetails>

alapvető információk az ügyfél erőforrásáról

listDocumentClassifiers(ListModelsOptions)

Az erőforrás osztályozóinak adatainak listázása. Ez a művelet támogatja a lapozást.

Példák

Aszinkron iteráció

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>

Paraméterek

options
ListModelsOptions

az osztályozókérések opcionális beállításai

Visszatér

PagedAsyncIterableIterator<DocumentClassifierDetails, DocumentClassifierDetails[], PageSettings>

a lapozást támogató osztályozó részleteinek aszinkron iterálása

listDocumentModels(ListModelsOptions)

Az erőforrás modelljeinek összefoglalóinak listázása. Az egyéni és az előre összeállított modellek is szerepelni fognak. Ez a művelet támogatja a lapozást.

A modell összefoglalása (DocumentModelSummary) csak a modell alapvető adatait tartalmazza, és nem tartalmaz információkat a modell dokumentumtípusairól (például a mezős sémákról és a megbízhatósági értékekről).

A modellre vonatkozó teljes információk eléréséhez használja getDocumentModel.

kompatibilitástörő változás

A Form Recognizer REST API és az SDK korábbi verzióiban a listModels metódus az összes modellt visszaadja, még azokat is, amelyek hiba miatt nem hozhatók létre. Az új szolgáltatásverziókban listDocumentModels és getDocumentModelcsak sikeresen létrehozott modelleket (azaz használatra kész modelleket). A sikertelen modellek lekérése mostantól az "operations" API-kon keresztül történik, lásd: getOperation és listOperations.

Példák

Aszinkron iteráció

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>

Paraméterek

options
ListModelsOptions

a modellkérelmek választható beállításai

Visszatér

PagedAsyncIterableIterator<DocumentModelSummary, DocumentModelSummary[], PageSettings>

a lapozást támogató modellösszegzők aszinkron iterálása

listOperations(ListOperationsOptions)

Modelllétrehozási műveletek listázása az erőforrásban. Ez az összes műveletet létrehozza, beleértve azokat a műveleteket is, amelyek nem sikerült modelleket létrehozni. Ez a művelet támogatja a lapozást.

Példák

Aszinkron iteráció

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>

Paraméterek

options
ListOperationsOptions

nem kötelező beállítások a műveleti kérelmekhez

Visszatér

PagedAsyncIterableIterator<OperationSummary, OperationSummary[], PageSettings>

a lapozást támogató műveletinformációs objektumok aszinkron iterálása