ImportIntentsHttp

Import intents into a workspace using a multipart request.

Path Parameters
namespace string โ€” REQUIRED

Namespace of the workspace.

playbook_id string โ€” REQUIRED

Unique identifier of the workspace.

Request body โ€” REQUIRED
file binary[]

(multi-part) content of the file in specified format

format string

(multi-part) format of the file. Possible formats:

  • INTENTS_FORMAT_CSV_SIMPLE_INTENTS
  • INTENTS_FORMAT_RASA_MARKDOWN
  • INTENTS_FORMAT_RASA_YAML
  • INTENTS_FORMAT_DIALOGFLOW_ES_AGENT
  • INTENTS_FORMAT_TXT_PHRASES
  • INTENTS_FORMAT_HF_JSON
  • INTENTS_FORMAT_COGNIGY_JSON

request ImportIntentsRequest
namespace string

Namespace of the workspace.

playbook_id string

Unique identifier of the workspace.

format enum

Format of the imported file. Values: 1 = CSV 2 = Rasa 1 Markdown 3 = Rasa 2 YAML 4 = Botpress 6 = Dialogflow ES 7 = Humanfirst JSON

format_options IntentsDataOptions
hierarchical_intent_name_disabled boolean

Disables intents hierarchy encoding via the intent names. Ex: 'Parent / Sub-parent / Intent'

hierarchical_delimiter string

Overrides the default delimiter used for intent hierarchy. Default is '--' for Botpress and Dialogflow, '+' for Rasa, '/' for CSV

zip_encoding boolean

Indicates that the intents are zipped and may be splits in different files.

hierarchical_follow_up boolean

To be used with Dialogflow to use intents hierarchy using intents follow-up.

include_negative_phrases boolean

Export negative phrases as well.

import_options ImportOptions
clear_intents boolean

Clears workspace intents before importing.

clear_entities boolean

Clears workspace entities before importing.

clear_tags boolean

Clears workspace tags before importing. Note: should not be used in combination with extra_intent_tags or extra_phrase_tags since we will clear potentially referenced tags.

merge_intents boolean

Tries to merge intents into existing ones if they can be found in the workspace.

merge_entities boolean

Tries to merge entities into existing ones if they can be found in the workspace.

merge_tags boolean

Tries to merge tags into existing ones if they can be found in the workspace.

extra_intent_tags TagReference[]

Add extra tags to imported intents.

id string

Unique identifier of the tag.

name string

(Optional) Only used when importing data that tag IDs are not defined yet. This will not be filled when requesting tagged objects.

protected boolean

For internal use. There is no guarantee that this will be properly filled.

extra_phrase_tags TagReference[]

Add extra tags to imported phrases.

id string

Unique identifier of the tag.

name string

(Optional) Only used when importing data that tag IDs are not defined yet. This will not be filled when requesting tagged objects.

protected boolean

For internal use. There is no guarantee that this will be properly filled.

data bytes

Bytes of the file to import. The format is the one requested through the format field in request.

clear_workspace boolean

Clears workspace intents, entities & tags before importing. Deprecated: use import_options

clear_intents boolean

Clears workspace intents before importing. Deprecated: use import_options

clear_entities boolean

Clears workspace entities before importing. Deprecated: use import_options

clear_tags boolean

Clears workspace tags before importing. Note: should not be used in combination with extra_intent_tags or extra_phrase_tags since we will clear potentially referenced tags. Deprecated: use import_options

merge_intents boolean

Tries to merge intents into existing ones if they can be found in the workspace. Deprecated: use import_options

merge_entities boolean

Tries to merge entities into existing ones if they can be found in the workspace. Deprecated: use import_options

merge_tags boolean

Tries to merge tags into existing ones if they can be found in the workspace. Deprecated: use import_options

soft_fail boolean

Returns fatal problems via the problems field instead of gRPC errors. Temporary flag until front-end properly handles soft failures instead of gRPC error.

extra_intent_tags TagReference[]

Add extra tags to imported intents. Deprecated: use import_options

id string

Unique identifier of the tag.

name string

(Optional) Only used when importing data that tag IDs are not defined yet. This will not be filled when requesting tagged objects.

protected boolean

For internal use. There is no guarantee that this will be properly filled.

extra_phrase_tags TagReference[]

Add extra tags to imported phrases. Deprecated: use import_options

id string

Unique identifier of the tag.

name string

(Optional) Only used when importing data that tag IDs are not defined yet. This will not be filled when requesting tagged objects.

protected boolean

For internal use. There is no guarantee that this will be properly filled.

Response Body
imported_intent_count uint32

Number of intents that were imported.

imported_training_phrase_count uint32

Number of training phrases that were imported.

problems ValidationProblem[]

List of problems that occurred while validating the file format. This list may not be exhaustive. If it's been limited, the total_problems indicate the total count.

level enum

Level of the problem. 1 = Warning 2 = Fatal

message string

Message of the problem.

filename string

(Optional) Filename in which the problem was encountered.

line uint32

(Optional) Line of filename on which the problem was encountered.

total_problems uint32

Indicates total number of problems at import.