Reference v7

Complete API reference for the AIDB extension: parameter tables, return types, and signatures for lookup. For usage context and worked examples, see the guide sections linked in the table below.

PageWhat it coversRelated guide
ModelsCatalog views, model CRUD (create_model, get_model, delete_model), HCP model functions, inference functions (encode_text, generate_text, rerank_text), and all model config helpersIntegrating models
Knowledge basesKnowledge base views and stats, retrieval functions (retrieve_key, retrieve_text), volume functions, and auto-processingKnowledge bases
Semantic knowledge basesCreating and managing a semantic KB, search functions, relationship functions, and comment curation functionsSemantic knowledge bases
OperationsPipeline error log functions (get_error_logs, clear_error_logs, requeue_pipeline_errors)Error log
FunctionsStandalone SQL functions: chunk_text, parse_html, parse_pdf, perform_ocr, summarize_textSQL functions
PipelinesPipeline types, views, CRUD functions, step config helpers, and vector index config helpersAI pipelines
AgentsAgent CRUD, conversation functions, structured output helpers, and catalog viewsAgents
ToolsTool catalog view, SQL tool registration, MCP server management, and parameter helpersTools
ObservabilityThe aidb_otel schema, storage format, retention/export functions, background workers, and traced attributesConfiguring AIDB parameters