mirror of
https://github.com/MindWorkAI/AI-Studio.git
synced 2026-08-15 16:42:11 +00:00
Added documentation for user-provided API keys of all provider kinds
This commit is contained in:
parent
15af56b090
commit
58087cdd12
@ -149,6 +149,11 @@ CONFIG["TRANSCRIPTION_PROVIDERS"] = {}
|
||||
-- -- Optional: Encrypted API key (see LLM_PROVIDERS example for details)
|
||||
-- -- ["APIKey"] = "ENC:v1:<base64-encoded encrypted data>",
|
||||
--
|
||||
-- -- Optional: let each user set their own API key for this otherwise locked transcription
|
||||
-- -- provider (see LLM_PROVIDERS example for details). Mutually exclusive with "APIKey"
|
||||
-- -- above: when both are set, the embedded key is ignored and a warning is logged.
|
||||
-- -- ["AllowUserProvidedAPIKey"] = true,
|
||||
--
|
||||
-- ["Model"] = {
|
||||
-- ["Id"] = "<the model ID>",
|
||||
-- ["DisplayName"] = "<user-friendly name of the model>",
|
||||
@ -171,6 +176,11 @@ CONFIG["EMBEDDING_PROVIDERS"] = {}
|
||||
-- -- Optional: Encrypted API key (see LLM_PROVIDERS example for details)
|
||||
-- -- ["APIKey"] = "ENC:v1:<base64-encoded encrypted data>",
|
||||
--
|
||||
-- -- Optional: let each user set their own API key for this otherwise locked embedding
|
||||
-- -- provider (see LLM_PROVIDERS example for details). Mutually exclusive with "APIKey"
|
||||
-- -- above: when both are set, the embedded key is ignored and a warning is logged.
|
||||
-- -- ["AllowUserProvidedAPIKey"] = true,
|
||||
--
|
||||
-- ["Model"] = {
|
||||
-- ["Id"] = "<the model ID, e.g., nomic-embed-text>",
|
||||
-- ["DisplayName"] = "<user-friendly name of the model>",
|
||||
|
||||
@ -8,7 +8,6 @@
|
||||
- Added a delete button for assistants, configurations, and language plugins you installed or placed yourself. Until now, such a plugin could only be removed from the data directory by hand, which was especially painful for configurations because they have no on/off switch. Before deleting a configuration, AI Studio lists what disappears with it, such as providers, data sources, and settings that return to their default. When you delete the language plugin you had chosen, AI Studio returns to choosing your language automatically. Plugins shipped with AI Studio and plugins deployed by your IT department cannot be deleted.
|
||||
- Added options for organizations to disable importing, sharing, and exporting plugins, with a separate option for configuration plugins. Organizations can now let people import assistants while keeping configurations to their IT department.
|
||||
- Added a priority for configuration plugins. Organizations that deploy several configurations can now decide which one wins: a configuration with a higher priority overrides the settings and providers of a lower one. This allows a company-wide base configuration that each department refines for itself.
|
||||
- Added providers for which you bring your own API key. Until now, a provider your organization configured had to come with a shared API key, which meant your IT department needed one key for everybody. Such a provider can now be handed out without a key, so that everyone signs in with their own, for example, a personal OpenAI or Anthropic account. The provider stays managed by your organization: the host, the model, the instance name, and everything else remain fixed, and the only thing you can edit is the API key. In the settings, these providers carry a key icon instead of the usual lock, so you can see at a glance where you have to add your key. Your key is stored on your device in the operating system's credential store, and it stays there even when your organization withdraws the provider later, so it is still in place should the same provider return. For IT departments: the new `AllowUserProvidedAPIKey` option on a provider does this.
|
||||
- Added the Batch Processing Assistant: process all documents of a folder in one run. Each document is sent to the AI along with your instructions – either a free prompt, one of your document analysis policies, or instructions you import from a file. You choose whether each answer is stored as its own Markdown file or whether all answers are collected in one CSV results table, which you can name yourself. Every run writes a log that lists each document with its processing time, the model, the status, and the reason for any error. When you start another run on the same output folder, we ask whether you want to continue it: documents that failed or are missing from the log are processed again, which is helpful after a crash or when documents exceeded the context window of your model. A single failing document never stops the run, and you can cancel at any time. The assistant was contributed by Jens Erler (`j-erler`) and marks his first contribution to AI Studio. Thank you, Jens, for this wonderful and useful contribution.
|
||||
- Added a way for IT departments to try out a configuration before rolling it out. A configuration placed in the new `.config-tests` directory below the plugins directory acts like one your organization deployed, including the approval of assistant plugins, so a test shows exactly what colleagues will see later. No configuration server is needed for this. AI Studio empties that directory every time it starts, so a test configuration is valid for one session, and the information page reports it while it is active. The Enterprise IT documentation describes the whole procedure.
|
||||
- Added CSV and TSV files to the file types you can attach. AI Studio was already able to read them, but they could not be selected.
|
||||
|
||||
@ -1 +1,3 @@
|
||||
# v26.8.2, build 252 (2026-08-xx xx:xx UTC)
|
||||
- Added providers for which you bring your own API key. Until now, a provider your organization configured had to come with a shared API key, which meant your IT department needed one key for everybody. Such a provider can now be handed out without a key, so that everyone signs in with their own, for example, a personal OpenAI or Anthropic account. This works for chat, embedding, and transcription providers alike. The provider stays managed by your organization: the host, the model, the instance name, and everything else remain fixed, and the only thing you can edit is the API key. In the settings, these providers carry a key icon instead of the usual lock, so you can see at a glance where you have to add your key; for embedding providers, the test button stays available, so you can check your key right after entering it. Your key is stored on your device in the operating system's credential store, and it stays there even when your organization withdraws the provider later, so it is still in place should the same provider return. For IT departments: the new `AllowUserProvidedAPIKey` option does this, and it works for `LLM_PROVIDERS`, `EMBEDDING_PROVIDERS`, and `TRANSCRIPTION_PROVIDERS` alike.
|
||||
- Fixed a removed API key staying in the operating system's credential store. When you cleared the API key of a provider, the previous key remained stored and was still used. It is now removed together with your change.
|
||||
@ -566,6 +566,39 @@ and users still cannot change the host, model, instance name, or any other field
|
||||
page shows a key icon instead of the usual lock icon for this provider; opening it only offers the
|
||||
API key field, with everything else disabled.
|
||||
|
||||
The flag works the same way for embedding and transcription providers:
|
||||
|
||||
```lua
|
||||
CONFIG["EMBEDDING_PROVIDERS"][#CONFIG["EMBEDDING_PROVIDERS"]+1] = {
|
||||
["Id"] = "3f0a4e8c-1d6b-4a91-8f2e-7c5d9b0a4e13",
|
||||
["Name"] = "Corporate Embeddings",
|
||||
["UsedLLMProvider"] = "OPEN_AI",
|
||||
["Host"] = "NONE",
|
||||
["Hostname"] = "",
|
||||
["AllowUserProvidedAPIKey"] = true,
|
||||
["Model"] = {
|
||||
["Id"] = "text-embedding-3-large",
|
||||
["DisplayName"] = "Text Embedding 3 Large",
|
||||
}
|
||||
}
|
||||
|
||||
CONFIG["TRANSCRIPTION_PROVIDERS"][#CONFIG["TRANSCRIPTION_PROVIDERS"]+1] = {
|
||||
["Id"] = "b1c7d24f-5e83-4a06-9d1b-2f8e6a3c7d50",
|
||||
["Name"] = "Corporate Transcription",
|
||||
["UsedLLMProvider"] = "OPEN_AI",
|
||||
["Host"] = "NONE",
|
||||
["Hostname"] = "",
|
||||
["AllowUserProvidedAPIKey"] = true,
|
||||
["Model"] = {
|
||||
["Id"] = "whisper-1",
|
||||
["DisplayName"] = "Whisper",
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For embedding providers, the settings page keeps the test button available next to the key icon, so
|
||||
users can verify their own key right after entering it.
|
||||
|
||||
This is mutually exclusive with an embedded `APIKey` on the same provider: if both are present,
|
||||
AI Studio ignores the embedded key and logs a warning, because the whole point of the flag is that
|
||||
each user manages their own key. Combine the two across different providers if you need it -- one
|
||||
|
||||
Loading…
Reference in New Issue
Block a user