Pipelines retrievers (deprecated) reference

Pipelines retrievers (deprecated) reference#

重要

The use of the term "retrievers" has been deprecated in version 4.0 and later. It is replaced by the term "knowledge base" and users should consult the Pipelines knowledge bases reference reference content. For backwards compatibility, the retrievers API is still available, but it is recommended to use the knowledge base API for new implementations. This section is covers the deprecated functions only. For the new API, see Pipelines knowledge bases reference .

helpb.RetrieverSourceDataFormat#

もう利用できません。代わりに aidb.PipelineDataFormat を使用してください。

ファンクション#

aidb.create_retriever_for_table 非推奨#

置き換えられました aidb.create_table_knowledge_base

指定されたテーブルのリトリーバーを作成します。

パラメーター#

Parameter

Type

Default

Description

name

TEXT

Required

レトリーバーの名前

model_name

TEXT

Required

使用するモデルの名前

source_table

regclass

Required

ソースとして使用するテーブルの名前

source_data_column

TEXT

Required

使用するソーステーブルの列名

source_data_type

helpb.PipelineDataFormat

Required

その列のデータの種類"Text"."Image","PDF"

source_key_column

TEXT

'id'

行を参照するためのキーとして使用する列

vector_table

TEXT

NULL

NA

vector_data_column

TEXT

'embeddings'

NA

vector_key_column

TEXT

'id'

NA

topk

INTEGER

1

NA

distance_operator

helpb.DistanceOperator

'L2'

NA

options

JSONB

'{}'::JSONB

オプション

index_type

TEXT

'vector'

ベクトルテーブルに使用するインデックスのタイプ。

distance_operator

index_type

L2

vector_l2_ops

InnerProduct

vector_ip_ops

Cosine

vector_cosine_ops

L1

vector_l1_ops

  • index_type がivfflat に設定されている場合、システムはベクターテーブルに IVFFlat インデックスを作成します。

  • index_type がdisabled に設定されている場合、インデックスは作成されません。

SELECT aidb.create_retriever_for_table(
               name => test_retriever,
               model_name => simple_model,
               source_table => test_source_table,
               source_data_column => content,
               source_data_type => Text,
       );

aidb.create_retriever_for_volume 非推奨#

置き換えられました aidb.create_volume_knowledge_base

指定されたPGFSボリュームのリトリーバーを作成します。

パラメーター#

Parameter

Type

Default

Description

name

TEXT

Required

レトリーバーの名前

model_name

TEXT

Required

モデルの名前

source_volume_name

TEXT

Required

ボリュームの名前

vector_table

TEXT

NULL

ベクタテーブルの名前

vector_data_column

TEXT

'embeddings'

ベクター列の名前

vector_key_column

TEXT

'id'

キーカラムの名前

topk

INTEGER

1

返される結果の数

distance_operator

aidb.distanceoperator

'L2'

距離演算子

options

JSONB

'{}'::JSONB

オプション

index_type

TEXT

'vector'

ベクトルテーブルに使用するインデックスのタイプ。

distance_operator

index_type

L2

vector_l2_ops

InnerProduct

vector_ip_ops

Cosine

vector_cosine_ops

L1

vector_l1_ops

  • index_type がivfflat に設定されている場合、システムはベクターテーブルに IVFFlat インデックスを作成します。

  • index_type がdisabled に設定されている場合、インデックスは作成されません。

SELECT aidb.create_retriever_for_volume(
               name => demo_vol_retriever,
               model_name => simple_model,
               source_volume_name => demo_bucket_vol
       );

aidb.set_retriever_auto_processing 非推奨#

置き換えられました aidb.set_auto_knowledge_base

このナレッジベースの自動処理モードを設定します。

パラメーター#

Parameter

Type

Default

Description

retriever_name

TEXT

自動埋め込みを有効にするレトリバーの名前

mode

aidb.PipelineAutoProcessingMode

目的の自動処理モード

例#

SELECT aidb.set_retriever_auto_processing(test_retriever, Live);
SELECT aidb.set_retriever_auto_processing(test_retriever, Disabled);

aidb.delete_retriever 非推奨#

置き換えられました :ref:``aidb.delete_knowledge_base` <aidb.delete_knowledge_base>`

レトリーバーの構成のみをデータベースから削除します。

パラメーター#

Parameter

Type

Default

Description

retriever_name

TEXT

削除するレトリバーの名前

例#

select aidb.delete_retriever(test_retriever);
__OUTPUT__
 delete_retriever
- -----------------

(1 row)
目次