Parameters

The Parameter API handles global parameters that either affects the current environment, or Bots individually. Bot parameters overrides environment parameters locally.

API SUBPATH: eva-parameter

Environment Parameters

Create a new parameter/configuration

POST/org/{orgUUID}/env/{envUUID}/parameters

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200201400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

200201400401403404409420422500

{
  "data": {
    "uuid": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Endpoint to get parameters from environment

GET/org/{orgUUID}/env/{envUUID}/v2/parameters

Path parameters

orgUUID*string

It is the id that represents an organization

envUUID*string

It is the id that represents an environment

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

parametersReservedParametersDTO (object)

DTO with reserved parameters cockpit version (only to environment), confidence min (only to bot) and timeouts (only to bots)

extensionsExtensionsDTO (object)

DTO if the extensions is enabled or not

listarray of ParameterDTO (object)

parameterParameterDTO (object)

Parameter with uuid, key, value, description and enabled of Configuration. This only will have value when search for specific key

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/v2/parameters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "parameters": {
    "cockpitVersion": "text",
    "confidenceMin": 0,
    "timeouts": {
      "genai": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "al": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "rephrasing": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "zeroShot": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "multilanguage": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      }
    },
    "maxTokens": {
      "zeroShot": {
        "min": 0,
        "value": 0,
        "max": 0
      }
    }
  },
  "extensions": {
    "improveAnswers": false,
    "generateExamples": false,
    "genaiCell": false,
    "rephrase": false,
    "multilanguage": {
      "enabled": false
    },
    "kai": {
      "enabled": false
    }
  },
  "list": [
    {
      "uuid": "text",
      "key": "text",
      "value": "text",
      "description": "text",
      "enabled": false
    }
  ],
  "parameter": {
    "uuid": "text",
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": false
  }
}

Return specific or a list of parameters globals or of the bot

GET/org/{orgUUID}/env/{envUUID}/parameters

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Query parameters

Response

200400401403404409422500

OK

Body

*/*

dataarray of ParameterListDataDTO (object)

List of parameter's DTO with id, enabled, description, key and value

extensionsParameterExtensionsResponseDTO (object)

Extensions configurations of the bot

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "data": [
    {
      "id": "text",
      "enabled": false,
      "description": "text",
      "key": "text",
      "value": "text",
      "extension": false
    }
  ],
  "extensions": {
    "timeouts": {
      "genai": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "al": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "rephrasing": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "zeroShot": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "multilanguage": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      }
    }
  },
  "message": "text"
}

Update a parameter/configuration

PUT/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

parameterId*string

Represents the id of configuration

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

200400401403404409420422500

{
  "data": {
    "uuid": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Delete a parameter/configuration

DELETE/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

parameterId*string

Represents the id of configuration

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Return a specific configuration 'cockpit-version'

GET/org/{orgUUID}/env/{envUUID}/parameters/version

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Response

200400401403404409422500

OK

Body

*/*

dataVersionDataDTO (object)

DTO with value of version

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters/version', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "data": {
    "value": "text"
  },
  "message": "text"
}

Return if the environment has the license to use automated learning. Deprecated method which will me removed past 4.5.0

GET/org/{orgUUID}/env/{envUUID}/parameters/automated-learning

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Response

200400401403404409422500

OK

Body

