Generative Service

The Generative Service API handles all integration with LLMs and generative content.

API SUBPATH: eva-generative-service

Pagination and Listing

Searches and paginates through expected Generative Service

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Query parameters

Response

200400401403404409422500

Ok

Body

application/json

totalPagesinteger (int32)

totalElementsinteger (int64)

pageablePageableObject (object)

numberOfElementsinteger (int32)

sizeinteger (int32)

contentarray of GenerativeServiceFlowsDTO (object)

numberinteger (int32)

sortSortObject (object)

firstboolean

lastboolean

emptyboolean

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service?page=1&size=5', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "unpaged": false,
    "paged": false,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": false,
      "sorted": false,
      "empty": false
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "generativeService": {
        "uuid": "text",
        "name": "text",
        "description": "text",
        "prompt": "text",
        "model": "text",
        "temperature": 0,
        "maximumTokens": 0,
        "topP": 0,
        "presencePenalty": 0,
        "frequencyPenalty": 0,
        "responseVariableName": "text",
        "usesBlacklist": false,
        "blacklistWords": "text",
        "removed": false,
        "createdAt": "2024-12-21T12:01:23.345Z",
        "updatedAt": "2024-12-21T12:01:23.345Z",
        "updatedBy": "text",
        "createdBy": "text"
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": false,
    "sorted": false,
    "empty": false
  },
  "first": false,
  "last": false,
  "empty": false
}

Searches (greedily) for any Generative Service names that exists in a bot, matching the typed term, left-to-right, and returns a list of Strings, ordered alphabetically.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/quicksearch

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot uuid to search

Query parameters

Response

200400401403404409422500

Ok

Body

application/json

itemsstring

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/quicksearch?searchTerm=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  "text"
]

Searches through all Generative Service recently used on a given bot to start a flow.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/list-on-flow

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entities you are searching

Response

200400401403404409422500

Ok

Body

application/json

uuidstring

The Generative Service's String uuid.

namestring

The Generative Service's name.

modelstring

The Generative Service's model.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/list-on-flow', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "uuid": "text",
    "name": "text",
    "model": "text"
  }
]

CRUD Operations

Creates a brand new Generative Service

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Body

application/json

name*string

Name of this Generative Service.

descriptionstring

An optional description of this Generative Service.

promptstring

Actual prompt to be executed during AI generation when executing this service.

modelstring

AI Model to be used in this Generative Service.

temperaturenumber (double)

AI's temperature value for execution of this Generative Service.

maximumTokensinteger (int32)

Maximum tokens to be used during a single execution of this Generative Service.

topPnumber (double)

AI's topP value for execution of this Generative Service.

presencePenaltynumber (double)

AI's presence penalty value for execution of this Generative Service.

frequencyPenaltynumber (double)

AI's frequency penalty value for execution of this Generative Service.

responseVariableNamestring

Name of the variable in $hiddenContext this service will store it's result.

usesBlacklistboolean

Wether this execution should blacklist specific words.

blacklistWordsstring

A blacklist of comma-separated terms to be excluded from this service's generation.

Response

200400401403404409422500

Ok

Body

application/json

generativeServiceGenerativeServiceDTO (object)

A Structure representing all data of a Generative Service.

flowsarray of FlowResponseDTO (object)

