Parameters
The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.
Last updated
The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.
Last updated
Represents the id of organization
Represents the id of environment
Represents the id of bot
Represents the id of configuration
OK
Represents the id of organization
Represents the id of environment
OK
Represents the id of organization
Represents the id of environment
Represents the id of configuration
OK
Represents the id of organization
Represents the id of environment
OK
A valid organization uuid
A valid environment uuid
A valid bot uuid
The slide type, it can be CONFIDENCE_MIN, GENAI, AL OR REPHRASING.
The slide value.
No content
Represents the id of organization
Represents the id of environment
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value
Represents the operation status, which can be OK or NOK
Represents the id of organization
Represents the id of environment
OK
DTO with value of version
Represents the operation status, which can be OK or NOK
A valid organization uuid
A valid environment uuid
A valid bot uuid
It is the key extension to toggle. Possible values are: al.enabled, genai.cell.enabled, utterance.completetions.enabled, genai.enhancements.enabled and genai.rephrasing.enabled
Parameter's value
Contains the properties of the extension
No Content
Represents the id of organization
Represents the id of environment
Represents the id of configuration
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value
Represents the operation status, which can be OK or NOK
Represents the id of organization
Represents the id of environment
Represents the id of bot
OK
List of parameter's DTO with id, enabled, description, key and value
Extensions configurations of the bot
Represents the operation status, which can be OK or NOK
Represents the id of organization
Represents the id of environment
Represents the id of bot
Represents the id of configuration
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value
Represents the operation status, which can be OK or NOK
It is the id that represents an organization
It is the id that represents an environment
It is the id that represents a bot.
Ok
If improve answer is enabled or not
If generate examples is enabled or not
If genai cell is enabled or not
If rephrase is enabled or not
A data transfer object (DTO) representing the multilanguage enabled/disabled status and properties.
DTO with KAI enabled and properties
Represents the id of organization
Represents the id of environment
Represents the id of bot
Parameter's key
Parameter's value
Parameter's description
Flag that indicates if the parameter is enabled
OK
DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value
Represents the operation status, which can be OK or NOK
Represents the id of organization
Represents the id of environment
OK
List of parameter's DTO with id, enabled, description, key and value
Extensions configurations of the bot
Represents the operation status, which can be OK or NOK
It is the id that represents an organization
It is the id that represents an environment
It is the id that represents a bot.
Ok
DTO with reserved parameters cockpit version (only to environment), confidence min (only to bot) and timeouts (only to bots)
DTO if the extensions is enabled or not
Parameter with uuid, key, value, description and enabled of Configuration. This only will have value when search for specific key
It is the id that represents an organization
It is the id that represents an environment
Ok
DTO with reserved parameters cockpit version (only to environment), confidence min (only to bot) and timeouts (only to bots)
DTO if the extensions is enabled or not
Parameter with uuid, key, value, description and enabled of Configuration. This only will have value when search for specific key