@azure/ai-form-recognizer package

クラス

AzureKeyCredential	基になるキー値の更新をサポートする静的キーベースの資格情報。
DocumentAnalysisClient	Form Recognizer サービスの分析機能を操作するためのクライアント。 例： Form Recognizer サービスとクライアントは、次の 2 つの認証方法をサポートしています。 Azure Active Directory import { DefaultAzureCredential } from "@azure/identity"; import { DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new DefaultAzureCredential(); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, ); API キー (サブスクリプション キー) import { AzureKeyCredential, DocumentAnalysisClient } from "@azure/ai-form-recognizer"; const credential = new AzureKeyCredential("<API key>"); const client = new DocumentAnalysisClient( "https://<resource name>.cognitiveservices.azure.com", credential, );
DocumentModelAdministrationClient	モデルの作成、読み取り、一覧表示、削除、コピーなど、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, );

インターフェイス

AddressValue	アドレス フィールドの値。
AnalyzeDocumentOptions	ドキュメント分析操作のオプション。
AnalyzeResult	分析操作の結果。 ドキュメントの種類は、分析の実行に使用されるモデルによって決まります。
AnalyzeResultCommon	LayoutResult、ReadResult、GeneralDocumentResult など、すべての AnalyzeResult に似た型の共通フィールド。
AnalyzedDocument	抽出されたドキュメント オブジェクト。 AnalyzedDocument は、モデル内のドキュメントの種類の 1 つのインスタンスです。 そのフィールドは、ドキュメント型のフィールド スキーマに対応します。
AzureBlobFileListSource	Azure BLOB コンテナーによって定義されたトレーニング データ ソースと、コンテナー内の JSONL ファイルの一覧。
AzureBlobFileListSourceDetails	Azure Blob Storage のファイルの一覧。
AzureBlobSource	Azure BLOB コンテナーによって定義されたトレーニング データ ソース。
AzureBlobSourceDetails	Azure Blob Storage のコンテンツ。
BeginBuildDocumentClassifierOptions	ドキュメント分類子のビルド操作のオプション。
BeginBuildDocumentModelOptions	モデルビルド操作のオプション。
BeginComposeDocumentModelOptions	モデル作成操作のオプション。
BeginCopyModelOptions	モデルのコピー操作のオプション。
BoundingRegion	入力の特定のページでの多角形の境界。
ClassifierDocumentTypeDetails	分類子ドキュメントの種類の情報。
ClassifyDocumentOptions	ドキュメント分類操作のオプション。
CommonModelCreationOptions	beginBuildDocumentModel、beginComposeDocumentModel、getCopyAuthorizationなど、新しいモデルを定義するすべての操作に共通するオプション。
CopyAuthorization	指定したターゲット リソースと modelId にドキュメント モデルをコピーするための承認。
CreateDocumentModelOptions	モデル作成操作のオプション。
CurrencyValue	通貨フィールドの値。
CustomDocumentModelsDetails	カスタム ドキュメント モデルに関する詳細。
DeleteDocumentModelOptions	モデル削除のオプション。
DocumentAddressField	構造化された物理アドレスを記述するドキュメント フィールド。
DocumentAnalysisClientOptions	DocumentAnalysisClient の構成可能なオプション。
DocumentAnalysisPollOperationState	分析操作の状態。最終的にはモデルに対応する結果の種類が生成されます。
DocumentAnnotation	チェック マークやクロスなど、ドキュメント内の視覚的な注釈要素。
DocumentArrayField	入れ子になったフィールドの配列で構成される DocumentField。 配列内のすべてのフィールドの型は同じです。
DocumentBarcode	抽出されたバーコード。
DocumentBooleanField	ブール値を持つ DocumentField。
DocumentCaption	表のキャプションの場所と内容を表すオブジェクト。
DocumentClassifierBuildOperationDetails	操作応答オブジェクトを取得します。
DocumentClassifierDetails	分類子情報をドキュメント化します。
DocumentClassifierDocumentTypeSources	ドキュメント分類子の作成に使用される一連のソース。 これは、対応するソースの種類のドキュメントを分類するためにモデルをトレーニングするために使用されるソースへのドキュメントの種類名のマップです。
DocumentClassifierOperationState	モデル作成操作の状態。
DocumentCountryRegionField	文字列として表される国または地域を示す値を持つ DocumentField。
DocumentCurrencyField	特定の通貨の金額を表す DocumentField。
DocumentDateField	Date 値を持つ DocumentField。
DocumentFieldCommon	すべての DocumentField バリアントに共通のフィールド。
DocumentFieldSchema	JSON スキーマ スタイル構文を使用したフィールド セマンティック スキーマの説明。
DocumentFootnote	表の脚注の場所と内容を表すオブジェクト。
DocumentFormula	抽出された数式。
DocumentIntegerField	整数値を持つ DocumentField。
DocumentKeyValueElement	キーと値のペアのフィールド キーまたは値を表すオブジェクト。
DocumentKeyValuePair	個別のフィールド ラベル (キー) とフィールド値 (空の場合があります) を持つフォーム フィールドを表すオブジェクト。
DocumentLanguage	特定のテキスト スパンで検出された言語を表すオブジェクト。
DocumentLine	単語や選択マークなどのコンテンツ要素の隣接するシーケンスで構成されるコンテンツ行オブジェクト。
DocumentModel	構造化ドキュメントの抽出をサポートする既知のモデル仕様。 beginAnalyzeDocumentの メソッドを参照してください。このメソッドでは、モデル ID 文字列ではなく、これらの DocumentModel オブジェクトを使用して、より強力な結果の種類を提供できます。
DocumentModelAdministrationClientOptions	DocumentModelAdministrationClient の構成可能なオプション。
DocumentModelBuildOperationDetails	操作応答オブジェクトを取得します。
DocumentModelComposeOperationDetails	操作応答オブジェクトを取得します。
DocumentModelCopyToOperationDetails	操作応答オブジェクトを取得します。
DocumentModelDetails	ドキュメント モデル情報。
DocumentModelOperationState	モデル作成操作の状態。
DocumentModelSummary	ドキュメント モデルの概要。
DocumentNumberField	数値を持つ DocumentField。
DocumentObjectField	独自の DocumentField 値を持つ複数の名前付きプロパティで構成される DocumentField。
DocumentPage	入力からページから抽出されたコンテンツ要素とレイアウト要素。
DocumentParagraph	一般的に、一般的な配置と間隔を持つ連続した行で構成される段落オブジェクト。
DocumentPhoneNumberField	文字列として表される電話番号の値を持つ DocumentField。
DocumentSelectionMark	チェック ボックス、ラジオ ボタン、および選択範囲を示すその他の要素を表す選択マーク オブジェクト。
DocumentSelectionMarkField	文字列として表される選択マークの状態 (チェック ボックスやラジオ ボタンなど) を示す値を持つ DocumentField。
DocumentSignatureField	文字列として表される署名の状態を示す DocumentField。
DocumentSpan	オフセットと長さとして指定された、連結されたコンテンツ プロパティの連続した領域。
DocumentStringField	文字列値を持つ DocumentField。
DocumentStyle	観察されたテキスト スタイルを表すオブジェクト。
DocumentTable	四角形のレイアウトに配置されたテーブル セルで構成されるテーブル オブジェクト。
DocumentTableCell	テーブル セルの場所と内容を表すオブジェクト。
DocumentTimeField	文字列として表される時間値を持つ DocumentField。
DocumentTypeDetails	ドキュメントの種類の情報。
DocumentValueField	文字列、数値などのプリミティブ値を持つ単純なフィールド。
DocumentWord	連続する文字シーケンスで構成される単語オブジェクト。 中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。
ErrorModel	エラー情報。
GetCopyAuthorizationOptions	コピーの取得承認メソッドのオプション。
GetModelOptions	モデル情報を取得するためのオプション。
GetOperationOptions	操作の状態を取得するためのオプション。
GetResourceDetailsOptions	Form Recognizer リソース情報を取得するためのオプション。
HasBoundingPolygon	単語、選択マーク、線などの単純なドキュメント要素は、多角形で囲まれます。
InnerError	詳細なエラー。
ListModelsOptions	モデルを一覧表示するためのオプション。
ListOperationsOptions	操作を一覧表示するためのオプション。
ModelAdministrationOperationStateCommon	すべての管理操作に共通するフィールドのセット。
OperationDetails	操作応答オブジェクトを取得します。
OperationSummary	操作情報。
Point2D	境界ポリゴンの定義に使用するポイントを表します。 単位は 'pixel' または 'inch' です (lengthUnit 参照)。
PollerOptions	Form Recognizer クライアントでの実行時間の長い操作 (ポーリング) のオプション。
QuotaDetails	クォータの使用、制限、および次回のリセットの日付/時刻。
ResourceDetails	現在のリソースに関する一般的な情報。

