Skip to content

Documentation Gaps

When to Use

Use this guide when the official documentation doesn't match actual behavior.

Gaps identified by comparing official docs to actual code through 1.4.2. New in 1.4.0-rc1: ChatProcessor plugin system, global guardrails, and AiExceptionEvent are not yet in official docs. New in 1.4.2: ai_file entity, ai.file_manager service, AiFileProviderInterface, ChatWithPdf capability, restrict_to_topic guardrail, and StreamableGuardrailInterface are not yet in official docs.

Each gap below names where this guide set covers it, or marks it as still undocumented anywhere.

Core Module

  • ProviderProxy wrapping pattern undocumented — covered in Core Architecture
  • Guardrails system has no developer guide — covered in Guardrails System
  • Short-term memory plugin system undocumented — covered in Short-Term Memory
  • AiDataTypeConverter plugin system undocumented — still undocumented
  • Prompt config entity system (ai.ai_prompt) minimally documented — covered in Prompt System
  • ai.text_chunker service not in developer guide — still undocumented
  • ChatProcessor plugin type (1.4) — covered in Core Architecture and AI Chatbot
  • AiExceptionEvent (1.4) — covered in Events System
  • Global guardrails in ai.settings (1.4) — covered in Guardrails System
  • ai_file content entity, ai.file_manager service (1.4.2) — covered in Core Architecture and Operation Types
  • AiFileProviderInterface (1.4.2) — covered in Provider System
  • ChatWithPdf capability (1.4.2) — covered in Enums & DTOs
  • StreamableGuardrailInterface and restrict_to_topic guardrail (1.4.2) — covered in Guardrails System

ai_assistant_api

  • use_function_calling mode (tool calls vs JSON-in-prompt) not documented — covered in AI Assistant API
  • AgentRunner path (assistant delegates to ai_agents) not documented — covered in AI Assistant API and AI Agents
  • setVerboseMode(), setThrowException() undocumented — covered in AI Assistant API
  • Specific error message overrides on entity undocumented — covered in AI Assistant API
  • AiAssistantPassContextToAgentEvent not in docs — covered in AI Assistant API

ai_chatbot

  • Full POST payload schema for /api/deepchat not documented — covered in AI Chatbot
  • should_continue protocol for tool-call round-trips not documented — covered in AI Chatbot
  • verbose_mode, show_copy_icon, show_structured_results block settings undocumented — covered in AI Chatbot
  • CSRF token acquisition flow incomplete in docs — covered in AI Chatbot
  • hook_deepchat_prepend_message not documented — covered in AI Chatbot

ai_automators

  • AutomatorsTool entity and function-calling integration undocumented — covered in AI Automators
  • All 4 events (AutomatorConfigEvent, ProcessFieldEvent, ValuesChangeEvent, RuleIsAllowedEvent) undocumented — covered in AI Automators
  • ViewsExtractor plugin undocumented — listed in AI Automators
  • Full 52-plugin inventory not listed — covered in AI Automators
  • $settings['ai_automator_advanced_mode_enabled'] undocumented — covered in AI Automators

ai_ckeditor

  • module_dependencies silencing mechanism undocumented — covered in AI CKEditor
  • ReformatHtml, ModifyPrompt, Help plugins undocumented — listed in AI CKEditor
  • AiAutomatorsCKEditor cross-module plugin undocumented — covered in AI CKEditor
  • Global ai_ckeditor.settings prompts config undocumented — covered in AI CKEditor
  • include_raw_embedding_vector feature undocumented — covered in AI Search
  • AiVdbProviderSearchApiInterface requirements undocumented — covered in AI Search
  • search_api_ai_get_chunks_result query option undocumented — covered in AI Search
  • Chunk preview tool in Fields form undocumented — still undocumented

ai_translate

  • Drush commands (ai:translate-entity, ai:translate-text) undocumented — covered in AI Translate
  • hook_ai_translate_translation_alter undocumented — covered in AI Translate
  • ChatTranslationProvider plugin undocumented — covered in AI Translate
  • Layout Builder translation integration undocumented — covered in AI Translate
  • Programmatic API not documented — covered in AI Translate

ai_observability

ai_validations

  • XTRUE/XFALSE protocol is the critical missing piece — covered in AI Validations
  • Image classification is deny-list (not allow-list) — not clarified — covered in AI Validations
  • FieldValidation module version requirement not prominent — covered in AI Validations

field_widget_actions

ai_eca

  • Docs describe a working module; actual code is a deprecated migration stub — see Deprecated Modules

ai_logging

  • prompt_logging_excluded_tags undocumented — covered in AI Logging
  • Deprecation notice missing from docs — the module is deprecated; use AI Observability

See Also

  • Reference: https://project.pages.drupalcode.org/ai/1.3.x/
  • Reference: https://git.drupalcode.org/project/ai