次の方法で共有


formrecognizer パッケージ

パッケージ

aio

クラス

AccountProperties

アカウント上のすべてのカスタム モデルの概要。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

AddressValue

アドレス フィールドの値。

バージョン 2023-07-31 の新機能: ユニットcity_districtstate_district郊外およびレベル のプロパティ。

AnalyzeResult

ドキュメント分析結果。

AnalyzedDocument

ドキュメントの場所とセマンティック コンテンツを記述する オブジェクト。

BlobFileListSource

Azure Blob Storageのファイル リストのコンテンツ ソース。

BlobSource

Azure Blob Storageのコンテンツ ソース。

BoundingRegion

ページに対応する境界領域。

ClassifierDocumentTypeDetails

トレーニング データ ソース。

CurrencyValue

通貨値要素。

バージョン 2023-07-31 の新機能: code プロパティ。

CustomDocumentModelsDetails

Form Recognizer リソースのカスタム モデルに関する詳細。

CustomFormModel

トレーニング済みモデルを表します。

バージョン v2.1 の新機能: model_name プロパティと プロパティ プロパティ、 to_dict メソッドと from_dict メソッドのサポート

CustomFormModelField

モデルが分析するフォームから抽出するフィールド。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

CustomFormModelInfo

カスタム モデル情報。

バージョン v2.1 の新機能: model_name プロパティと プロパティ プロパティ、 to_dict メソッドと from_dict メソッドのサポート

CustomFormModelProperties

省略可能なモデル プロパティ。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

CustomFormSubmodel

特定の種類のフォームからフィールドを抽出するサブモデルを表します。

バージョン v2.1 の新機能: model_id プロパティ、 to_dict および from_dict メソッドのサポート

DocumentAnalysisClient

