Document Understanding アクティビティ

最終更新日時 2024年12月5日

OCRNativeActivity クラス

定義

名前空間: UiPath.OCR.Contracts.Activities
アセンブリ: UiPath.OCR.Contracts

説明

Workflow Foundation フレームワークから NativeActivity を構築するために実装する必要がある抽象クラスです。

メンバー

メソッド

BeforeExecute(System.Activities.NativeActivityContext) System.Collections.Generic.Dictionary<string, object> - このメソッドをオーバーライドして、アクティビティの Image 引数以外のすべての入力引数を計算および提供し、アクティビティの入力引数をディクショナリとして返します。キーは引数名、値は引数値です。
メモ：設計時にコンテキストが利用できないとき、メソッドのパラメーターは null になります。この場合、アクティビティの引数を読み取れないため、既定値を指定できます。
Execute(System.Activities.NativeActivityContext) void Execute(System.Activities.NativeActivityContext - このメソッドをオーバーライドしてアクティビティコードを実装できます。これは、アクティビティを実行するためにワークフローランタイムによって呼び出されます。追跡、変数、引数へのアクセスも可能です。
OCRNativeActivity.OCRNativeActivity() - アクティビティコンストラクター
OnSuccess(System.Activities.NativeActivityContext, UiPath.OCR.Contracts.DataContracts.OCRResult) void OnSuccess(System.Activities.NativeActivityContext context, UiPath.OCR.Contracts.DataContracts.OCRResult result) - このメソッドは、OCR 結果を計算した後に呼び出されます。出力引数やその他の最終操作を設定するために使用できます。
PerformOCRAsync(System.Drawing.Image, System.Collections.Generic.Dictionary<string, object>, System.Threading.CancellationToken) - 画像を処理し、抽出したテキスト情報を返します。Options パラメーターはアクティビティ引数のディクショナリで、キーは引数名、値は引数値です。

プロパティ

ExtractWords - 単語を抽出する必要があるかどうかを取得または設定します。
Image System.Activities.InArgument<System.Drawing.Image> - 処理する画像です。
Language System.Activities.InArgument<string> - OCR エンジンが UI 要素または画像から文字列を抽出する際に使用する言語です。
Output System.Activities.OutArgument<UiPath.OCR.Contracts.OcrActivityResult> - アクティビティの出力です。レガシー、時代遅れの議論。
Text System.Activities.OutArgument<string> - 抽出したテキストです。

コードサンプル

[DisplayName("Sample OCRNativeActivity")]
internal class SampleOCRNativeActivity : OCRNativeActivity
    {
        public InArgument<string> CustomInput { get; set; }

        public OutArgument<string> CustomOutput { get; set; }

        public override Task<OCRResult> PerformOCRAsync(Image image, Dictionary<string, object> options, CancellationToken ct)
        {
            string customInput = options[nameof(CustomInput)] as string;
            string text = $"Text from {nameof(SampleOCRNativeActivity)} with custom input: {customInput}";
            return Task.FromResult(OCRResultHelper.FromText(text));
        }

        protected override void OnSuccess(NativeActivityContext context, OCRResult result)
        {
            CustomOutput.Set(context, $"Custom output: '{result.Text}' has {result.Words.Length} words.");
        }

        protected override Dictionary<string, object> BeforeExecute(NativeActivityContext context)
        {
            return new Dictionary<string, object>
            {
                { nameof(CustomInput), CustomInput.Get(context) }
            };
        }
    }[DisplayName("Sample OCRNativeActivity")]
internal class SampleOCRNativeActivity : OCRNativeActivity
    {
        public InArgument<string> CustomInput { get; set; }

        public OutArgument<string> CustomOutput { get; set; }

        public override Task<OCRResult> PerformOCRAsync(Image image, Dictionary<string, object> options, CancellationToken ct)
        {
            string customInput = options[nameof(CustomInput)] as string;
            string text = $"Text from {nameof(SampleOCRNativeActivity)} with custom input: {customInput}";
            return Task.FromResult(OCRResultHelper.FromText(text));
        }

        protected override void OnSuccess(NativeActivityContext context, OCRResult result)
        {
            CustomOutput.Set(context, $"Custom output: '{result.Text}' has {result.Words.Length} words.");
        }

        protected override Dictionary<string, object> BeforeExecute(NativeActivityContext context)
        {
            return new Dictionary<string, object>
            {
                { nameof(CustomInput), CustomInput.Get(context) }
            };
        }
    }