メインコンテンツへスキップ

何をするか

フィルターされたバッチのセットを、グループ単位でサーバーからリクエストします。たとえば、次のようなリクエストを送信できます。「500 番目のバッチから開始し、認識ステージにあるバッチを 100 件返す。」

定義

int GetFilteredBatches(int sessionId, int projectId, int batchTypeId, int[] stageTypes, int[] stageExtIds, string name, int batchPurpose, long startDate, long stopDate, long slaDateBeginRange, long slaDateEndRange, int slaStateFlags, int firstRecord, int recordsCount, RegistrationProperty[] filterRegParams, out Batch[] batches)

パラメーター

sessionId

int

Application Server への接続ID

projectId

int

情報を取得する対象のバッチタイプを含むプロジェクトのID。

batchTypeId

int

バッチタイプのID

  • 0 - 既定のバッチ
  • -1 - すべてのバッチタイプ

stageTypes

int []

探しているバッチが含まれるステージ型のセット (指定可能な値についてはProcessingStageを参照)

  • 空のセット - すべてのバッチ
  • 0 - 特定のステージに属していないバッチ

stageExtIds

int []

探しているバッチが含まれるステージ ID (ProcessingStage 構造体の Id field) の集合

  • 空の集合 - すべてのバッチ
  • 0 - 特定のステージに属していないバッチ

name

string

バッチ名の接頭辞。空欄は任意の名前を使用できることを示します

batchPurpose

int

バッチの用途

指定可能な値:

  • 0 - データを含むバッチ
  • 1 - Document Definition のマッチング学習用バッチ
  • 2 - 分類器の学習用バッチ

startDate

long

指定した日付より後に作成されたバッチ。0 はすべてのバッチを表します

変換には次のメソッドを使用します (以下の例は C#) 。

DateTime dtTime; long lTime; … // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); … // long から DataTime への変換 lTime = dTime.ToFileTime();

stopDate

long

指定した日付以降に作成されたバッチ。0 はすべてのバッチを表します

変換するには、次のメソッドを使用します (以下は C# の例です) 。

DateTime dtTime; long lTime; … // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); … // long から DataTime への変換 lTime = dTime.ToFileTime();

slaDateBeginRange

long

SLA における処理終了日が指定した日付以前ではない batch。0 はすべての batch を表します

変換には、次のメソッドを使用します (以下の例は C#) 。

DateTime dtTime; long lTime; … // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); … // long から DataTime への変換 lTime = dTime.ToFileTime();

slaDateEndRange

long

SLA における処理終了日が指定した日付以前の Batches。0 はすべての batch を表します

変換には次のメソッドを使用します (以下の例は C# です) 。

DateTime dtTime; long lTime; … // DataTime から long への変換 dTime = DataTime.FromFileTime(lTime); … // long から DataTime への変換 lTime = dTime.ToFileTime();

slaStateFlags

int

バッチの処理期限に関する警告を含みます

次の値、またはそれらの論理和 (OR) を指定できます:

  • 0 - この属性ではバッチは絞り込まれません
  • 1 - 処理期限が指定されていないバッチ
  • 2 - 処理期限が近づいておらず、期限にも達していないバッチ
  • 4 - 処理期限が近づいているバッチ
  • 8 - 処理期限に達したバッチ

firstRecord

int

リストの先頭レコード

(レコード番号は 0 から始まります)

recordsCount

int

ユーザーが取得しようとするbatch数

filterRegParams

RegistrationProperty[]

登録パラメーターでフィルタリングするために使用される「name–value」ペアのセット

(送信できる値のペアは 5 件までで、それ以外のペアは無視されます)

Batches は ID の降順で並べ替えられるため、最新のバッチがリストの先頭に返されます。

戻り値

説明
int指定したフィルター条件に一致するサーバー上のバッチ数
Batch[]完了した Batch 構造体のセット