Skip to content

Commit 207bd1a

Browse files
authored
Fixes #1086 - Add AI provider toggle to provider configuration
1 parent e21a3d9 commit 207bd1a

3 files changed

Lines changed: 57 additions & 56 deletions

File tree

ai/provider.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@ Provider
22
========
33

44
Zammad offers AI-powered features to support your agents!
5-
To use AI features in Zammad, you have to configure an AI provider which handles
6-
the requests first. Add your provider in Zammad's admin settings under
7-
*AI > Provider*. To access this page, the ``admin.ai_provider`` permission is
8-
required.
5+
To use AI features in Zammad, you must first configure and enable an AI
6+
provider. Such an AI provider processes all your AI requests and is required for
7+
any AI functionality. Add your provider in Zammad's admin settings
8+
under *AI > Provider* and make sure to activate the toggle. This setting
9+
requires ``admin.ai_provider`` permission to access it.
910

1011
.. note:: Zammad's AI feature is completely optional and requires a
1112
configuration before any AI request is made. However, if you don't want to

images/ai/ai-provider.png

953 Bytes
Loading

locale/admin-docs.pot

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: Zammad Admin Documentation pre-release\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2026-03-13 12:59+0100\n"
11+
"POT-Creation-Date: 2026-03-17 10:13+0100\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -134,19 +134,19 @@ msgid "This AI agent is capable of rephrasing the ticket title based on the cont
134134
msgstr ""
135135

136136
#: ../ai/provider.rst:2
137-
#: ../ai/provider.rst:39
137+
#: ../ai/provider.rst:40
138138
msgid "Provider"
139139
msgstr ""
140140

141141
#: ../ai/provider.rst:4
142-
msgid "Zammad offers AI-powered features to support your agents! To use AI features in Zammad, you have to configure an AI provider which handles the requests first. Add your provider in Zammad's admin settings under *AI > Provider*. To access this page, the ``admin.ai_provider`` permission is required."
142+
msgid "Zammad offers AI-powered features to support your agents! To use AI features in Zammad, you must first configure and enable an AI provider. Such an AI provider processes all your AI requests and is required for any AI functionality. Add your provider in Zammad's admin settings under *AI > Provider* and make sure to activate the toggle. This setting requires ``admin.ai_provider`` permission to access it."
143143
msgstr ""
144144

145-
#: ../ai/provider.rst:10
145+
#: ../ai/provider.rst:11
146146
msgid "Zammad's AI feature is completely optional and requires a configuration before any AI request is made. However, if you don't want to see the settings at all, read about :docs:`how to hide it in the system docs </admin/console/other-useful-commands.html#remove-ai-feature>`."
147147
msgstr ""
148148

149-
#: ../ai/provider.rst:16
149+
#: ../ai/provider.rst:17
150150
#: ../channels/email/settings.rst:2
151151
#: ../channels/form.rst:28
152152
#: ../channels/email/settings.rst:2
@@ -163,187 +163,187 @@ msgstr ""
163163
msgid "Screenshot shows configuration of AI provider in Zammad"
164164
msgstr ""
165165

166-
#: ../ai/provider.rst:23
166+
#: ../ai/provider.rst:24
167167
msgid "You can choose from different supported providers:"
168168
msgstr ""
169169

170-
#: ../ai/provider.rst:25
171-
#: ../ai/provider.rst:87
170+
#: ../ai/provider.rst:26
171+
#: ../ai/provider.rst:88
172172
msgid "Zammad AI"
173173
msgstr ""
174174

175-
#: ../ai/provider.rst:26
175+
#: ../ai/provider.rst:27
176176
msgid "OpenAI"
177177
msgstr ""
178178

179-
#: ../ai/provider.rst:27
180-
#: ../ai/provider.rst:117
179+
#: ../ai/provider.rst:28
180+
#: ../ai/provider.rst:118
181181
msgid "Ollama"
182182
msgstr ""
183183

184-
#: ../ai/provider.rst:28
184+
#: ../ai/provider.rst:29
185185
msgid "Anthropic"
186186
msgstr ""
187187

188-
#: ../ai/provider.rst:29
188+
#: ../ai/provider.rst:30
189189
msgid "Azure AI"
190190
msgstr ""
191191

192-
#: ../ai/provider.rst:30
192+
#: ../ai/provider.rst:31
193193
msgid "Mistral AI"
194194
msgstr ""
195195

196-
#: ../ai/provider.rst:31
196+
#: ../ai/provider.rst:32
197197
msgid "Custom (OpenAI Compatible)"
198198
msgstr ""
199199

