Reference#
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.
Page |
What it covers |
Related guide |
|---|---|---|
Catalog views, model CRUD (create_model, get_model, delete_model), HCP model functions, inference functions (encode_text, generate_text, rerank_text), and all model config helpers |
||
Knowledge base views and stats, retrieval functions (retrieve_key, retrieve_text), volume functions, and auto-processing |
||
Pipeline error log functions (get_error_logs, clear_error_logs, requeue_pipeline_errors) |
||
Standalone SQL functions: chunk_text, parse_html, parse_pdf, perform_ocr, summarize_text |
||
Pipeline types, views, CRUD functions, step config helpers, and vector index config helpers |
||
Agent CRUD, conversation functions, structured output helpers, and catalog views |
||
Tool catalog view, SQL tool registration, MCP server management, and parameter helpers |
- Models reference
- Configuration model
- Catalog views
- Model management functions
- HCP model functions
- Inference functions
- Inference configuration helper
- Model config helpers
- aidb.embeddings_config
- Example
- aidb.completions_config
- Example
- aidb.max_tokens_config
- Example
- aidb.bert_config
- Example
- aidb.clip_config
- Example
- aidb.llama_config
- Example
- aidb.t5_config
- Example
- aidb.gemini_config
- Example
- aidb.nim_clip_config
- Example
- aidb.nim_ocr_config
- Example
- aidb.nim_reranking_config
- Example
- aidb.openrouter_chat_config
- Example
- aidb.openrouter_embeddings_config
- Example
- aidb.openai_responses_config
- Examples
- aidb.anthropic_messages_config
- Examples
- Knowledge bases reference
- Operations reference
- Functions reference
- Pipelines reference
- Agents reference
- Tools reference