型エイリアス

AnalysisPoller	分析操作の状態を追跡し、最終的にモデルに対応する結果の種類を生成する実行時間の長い操作 (ポーリング)。
AnalyzeResultOperationStatus	AnalyzeResultOperationStatus の値を定義します。
DocumentBarcodeKind	DocumentBarcodeKind の値を定義します。 KnownDocumentBarcodeKind DocumentBarcodeKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 QRCode: ISO/IEC 18004:2015 で定義されている QR コード。 PDF417: PDF417(ISO 15438 で定義)。 UPCA: GS1 12 桁のユニバーサル製品コード。 UPCE: GS1 6 桁のユニバーサル製品コード。 Code39: ISO/IEC 16388:2007 で定義されているコード 39 バーコード。 Code128: ISO/IEC 15417:2007 で定義されているコード 128 バーコード。 EAN8: GS1 8 桁の国際商品番号 (ヨーロッパの記事番号)。 EAN13: GS1 13 桁の国際商品番号 (ヨーロッパの記事番号)。 DataBar: GS1 DataBar バーコード。 Code93: ANSI/AIM BC5-1995 で定義されているコード 93 バーコード。 Codabar: ANSI/AIM BC3-1995 で定義されている Codabar バーコード。 DataBarExpanded: GS1 DataBar Expanded バーコード。 ITF: ANSI/AIM BC2-1995 で定義されているように、5 バーコードのインターリーブ 2。 MicroQRCode: ISO/IEC 23941:2022 で定義されているマイクロ QR コード。 Aztec: ISO/IEC 24778:2008 で定義されている Aztec コード。 DataMatrix: ISO/IEC 16022:2006 で定義されているデータ マトリックス コード。 MaxiCode: MaxiCode (ISO/IEC 16023:2000 で定義)。
DocumentBuildMode	DocumentBuildMode の値を定義します。 KnownDocumentBuildMode を DocumentBuildMode と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 テンプレート: 類似したビジュアル テンプレートを使用してドキュメントをターゲットに設定します。 ニューラル: 多様なビジュアル テンプレートを使用してドキュメントをサポートします。
DocumentClassifierPoller	カスタム分類子作成操作の状態を追跡し、最終的に DocumentClassifierDetailsを生成する実行時間の長い操作 (poller)。
DocumentClassifierSource	ドキュメント分類子の構築に使用できるコンテンツ ソース。 次のいずれか: ブロブソース ブロブファイル・リスト・ソース
DocumentField	抽出されたフィールド。 kind プロパティは、DocumentFieldの型を識別 (判別) します。
DocumentFieldType	DocumentFieldType の値を定義します。 KnownDocumentFieldType DocumentFieldType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 文字列: プレーンテキスト。 日付: ISO 8601 (YYYY-MM-DD) 形式に正規化された日付。 時間: ISO 8601 (hh:mm:ss) 形式に正規化された時間。 phoneNumber: E.164 (+{CountryCode}{SubscriberNumber}) 形式に正規化された電話番号。 数値: 倍精度浮動小数点に正規化された浮動小数点数。 整数: 64 ビット符号付き整数に正規化された整数。 selectionMark: フィールドは選択されていますか? countryRegion: 国/地域。ISO 3166-1 alpha-3 形式 (米国など) に正規化されます。 署名: 署名は存在しますか? 配列: 同じ型のサブフィールドのリスト。 オブジェクト: 潜在的に異なる型のサブフィールドの名前付きリスト。 通貨: 通貨記号と単位を省略可能な通貨金額。 アドレス: 解析されたアドレス。 ブール: true または false に正規化されたブール値。
DocumentFormulaKind	DocumentFormulaKind の値を定義します。 KnownDocumentFormulaKind DocumentFormulaKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 インライン : 段落のコンテンツ内に埋め込まれた数式。 表示: 行全体を占有する表示モードの数式。
DocumentModelBuildMode	サポートされているモデルのビルド モード。 モデル ビルド モードでは、ラベル付けされたトレーニング データに基づいて、サービスがモデルのトレーニングに使用するエンジンが選択されます。 オプションは次のとおりです。 "ニューラル" は、データの構造が同じであるが、レイアウトが異なるドキュメントのクラスからデータを抽出できる最高品質のモデルを生成します (たとえば、W2 税フォームは会社によって異なる場合がありますが、常に同じ情報が含まれます)。 "template"。すべてのドキュメントに同じ固定レイアウト (テンプレート) が必要です。 詳細については、次のリンクを参照してください: https://aka.ms/azsdk/formrecognizer/buildmode
DocumentModelPoller	モデル作成操作の状態を追跡し、最終的に DocumentModelDetailsを生成する実行時間の長い操作 (ポーリング) です。
DocumentModelSource	ドキュメント モデルの構築に使用できるコンテンツ ソース。 次のいずれか: ブロブソース ブロブファイル・リスト・ソース
DocumentSignatureType	DocumentSignatureType の値を定義します。 KnownDocumentSignatureType DocumentSignatureType と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 署名された: 署名が検出されます。 署名されていない: 署名は検出されません。
DocumentTableCellKind	DocumentTableCellKind の値を定義します。 KnownDocumentTableCellKind DocumentTableCellKind と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 コンテンツ: メインのコンテンツ/データが含まれます。 rowHeader: 行の内容について説明します。 columnHeader: 列の内容について説明します。 stubHead: 通常はテーブルの左上隅にある行ヘッダーについて説明します。 説明: テーブル内のコンテンツ (一部) について説明します。
FontStyle	FontStyle の値を定義します。 KnownFontStyle を FontStyle と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 通常の: 文字は通常どおりに表されます。 斜体: 文字は視覚的に右に斜め表示されます。
FontWeight	FontWeight の値を定義します。 KnownFontWeight FontWeight と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 通常の: 文字は通常どおりに表されます。 太字の: 文字は太いストロークで表されます。
FormRecognizerFeature	要求に対して有効にできるアドオン機能 (機能)。 Form Recognizer で使用できる機能の詳細については、サービスのドキュメントを参照してください。 https://aka.ms/azsdk/formrecognizer/features
FormRecognizerRequestBody	Form Recognizer サービスにバイナリ データとしてアップロードできる要求入力。 Form Recognizer は string 入力を URL として扱うので、文字列を バイナリ 入力として送信するには、まず文字列を次のいずれかの入力型に変換します。
LengthUnit	LengthUnit の値を定義します。 KnownLengthUnit を LengthUnit と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 ピクセル: 画像ファイルの長さ単位。 インチ: PDFファイルの長さ単位。
OperationDetailsUnion	さまざまな種類の Form Recognizer 管理操作の詳細。
OperationKind	OperationKind の値を定義します。 KnownOperationKind を OperationKind と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 documentModelBuild: 新しいカスタム ドキュメント モデルを構築します。 documentModelCompose: 既存のモデルから新しいカスタム ドキュメント モデルを作成します。 documentModelCopyTo: 既存のドキュメント モデルを別のリソース、リージョン、またはサブスクリプションにコピーします。 documentClassifierBuild: 新しいカスタム分類子モデルを構築します。
OperationStatus	OperationStatus の値を定義します。
ParagraphRole	ParagraphRole の値を定義します。 KnownParagraphRole ParagraphRole と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 pageHeader: ページの上端付近のテキスト。 pageFooter: ページの下端付近のテキスト。 pageNumber: ページ番号。 タイトル: ドキュメント全体を説明する最上位レベルのタイトル。 セクション見出し: 文書のセクションを説明するサブ見出し。 脚注: 通常、ページのメイン コンテンツの後に配置されるノート。 formulaBlock: 数式のブロック 。多くの場合、配置が共有されています。
SelectionMarkState	SelectionMarkState の値を定義します。 KnownSelectionMarkState を SelectionMarkState と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 選択した: 選択マークが選択され、多くの場合、選択マーク内のチェック ✓ またはクロス X で示されます。 選択されていない: 選択マークは選択されていません。
StringIndexType	Form Recognizer サービスおよび SDK クライアントでサポートされる有効な文字列インデックスの種類。