A list of Flows associated to this Generative Service

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "generativeService": {
    "uuid": "text",
    "name": "text",
    "description": "text",
    "prompt": "text",
    "model": "text",
    "temperature": 0,
    "maximumTokens": 0,
    "topP": 0,
    "presencePenalty": 0,
    "frequencyPenalty": 0,
    "responseVariableName": "text",
    "usesBlacklist": false,
    "blacklistWords": "text",
    "removed": false,
    "createdAt": "2024-12-21T12:01:23.345Z",
    "updatedAt": "2024-12-21T12:01:23.345Z",
    "updatedBy": "text",
    "createdBy": "text"
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Retrieves info from a specific given Generative Service.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

uuid*string

The generativeService's uuid

Response

200400401403404409422500

Ok

Body

application/json

generativeServiceGenerativeServiceDTO (object)

A Structure representing all data of a Generative Service.

flowsarray of FlowResponseDTO (object)

A list of Flows associated to this Generative Service

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "generativeService": {
    "uuid": "text",
    "name": "text",
    "description": "text",
    "prompt": "text",
    "model": "text",
    "temperature": 0,
    "maximumTokens": 0,
    "topP": 0,
    "presencePenalty": 0,
    "frequencyPenalty": 0,
    "responseVariableName": "text",
    "usesBlacklist": false,
    "blacklistWords": "text",
    "removed": false,
    "createdAt": "2024-12-21T12:01:23.345Z",
    "updatedAt": "2024-12-21T12:01:23.345Z",
    "updatedBy": "text",
    "createdBy": "text"
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Updates a Generative Service.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}

Path parameters

orgUUID*string

A valid uuid of an organization

envUUID*string

A valid uuid of an environment

botUUID*string

The UUID of the bot whose entity you are searching belong to

uuid*string

The generativeService's uuid

Body

application/json

name*string

Name of this Generative Service.

descriptionstring

An optional description of this Generative Service.

promptstring

Actual prompt to be executed during AI generation when executing this service.

modelstring

AI Model to be used in this Generative Service.

temperaturenumber (double)

AI's temperature value for execution of this Generative Service.

maximumTokensinteger (int32)

Maximum tokens to be used during a single execution of this Generative Service.

topPnumber (double)

AI's topP value for execution of this Generative Service.

presencePenaltynumber (double)

AI's presence penalty value for execution of this Generative Service.

frequencyPenaltynumber (double)

AI's frequency penalty value for execution of this Generative Service.

responseVariableNamestring

Name of the variable in $hiddenContext this service will store it's result.

usesBlacklistboolean

Wether this execution should blacklist specific words.

blacklistWordsstring

A blacklist of comma-separated terms to be excluded from this service's generation.

Response

200400401403404409422500

Ok

Body

application/json

generativeServiceGenerativeServiceDTO (object)

A Structure representing all data of a Generative Service.

flowsarray of FlowResponseDTO (object)

A list of Flows associated to this Generative Service

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "generativeService": {
    "uuid": "text",
    "name": "text",
    "description": "text",
    "prompt": "text",
    "model": "text",
    "temperature": 0,
    "maximumTokens": 0,
    "topP": 0,
    "presencePenalty": 0,
    "frequencyPenalty": 0,
    "responseVariableName": "text",
    "usesBlacklist": false,
    "blacklistWords": "text",
    "removed": false,
    "createdAt": "2024-12-21T12:01:23.345Z",
    "updatedAt": "2024-12-21T12:01:23.345Z",
    "updatedBy": "text",
    "createdBy": "text"
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Deletes a Generative Service. The Generative Service is disabled via the 'removed' parameter rather than deleted from the DB.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

uuid*string

The generativeService's uuid

Response

200400401403404409422500

Ok

Request

JavaScriptCurlPython

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

Response

400401403404409422500

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

Execution

The following section contains methods which are useable to test or simulate the cell's working.

Simulates a generative AI output.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/simulate

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Body

application/json

name*string

Name of this Generative Service.

descriptionstring

An optional description of this Generative Service.

promptstring

Actual prompt to be executed during AI generation when executing this service.

modelstring

AI Model to be used in this Generative Service.

temperaturenumber (double)

AI's temperature value for execution of this Generative Service.

maximumTokensinteger (int32)

Maximum tokens to be used during a single execution of this Generative Service.

topPnumber (double)

AI's topP value for execution of this Generative Service.

presencePenaltynumber (double)

AI's presence penalty value for execution of this Generative Service.

frequencyPenaltynumber (double)

AI's frequency penalty value for execution of this Generative Service.

responseVariableNamestring

Name of the variable in $hiddenContext this service will store it's result.

usesBlacklistboolean

Wether this execution should blacklist specific words.

blacklistWordsstring

A blacklist of comma-separated terms to be excluded from this service's generation.

Response

200400401403404409422500

Ok

Body

application/json

text*string

Text generated by prompt

usedTokens*integer (int32)

Consumed tokens for output

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "text": "text",
  "usedTokens": 0
}

Generates content for an answer, either enhancing previous texts or generating it on a whole.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/enhance

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Body

application/json

enhancementTypeenum

Discerns which task will be performed to enhance this task.

GENERATE_CONTENTIMPROVE_WRITINGSHORTENEXTENDFIX_GRAMMARTONE_CHANGE

inputTextstring

Either the context, if enhancementType is GENERATE_CONTENT, or the previously existing answer otherwise.

tonestring

Tone to be applied into the answer. Used only if enhancementType is 'TONE_CHANGE' or 'GENERATE_CONTENT'

languagestring

Language of this bot.

channelTypeinteger (int32)

It is the channel type from the answer

Response

200400401403404409422500

Ok

Body

application/json

answer*string

Answer generated by answer assist.

enhancementType*enum

Which Enhancement Type was used to generate this response.

GENERATE_CONTENTIMPROVE_WRITINGSHORTENEXTENDFIX_GRAMMARTONE_CHANGE

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "answer": "text",
  "enhancementType": "GENERATE_CONTENT"
}

Auxiliary Methods

Generates content for an answer, either enhancing previous texts or generating it on a whole.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/availability

Path parameters

orgUUID*string

A valid uuid of organization

envUUID*string

A valid uuid of environment

botUUID*string

A valid uuid of bot

Response

200400401403404409422500

Ok

Body

application/json

availableTonesarray of enum

Returns the currently available tone ENUM list.

enabledboolean

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

{
  "availableTones": [
    "ADVENTUROUS"
  ],
  "enabled": false
}