Pipelines semantic knowledge bases reference Innovation Release

This reference documentation for Pipelines semantic knowledge bases includes information on the functions and views available in the aidb extension for semantic knowledge bases.

Views

aidb.list_semantic_kbs

Returns a list of all semantic knowledge bases.

Example

SELECT * FROM aidb.list_semantic_kbs();

Functions

aidb.create_semantic_kb

Creates a new semantic knowledge base that indexes database schema metadata.

Parameters

Example

SELECT aidb.create_semantic_kb(
    'my_kb',
    'my_embedding_model',
    ARRAY['public', 'sales'],
    'Background',
    FALSE,
    aidb.vector_index_hnsw_config(m => 16, ef_construction => 64)
);

aidb.delete_semantic_kb

Deletes a semantic knowledge base and its metadata.

Parameters

Example

SELECT aidb.delete_semantic_kb('my_kb');

aidb.refresh_semantic_kb

Re-crawls all monitored schemas and rebuilds the metadata index.

Parameters

Example

SELECT aidb.refresh_semantic_kb('my_kb');

aidb.update_semantic_kb_auto_processing

Changes the auto-processing mode for an existing semantic knowledge base.

Parameters

Example

SELECT aidb.update_semantic_kb_auto_processing('my_kb', 'Background');

aidb.semantic_kb_stats

Returns statistics about a semantic knowledge base.

Parameters

Returns

Example

SELECT * FROM aidb.semantic_kb_stats('my_kb');

Search functions

aidb.get_metadata

Searches all indexed entities (tables, views, columns) matching a query.

Parameters

Returns

Example

SELECT schema_name, relation_name, column_name, entity_type, definition, similarity
FROM aidb.get_metadata('my_kb', 'customer orders', 0.8, 10, 0);

aidb.get_column_definitions

Searches only column definitions.

Parameters

Returns

Example

SELECT * FROM aidb.get_column_definitions('my_kb', 'payment method', 0.8, 10, 0);

aidb.get_entity_definitions

Searches table and view definitions, filtered by entity type.

Parameters

Returns

Example

SELECT * FROM aidb.get_entity_definitions('my_kb', 'transaction history', 0.8, ARRAY['Table', 'View'], 10, 0);

aidb.search_by_comment

Searches based on table/column COMMENT values.

Parameters

Returns

Example

SELECT * FROM aidb.search_by_comment('my_kb', 'stores customer preferences', 0.7, 10, 0);

Semantic alias functions

aidb.create_semantic_alias

Creates a parameterized SQL query with a semantic description.

Parameters

Example

SELECT aidb.create_semantic_alias(
    'get_customer_orders',
    'Retrieve all orders for a specific customer',
    'SELECT * FROM orders WHERE customer_id = ${customer_id}',
    aidb.alias_params(
        aidb.alias_param('customer_id', 'integer', 'The customer ID')
    ),
    'my_embedding_model'
);

aidb.alias_param

Defines a single parameter for a semantic alias.

Parameters

Example

aidb.alias_param('status', 'text', 'Order status filter', ARRAY['pending', 'shipped', 'delivered'])

aidb.alias_params

Combines multiple alias parameters.

Parameters

Example

aidb.alias_params(
    aidb.alias_param('customer_id', 'integer', 'Customer identifier'),
    aidb.alias_param('limit', 'integer', 'Maximum results to return')
)

aidb.execute_semantic_alias

Executes a semantic alias with provided parameters.

Parameters

Example

SELECT * FROM aidb.execute_semantic_alias(
    'get_customer_orders',
    '{"customer_id": 123}'::jsonb
);

-- With role-based execution
SELECT * FROM aidb.execute_semantic_alias(
    'get_customer_orders',
    '{"customer_id": 123}'::jsonb,
    'analytics_role'
);

aidb.search_semantic_aliases

Searches aliases by semantic similarity.

Parameters

Returns

Example

SELECT * FROM aidb.search_semantic_aliases('my_embedding_model', 'customer purchase history', 0.7, 10, 0);

aidb.get_semantic_aliases

Lists all semantic aliases.

Example

SELECT * FROM aidb.get_semantic_aliases();

aidb.get_semantic_alias

Gets details for a specific semantic alias.

Parameters

Example

SELECT * FROM aidb.get_semantic_alias('get_customer_orders');

aidb.delete_semantic_alias

Deletes a semantic alias.

Parameters

Example

SELECT aidb.delete_semantic_alias('get_customer_orders');

Vector index helper functions

aidb.vector_index_hnsw_config

Configures an HNSW index for the semantic knowledge base.

Parameters

Example

aidb.vector_index_hnsw_config(m => 16, ef_construction => 64)

aidb.vector_index_ivfflat_config

Configures an IVFFlat index for the semantic knowledge base.

Parameters

Example

aidb.vector_index_ivfflat_config(lists => 100)

aidb.vector_index_disabled_config

Disables vector indexing for the semantic knowledge base.

Example

aidb.vector_index_disabled_config()