列挙型

KnownDocumentBarcodeKind	DocumentBarcodeKind の既知の値は、サービスが受け入れる。
KnownDocumentBuildMode	サービス 受け入れる DocumentBuildMode の既知の値。
KnownDocumentFieldType	DocumentFieldType 既知の値は、サービスが受け入れる。
KnownDocumentFormulaKind	サービス 受け入れる DocumentFormulaKind の既知の値。
KnownDocumentSignatureType	サービス 受け入れる DocumentSignatureType の既知の値。
KnownDocumentTableCellKind	サービス 受け入れる DocumentTableCellKind の既知の値。
KnownFontStyle	FontStyle の既知の値は、サービスが受け入れる。
KnownFontWeight	サービスが受け入れる FontWeight 既知の値。
KnownFormRecognizerAudience	Form Recognizer の既知のクラウド対象ユーザーを定義します。 TokenCredential環境でEntra Id(を使用)で認証するには、audienceまたはDocumentAnalysisClientの作成時にDocumentModelAdministrationClientオプションとして以下の適切な値を指定します。 既定値は Azure パブリック クラウドで作成された Form Recognizer リソースに適しているため、この値は別のクラウド環境で Form Recognizer を使用する場合にのみ必要です。
KnownLengthUnit	サービスが受け入れる LengthUnit の既知の値。
KnownOperationKind	OperationKind の既知の値は、サービスが受け入れる。
KnownParagraphRole	ParagraphRole の既知の値は、サービスが受け入れる。
KnownSelectionMarkState	サービスが受け入れる SelectionMarkState 既知の値。