update-ai-model

Updates an existing AI model configuration.

update-ai-model
[-b value | --bootstrap-config=value]
[-t value | --tool-password=value]
<--id=value>
[--name=value]
[--model=value]
[--api=value]
[--mode=value]
[--api-base=value]
[--auth-type=value]
[--api-key=value]
[--prompt-api-key]
[--priority=value]
[--enable]
[--disable]
{-Gvalue}
{-gvalue}
{-Uvalue}
{-rvalue}
[--auth-header-mode=value]
[--auth-header=value]
[--path-override=value]
{-Hkey=value}
{-hvalue}
<-u value | --user=value>

Overview

Use this command to modify an existing AI model configuration. Only the arguments that are explicitly provided are changed; omitted arguments leave the corresponding fields unchanged.

Options


Option	Optional or Required	Default Value	Description
`-b value --bootstrap-config=value`	Optional	none	The path to the bootstrap configuration file. See Bootstrap.xml file for more information about this file.
`-t value --tool-password=value`	Optional	none	The configuration tool password used to decrypt the database password in the file bootstrap.xml. If the tool password is omitted, the command prompts the user for it in the console. See Bootstrap.xml file.
`--id=value`	Required	none	The UUID of the AI model to update.
`--name=value`	Optional	none	The new display name of the AI model.
`--model=value`	Optional	none	The new model identifier string. For example, `gpt-4o` or `claude-3-5-sonnet`.
`--api=value`	Optional	none	The new API type for the model. The valid values are `AzureOpenAi`, `AzureAnthropic`, `AzureMistral`, `Anthropic`, `Gemini`, `Mistral`, `OpenAi`, `AwsBedrock`, and `Ollama`.
`--mode=value`	Optional	`Completion`	The new model interaction mode. The valid value is `Completion`.
`--api-base=value`	Optional	none	The new base URL of the AI provider endpoint.
`--auth-type=value`	Optional	none	The new authentication type used to call the AI provider. The valid values are `ApiKey` and `None`. Use `None` for providers that do not require authentication, for example local Ollama instances. Switching to `None` clears the stored API key and authorization header settings.
`--api-key=value`	Optional	none	The new API key used for autentication. Mutually exclusive with `--prompt-api-key`. Must not be specified when `auth-type=None`.
`--prompt-api-key`	Optional	none	When specified, prompts interactively for the new API key. Mutually exclusive with `--api-key`. Must not be specified when `auth-type` is `None`.
`--priority=value`	Optional	none	The new priority of this model relative to others in this scope. Lower values indicate higher priority.
`--enable`	Optional	none	When specified, clears the disabled flag so the model is active again.
`--disable`	Optional	none	When specified, sets the disabled flag so the model is inactive. Disabled models are excluded from user-facing listings and proxying. The priority is left unchanged.
`-Gvalue`	Optional	none	The name of a group to add to the allowed-groups list. Can be specified multiple times with different values.
`-gvalue`	Optional	none	The name of a group to remove from the allowed-groups list. Can be specified multiple times with different values.
`-Uvalue`	Optional	none	The name of a user to add to the allowed-users list. Can be specified multiple times with different values.
`-rvalue`	Optional	none	The name of a user to remove from the allowed-users list. Can be specified multiple times with different values.
`--auth-header-mode=value`	Optional	none	Controls how the authorization header is constructed. The valid values are `Default` (use the convention defined by the API type), `AuthorizationBearer` (always send `Authorization: Bearer <apiKey>`) and `Custom` (send `<auth-header>: <apiKey>`).
`--auth-header=value`	Optional	none	The custom authorization header name to use when `--auth-header-mode=Custom`. The header value will be the raw API key.
`--path-override=value`	Optional	none	An optional path override for clients. When set, clients use this path instead of the default when constructing gateway requests.
`-Hkey=value`	Optional	none	A custom HTTP header to set on the model, specified as 'name=value'. If the header already exists, its value is replaced. Can be specified multiple times with different keys.
`-hvalue`	Optional	none	The name of a custom HTTP header to remove from the model. Can be specified multiple times with different values.
`-u value --user=value`	Required	none	The user performing the operation. This should be an administrator. Unless the user is part of the configured default domain, the name of the user must include the user's domain name. For example, DOMAIN\user or user@domain.