200-
#: ../ai/provider.rst:33
200+
#: ../ai/provider.rst:34
201201
msgid "Depending on which provider you choose, Zammad displays different fields you can configure."
202202
msgstr ""
203203

204-
#: ../ai/provider.rst:36
204+
#: ../ai/provider.rst:37
205205
msgid "The AI service you have subscribed to is not available? This is just the first step. We are going to add more providers soon! If you want to support us or need the provider as soon as possible, just let our `sales department <https://zammad.com/en/company/contact>`_ know!"
206206
msgstr ""
207207

208-
#: ../ai/provider.rst:44
208+
#: ../ai/provider.rst:45
209209
msgid "Token"
210210
msgstr ""
211211

212-
#: ../ai/provider.rst:42
212+
#: ../ai/provider.rst:43
213213
msgid "Add your API token which you got from your provider here. Don't confuse it with the tokens a large language model (LLM) is dealing with when processing a request."
214214
msgstr ""
215215

216-
#: ../ai/provider.rst:48
216+
#: ../ai/provider.rst:49
217217
#: ../manage/knowledge-base.rst:151
218218
#: ../system/integrations/elasticsearch.rst:57
219219
msgid "URL"
220220
msgstr ""
221221

222-
#: ../ai/provider.rst:47
222+
#: ../ai/provider.rst:48
223223
msgid "Provide the URL or IP address of your provider. This is required for Ollama and OpenAI compatible providers."
224224
msgstr ""
225225

226-
#: ../ai/provider.rst:52
226+
#: ../ai/provider.rst:53
227227
msgid "URL (Completions)"
228228
msgstr ""
229229

230-
#: ../ai/provider.rst:51
230+
#: ../ai/provider.rst:52
231231
msgid "Only for Azure AI as provider. Add the endpoint where your text generation model is available."
232232
msgstr ""
233233

234-
#: ../ai/provider.rst:57
234+
#: ../ai/provider.rst:58
235235
msgid "Model"
236236
msgstr ""
237237

238-
#: ../ai/provider.rst:55
238+
#: ../ai/provider.rst:56
239239
msgid "Enter the exact name of the model here. This model has to be available on your provider's side. Leave it empty (if not mandatory) to use the default which is shown as a placeholder."
240240
msgstr ""
241241

242-
#: ../ai/provider.rst:65
242+
#: ../ai/provider.rst:66
243243
msgid "Recognize Image Text (OCR)"
244244
msgstr ""
245245

246-
#: ../ai/provider.rst:60
246+
#: ../ai/provider.rst:61
247247
msgid "Zammad allows you to use optical character recognition (OCR) to extract text from images. This can be useful if you often get error messages or other important information, which is only present in images."
248248
msgstr ""
249249

250-
#: ../ai/provider.rst:64
250+
#: ../ai/provider.rst:65
251251
msgid "Simply switch the toggle on or off. Be aware that using this feature can cause a high consumption of tokens."
252252
msgstr ""
253253

254-
#: ../ai/provider.rst:72
254+
#: ../ai/provider.rst:73
255255
msgid "OCR Model"
256256
msgstr ""
257257

258-
#: ../ai/provider.rst:68
258+
#: ../ai/provider.rst:69
259259
msgid "Specify a model to use for the OCR feature. Leave it empty to use the default model of your provider."
260260
msgstr ""
261261

262-
#: ../ai/provider.rst:71
262+
#: ../ai/provider.rst:72
263263
msgid "Note: the field is called **URL (OCR)** for Azure AI and expects a URL where the OCR model is available instead of a model itself."
264264
msgstr ""
265265

266-
#: ../ai/provider.rst:74
266+
#: ../ai/provider.rst:75
267267
msgid "After providing the information, make sure to click the ``Save`` button and activate AI features."
268268
msgstr ""
269269

270-
#: ../ai/provider.rst:78
270+
#: ../ai/provider.rst:79
271271
msgid "Excursion"
272272
msgstr ""
273273

274-
#: ../ai/provider.rst:80
274+
#: ../ai/provider.rst:81
275275
msgid "In case you want to know more about Zammad AI or Ollama, read on here. Otherwise, head over to :ref:`feedback-logs` or check out the AI-powered features and how to use them."
276276
msgstr ""
277277

278-
#: ../ai/provider.rst:89
278+
#: ../ai/provider.rst:90
279279
msgid "Using Zammad AI as a provider is the easiest way you can get started with Zammad's AI features. It has some big advantages like:"
280280
msgstr ""
281281

282-
#: ../ai/provider.rst:92
282+
#: ../ai/provider.rst:93
283283
msgid "You don't have to take care of the setup of an AI system and its configuration."
284284
msgstr ""
285285