DocumentAnalysisClient は、ドキュメントと画像からの情報を分析し、ドキュメントを分類します。 これは、事前構築済みモデル (領収書、名刺、請求書、ID ドキュメントなど) を使用した分析、ドキュメントからのレイアウトの分析、一般的なドキュメントの種類の分析、および構築されたモデルを使用したカスタム ドキュメントの分析に使用するインターフェイスです (サービスでサポートされているモデルの完全な一覧を表示するには、次 https://aka.ms/azsdk/formrecognizer/modelsを参照してください)。 URL からの入力とストリームからの入力に基づいて、さまざまなメソッドが提供されます。

注意

DocumentAnalysisClient は API バージョンで使用する必要がある

2022-08-31 以降。 API バージョン =v2.1 を <使用するには、FormRecognizerClient をインスタンス化します。

バージョン 2022-08-31 の新機能: DocumentAnalysisClient とそのクライアント メソッド。

DocumentAnalysisError

DocumentAnalysisError には、サービスによって返されるエラーの詳細が含まれています。

DocumentAnalysisInnerError

DocumentAnalysisError の内部エラーの詳細。

DocumentBarcode

バーコード オブジェクト。

DocumentClassifierDetails

ドキュメント分類子情報。 モデルで分類できるドキュメントの種類が含まれます。

DocumentField

ドキュメント フィールド値の内容と場所を表す オブジェクト。

バージョン 2023-07-31 の新機能: ブール値 のvalue_typeと ブール

DocumentFormula

数式オブジェクト。

DocumentKeyValueElement

キーと値のペアのフィールド キーまたは値を表す オブジェクト。

DocumentKeyValuePair

個別のフィールド ラベル (キー) とフィールド値 (空の場合があります) を持つドキュメント フィールドを表す オブジェクト。

DocumentLanguage

特定のテキスト スパンに対して検出された言語を表す オブジェクト。

DocumentLine

ドキュメントの 1 行で見つかったコンテンツを表すコンテンツ行オブジェクト。

DocumentModelAdministrationClient

DocumentModelAdministrationClient は、モデルの構築と管理に使用するForm Recognizer インターフェイスです。

モデルと分類子を構築するためのメソッドと、モデルと分類子の表示と削除、モデルと分類子の操作の表示、アカウント情報へのアクセス、別のForm Recognizer リソースへのモデルのコピー、既存のモデルのコレクションからの新しいモデルの作成を行うメソッドを提供します。

注意

DocumentModelAdministrationClient は API バージョンで使用する必要がある

2022-08-31 以降。 API バージョン =v2.1 を <使用するには、FormTrainingClient をインスタンス化します。

バージョン 2022-08-31 の新機能: DocumentModelAdministrationClient とそのクライアント メソッド。

DocumentModelAdministrationLROPoller

プロトコルを実装し、その後に返される poller オブジェクトを実装します。

DocumentModelDetails

ドキュメント モデル情報。 モデルで分析できるドキュメントの種類が含まれます。

バージョン 2023-07-31 の新機能: expires_on プロパティ。

DocumentModelSummary

モデル ID、その説明、モデルの作成日時を含むドキュメント モデル情報の概要。

バージョン 2023-07-31 の新機能: expires_on プロパティ。

DocumentPage

入力のページから抽出されたコンテンツ要素とレイアウト要素。

バージョン 2023-07-31 の新機能: バーコード数式の プロパティ。

DocumentParagraph

段落オブジェクトは、通常、共通の配置と間隔を持つ連続した行で構成されます。

バージョン 2023-07-31 の新機能: formulaBlock ロール。

DocumentSelectionMark

チェック ボックス、ラジオ ボタン、および選択範囲を示すその他の要素を表す選択マーク オブジェクト。

DocumentSpan

プロパティのコンテンツの連続した領域。オフセットと長さとして指定されます。

DocumentStyle

観察されたテキスト スタイルを表す オブジェクト。

バージョン 2023-07-31 の新機能: similar_font_familyfont_stylefont_weightおよびbackground_color プロパティ。

DocumentTable

四角形のレイアウトに配置されたテーブル セルで構成されるテーブル オブジェクト。

DocumentTableCell

テーブル セルの場所と内容を表す オブジェクト。

DocumentTypeDetails

DocumentTypeDetails は、モデルが認識できるドキュメントの種類 (フィールドと型、それらのフィールドの信頼度など) を表します。

DocumentWord

連続する文字シーケンスで構成される単語オブジェクト。 中国語、日本語、韓国語などのスペース区切り以外の言語の場合、各文字は独自の単語として表されます。

FieldData

フォーム フィールドのデータを格納します。 これには、テキスト、フォーム上のテキストの場所、およびテキストを構成する要素のコレクションが含まれます。

バージョン v2.1 の新機能: FormSelectionMark は、field_elementsの一覧で返される型、 to_dict および from_dict メソッドのサポートに追加されます

FormElement

フォーム要素のプロパティを含む基本型。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

FormField

入力フォームで認識されるフィールドを表します。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

FormLine

抽出されたテキスト行を表す オブジェクト。

バージョン v2.1 の新機能: appearance プロパティ、 to_dict および from_dict メソッドのサポート

FormPage

入力ドキュメントから認識されるページを表します。 行、単語、選択マーク、テーブル、およびページ メタデータが含まれます。

バージョン v2.1 の新機能: selection_marks プロパティ、 to_dict メソッドと from_dict メソッドのサポート

FormPageRange

フォームの 1 から始まるページ範囲。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

FormRecognizerClient

FormRecognizerClient は、フォームとイメージから構造化データに情報を抽出します。 事前構築済みモデル (領収書、名刺、請求書、ID ドキュメント) での分析、フォームからのコンテンツ/レイアウトの認識、トレーニング済みモデルからのカスタム フォームの分析に使用するインターフェイスです。 URL からの入力とストリームからの入力に基づいて、さまざまなメソッドが提供されます。

注意

FormRecognizerClient は、API バージョン =v2.1 で使用する <必要があります。

API バージョン 2022-08-31 以降を使用するには、DocumentAnalysisClient をインスタンス化します。

FormRecognizerError

トレーニング中に発生したエラーを表します。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

FormSelectionMark

抽出された選択マークに関する情報。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

FormTable

ページに含まれる抽出されたテーブルに関する情報。

バージョン v2.1 の新機能: bounding_box プロパティ、 to_dict メソッドと from_dict メソッドのサポート

FormTableCell

入力ドキュメントから認識されるテーブルに含まれるセルを表します。

バージョン v2.1 の新機能: FormSelectionMark は、field_elementsの一覧で返される型、 to_dict および from_dict メソッドのサポートに追加されます

FormTrainingClient

FormTrainingClient は、カスタム モデルの作成と管理に使用するForm Recognizer インターフェイスです。 指定したフォームでモデルをトレーニングするためのメソッドと、モデルの表示と削除、アカウント プロパティへのアクセス、別のForm Recognizer リソースへのモデルのコピー、ラベルでトレーニングされた既存のモデルのコレクションからのモデルの作成を行うメソッドを提供します。

注意

FormTrainingClient は、API バージョン =v2.1 で使用する <必要があります。

API バージョン 2022-08-31 以降を使用するには、DocumentModelAdministrationClient をインスタンス化します。

FormWord

入力文書から認識される単語を表します。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

OperationDetails

OperationDetails は、モデル操作に関する情報で構成されます。これには、操作が完了した場合の結果またはエラーが含まれます。

操作情報は 24 時間のみ保持されることに注意してください。 操作が成功した場合は、、 <xref:azure.ai.formrecognizer.list_document_classifiers> API を使用して<xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.get_document_model><xref:azure.ai.formrecognizer.list_document_models>モデルにアクセスすることもできます。

バージョン 2023-07-31 の新機能: documentClassifierBuild の種類と DocumentClassifierDetails の結果。

OperationSummary

操作の種類や状態、作成時などのモデル操作情報。

操作情報は 24 時間のみ保持されることに注意してください。 操作が成功した場合は、API を使用してモデルに<xref:azure.ai.formrecognizer.get_document_model><xref:azure.ai.formrecognizer.list_document_models><xref:azure.ai.formrecognizer.get_document_classifier><xref:azure.ai.formrecognizer.list_document_classifiers>アクセスできます。 操作が失敗した理由を確認するには、 を使用 <xref:azure.ai.formrecognizer.get_operation> し、 operation_idを指定します。

バージョン 2023-07-31 の新機能: documentClassifierBuild の種類。

Point

境界ボックスまたは多角形上の点の x、y 座標。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

QuotaDetails

クォータの使用、制限、次回のリセット日時。

RecognizedForm

トレーニング済みモデルまたは事前構築済みモデルによって認識されたフォームを表します。 fields プロパティには、フォームから抽出されたフォーム フィールドが含まれます。 テーブル、テキスト行/単語、および選択マークはページごとに抽出され、 pages プロパティにあります。

バージョン v2.1 の新機能: form_type_confidence プロパティと model_id プロパティ、 to_dict メソッドと from_dict メソッドのサポート

ResourceDetails

Form Recognizer リソースに関する詳細。

バージョン 2023-07-31 の新機能: neural_document_model_quota プロパティ。

TextAppearance

テキスト行の外観を表す オブジェクト。

バージョン v2.1 の新機能: to_dict メソッドと from_dict メソッドのサポート

TrainingDocumentInfo

カスタム モデルのトレーニングに使用される個々のドキュメントのレポート。

バージョン v2.1 の新機能: model_id プロパティ、 to_dict および from_dict メソッドのサポート

列挙型

AnalysisFeature

有効にするドキュメント分析機能。

CustomFormModelStatus

使用するモデルの準備状態を示す状態。

DocumentAnalysisApiVersion

Form Recognizer DocumentAnalysisClient および DocumentModelAdministrationClient でサポートされている API バージョン。

FieldValueType

フィールド値のセマンティック データ型。

バージョン v2.1 の新機能: selectionMarkcountryRegion の値

FormContentType

アップロードするコンテンツ タイプ。

バージョン v2.1 の新機能: image/bmp のサポート

FormRecognizerApiVersion

Form Recognizer FormRecognizerClient および FormTrainingClient でサポートされている API バージョン。

LengthUnit

幅、高さ、境界ボックスのプロパティで使用される単位。 画像の場合、単位は "ピクセル" です。 PDF の場合、単位は "inch" です。

ModelBuildMode

カスタム モデルを構築するときに使用されるモード。

詳細については、「https://aka.ms/azsdk/formrecognizer/buildmode」を参照してください。

TrainingStatus

トレーニング操作の状態。