Class: ChatBotCreateService

ChatBotCreateService()

Creates a chatbot and returns its ID. The id will later be used to allow users to interact with it.

Constructor

new ChatBotCreateService()

Source:

Methods

call(user, role, chatbot_name, chatbot_idopt) → {Promise.<Object>}

Parameters:
Name Type Attributes Default Description
user string The ID of the user accessing the Soffos API. This string will be used for throttling and profanity tracking. Soffos assumes that the owner of the api is an application (app) and that app has users. Soffos API will accept any string."
role string A description of your bot's purpose. You may also describe its tone when responding. The system may not be able to follow complex instructions specified in this field.
chatbot_name string The name/identity of your chatbot.
chatbot_id string <optional>
 null The chatbot's id. Provided when you create the chatbot. If you provide this, the chatbot with this ID's will be updated. The role and name will be updated.
Source:
Returns:
chatbot_id - The chatbot's id. Provided when you create the chatbot. If you provide this, the chatbot with this ID's will be updated. The role and name will be updated.
Type
Promise.<Object>
Example
Examples are available at "https://github.com/Soffos-Inc/soffosai-js/tree/master/samples"

setInputConfigs(name, role, chatbot_name, chatbot_idopt)

Parameters:
Name Type Attributes Default Description
name string Reference name of this Service. It will be used by the Pipeline to reference this Service.
role string | InputConfig A description of your bot's purpose. You may also describe its tone when responding. The system may not be able to follow complex instructions specified in this field.
chatbot_name string | InputConfig The name/identity of your chatbot.
chatbot_id string | InputConfig <optional>
 null The chatbot's id. Provided when you create the chatbot. If you provide this, the chatbot with this ID's will be updated. The role and name will be updated.
Source: