DocumentModelAdministrationClient class
モデルの作成、読み取り、一覧表示、削除、コピーなど、Form Recognizer サービスのモデル管理機能を操作するためのクライアント。
例:
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 キー (サブスクリプション キー)
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,
);
コンストラクター
Document |
リソース エンドポイントと静的 API キー ( 例:
|
Document |
リソース エンドポイントと Azure ID Azure Active Directory での認証の詳細については、 例:
|
メソッド
begin |
指定された分類子 ID とドキュメントの種類を使用して、新しいドキュメント分類子を作成します。 分類子 ID は、リソース内の分類子間で一意である必要があります。 ドキュメントの種類は、ドキュメントの種類の名前を、そのドキュメントの種類のトレーニング データ セットにマップするオブジェクトとして指定されます。 次の 2 つのトレーニング データ入力方法がサポートされています。
Form Recognizer サービスは、サービス バックエンドがコンテナーと通信できるようにする SAS トークンを使用して、コンテナーへの URL として指定された、Azure Storage コンテナーからトレーニング データ セットを読み取ります。 少なくとも、"読み取り" と "リスト" のアクセス許可が必要です。 さらに、特定のコンテナー内のデータは、特定の規則に従って編成する必要があります。これは、カスタム ドキュメント分類子を構築するためのサービスのドキュメントに記載されています。 例
|
begin |
モデル コンテンツ ソースから特定の ID を持つ新しいモデルを構築します。 モデル ID は、"事前構築済み" で始まらない限り(これらのモデルはすべてのリソースに共通する事前構築済みの Form Recognizer モデルを参照するため)、リソース内にまだ存在しない限り、任意のテキストで構成できます。 コンテンツ ソースは、入力トレーニング データの読み取りにサービスが使用するメカニズムについて説明します。 詳細については、<xref:DocumentModelContentSource> の種類を参照してください。 例
|
begin |
一連の入力ドキュメントとラベル付きフィールドから、特定の ID を持つ新しいモデルを構築します。 モデル ID は、"事前構築済み" で始まらない限り(これらのモデルはすべてのリソースに共通する事前構築済みの Form Recognizer モデルを参照するため)、リソース内にまだ存在しない限り、任意のテキストで構成できます。 Form Recognizer サービスは、サービス バックエンドがコンテナーと通信できるようにする SAS トークンを使用して、コンテナーへの URL として指定された、Azure Storage コンテナーからトレーニング データ セットを読み取ります。 少なくとも、"読み取り" と "リスト" のアクセス許可が必要です。 さらに、特定のコンテナー内のデータは、特定の規則に従って編成する必要があります。これは、カスタム モデル 構築するためのサービスのドキュメントに記載されています。 例
|
begin |
複数の既存のサブモデルから 1 つの構成済みモデルを作成します。 生成された構成済みモデルは、そのコンポーネント モデルのドキュメントの種類を結合し、抽出パイプラインに分類ステップを挿入して、指定された入力に最も適したコンポーネント サブモデルを決定します。 例
|
begin |
指定された ID を持つモデルを、特定のコピー承認によってエンコードされたリソースとモデル ID にコピーします。 「copyAuthorization と getCopyAuthorization の 参照してください。 例
|
delete |
指定された ID を持つ分類子が存在する場合は、クライアントのリソースから削除します。 この操作を元に戻すことはできません。 例
|
delete |
指定された ID を持つモデルが存在する場合は、クライアントのリソースから削除します。 この操作を元に戻すことはできません。 例
|
get |
例
|
get |
分類子 (DocumentClassifierDetails) に関する情報を ID で取得します。 例
|
get |
モデル (DocumentModelDetails) に関する情報を ID で取得します。 このメソッドは、カスタム モデルと事前構築済みモデルに関する情報を取得できます。 破壊的変更以前のバージョンの Form Recognizer REST API と SDK では、 例
|
get |
操作 ( 操作は、モデルの構築、作成、コピーなど、分析以外のタスクを表します。 |
get |
このクライアントのリソースに関する基本情報を取得します。 例
|
list |
リソース内の分類子に関する詳細を一覧表示します。 この操作では、ページングがサポートされます。 例非同期イテレーション
|
list |
リソース内のモデルの概要を一覧表示します。 カスタム モデルと事前構築済みモデルが含まれます。 この操作では、ページングがサポートされます。 モデルの概要 (DocumentModelSummary) には、モデルに関する基本情報のみが含まれており、モデル内のドキュメントの種類 (フィールド スキーマや信頼度の値など) に関する情報は含まれません。 モデルに関する完全な情報にアクセスするには、getDocumentModel 使用します。 破壊的変更以前のバージョンの Form Recognizer REST API と SDK では、 例非同期イテレーション
|
list |
リソース内のモデル作成操作を一覧表示します。 これにより、モデルを正常に作成できなかった操作を含むすべての操作が生成されます。 この操作では、ページングがサポートされます。 例非同期イテレーション
|
コンストラクターの詳細
DocumentModelAdministrationClient(string, KeyCredential, DocumentModelAdministrationClientOptions)
リソース エンドポイントと静的 API キー (KeyCredential
) から DocumentModelAdministrationClient インスタンスを作成する
例:
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)
パラメーター
- endpoint
-
string
Azure Cognitive Services インスタンスのエンドポイント URL
- credential
- KeyCredential
Cognitive Services インスタンスのサブスクリプション キーを含む KeyCredential
クライアント内のすべてのメソッドを構成するためのオプションの設定
DocumentModelAdministrationClient(string, TokenCredential, DocumentModelAdministrationClientOptions)
リソース エンドポイントと Azure ID TokenCredential
から DocumentModelAdministrationClient インスタンスを作成します。
Azure Active Directory での認証の詳細については、@azure/identity
パッケージを参照してください。
例:
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)
パラメーター
- endpoint
-
string
Azure Cognitive Services インスタンスのエンドポイント URL
- credential
- TokenCredential
@azure/identity
パッケージからの TokenCredential インスタンス
クライアント内のすべてのメソッドを構成するためのオプションの設定
メソッドの詳細
beginBuildDocumentClassifier(string, DocumentClassifierDocumentTypeSources, BeginBuildDocumentClassifierOptions)
指定された分類子 ID とドキュメントの種類を使用して、新しいドキュメント分類子を作成します。
分類子 ID は、リソース内の分類子間で一意である必要があります。
ドキュメントの種類は、ドキュメントの種類の名前を、そのドキュメントの種類のトレーニング データ セットにマップするオブジェクトとして指定されます。 次の 2 つのトレーニング データ入力方法がサポートされています。
-
azureBlobSource
。指定された Azure Blob Storage コンテナー内のデータを使用して分類子をトレーニングします。 -
azureBlobFileListSource
。これはazureBlobSource
に似ていますが、JSONL 形式のファイル リストを使用して、トレーニング データ セットに含まれるファイルをより細かく制御できます。
Form Recognizer サービスは、サービス バックエンドがコンテナーと通信できるようにする SAS トークンを使用して、コンテナーへの URL として指定された、Azure Storage コンテナーからトレーニング データ セットを読み取ります。 少なくとも、"読み取り" と "リスト" のアクセス許可が必要です。 さらに、特定のコンテナー内のデータは、特定の規則に従って編成する必要があります。これは、カスタム ドキュメント分類子を構築するためのサービスのドキュメントに記載されています。
例
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>
パラメーター
- classifierId
-
string
作成する分類子の一意の ID
- docTypeSources
- DocumentClassifierDocumentTypeSources
分類子とそのソースに含めるドキュメントの種類 (ClassifierDocumentTypeDetails
へのドキュメント型名のマップ)
分類子のビルド操作の省略可能な設定
戻り値
Promise<DocumentClassifierPoller>
作成された分類子の詳細またはエラーを最終的に生成する実行時間の長い操作 (ポーリング)
beginBuildDocumentModel(string, DocumentModelSource, DocumentModelBuildMode, BeginBuildDocumentModelOptions)
モデル コンテンツ ソースから特定の ID を持つ新しいモデルを構築します。
モデル ID は、"事前構築済み" で始まらない限り(これらのモデルはすべてのリソースに共通する事前構築済みの Form Recognizer モデルを参照するため)、リソース内にまだ存在しない限り、任意のテキストで構成できます。
コンテンツ ソースは、入力トレーニング データの読み取りにサービスが使用するメカニズムについて説明します。 詳細については、<xref:DocumentModelContentSource> の種類を参照してください。
例
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>
パラメーター
- modelId
-
string
作成するモデルの一意の ID
- contentSource
- DocumentModelSource
このモデルのトレーニング データを提供するコンテンツ ソース
- buildMode
-
DocumentModelBuildMode
モデルの構築時に使用するモード (DocumentModelBuildMode
を参照)
- options
- BeginBuildDocumentModelOptions
モデルビルド操作のオプション設定
戻り値
Promise<DocumentModelPoller>
作成されたモデル情報またはエラーを最終的に生成する実行時間の長い操作 (ポーリング)
beginBuildDocumentModel(string, string, DocumentModelBuildMode, BeginBuildDocumentModelOptions)
一連の入力ドキュメントとラベル付きフィールドから、特定の ID を持つ新しいモデルを構築します。
モデル ID は、"事前構築済み" で始まらない限り(これらのモデルはすべてのリソースに共通する事前構築済みの Form Recognizer モデルを参照するため)、リソース内にまだ存在しない限り、任意のテキストで構成できます。
Form Recognizer サービスは、サービス バックエンドがコンテナーと通信できるようにする SAS トークンを使用して、コンテナーへの URL として指定された、Azure Storage コンテナーからトレーニング データ セットを読み取ります。 少なくとも、"読み取り" と "リスト" のアクセス許可が必要です。 さらに、特定のコンテナー内のデータは、特定の規則に従って編成する必要があります。これは、カスタム モデル 構築するためのサービスのドキュメントに記載されています。
例
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>
パラメーター
- modelId
-
string
作成するモデルの一意の ID
- containerUrl
-
string
トレーニング データ セットを保持する Azure Storage コンテナーへの SAS エンコード URL
- buildMode
-
DocumentModelBuildMode
モデルの構築時に使用するモード (DocumentModelBuildMode
を参照)
- options
- BeginBuildDocumentModelOptions
モデルビルド操作のオプション設定
戻り値
Promise<DocumentModelPoller>
作成されたモデル情報またはエラーを最終的に生成する実行時間の長い操作 (ポーリング)
beginComposeDocumentModel(string, Iterable<string>, BeginComposeDocumentModelOptions)
複数の既存のサブモデルから 1 つの構成済みモデルを作成します。
生成された構成済みモデルは、そのコンポーネント モデルのドキュメントの種類を結合し、抽出パイプラインに分類ステップを挿入して、指定された入力に最も適したコンポーネント サブモデルを決定します。
例
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>
パラメーター
- modelId
-
string
作成するモデルの一意の ID
- componentModelIds
-
Iterable<string>
作成するモデルの一意のモデル ID を表す文字列の Iterable
- options
- BeginComposeDocumentModelOptions
モデル作成のオプション設定
戻り値
Promise<DocumentModelPoller>
作成されたモデル情報またはエラーを最終的に生成する実行時間の長い操作 (ポーリング)
beginCopyModelTo(string, CopyAuthorization, BeginCopyModelOptions)
指定された ID を持つモデルを、特定のコピー承認によってエンコードされたリソースとモデル ID にコピーします。
「copyAuthorization と getCopyAuthorization の 参照してください。
例
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>
パラメーター
- sourceModelId
-
string
コピーされるソース モデルの一意の ID
- authorization
- CopyAuthorization
getCopyAuthorization を使用して作成された、モデルをコピーするための承認
- options
- BeginCopyModelOptions
オプションの設定
戻り値
Promise<DocumentModelPoller>
コピーされたモデル情報またはエラーを最終的に生成する実行時間の長い操作 (ポーリング)
deleteDocumentClassifier(string, OperationOptions)
指定された ID を持つ分類子が存在する場合は、クライアントのリソースから削除します。 この操作を元に戻すことはできません。
例
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>
パラメーター
- classifierId
-
string
リソースから削除する分類子の一意の ID
- options
- OperationOptions
要求の省略可能な設定
戻り値
Promise<void>
deleteDocumentModel(string, DeleteDocumentModelOptions)
指定された ID を持つモデルが存在する場合は、クライアントのリソースから削除します。 この操作を元に戻すことはできません。
例
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>
パラメーター
- modelId
-
string
リソースから削除するモデルの一意の ID
- options
- DeleteDocumentModelOptions
要求の省略可能な設定
戻り値
Promise<void>
getCopyAuthorization(string, GetCopyAuthorizationOptions)
beginCopyModelTo
メソッドで使用される、リソースにモデルをコピーする承認を作成します。
CopyAuthorization
は、承認にエンコードされたモデル ID とオプションの説明を使用して、このクライアントのリソースにモデルを作成する権限を別のコグニティブ サービス リソースに付与します。
例
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>
パラメーター
- destinationModelId
-
string
コピー先モデルの一意の ID (モデルのコピー先の ID)
- options
- GetCopyAuthorizationOptions
コピー承認を作成するためのオプションの設定
戻り値
Promise<CopyAuthorization>
指定された modelId と省略可能な説明をエンコードするコピー承認
getDocumentClassifier(string, OperationOptions)
分類子 (DocumentClassifierDetails) に関する情報を ID で取得します。
例
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>
パラメーター
- classifierId
-
string
クエリを実行する分類子の一意の ID
- options
- OperationOptions
要求の省略可能な設定
戻り値
Promise<DocumentClassifierDetails>
指定された ID を持つ分類子に関する情報
getDocumentModel(string, GetModelOptions)
モデル (DocumentModelDetails) に関する情報を ID で取得します。
このメソッドは、カスタム モデルと事前構築済みモデルに関する情報を取得できます。
破壊的変更
以前のバージョンの Form Recognizer REST API と SDK では、getModel
メソッドは、エラーが原因で作成できなかったモデルであっても、任意のモデルを返す可能性があります。 新しいサービス バージョンでは、getDocumentModel
と listDocumentModels
は、正常に作成されたモデル (つまり、使用できる状態のモデル) のみを生成します。 失敗したモデルは、"操作" API を使用して取得されるようになりました。getOperation と listOperations 参照してください。
例
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>
パラメーター
- modelId
-
string
クエリを実行するモデルの一意の ID
- options
- GetModelOptions
要求の省略可能な設定
戻り値
Promise<DocumentModelDetails>
指定された ID を持つモデルに関する情報
getOperation(string, GetOperationOptions)
操作 (OperationDetails
) に関する情報を ID で取得します。
操作は、モデルの構築、作成、コピーなど、分析以外のタスクを表します。
function getOperation(operationId: string, options?: GetOperationOptions): Promise<OperationDetails>
パラメーター
- operationId
-
string
クエリを実行する操作の ID
- options
- GetOperationOptions
要求の省略可能な設定
戻り値
Promise<OperationDetails>
指定された ID を持つ操作に関する情報
例
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)
このクライアントのリソースに関する基本情報を取得します。
例
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>
パラメーター
- options
- GetResourceDetailsOptions
要求の省略可能な設定
戻り値
Promise<ResourceDetails>
このクライアントのリソースに関する基本情報
listDocumentClassifiers(ListModelsOptions)
リソース内の分類子に関する詳細を一覧表示します。 この操作では、ページングがサポートされます。
例
非同期イテレーション
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>
パラメーター
- options
- ListModelsOptions
分類子要求の省略可能な設定
戻り値
ページングをサポートする分類子の詳細の非同期 iterable
listDocumentModels(ListModelsOptions)
リソース内のモデルの概要を一覧表示します。 カスタム モデルと事前構築済みモデルが含まれます。 この操作では、ページングがサポートされます。
モデルの概要 (DocumentModelSummary) には、モデルに関する基本情報のみが含まれており、モデル内のドキュメントの種類 (フィールド スキーマや信頼度の値など) に関する情報は含まれません。
モデルに関する完全な情報にアクセスするには、getDocumentModel 使用します。
破壊的変更
以前のバージョンの Form Recognizer REST API と SDK では、listModels
メソッドはすべてのモデルを返します。エラーが原因で作成に失敗したモデルも含まれます。 新しいサービス バージョンでは、listDocumentModels
と getDocumentModel
は、正常に作成されたモデル (つまり、使用できる状態のモデル) のみを生成します。 失敗したモデルは、"操作" API を使用して取得されるようになりました。getOperation と listOperations 参照してください。
例
非同期イテレーション
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>
パラメーター
- options
- ListModelsOptions
モデル要求の省略可能な設定
戻り値
ページングをサポートするモデルの概要の非同期の iterable
listOperations(ListOperationsOptions)
リソース内のモデル作成操作を一覧表示します。 これにより、モデルを正常に作成できなかった操作を含むすべての操作が生成されます。 この操作では、ページングがサポートされます。
例
非同期イテレーション
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>
パラメーター
- options
- ListOperationsOptions
操作要求の省略可能な設定
戻り値
ページングをサポートする操作情報オブジェクトの非同期 iterable