Skip to content

Commit c5360b9

Browse files
iakinseynidhibhammar
authored andcommitted
AIDB semantic knowledge base documentation
1 parent b7946fa commit c5360b9

File tree

6 files changed

+1107
-0
lines changed

6 files changed

+1107
-0
lines changed

product_docs/docs/edb-postgres-ai/preview/ai-factory/pipeline/index.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ navigation:
1313
- installing
1414
- "#Core concepts"
1515
- knowledge_base
16+
- semantic_knowledge_base
1617
- preparers
1718
- capabilities
1819
- models
@@ -92,6 +93,22 @@ Supports:
9293

9394
See [Knowledge Base Concepts](knowledge_base/).
9495

96+
### Semantic Knowledge Bases
97+
98+
Semantic Knowledge Bases provide a vector-searchable representation of your database schema:
99+
100+
- Create a semantic KB (`aidb.create_semantic_kb()`) to index schema metadata
101+
- Search for tables, views, and columns using natural language
102+
- Create semantic aliases for reusable, parameterized SQL queries
103+
104+
Use cases:
105+
106+
- Text-to-SQL context retrieval for AI agents
107+
- Schema discovery and exploration
108+
- Building centralized query libraries
109+
110+
See [Semantic Knowledge Base](semantic_knowledge_base/).
111+
95112
### Auto-Processing
96113

97114
Pipelines supports flexible auto-processing modes:
@@ -132,6 +149,7 @@ Use Pipelines when you need to:
132149
## Learn More
133150

134151
- [Knowledge Base Concepts](knowledge_base/)
152+
- [Semantic Knowledge Base](semantic_knowledge_base/)
135153
- [Preparer Concepts](preparers/)
136154
- [Auto-Processing](capabilities/auto-processing/)
137155
- [Supported Embedding Models](models/supported-models/)

product_docs/docs/edb-postgres-ai/preview/ai-factory/pipeline/reference/index.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ navigation:
88
- models
99
- preparers
1010
- knowledge_bases
11+
- semantic_knowledge_bases
1112
---
1213

1314
## Models
@@ -72,6 +73,41 @@ navigation:
7273
* [aidb.create_volume](knowledge_bases#aidbcreate_volume)
7374
* [aidb.delete_volume](knowledge_bases#aidbdelete_volume)
7475

76+
## Semantic knowledge bases
77+
78+
### Semantic knowledge base functions
79+
80+
* [aidb.create_semantic_kb](semantic_knowledge_bases#aidbcreate_semantic_kb)
81+
* [aidb.delete_semantic_kb](semantic_knowledge_bases#aidbdelete_semantic_kb)
82+
* [aidb.refresh_semantic_kb](semantic_knowledge_bases#aidbrefresh_semantic_kb)
83+
* [aidb.update_semantic_kb_auto_processing](semantic_knowledge_bases#aidbupdate_semantic_kb_auto_processing)
84+
* [aidb.semantic_kb_stats](semantic_knowledge_bases#aidbsemantic_kb_stats)
85+
* [aidb.list_semantic_kbs](semantic_knowledge_bases#aidblist_semantic_kbs)
86+
87+
### Semantic knowledge base search functions
88+
89+
* [aidb.get_metadata](semantic_knowledge_bases#aidbget_metadata)
90+
* [aidb.get_column_definitions](semantic_knowledge_bases#aidbget_column_definitions)
91+
* [aidb.get_entity_definitions](semantic_knowledge_bases#aidbget_entity_definitions)
92+
* [aidb.search_by_comment](semantic_knowledge_bases#aidbsearch_by_comment)
93+
94+
### Semantic alias functions
95+
96+
* [aidb.create_semantic_alias](semantic_knowledge_bases#aidbcreate_semantic_alias)
97+
* [aidb.alias_param](semantic_knowledge_bases#aidbalias_param)
98+
* [aidb.alias_params](semantic_knowledge_bases#aidbalias_params)
99+
* [aidb.execute_semantic_alias](semantic_knowledge_bases#aidbexecute_semantic_alias)
100+
* [aidb.search_semantic_aliases](semantic_knowledge_bases#aidbsearch_semantic_aliases)
101+
* [aidb.get_semantic_aliases](semantic_knowledge_bases#aidbget_semantic_aliases)
102+
* [aidb.get_semantic_alias](semantic_knowledge_bases#aidbget_semantic_alias)
103+
* [aidb.delete_semantic_alias](semantic_knowledge_bases#aidbdelete_semantic_alias)
104+
105+
### Vector index helper functions
106+
107+
* [aidb.vector_index_hnsw_config](semantic_knowledge_bases#aidbvector_index_hnsw_config)
108+
* [aidb.vector_index_ivfflat_config](semantic_knowledge_bases#aidbvector_index_ivfflat_config)
109+
* [aidb.vector_index_disabled_config](semantic_knowledge_bases#aidbvector_index_disabled_config)
110+
75111
## PGFS
76112

77113
### PGFS functions

0 commit comments

Comments
 (0)