All Classes and Interfaces
Class
Description
Abstract base class for detecting whether field values contain content similar to AI-generated text.
Deprecated, for removal: This API element is subject to removal in a future version.
No replacement.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
TextChunker instead.Abstract base class for context generators that use vector database operations to retrieve relevant records.
Abstract builder class for constructing
AbstractVectorDatabaseBasedContextGenerator instances.An AI-generated author persona profile that creates writing style descriptions by analyzing provided content samples
using Large Language Models (LLMs).
Represents an AI chat client configuration that provides settings for creating content with AI assistance.
Dynamic field implementation that enforces AI chat client requirements.
Permission class that controls access to AI chat functionality for content creation.
Represents a reusable prompt suggestion for AI chat interactions.
Interface for AI chat providers that can integrate with various Large Language Model (LLM) services.
Value generator that provides available model IDs for AI chat providers.
Represents a chat request to the AI with comprehensive configuration options for conversation management.
Main builder class for constructing AIChatRequest instances with comprehensive configuration options.
Initial builder stage for constructing AIChatRequest instances.
Site-level configuration settings for AI chat functionality in the CMS.
Permission class for controlling access to the AI Dashboard widgets.
Modification that tracks AI-generated content metadata specifically for
Draft objects.Value generator that provides available embedding model IDs for AI vector embedding providers.
AI specific
ObjectField data and behaviors.Modification that tracks AI-generated content metadata for content objects, maintaining information about which
fields contain AI-generated content and whether they still match the original AI responses.
Search result field that displays which fields contain AI-generated content for content objects.
Abstract base class for AI provider configuration options.
AI specific
Record data and behaviors.Rich text transformer that wraps AI-generated content in HTML
<ai> tags for tracking purposes.REST endpoint that provides information about fields containing AI-generated content for a given object.
AI specific
ObjectType data and behaviors.Interface for providing vector embedding capabilities to the AI module.
Modification that tracks AI-generated content metadata specifically for
WorkInProgress objects.Prompt template for generating AI-powered answers based on questions and contextual information.
Builder class for constructing AnswerPrompt instances with fluent API.
Configuration and management for AI-powered search and content retrieval functionality.
Dynamic field implementation that makes the Ask AI client field required when Ask AI functionality is enabled in site
settings.
Main page for the Ask AI functionality that handles conversational AI interactions.
Permission class for controlling access to "Ask AI" functionality within the CMS.
Abstract configuration for defining content types eligible for AI vectorization.
A
NumbersSeries that represents the number of Ask AI actions taken, using the name format of "{siteId}.ask"
for site-specific data and ".ask" for global data.Asynchronous background task that processes items from a queue and writes them to a vector database.
Dashboard widget that displays audit information and metrics for AI chat requests.
Tool page that exports AI audit data as a downloadable CSV file.
Tool page that displays detailed audit metadata for a specific AI chat request.
Represents an author persona that models an author's unique writing style, voice, and preferences for use with
AI-generated content.
Abstract base class for author persona profiles that define and store writing style characteristics for use in
AI-assisted content generation.
Site-level configuration settings for author personas.
User-level configuration settings for author personas.
A database record that tracks the progress and results of bulk vector indexing operations.
Enumeration representing the possible states of a bulk vector indexing operation.
A background task that performs bulk vectorization of content items for use with AI features.
Debug servlet that provides a web interface for initiating bulk vectorization operations.
Represents a chat conversation containing a series of messages between a user and an AI assistant.
Web page for displaying and interacting with AI chat conversations.
Represents a record that associates chat conversations with specific users and CMS records.
Handles AI chat responses and interactions for the chat interface.
Extends
Chat records with author persona information for context-aware AI conversations.Tool page head component that injects AI chat resources and permission data into CMS pages.
Deprecated, for removal: This API element is subject to removal in a future version.
No replacement.
Search modification that adds AI content filtering capabilities to CMS searches.
Search extension that provides AI content filtering capabilities for content searches.
Search result field that displays whether content contains AI-generated content.
Deprecated, for removal: This API element is subject to removal in a future version.
No replacement.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
TextEmbeddingGenerator and TextChunker instead.Core interface for generating contextual records to support AI conversation responses.
Represents an AI-powered conversational search session that uses vector search and RAG (Retrieval-Augmented
Generation) to provide contextually relevant answers to user questions.
A modification of
Response that provides additional data structures for conversation responses in the context
of AI-powered search and retrieval augmented generation (RAG).Metadata container for conversation response data that tracks search configuration settings and performance metrics
during AI conversation processing.
A
NumbersSeries that represents the number of Create with AI actions taken, using the name format of
"{siteId}.create" for site-specific data and ".create" for global data.Default implementation of Ask AI types setting that provides opt-in content type selection.
Default implementation of context generation using direct vector database queries.
Builder class for creating
DefaultContextGenerator instances.Default implementation of
AbstractGeneratedContentDetector that uses the Jaro-Winkler string similarity
algorithm to determine if content is AI-generated.Deprecated.
Deprecated, for removal: This API element is subject to removal in a future version.
No replacement.
An annotation to determine whether to exclude the target field when generating an embedding.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
ExcludeFromEmbedding instead.Deprecated, for removal: This API element is subject to removal in a future version.
Use
AIFieldData instead.Represents types of AI features; in other words, denotes in which feature the
AIChatRequest was made.REST endpoint that marks a specific AI response as being actively used in a CMS field.
Prompt template for generating AI answers with numbered footnote-style context references.
Builder class for constructing FootnoteAnswerPrompt instances with fluent API.
Tracks the execution status and results of
GenerateAuthorPersonaTask operations.Handlebars template prompt for generating an AI author persona profile from writing samples.
Builder class for constructing GenerateAuthorPersonaPrompt instances.
Handlebars template prompt for generating sample writing based on an author persona profile.
Builder class for constructing GenerateAuthorPersonaSamplePrompt instances.
Enumeration of possible states for author persona generation tasks.
Asynchronous task that generates AI author persona profiles by analyzing reference content samples.
An annotation to determine whether to generate an embedding for an instance of the target type.
Abstract base class for implementing content guardrails in AI chat systems.
Interface for implementing guardrail assessment logic that evaluates AI chat content for safety and compliance.
Abstract base class representing the result of a guardrail assessment.
Enumeration of possible guardrail violation types that can be detected during content assessment.
Site-level configuration for guardrail functionality in AI chat systems.
Abstract base class for prompt templates that use Handlebars templating engine.
Metadata container for Large Language Model (LLM) response information.
A manually created author persona profile where users directly provide writing style descriptions.
A response text formatter that converts AI responses from Markdown to HTML.
Abstract base class representing a message within a chat conversation.
Enumeration of message user types in a chat conversation.
A response text formatter that applies no formatting to AI responses.
AI provider option that allows for one-off, embedded AI chat provider configuration.
CMS tool page that displays a preview of writing samples generated for an author persona.
Represents a user-generated prompt message in a chat conversation.
Web page that provides prompt suggestions for AI chat interactions.
Interface for AI prompt templates that can generate prompt strings for various AI operations.
An advanced context generator that analyzes user questions to determine if additional context is needed from vector
search before generating responses.
Builder class for constructing
QuestionAwareContextGenerator instances.Prompt template for generating context-aware responses with structured output formatting.
Builder class for constructing QuestionAwareContextGeneratorPrompt instances.
CMS tool page that refreshes the display of an author persona to show the latest generation results.
CMS tool page that triggers regeneration of AI author persona profiles.
A
NumbersSeries that calculates the remaining AI actions from both Ask AI and Create with AI based on
allocated actions in UsageCapSettings.Represents an AI-generated response message in a chat conversation.
Modification that adds usage tracking metadata to AI chat responses.
Abstract base class for formatting AI response text for display.
Tool page that retrieves and returns the full text of an AI chat prompt suggestion.
AI provider option that references a shared AI chat provider configuration.
A static prompt implementation that uses Handlebars templates without dynamic data binding.
Prompt template for generating contextual summaries based on questions and content.
Builder class for constructing SummarizePrompt instances with fluent API.
Represents a system-generated message in a chat conversation.
A text chunker.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
TextChunker instead.Functional interface for token count estimation.
A text embedding generator.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
FixedSizeTextChunker instead.Site settings for usage caps related to AI features.
Dashboard widget that displays AI usage statistics, including line and bar charts for Create with AI and Ask AI
actions over a specified period.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
AIRecordData instead.Deprecated, for removal: This API element is subject to removal in a future version.
No replacement.