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

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Body

application/json

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

OK

*/*

DTO returned when create or update parameter/configuration

messagestringOptional

Represents the operation status, which can be OK or NOK

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

post

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/parameters HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Endpoint to get parameters from environment

get

Path parameters

orgUUIDstringRequired

It is the id that represents an organization

envUUIDstringRequired

It is the id that represents an environment

Query parameters

parameterstringOptional

Parameter key to search only for this

Header parameters

x-request-idstringOptional

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

Responses

200

Ok

*/*

DTO with reserved key parameters, extensions and list of other parameters (environment or bot)

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/v2/parameters HTTP/1.1
Accept: */*

{
  "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,
    "genaiCell": true,
    "rephrase": true,
    "multilanguage": {
      "enabled": true,
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "kai": {
      "enabled": true,
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  },
  "list": [
    {
      "uuid": "text",
      "key": "text",
      "value": "text",
      "description": "text",
      "enabled": true
    }
  ],
  "parameter": {
    "uuid": "text",
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": true
  }
}

Deprecated

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

get

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Query parameters

parameterstringOptional

It is the parameter's name to find

Responses

200

OK

*/*

DTO returning list of parameters

messagestringOptional

Represents the operation status, which can be OK or NOK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/parameters HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "text",
      "enabled": true,
      "description": "text",
      "key": "text",
      "value": "text",
      "extension": true
    }
  ],
  "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"
}

Updates an existing parameter/configuration for a specific bot. Those take precedence over environment configurations.

put

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

parameterIdstringRequired

Represents the id of configuration

Body

application/json

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

OK

*/*

DTO returned when create or update parameter/configuration

messagestringOptional

Represents the operation status, which can be OK or NOK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Parameter with that id and botUUID doesn't exist

*/*

408

Request Timeout

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

put

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Delete a parameter/configuration

delete

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

parameterIdstringRequired

Represents the id of configuration

Responses

200

OK

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Configuration is not erasable

*/*

404

Parameter with that id doesn't exist

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

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

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/parameters/{parameterId} HTTP/1.1
Accept: */*

No content

Return a specific configuration 'cockpit-version'

get

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses

200

OK

*/*

DTO with version and message

messagestringOptional

Represents the operation status, which can be OK or NOK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Configuration not found

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/parameters/version HTTP/1.1
Accept: */*

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

Deprecated

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

get

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses

200

OK

*/*

hasLicensebooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/parameters/automated-learning HTTP/1.1
Accept: */*

{
  "hasLicense": true
}

Bot Parameters

Create a new parameter/configuration

post

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

Body

application/json

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

OK

*/*

DTO returned when create or update parameter/configuration

messagestringOptional

Represents the operation status, which can be OK or NOK

201

Created

*/*

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

post

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Endpoint to reserved bot parameters

post

Path parameters

orgUUIDstringRequired

A valid organization uuid

envUUIDstringRequired

A valid environment uuid

botUUIDstringRequired

A valid bot uuid

Header parameters

x-request-idstringOptional

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

Body

application/json

DTO with type and value to the slides.

typestringRequired

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

valueinteger · int32Required

The slide value.

Responses

204

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/update-reserved HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "type": "text",
  "value": 1
}

No content

Endpoint to get parameters from bot

get

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

parameterstringOptional

Parameter key to search only for this

Header parameters

x-request-idstringOptional

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

Responses

200

Ok

*/*

DTO with reserved key parameters, extensions and list of other parameters (environment or bot)

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/v2/parameters HTTP/1.1
Accept: */*

{
  "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,
    "genaiCell": true,
    "rephrase": true,
    "multilanguage": {
      "enabled": true,
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    },
    "kai": {
      "enabled": true,
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  },
  "list": [
    {
      "uuid": "text",
      "key": "text",
      "value": "text",
      "description": "text",
      "enabled": true
    }
  ],
  "parameter": {
    "uuid": "text",
    "key": "text",
    "value": "text",
    "description": "text",
    "enabled": true
  }
}

Deprecated

Return specific or a list of parameters globals of the bot

get

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

botUUIDstringRequired

Represents the id of bot

Query parameters

parameterstringOptional

It is the parameter's name to find

Responses

200

OK

*/*

DTO returning list of parameters

messagestringOptional

Represents the operation status, which can be OK or NOK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": "text",
      "enabled": true,
      "description": "text",
      "key": "text",
      "value": "text",
      "extension": true
    }
  ],
  "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"
}

Update a parameter/configuration

put

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

application/json

DTO to request create or update parameter/configuration with key, value, description and enabled

keystringRequired

Parameter's key

valuestringRequired

Parameter's value

descriptionstringRequired

Parameter's description

enabledbooleanOptional

Flag that indicates if the parameter is enabled

Responses

200

OK

*/*

DTO returned when create or update parameter/configuration

messagestringOptional

Represents the operation status, which can be OK or NOK

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Parameter with that id and botUUID doesn't exist

*/*

409

Conflict

*/*

420

This key is already being used

*/*

422

Unprocessable Entity

*/*

500

Bot not exists

*/*

put

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "key": "text",
  "value": "text",
  "description": "text",
  "enabled": true
}

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

Delete a parameter/configuration

delete

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

200

OK

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Configuration is not erasable

*/*

404

Parameter with that id doesn't exist

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

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

HTTPcURLJavaScriptPython

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/parameters/{parameterId} HTTP/1.1
Accept: */*

No content

Environment Extensions

Return if the environment has the license to use genai extensions

get

Path parameters

orgUUIDstringRequired

Represents the id of organization

envUUIDstringRequired

Represents the id of environment

Responses

200

OK

*/*

hasLicensebooleanOptional

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/extensions/genai-enabled HTTP/1.1
Accept: */*

{
  "hasLicense": true
}

Bot Extensions

Enable or disable genai extensions

post

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-idstringOptional

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

Body

application/json

DTO to enable or disable an extension in a bot.

valuebooleanRequired

Parameter's value

configurationValuestringOptional

Responses

204

No Content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Bot's key validation error

*/*

post

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

HTTPcURLJavaScriptPython

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions/update-status/{extension} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "value": true,
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "configurationValue": "text"
}

No content

Endpoint to return if all extensions is enabled or disabled

get

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

200

Ok

*/*

DTO if the extensions is enabled or not

improveAnswersbooleanOptional

If improve answer is enabled or not

generateExamplesbooleanOptional

If generate examples is enabled or not

automatedLearningbooleanOptionalDeprecated

If automated learning is enabled or not. Now it is to get value from 'kai'

genaiCellbooleanOptional

If genai cell is enabled or not

rephrasebooleanOptional

If rephrase is enabled or not

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/extensions HTTP/1.1
Accept: */*

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