AIRecommendation

Entity description

An AIRecommendation entity represents an AI-generated suggestion provided to a specific target. The recommendation includes actions, context, display details, and metadata regarding its status.

Properties

Name	Description	Type	Example
uid	A unique identifier for the recommendation	string	`rec-123`
created_at	The timestamp when the recommendation was created, in ISO 8601 format	string	`2025-02-04T12:00:00Z`
updated_at	The timestamp when the recommendation was last updated, in ISO 8601 format	string	`2025-02-04T12:30:00Z`
actions	A list of recommended actions related to this entity	array	See Actions Properties below
display	Contains display-related information for the recommendation	object	See Display Properties below
reason	A brief explanation of why the recommendation was generated	string	`Clarification needed`
context	The context in which the recommendation was generated	object	See Context Properties below
target	The target entity for this recommendation, typically representing the user or business involved	object	See Target Properties below
recommendation_type	The type of recommendation (`matter_next_best_action`, `schedule`, `estimate`)	string	`matter_next_best_action`
status	Metadata about the status of the recommendation	object	See Status Properties below

Actions Properties

See AIRecommendedAction

Display Properties

Name	Description	Type	Example
title	A human-readable title describing the recommendation	string	`We recommend replying to the user's message.`

Context Properties

Name	Description	Type	Example
context_uid	A unique identifier for the context associated	string	`ctx-456`
context_type	The type of context (`matter`, `client`, `business`)	string	`client`

Target Properties

Name	Description	Type	Example
target_actor_uid	A unique identifier for the target actor	string	`staff-789`
target_actor_type	The type of target actor (`staff`, `directory`)	string	`staff`

Status Properties

Name	Description	Type	Example
dismissed	Indicates whether the recommendation has been dismissed	boolean	`false`
dismissed_source_type	Source of dismissal (`user`, `system`)	string	`user`

Example

{
  "uid": "rec-123",
  "created_at": "2025-02-04T12:00:00Z",
  "updated_at": "2025-02-04T12:30:00Z",
  "actions": [
    {
      "uid": "act-456",
      "action": "reply",
      "display": {
        "title": "Follow up with the client"
      },
      "reason": "User needs clarification on pricing",
      "payload": {"content":"Please tell me more about your carpet so I can send you a quote"},
      "evidence": ["User asked for price estimate"],
      "confidence": 0.85
    }
  ],
  "display": {
    "title": "We recommend replying to the user's message."
  },
  "context": {
    "context_uid": "ctx-456",
    "context_type": "client"
  },
   "recommendation_type": "client_incoming_message",
  "target": {
    "target_actor_uid": "staff-789",
    "target_actor_type": "staff"
  },
  "status":{
    "dismissed": false,
    "dismissed_source_type": "user",
    "viewed": true
  }
}