Tag

The tag API handles searching with tags

API SUBPATH: eva-tag

Auxiliary Methods

Retrieves all existing Tags registered in a given Bot.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Response

200400401403404409422500

Ok

Body

application/json

uuidstring

Uuid of the tag, if existing. Not required, but will speed up the search if present.

namestring

Name of the tag.

objectRef*string

The Uuid of the object associated with it. The kind of object is declared in tagTypeId

tagTypeId*integer (int64)

The type of object this tag shall refer to:

1 - Intent

2 - Entity

3 - Answer

4 - Flow

5 - Unused stubs (prototype)

6 - Service

7 - Question

8 - RestConnector

9 - GenerativeService

10 - Document

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

[
  {
    "uuid": "text",
    "name": "text",
    "objectRef": "text",
    "tagTypeId": 0
  }
]

Retrieves the tags just consulted.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/recent-search

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Query parameters

Header parameters

Response

400401403404409422500default

Bad Request

Body

*/*

timestampinteger (int64)

errorCodestring

errorTypeenum

API_ERRORAPI_INFOUSER_ERROR

messagestring

pathstring

Request

JavaScriptCurlPython

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

Response

400401403404409422500default

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

Its service is used to search a tags by name.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/quicksearch

Path parameters

orgUUID*string

It is the organization where the flow is, used to connect to the correct database

envUUID*string

It is the environment where the flow is, used to connect to the correct database

botUUID*string

It is the bot where the flow is, used to filter tags

Query parameters

Header parameters

Response

200400401403404409422500

Ok

Body

application/json

uuidstring

Uuid of the tag, if existing. Not required, but will speed up the search if present.

namestring

Name of the tag.

Request

JavaScriptCurlPython

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

Response

200400401403404409422500

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

Records new tag searches.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/add-recent

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Header parameters

Body

application/json

itemsstring

Response

200400401403404409422500

OK

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/add-recent', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Response

400401403404409422500

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