Generative Service

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

PreviousEntity NextIntent

Last updated 5 months ago

Was this helpful?

Searches and paginates through expected Generative Service

get

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

searchTermstringOptional

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

pageinteger · int32Required

Current page, starting at 1

Default: 1Example: 1

sizeinteger · int32Required

Size of the page

Default: 5Example: 1

orderBystringOptional

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

Default: updatedAt

directionstringOptional

Order direction(ASC/DESC), defaulted to DESC

Default: DESC

Responses

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service?page=1&size=1 HTTP/1.1
Host: 
Accept: */*

{
  "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,
  "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-05-09T11:39:38.717Z",
        "updatedAt": "2025-05-09T11:39:38.717Z",
        "updatedBy": "text",
        "createdBy": "text"
      },
      "flows": [
        {
          "uuid": "text",
          "name": "text"
        }
      ]
    }
  ],
  "number": 1,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

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

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 · int32Optional

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

Default: 6Example: 1

Responses

200

application/json

Responsestring[]

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/quicksearch?searchTerm=text HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

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

get

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

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/list-on-flow HTTP/1.1
Host: 
Accept: */*

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

Retrieves info from a specific given Generative Service.

get

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

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid} HTTP/1.1
Host: 
Accept: */*

{
  "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-05-09T11:39:38.717Z",
    "updatedAt": "2025-05-09T11:39:38.717Z",
    "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

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

200

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

delete

DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid} HTTP/1.1
Host: 
Accept: */*

No content

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

get

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Responses

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/availability HTTP/1.1
Host: 
Accept: */*

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

Creates a brand new Generative Service

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Contract required to request the creation of a Generative Service.

namestringRequired

Name of this Generative Service.

descriptionstringOptional

An optional description of this Generative Service.

promptstringOptional

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

modelstringOptional

AI Model to be used in this Generative Service.

temperaturenumber · doubleOptional

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

maximumTokensinteger · int32Optional

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

topPnumber · doubleOptional

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

presencePenaltynumber · doubleOptional

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

frequencyPenaltynumber · doubleOptional

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

responseVariableNamestringOptional

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

usesBlacklistbooleanOptional

Wether this execution should blacklist specific words.

blacklistWordsstringOptional

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

Responses

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "name": "text",
  "description": "text",
  "prompt": "text",
  "model": "text",
  "temperature": 1,
  "maximumTokens": 1,
  "topP": 1,
  "presencePenalty": 1,
  "frequencyPenalty": 1,
  "responseVariableName": "text",
  "usesBlacklist": true,
  "blacklistWords": "text"
}

{
  "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-05-09T11:39:38.717Z",
    "updatedAt": "2025-05-09T11:39:38.717Z",
    "updatedBy": "text",
    "createdBy": "text"
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Updates a Generative Service.

put

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

Contract required to request the creation of a Generative Service.

namestringRequired

Name of this Generative Service.

descriptionstringOptional

An optional description of this Generative Service.

promptstringOptional

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

modelstringOptional

AI Model to be used in this Generative Service.

temperaturenumber · doubleOptional

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

maximumTokensinteger · int32Optional

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

topPnumber · doubleOptional

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

presencePenaltynumber · doubleOptional

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

frequencyPenaltynumber · doubleOptional

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

responseVariableNamestringOptional

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

usesBlacklistbooleanOptional

Wether this execution should blacklist specific words.

blacklistWordsstringOptional

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

Responses

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/{uuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "name": "text",
  "description": "text",
  "prompt": "text",
  "model": "text",
  "temperature": 1,
  "maximumTokens": 1,
  "topP": 1,
  "presencePenalty": 1,
  "frequencyPenalty": 1,
  "responseVariableName": "text",
  "usesBlacklist": true,
  "blacklistWords": "text"
}

{
  "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-05-09T11:39:38.717Z",
    "updatedAt": "2025-05-09T11:39:38.717Z",
    "updatedBy": "text",
    "createdBy": "text"
  },
  "flows": [
    {
      "uuid": "text",
      "name": "text"
    }
  ]
}

Simulates a generative AI output.

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Contract required to request the creation of a Generative Service.

namestringRequired

Name of this Generative Service.

descriptionstringOptional

An optional description of this Generative Service.

promptstringOptional

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

modelstringOptional

AI Model to be used in this Generative Service.

temperaturenumber · doubleOptional

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

maximumTokensinteger · int32Optional

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

topPnumber · doubleOptional

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

presencePenaltynumber · doubleOptional

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

frequencyPenaltynumber · doubleOptional

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

responseVariableNamestringOptional

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

usesBlacklistbooleanOptional

Wether this execution should blacklist specific words.

blacklistWordsstringOptional

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

Responses

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/generative-service/simulate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "name": "text",
  "description": "text",
  "prompt": "text",
  "model": "text",
  "temperature": 1,
  "maximumTokens": 1,
  "topP": 1,
  "presencePenalty": 1,
  "frequencyPenalty": 1,
  "responseVariableName": "text",
  "usesBlacklist": true,
  "blacklistWords": "text"
}

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

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

post

Path parameters

orgUUIDstringRequired

A valid uuid of organization

envUUIDstringRequired

A valid uuid of environment

botUUIDstringRequired

A valid uuid of bot

Body

Structure with data for a Answer Assist enhancement request.

enhancementTypestring · enumOptional

Discerns which task will be performed to enhance this task.

Possible values:

inputTextstringOptional

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

tonestringOptional

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

languagestringOptional

Language of this bot.

channelTypeinteger · int32Optional

It is the channel type from the answer

Responses

200

application/json

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

post

POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/answer/enhance HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "enhancementType": "GENERATE_CONTENT",
  "inputText": "text",
  "tone": "text",
  "language": "text",
  "channelType": 1
}

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

Generative Service

Generative Service

CRUD Operations

Execution

Auxiliary Methods

CRUD Operations

Execution

Auxiliary Methods

Searches and paginates through expected Generative Service

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.

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

Retrieves info from a specific given Generative Service.

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

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

Creates a brand new Generative Service

Updates a Generative Service.

Simulates a generative AI output.

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

Pagination and Listing

CRUD Operations

Execution

Auxiliary Methods

Pagination and Listing

CRUD Operations

Execution

Auxiliary Methods

Searches and paginates through expected Generative Service

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.

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

Retrieves info from a specific given Generative Service.

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

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

Creates a brand new Generative Service

Updates a Generative Service.

Simulates a generative AI output.

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