Crate csml_engine[][src]

Modules

data

Structs

Client
CsmlResult
ErrorInfo
Flow
Warnings

Enums

Expr
InstructionScope

Functions

create_bot_version

Create bot version

create_client_memory

Create memory

delete_all_bot_data

Delete all data related to bot: versions, conversations, messages, memories, nodes, integrations

delete_all_bot_versions

Delete all bot versions of bot_id

delete_bot_version_id

delete bot by version_id

delete_client

Delete all data related to a given Client

delete_client_memories

Delete all the memories of a given client

delete_client_memory

Delete a single memory for a given Client

get_bot_by_version_id

get bot by version_id

get_bot_versions

List the last 20 versions of the bot if no limit is set

get_client_conversations
get_client_memories
get_client_memory
get_client_messages
get_current_state

Get current State ether Hold or NULL

get_last_bot_version

get by bot_id

get_open_conversation

Return the latest conversation that is still open for a given user (there should not be more than one), or None if there isn’t any.

get_steps_from_flow

List all the steps in every flow of a given CSML bot

load_components
start_conversation

Initiate a CSML chat request. Takes 2 arguments: the request being made and the CSML bot. This method assumes that the bot is already validated in advance. A best practice is to pre-validate the bot and store it in a valid state.

user_close_all_conversations

Close any open conversation a given client may currently have. We also need to both clean the hold/local memory state to make sure that outdated variables or hold positions are not loaded into the next open conversation.

validate_bot

Simple static CSML bot linter. Does not check for possible runtime errors, only for build-time errors (missing steps or flows, syntax errors, etc.)