Settings

Default NLU Pipeline

The default configuration for NLU will be automatically selected. Components in the NLU pipeline make up your NLU to work sequentially and process user input into structured output. There are components for entity extraction, for intent classification, response selection, pre-processing, and more. To Learn more

Default policies

Policies are used to define actions in a story it works in a sequential order in a conversation. You can customize the policies for your Clai by specifying the policies key in your project. There are different policies to choose from, and you can include multiple policies in a single configuration. To Learn more

Default domain

Default Domain contains default slots and default actions which are common for all the projects which are created, custom defualt actions will also be displayed here.

Webhooks:

The webhooks feature is only available with the Enterprise Edition.

To map Clai features with specific use cases of your infrastructure, you can implement webhooks that will be invoked by Clai.

The imagesvc service provided with the enterprise version provides the Upload and Delete Image webhook endpoints. At the moment the Deploy and Post-training webhooks if required, will be implemented based on your environment/architecture of your installation of Clai. It is planned to implement a service for the Deploy and Post-training webhook endpoint features in the 1.3 version of Clai.

Upload Image

If set, an upload widget will be available in the dialog builder. The webhook will be invoked when a user uploads an image.

Request

{
    "projectId": string,
    "data": string, // image encoded in base64
    "mimeType": string,
    "language": string,
    "responseId": string // template name followed by unix timestamp, e.g. utter_get_started_1588107073256
}

Response

{
    "uri": string // the publicly accessible URI for the asset just received
}

Delete Image

The webhook will be invoked by Clai when an image URL is no longer used in a response. The request will be sent whether or not the resource actually exists on the server.

Request

{
    "projectId": string,
    "uri": string // the publicly accessible URI for the asset to be deleted
}

Response

Clai expects a 204 success response, and a 404 if ressource was not found. Any other response may signal an error to the user in the future.

Deploy

If set, and your project has environments, the deploy menu will be available in the training button dropdown list.

Request

Clai will send a request to the api with the following information

{
    "projectId" : string, 
    "namespace" : string, 
    "environment" : string,
    "gitString" : string, 
}

Response

Clai expects a successful response to have the status code 200, responses with other status codes are treated as errors. You can specify a message property which will be displayed in a notification if the status code is 200.

{
    "message" : string
}

If the status code is not 200 Clai will display the detail property in a notification.

{
    "detail" : string
}

PostTraining

If set, this webhook will be invoked every time a project finishes training and is used to store a trained model.

Request

Clai will send a request to the webhook url with the following parameters.

{
    "projectId" : string,
    "namespace" : string,
    "model" : string, // base64 conversion of the trained model
    "mimeType" string,
}

Expected response

Clai except a 200 success response, other response are treated as errors. You can add a message property in the error response body that will be displayed to the user.

Appearance

In this page you can set the logo displayed at the top left of the expanded sidebar by default to all projects.

And can also set the small logo that will be displayed at the top left of the collapsed sidebar by default to all the projects.

Misc

In this session you can add documentation url in which after clicking Documentation tab it will redirect to that particular page.