AIChatModelsConfig
typedef
The configuration of the AI Chat models feature.
ClassicEditor.create( {
ai: {
chat: {
models: {
defaultModelId: ...,
modelSelectorAlwaysVisible: ...,
displayedModels: ...
}
}
}
} )
.then( ... )
.catch( ... );
See all editor options.
Properties
-
defaultModelId : string | undefinedmodule:ai/aichat/model/aichatmodels~AIChatModelsConfig#defaultModelIdDecides which model is selected by default when the AI Chat is initialized or when user starts a new conversation.
-
displayedModels : string | Array<string> | undefinedmodule:ai/aichat/model/aichatmodels~AIChatModelsConfig#displayedModelsDecides which models are visible in the model selector dropdown. It can be a string or an array of strings.
- It is optional and if not provided, all models are supported.
- If configured, editor will try to match the passed models by their ID, name or provider. Order by which the models are matched
- is later reflected in the model selector dropdown.
-
modelSelectorAlwaysVisible : boolean | undefinedmodule:ai/aichat/model/aichatmodels~AIChatModelsConfig#modelSelectorAlwaysVisibleDecides whether the model selector dropdown is always visible. It is
trueby default, which means the selector will be always visible in the UI. Setting it tofalse, hides the model selector dropdown when:- Only one model is available.
- User has selected a model and send first message (which is the point when model cannot be changed).