Pipelines reference - Preparers
===============================

パイプライン準備者のためのこのリファレンスドキュメントには、
:ref:`Pipelines reference - Preparers <Pipelines reference - Preparers>` に関連するailb拡張機能で使用可能なファンクションとビューに関する情報が含まれています。詳細については、
:ref:`Pipelines knowledge bases usage <Pipelines knowledge bases usage>` および :ref:`Where to find SDK references and examples? <Where to find SDK references and examples?>` を参照してください。

ビュー
------

helpb.preparers
^^^^^^^^^^^^^^^

``aidb.preps`` としても参照可能な\ ``aidb.preparers``
ビューには、構成されたデータプリペアラーに関する情報が含まれています。これには、次の列が含まれます。

.. csv-table::
  :header: Column,Type,Description
  :widths: 12,15,25
  :align: left
  :class: longtable

  id,INTEGER,NA
  name,TEXT,準備者の名前。
  operation,:ref:`helpb.DataPreparationOperation<helpb.DataPreparationOperation>` ,実行する処理ステップの種類。
  destination_schema,TEXT,出力データを保存する宛先テーブルのスキーマ。
  destination_table,TEXT,出力データを保存する宛先テーブルの名前。
  destination_key_column,TEXT,ソースデータのキーを参照する宛先テーブルの列。
  destination_data_column,TEXT,出力データを保存する宛先テーブルの列。
  options,JSONB,"データ準備操作の構成オプション。  :ref:`**vector-native capabilities** <Pipelines model primitives>` と同じAPIを使用します。"
  source_type,TEXT,準備者が作業しているソースデータのタイプ。 'テーブル'または'ボリューム'のいずれかです。
  source_schema,TEXT,準備者が処理するソースデータを含むテーブルのスキーマ。 `Table`ソースタイプのプリペアラーにのみ適用されます。
  source_table,TEXT,プリペアラーが処理するソースデータを含むテーブルの名前。 `Table`ソースタイプのプリペアラーにのみ適用されます。
  source_data_column,TEXT,準備者が処理するソースデータを含むソーステーブルの列。 `Table`ソースタイプのプリペアラーにのみ適用されます。
  source_key_column,TEXT,出力処理されたデータで参照するソーステーブルのキー列の名前。 `Table`ソースタイプのプリペアラーにのみ適用されます。
  source_volume_name,TEXT,データソースとして使用するボリュームの名前。 `Volume`ソースタイプのプリペアラーにのみ適用されます。

タイプ
------

helpb.DataPreparationOperation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

``aidb.DataPreparationOperation``
タイプは、実行可能な前処理ステップのさまざまなタイプを表す列挙型です。

- ChunkText

- テキストの要約

- ParseHtml

- ParsePdf

- PerformOcr

ファンクション
--------------

helpb.create_table_preparer
^^^^^^^^^^^^^^^^^^^^^^^^^^^

ソースデータテーブルを使用してプリペアラーを作成します。

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  name,TEXT,Required,作成者の名前
  operation,:ref:`helpb.DataPreparationOperation<helpb.DataPreparationOperation>` ,Required,データ準備操作の種類
  source_table,TEXT,Required,ソースデータテーブルの名前
  source_data_column,TEXT,Required,生データを含むソーステーブルの列
  destination_table,TEXT,Required,宛先テーブルの名前
  destination_data_column,TEXT,Required,処理されたデータの宛先テーブルの列
  source_key_column,TEXT,'id',行を参照するキーとして使用するソーステーブル内の一意の列。
  destination_key_column,TEXT,'id',`source_key_column`を参照する宛先テーブルのキー列
  options,JSONB,'{}'::JSONB,"データ準備操作の構成オプション。  :ref:`**vector-native capabilities** <Pipelines model primitives>` と同じAPIを使用します。"

``aidb.create_preparer_for_table`` 非推奨
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

同じ引数を使用した** :ref:`aidb.create_table_preparer <aidb.create_table_preparer>` に置き換えられます。

promoteb.create_volume_preparer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

指定されたPGFSボリュームのプリペアラーを作成します。

.. _パラメーター-1:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  name,TEXT,Required,作成者の名前
  operation,:ref:`helpb.DataPreparationOperation<helpb.DataPreparationOperation>` ,Required,データ準備操作の種類
  source_volume_name,TEXT,Required,生データが含まれるソースボリュームの名前
  destination_table,TEXT,Required,宛先テーブルの名前
  destination_data_column,TEXT,Required,処理されたデータの宛先テーブルの列
  destination_key_column,TEXT,'id',処理されたデータを一意に識別する宛先テーブルのキー列
  options,JSONB,'{}'::JSONB,"データ準備操作の構成オプション。  :ref:`**vector-native capabilities** <Pipelines model primitives>` と同じAPIを使用します。"
  invoker_role,TEXT,NULL,テーブル、パイプライン、およびバックグラウンドジョブ実行を所有するロール。

``aidb.create_preparer_for_volume`` 非推奨
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

同じ引数を使用した** :ref:`aidb.create_volume_preparer <aidb.create_volume_preparer>` に置き換えられます。

promoteb.bulk_data_preparation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

指定されたプリペアラーのソースからすべてのデータに対して、構成されたデータ準備オペレーションを実行します。

.. _パラメーター-2:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Description
  :widths: 12,15,25
  :align: left
  :class: longtable

  preparer_name,TEXT,作成者の名前

promoteb.set_auto_preparer
^^^^^^^^^^^^^^^^^^^^^^^^^^

このプリペアラーの自動処理モードを設定します。このファンクションは、自動データ準備を有効または無効にするために使用されます。\ ``Live``
モードはPostgresトリガーベースのオートメーションを有効にし、\ ``Disabled``
はすべてのオートメーションを無効にします。

.. _パラメーター-3:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Default,Description
  :widths: 15,12,12,20
  :align: left
  :class: longtable

  preparer_name,TEXT,"",作成者の名前
  mode,:ref:`helpb.PipelineAutoProcessingモード<helpb.PipelineAutoProcessingモード>` ,"",目的の処理モード

例
^^

.. code:: sql

   SELECT aidb.set_auto_preparer(test_preparer, Live);
   SELECT aidb.set_auto_preparer(test_preparer, Disabled);

``aidb.set_preparer_auto_processing`` 非推奨
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

同じ引数を使用した** :ref:`aidb.set_auto_preparer <aidb.set_auto_preparer>` に置き換えられます。

promoteb.delete_preparer
^^^^^^^^^^^^^^^^^^^^^^^^

プリペアラーの構成を削除します。

.. _パラメーター-4:

パラメーター
^^^^^^^^^^^^

.. csv-table::
  :header: Parameter,Type,Description
  :widths: 12,15,25
  :align: left
  :class: longtable

  preparer_name,TEXT,削除する準備者の名前

..  Note::
   This  function doesn't delete the destination table or any data in it.
