Socotra Assistant Configuration

The Socotra Assistant can be configured through the top-level AssistantRef configuration object. This configuration allows the assistant to authenticate requests performed on behalf of a tenant and controls how inbound emails are routed to tasks in the email intake workflow.

Here's an example of an AssistantRef configuration:

{
	"assistant": {
		"patTokenSecretRef": {
			"name": "SocotraAssistantPat",
			"key": "patToken"
		},
		"inquiryIntents": {
			"newQuoteIntake": {
				"intentType": "newQuote",
				"taskType": "newSubmission",
				"workgroup": "new-business-team"
			},
			"generalIntake": {
				"intentType": "unknown",
				"taskType": "emailIntake"
			}
		}
	}
}

Secrets

The patTokenSecretRef object references the static name of the SecretRef configuration object containing the personal access token (PAT) used by the Socotra Assistant, and contains the following fields:

name - The static name of the SecretRef object
key - The name of the secret item containing the PAT

Secrets can be created by using the Create a Secret API endpoint. Once a secret is created, it must be added to a resource group by using the Create a Resource Group or Update a Resource Group API endpoint.

Ensure secret configurations are deployed before using the Socotra Assistant.

Intent Plans

When the Socotra Assistant intercepts an inbound email, the assistant classifies the email into an intent and creates a task using the matching intent plan. The inquiryIntents object maps intent plan names to intent plans.

Each intent plan contains the following fields:

intentType - The intent handled by the plan. Supported values are newQuote, policyChange, policyCancellation, policyReinstatement, and unknown.
taskType - The type of task that will be created for emails matching the intent. The value must match a task type defined in the WorkManagementRef configuration for your tenant.
workgroup - An optional reference to the name of the workgroup used to auto-assign tasks created for the intent

Workgroup names must be between 1 and 128 characters, must start with a letter or digit, and can only contain letters, digits, periods, underscores, and hyphens.

Validation Rules

The following rules are enforced when an AssistantRef configuration is deployed:

The inquiryIntents object must include exactly one intent plan with the unknown intent type. This plan acts as a fallback for emails that don't match any other intent.
Each intent type can be used by at most one intent plan.
Each taskType must match a task type defined in the WorkManagementRef configuration for your tenant.

Socotra Assistant Configuration

Secrets

Intent Plans

Validation Rules

See Also

On this page