*/*

hasLicenseboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/parameters/automated-learning', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "hasLicense": false
}

Bot Parameters

Create a new parameter/configuration

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200201400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

200201400401403404409420422500

{
  "data": {
    "uuid": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Endpoint to reserved bot parameters

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/update-reserved

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

Header parameters

Body

application/json

type*string

The slide type, it can be CONFIDENCE_MIN, GENAI, AL OR REPHRASING.

value*integer (int32)

The slide value.

Response

204400401403404409422500

No content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/update-reserved', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "text",
      "value": 0
    }),
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Endpoint to get parameters from bot

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/v2/parameters

Path parameters

orgUUID*string

It is the id that represents an organization

envUUID*string

It is the id that represents an environment

botUUID*string

It is the id that represents a bot.

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

parametersReservedParametersDTO (object)

DTO with reserved parameters cockpit version (only to environment), confidence min (only to bot) and timeouts (only to bots)

extensionsExtensionsDTO (object)

DTO if the extensions is enabled or not

listarray of ParameterDTO (object)

parameterParameterDTO (object)

Parameter with uuid, key, value, description and enabled of Configuration. This only will have value when search for specific key

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/v2/parameters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "parameters": {
    "cockpitVersion": "text",
    "confidenceMin": 0,
    "timeouts": {
      "genai": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "al": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "rephrasing": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "zeroShot": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "multilanguage": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      }
    },
    "maxTokens": {
      "zeroShot": {
        "min": 0,
        "value": 0,
        "max": 0
      }
    }
  },
  "extensions": {
    "improveAnswers": false,
    "generateExamples": false,
    "genaiCell": false,
    "rephrase": false,
    "multilanguage": {
      "enabled": false
    },
    "kai": {
      "enabled": false
    }
  },
  "list": [
    {
      "uuid": "text",
      "key": "text",
      "value": "text",
      "description": "text",
      "enabled": false
    }
  ],
  "parameter": {
    "uuid": "text",
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": false
  }
}

Return specific or a list of parameters globals of the bot

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

Query parameters

Response

200400401403404409422500

OK

Body

*/*

dataarray of ParameterListDataDTO (object)

List of parameter's DTO with id, enabled, description, key and value

extensionsParameterExtensionsResponseDTO (object)

Extensions configurations of the bot

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "data": [
    {
      "id": "text",
      "enabled": false,
      "description": "text",
      "key": "text",
      "value": "text",
      "extension": false
    }
  ],
  "extensions": {
    "timeouts": {
      "genai": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "al": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "rephrasing": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "zeroShot": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      },
      "multilanguage": {
        "min": 0,
        "recommendation": 0,
        "value": 0,
        "max": 0
      }
    }
  },
  "message": "text"
}

Update a parameter/configuration

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

parameterId*string

Represents the id of configuration

Body

application/json

key*string

Parameter's key

value*string

Parameter's value

description*string

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Response

200400401403404409420422500

OK

Body

*/*

dataParameterDataDTO (object)

DTO with data of parameter/configuration after creating or updating id, enabled, description, key and value

messagestring

Represents the operation status, which can be OK or NOK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "description": "text",
      "key": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

200400401403404409420422500

{
  "data": {
    "uuid": "text",
    "enabled": false,
    "description": "text",
    "key": "text",
    "value": "text"
  },
  "message": "text"
}

Delete a parameter/configuration

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

botUUID*string

Represents the id of bot

parameterId*string

Represents the id of configuration

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Environment Extensions

Return if the environment has the license to use genai extensions

GET/org/{orgUUID}/env/{envUUID}/extensions/genai-enabled

Path parameters

orgUUID*string

Represents the id of organization

envUUID*string

Represents the id of environment

Response

200400401403404409422500

OK

Body

*/*

hasLicenseboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/extensions/genai-enabled', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "hasLicense": false
}

Bot Extensions

Enable or disable genai extensions

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions/update-status/{extension}

Path parameters

orgUUID*string

A valid organization uuid

envUUID*string

A valid environment uuid

botUUID*string

A valid bot uuid

extension*string

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

Header parameters

Body

application/json

value*boolean

Parameter's value

propertiesobject

Contains the properties of the extension

configurationValuestring

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions/update-status/{extension}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": false
    }),
});
const data = await response.json();

Response

400401403404409422500

{
  "timestamp": 0,
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Endpoint to return if all extensions is enabled or disabled

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions

Path parameters

orgUUID*string

It is the id that represents an organization

envUUID*string

It is the id that represents an environment

botUUID*string

It is the id that represents a bot.

Response

200400401403404409422500

Ok

Body

*/*

improveAnswersboolean

If improve answer is enabled or not

generateExamplesboolean

If generate examples is enabled or not

genaiCellboolean

If genai cell is enabled or not

rephraseboolean

If rephrase is enabled or not

multilanguageMultilanguageDTO (object)

A data transfer object (DTO) representing the multilanguage enabled/disabled status and properties.

kaiKAIDTO (object)

DTO with KAI enabled and properties

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "improveAnswers": false,
  "generateExamples": false,
  "genaiCell": false,
  "rephrase": false,
  "multilanguage": {
    "enabled": false
  },
  "kai": {
    "enabled": false
  }
}