Generative Service

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

API SUBPATH: eva-generative-service

Pagination and Listing

CRUD Operations

Execution

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

Auxiliary Methods

PreviousEntity NextIntent

Last updated 2 months ago

Was this helpful?

Searches and paginates through expected Generative Service

get

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

Path parameters

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

The UUID of the bot whose entities you are searching

Query parameters

searchTermstring

Term being searched. This expects one optional String matching the name of an generativeService.

pageinteger · int32 · default: 1required

Current page, starting at 1

Example: 1

sizeinteger · int32 · default: 5required

Size of the page

Example: 1

orderBystring · default: updatedAt

Criteria to order result, defaulted to updatedAt date. Possible fields include name, createdAt, updatedAt, createdBy and updatedBy.

directionstring · default: DESC

Order direction(ASC/DESC), defaulted to DESC

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service?page=1&size=5'

200

400

401

403

404

409

422

500

{
  "totalPages": 1,
  "totalElements": 1,
  "pageable": {
    "unpaged": true,
    "paged": true,
    "pageNumber": 1,
    "pageSize": 1,
    "offset": 1,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 1,
  "size": 1,
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true,
  "content": [
    {
      "generativeService": {
        "uuid": "text",
        "name": "text",
        "description": "text",
        "prompt": "text",
        "model": "text",
        "temperature": 1,
        "maximumTokens": 1,
        "topP": 1,
        "presencePenalty": 1,
        "frequencyPenalty": 1,
        "responseVariableName": "text",
        "usesBlacklist": true,
        "blacklistWords": "text",
        "removed": true,
        "createdAt": "2025-02-21T18:07:24.094Z",
        "updatedAt": "2025-02-21T18:07:24.094Z",
        "updatedBy": "text",
        "createdBy": "text"
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ]
}

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

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot uuid to search

Query parameters

searchTermstringrequired

Term being searched

limitinteger · int32 · default: 6

How many items will be returned in the list. Defaults to 6.

Example: 1

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/quicksearch?searchTerm=text'

200

400

401

403

404

409

422

500

[
  "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

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

The UUID of the bot whose entities you are searching

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/list-on-flow'

200

400

401

403

404

409

422

500

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

Creates a brand new Generative Service

post

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

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Body

namestringrequired

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.

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

400

401

403

404

409

422

500

{
  "generativeService": {
    "uuid": "text",
    "name": "text",
    "description": "text",
    "prompt": "text",
    "model": "text",
    "temperature": 1,
    "maximumTokens": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1,
    "responseVariableName": "text",
    "usesBlacklist": true,
    "blacklistWords": "text",
    "removed": true,
    "createdAt": "2025-02-21T18:07:24.094Z",
    "updatedAt": "2025-02-21T18:07:24.094Z",
    "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

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

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

uuidstringrequired

The generativeService's uuid

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}'

200

400

401

403

404

409

422

500

{
  "generativeService": {
    "uuid": "text",
    "name": "text",
    "description": "text",
    "prompt": "text",
    "model": "text",
    "temperature": 1,
    "maximumTokens": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1,
    "responseVariableName": "text",
    "usesBlacklist": true,
    "blacklistWords": "text",
    "removed": true,
    "createdAt": "2025-02-21T18:07:24.094Z",
    "updatedAt": "2025-02-21T18:07:24.094Z",
    "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

orgUUIDstringrequired

A valid uuid of an organization

envUUIDstringrequired

A valid uuid of an environment

botUUIDstringrequired

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

uuidstringrequired

The generativeService's uuid

Body

namestringrequired

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.

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

400

401

403

404

409

422

500

{
  "generativeService": {
    "uuid": "text",
    "name": "text",
    "description": "text",
    "prompt": "text",
    "model": "text",
    "temperature": 1,
    "maximumTokens": 1,
    "topP": 1,
    "presencePenalty": 1,
    "frequencyPenalty": 1,
    "responseVariableName": "text",
    "usesBlacklist": true,
    "blacklistWords": "text",
    "removed": true,
    "createdAt": "2025-02-21T18:07:24.094Z",
    "updatedAt": "2025-02-21T18:07:24.094Z",
    "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

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

uuidstringrequired

The generativeService's uuid

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid}'

200

400

401

403

404

409

422

500

No body

Simulates a generative AI output.

post

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

Path parameters

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Body

namestringrequired

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.

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/simulate' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

400

401

403

404

409

422

500

{
  "text": "text",
  "usedTokens": 1
}

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

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Body

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

enhancementTypestring · enum

Discerns which task will be performed to enhance this task.

Options: GENERATE_CONTENT, IMPROVE_WRITING, SHORTEN, EXTEND, FIX_GRAMMAR, TONE_CHANGE

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/enhance' \
  --header 'Content-Type: application/json' \
  --data '{"enhancementType":"GENERATE_CONTENT"}'

200

400

401

403

404

409

422

500

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

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

orgUUIDstringrequired

A valid uuid of organization

envUUIDstringrequired

A valid uuid of environment

botUUIDstringrequired

A valid uuid of bot

Responses

application/json

*/*

cURL

JavaScript

Python

HTTP

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

200

400

401

403

404

409

422

500

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