Skip to content

Commit a91997f

Browse files
committed
DOC-3356: Move limits and models in nav.adoc file.
1 parent 74e85f4 commit a91997f

File tree

3 files changed

+24
-11
lines changed

3 files changed

+24
-11
lines changed

modules/ROOT/nav.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -265,15 +265,14 @@
265265
**** xref:tinymceai-chat.adoc[Chat]
266266
**** xref:tinymceai-review-plugin.adoc[Review]
267267
**** xref:tinymceai-actions-plugin.adoc[Actions]
268+
**** xref:tinymceai-models.adoc[AI Models]
269+
**** xref:tinymceai-limits.adoc[Limits]
268270
**** xref:tinymceai-integration-options.adoc[Integration Options]
269271
***** xref:tinymceai.adoc[Plugin quick start]
270272
***** REST API
271273
****** xref:tinymceai-api-overview.adoc[API Overview]
272274
****** xref:tinymceai-api-quick-start.adoc[API quick start]
273-
****** Configuration
274-
******* xref:tinymceai-models.adoc[AI models]
275-
******* xref:tinymceai-limits.adoc[Limits]
276-
******* xref:tinymceai-streaming.adoc[Streaming]
275+
****** xref:tinymceai-streaming.adoc[Streaming]
277276
**** xref:tinymceai-jwt-authentication-intro.adoc[JWT Authentication]
278277
***** xref:tinymceai-permissions.adoc[Permissions]
279278
***** Guides

modules/ROOT/pages/tinymceai-limits.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ TinyMCE AI implements various limits to ensure fair usage, optimal performance,
1515
[[rate-limits]]
1616
== Rate Limits
1717

18-
Rate limits control the frequency of API requests to prevent abuse and ensure service stability. The service implements limits on API requests, token usage, web search, and web scraping requests per minute. All rate limits are applied at both organization level (higher limits) and individual user level (lower limits) to ensure fair usage.
18+
Rate limits control the frequency of requests to prevent abuse and ensure service stability. These limits apply to both plugin usage and direct API calls, as the plugin uses the API under the hood. The service implements limits on requests, token usage, web search, and web scraping requests per minute. All rate limits are applied at both organization level (higher limits) and individual user level (lower limits) to ensure fair usage.
1919

2020
NOTE: Specific rate limit values are subject to change and may vary based on the subscription tier. Contact support for current rate limit details for the environment.
2121

modules/ROOT/pages/tinymceai-models.adoc

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
:description_short: AI model configuration
66
:keywords: AI, models, configuration, tinymceai
77

8+
TinyMCE AI supports multiple AI models from different providers. Model selection and configuration can be done through the plugin UI or via the REST API. This page covers model capabilities, configuration options, and limitations that apply to both plugin and API usage.
9+
810
[[recommended-agent-models]]
911
== Recommended: Agent Models
1012

@@ -112,7 +114,13 @@ The agent model (`agent-1`) automatically selects the best underlying model base
112114
* **Required capabilities** – Web search and reasoning require compatible models
113115
* **Cost optimization** – Balances quality with cost efficiency
114116

115-
A model can also be specified directly in API requests for more control.
117+
[[model-configuration]]
118+
=== Model Configuration
119+
120+
Models can be configured in two ways:
121+
122+
* **Plugin Configuration** – Use `tinymceai_default_model`, `tinymceai_allow_model_selection`, and `tinymceai_allowed_models` options. See xref:tinymceai-chat.adoc#model-selection-configuration[Chat model configuration] for details.
123+
* **API Configuration** – Specify the model directly in API requests for more control. See xref:tinymceai-models.adoc#api-examples[API Examples] below.
116124

117125
[[model-compatibility-versions]]
118126
== Model Compatibility Versions
@@ -127,12 +135,15 @@ Compatibility versions allow TinyMCE AI to introduce new models and capabilities
127135
[[checking-compatibility]]
128136
=== Checking Compatibility
129137

130-
Check the `/v1/models` endpoint to see available models for the compatibility version. The API response includes model capabilities, limits, and availability.
138+
To see available models for your compatibility version:
139+
140+
* **Via API** – Check the `/v1/models` endpoint. The API response includes model capabilities, limits, and availability.
141+
* **Via Plugin** – Available models are shown in the model selection dropdown when `tinymceai_allow_model_selection` is enabled.
131142

132143
[[model-capabilities]]
133144
== Model Capabilities
134145

135-
Different models support different capabilities. Check the model information endpoint to see which capabilities are available for each model.
146+
Different models support different capabilities. Check the model information via the API endpoint or the plugin's model selection UI to see which capabilities are available for each model.
136147

137148
[[web-search]]
138149
=== Web Search
@@ -149,9 +160,9 @@ Enable step-by-step reasoning to see the AI's problem-solving process. Some mode
149160
* Reasoning is always active during inference.
150161
* Reasoning cannot be turned off via the API.
151162

152-
To determine if a model has always-on reasoning, check the API response when listing models. Models with mandatory reasoning will indicate this in their capability structure.
163+
To determine if a model has always-on reasoning, check the API response when listing models or refer to the model capabilities in the plugin UI. Models with mandatory reasoning will indicate this in their capability structure.
153164

154-
NOTE: Please observe, that model names such as `gpt-5`, `claude-4-sonnet`, etc. are examples. Actual available models depend on the service's compatibility version. Use the `/v1/models` endpoint to see current available models for the environment.
165+
NOTE: Please observe, that model names such as `gpt-5`, `claude-4-sonnet`, etc. are examples. Actual available models depend on the service's compatibility version. Use the `/v1/models` API endpoint or check the plugin's model selection dropdown to see current available models for your environment.
155166

156167
[[web-scraping]]
157168
=== Web Scraping
@@ -196,6 +207,8 @@ Models scheduled for removal will include a `removal` field with an ISO 8601 dat
196207
[[api-examples]]
197208
== API Examples
198209

210+
The following examples show how to configure models when using the REST API directly. For plugin configuration, see xref:tinymceai-chat.adoc#model-selection-configuration[Chat model configuration].
211+
199212
[[model-selection]]
200213
=== Model Selection
201214

@@ -293,6 +306,7 @@ For complete documentation on model endpoints, compatibility versions, and capab
293306
[[related-features]]
294307
== Related Features
295308

296-
* xref:tinymceai-chat.adoc[Chat] – Use models in interactive AI discussions.
309+
* xref:tinymceai-chat.adoc[Chat] – Use models in interactive AI discussions and configure model selection.
297310
* xref:tinymceai-review-plugin.adoc[Review] – Apply models to content analysis and improvement.
298311
* xref:tinymceai-actions-plugin.adoc[Quick Actions] – Use models for content transformation tasks.
312+
* xref:tinymceai.adoc[Plugin Reference] – Complete plugin configuration options including model settings.

0 commit comments

Comments
 (0)