286-
#: ../ai/provider.rst:94
286+
#: ../ai/provider.rst:95
287287
msgid "Hosted in the EU and compliant with GDPR."
288288
msgstr ""
289289

290-
#: ../ai/provider.rst:95
290+
#: ../ai/provider.rst:96
291291
msgid "No configuration in Zammad needed (for SaaS customers) or only an API key required (for self-hosted customers)."
292292
msgstr ""
293293

294-
#: ../ai/provider.rst:97
294+
#: ../ai/provider.rst:98
295295
msgid "Your requests with sensitive information aren't used for training."
296296
msgstr ""
297297

298-
#: ../ai/provider.rst:98
298+
#: ../ai/provider.rst:99
299299
msgid "If something isn't working as expected, you just have one place where you get support."
300300
msgstr ""
301301

302-
#: ../ai/provider.rst:108
302+
#: ../ai/provider.rst:109
303303
msgid "SaaS Customers"
304304
msgstr ""
305305

306-
#: ../ai/provider.rst:102
306+
#: ../ai/provider.rst:103
307307
msgid "Using Zammad AI requires a \"V2\" plan. Check your :doc:`subscription settings </system/subscription>` and consider to switch your plan. If a \"V2\" plan is active, you can buy AI calls for AI processing. After doing so, Zammad AI is automatically configured as AI provider and you can activate and configure AI features as you like. Check your remaining AI calls from time to time or activate the notification to be alerted when few calls remain."
308308
msgstr ""
309309

310-
#: ../ai/provider.rst:114
310+
#: ../ai/provider.rst:115
311311
msgid "Self-Hosted Customers"
312312
msgstr ""
313313

314-
#: ../ai/provider.rst:111
314+
#: ../ai/provider.rst:112
315315
msgid "Please `get in touch with our sales department <https://zammad.com/en/company/contact>`_ to obtain a Zammad AI API key and to buy AI calls. After receiving your API key, simply add and save it. Then you are ready to activate and configure AI features as you like."
316316
msgstr ""
317317

318-
#: ../ai/provider.rst:119
318+
#: ../ai/provider.rst:120
319319
msgid "`Ollama <https://ollama.com/>`_ is an AI tool that allows you to set up your own AI server on a machine you control. That means your data is not transferred to a third party. Be aware that this only makes sense if you have a powerful GPU in your system!"
320320
msgstr ""
321321

322-
#: ../ai/provider.rst:124
322+
#: ../ai/provider.rst:125
323323
msgid "If you don't have an Ollama running already, their `documentation <https://docs.ollama.com/>`_ is a good starting point. You can find the available models in `Ollama's model library <https://ollama.com/library>`_ and useful information and additional links in the `Ollama Github repository <https://github.com/ollama/ollama>`_."
324324
msgstr ""
325325

326-
#: ../ai/provider.rst:134
326+
#: ../ai/provider.rst:135
327327
msgid "Feedback & Logs"
328328
msgstr ""
329329

330-
#: ../ai/provider.rst:136
330+
#: ../ai/provider.rst:137
331331
msgid "At the top of the settings page, you can switch to the **Feedback & Logs** tab."
332332
msgstr ""
333333

334334
#: ../ai/provider.rst:None
335335
msgid "Screenshot shows AI provider settings with activated \"Feedback & Logs\" tab"
336336
msgstr ""
337337

338-
#: ../ai/provider.rst:144
338+
#: ../ai/provider.rst:145
339339
msgid "Downloads"
340340
msgstr ""
341341

342-
#: ../ai/provider.rst:146
342+
#: ../ai/provider.rst:147
343343
msgid "Your agents can provide feedback like thumbs up or down and leave a comment in case they gave thumbs down. You can download this feedback as well as error logs. Both downloads provide an Excel file (.xlsx) with the requested information."
344344
msgstr ""
345345

346-
#: ../ai/provider.rst:152
346+
#: ../ai/provider.rst:153
347347
#: ../system/integrations/checkmk/admin-panel-reference.rst:35
348348
#: ../system/integrations/cti/includes/recent-logs.include.rst:2
349349
#: ../system/integrations/cti/includes/recent-logs.include.rst:2
@@ -354,7 +354,7 @@ msgstr ""
354354
msgid "Recent Logs"
355355
msgstr ""
356356

357-
#: ../ai/provider.rst:154
357+
#: ../ai/provider.rst:155
358358
msgid "Zammad shows the last requests and responses in the UI as well. So in case something isn't working, have a look there. When you open an entry, you can find the request as well as the response from your AI provider."
359359
msgstr ""
360360

0 commit comments

Comments
 (0)