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

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/parameters' \
  --header 'Content-Type: application/json' \
  --data '{"key":"text","value":"text","description":"text"}'

200

201

400

401

403

404

409

420

422

500

200

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

OK

Endpoint to get parameters from environment

get

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

Path parameters

orgUUIDstringrequired

It is the id that represents an organization

envUUIDstringrequired

It is the id that represents an environment

Query parameters

parameterstring

Parameter key to search only for this

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/v2/parameters'

200

400

401

403

404

409

422

500

200

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

Ok

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

Deprecated

get

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Query parameters

parameterstring

It is the parameter's name to find

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/parameters'

200

400

401

403

404

409

422

500

200

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

OK

Update a parameter/configuration

put

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

parameterIdstringrequired

Represents the id of configuration

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}' \
  --header 'Content-Type: application/json' \
  --data '{"key":"text","value":"text","description":"text"}'

200

400

401

403

404

409

420

422

500

200

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

OK

Delete a parameter/configuration

delete

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

parameterIdstringrequired

Represents the id of configuration

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/{parameterId}'

200

400

401

403

404

409

422

500

200

No body

OK

Return a specific configuration 'cockpit-version'

get

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/version'

200

400

401

403

404

409

422

500

200

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

OK

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

Deprecated

get

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/parameters/automated-learning'

200

400

401

403

404

409

422

500

200

{
  "hasLicense": true
}

OK

Bot Parameters

Create a new parameter/configuration

post

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters' \
  --header 'Content-Type: application/json' \
  --data '{"key":"text","value":"text","description":"text"}'

200

201

400

401

403

404

409

420

422

500

200

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

OK

Endpoint to reserved bot parameters

post

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

Path parameters

orgUUIDstringrequired

A valid organization uuid

envUUIDstringrequired

A valid environment uuid

botUUIDstringrequired

A valid bot uuid

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

typestringrequired

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

valueinteger · int32required

The slide value.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/update-reserved' \
  --header 'Content-Type: application/json' \
  --data '{"type":"text","value":1}'

204

400

401

403

404

409

422

500

204

No body

No content

Endpoint to get parameters from bot

get

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

Path parameters

orgUUIDstringrequired

It is the id that represents an organization

envUUIDstringrequired

It is the id that represents an environment

botUUIDstringrequired

It is the id that represents a bot.

Query parameters

parameterstring

Parameter key to search only for this

Header parameters

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/v2/parameters'

200

400

401

403

404

409

422

500

200

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

Ok

Return specific or a list of parameters globals of the bot

Deprecated

get

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

Query parameters

parameterstring

It is the parameter's name to find

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters'

200

400

401

403

404

409

422

500

200

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

OK

Update a parameter/configuration

put

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

parameterIdstringrequired

Represents the id of configuration

Body

keystringrequired

Parameter's key

valuestringrequired

Parameter's value

descriptionstringrequired

Parameter's description

enabledboolean

Flag that indicates if the parameter is enabled

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}' \
  --header 'Content-Type: application/json' \
  --data '{"key":"text","value":"text","description":"text"}'

200

400

401

403

404

409

420

422

500

200

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

OK

Delete a parameter/configuration

delete

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

botUUIDstringrequired

Represents the id of bot

parameterIdstringrequired

Represents the id of configuration

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId}'

200

400

401

403

404

409

422

500

200

No body

OK

Environment Extensions

Return if the environment has the license to use genai extensions

get

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

Path parameters

orgUUIDstringrequired

Represents the id of organization

envUUIDstringrequired

Represents the id of environment

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/extensions/genai-enabled'

200

400

401

403

404

409

422

500

200

{
  "hasLicense": true
}

OK

Bot Extensions

Enable or disable genai extensions

post

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

Path parameters

orgUUIDstringrequired

A valid organization uuid

envUUIDstringrequired

A valid environment uuid

botUUIDstringrequired

A valid bot uuid

extensionstringrequired

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

x-request-idstring

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

valuebooleanrequired

Parameter's value

configurationValuestring

propertiesobject

Contains the properties of the extension

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions/update-status/{extension}' \
  --header 'Content-Type: application/json' \
  --data '{"value":true,"properties":{"ANY_ADDITIONAL_PROPERTY":{}}}'

204

400

401

403

404

409

422

500

204

No body

No Content

Endpoint to return if all extensions is enabled or disabled

get

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

Path parameters

orgUUIDstringrequired

It is the id that represents an organization

envUUIDstringrequired

It is the id that represents an environment

botUUIDstringrequired

It is the id that represents a bot.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions'

200

400

401

403

404

409

422

500

200

{
  "improveAnswers": true,
  "generateExamples": true,
  "automatedLearning": true,
  "genaiCell": true,
  "rephrase": true,
  "multilanguage": {
    "enabled": true,
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "kai": {
    "enabled": true,
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  }
}

Ok