Tag

The tag API handles searching with tags

API SUBPATH: eva-tag

Auxiliary Methods

Retrieves all existing Tags registered in a given Bot.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Responses

200

Ok

application/json

Sent both as request and response, this DTO represents the Tag name and the Tag's associations with other items through TagUses. Both models are setup seamlessly on the background, for ease of use.

uuidstringOptional

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

namestringOptional

Name of the tag.

objectRefstringRequired

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

tagTypeIdinteger · int64Required

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 11 - Supervisor 12 - Agent 13 - Function

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

get

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

HTTPcURLJavaScriptPython

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

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

Retrieves the tags just consulted.

get

Path parameters

orgUUIDstringRequired

A valid organization Uuid

envUUIDstringRequired

A valid environment Uuid

botUUIDstringRequired

A valid bot Uuid

Query parameters

limitinteger · int32OptionalDefault: 10

Header parameters

x-request-idstringOptional

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

Responses

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

408

Request Timeout

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

default

default response

application/json

get

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

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/recent-search HTTP/1.1
Accept: */*

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

Its service is used to search a tags by name.

get

Path parameters

orgUUIDstringRequired

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

envUUIDstringRequired

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

botUUIDstringRequired

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

Query parameters

namestringRequired

It is the parameter used to search for tags related to the entered value

limitinteger · int32Optional

It is the max number of result, default value 6

Default: 6Example: 6

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

application/json

It is a tag simplification, it has only the tag name and the tag uuid.

uuidstringOptional

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

namestringOptional

Name of the tag.

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}/tags/quicksearch

HTTPcURLJavaScriptPython

GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/quicksearch?name=text HTTP/1.1
Accept: */*

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

Records new tag searches.

put

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.

Bodystring[]

application/json

string[]Optional

Uuids of consulted tags.

Responses

200

OK

No content

400

Bad Request

*/*

401

Unauthorized

*/*

403

Forbidden

*/*

404

Not Found

*/*

409

Conflict

*/*

422

Unprocessable Entity

*/*

500

Internal Server Error

*/*

put

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

HTTPcURLJavaScriptPython

PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/tags/add-recent HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

No content