How it works

In practice, this Suggestion Assistant process is as follows:

  • If the conditions for displaying the Suggestion Assistant icons are met (display condition + current user roles) any time after the first save of a record, the system displays the Suggestion Assistant icon
  • When the user clicks the Suggestion Assistant icon, the system
    • Retrieves data from the record to substitute into the Retrieval Context prompt
      (for RAG Suggestion Assistant only)
    • Identifies the relevant rows from the configured AI Reference Dataset using data retrieved from the Retrieval Context prompt. The system will retrieve a number of rows according to the configured "Retrieval Sample Size"
      (for RAG Suggestion Assistant only)
    • Retrieves data from the record to substitute into the main Prompt
    • Substitutes the retrieved relevant AI Reference Dataset rows into the main Prompt
      (for RAG Suggestion Assistant only)
    • Sends the Prompt to the AI provider ( OpenAI Enterprise or Azure OpenAI)
    • Receives the response from the AI provider
    • Stores the suggestions in the configured text field
    • Displays the suggestions to the user

      If the system has a Google API Key setup, the system will translate and display the suggestion to the user in their configured language

suggestion_assistant_example

  • If none of the fields that affect the Suggestion Assistant (ie. None of the fields that have placeholders in the Suggestion Prompt) have been updated since the last time that Suggestion Assistant was viewed by any user, then the Suggestion Assistant just shows the suggestion text stored in the text field without asking the AI provider again.
  • If "Response Copy Over" is setup, users can highlight text from Suggestion Assistant response and use the "Copy To" option to select the target field. The highlighted text is then copied directly into the chosen field, making it faster and easier to document next steps.
    suggestion_assistant_Response_Copy_Over
  • If the Suggestion Assistant is configured to be in "expanded" mode, as soon as the Suggestion Assistant icon is visible to a user, it is automatically expanded and the suggestions are automatically retrieved and displayed.
  • Users will have the option to Dismiss the Suggestions.

    Clicking on Dismiss will hide that Suggestion Assistant for that user, for that record until one of the fields that affects the Suggestion Assistant has been modified.

note_awesome

NOTE:

If a RAG Suggestion Assistant cannot find any relevant rows in the AI Reference Dataset, it will abort the process and just report “no suggestions found” to the user

See Also

Suggestion Assistant

Configuring the Fields

Configuring an AI Reference Dataset

Configuring a Suggestion Prompt

Configuring a Suggestion Assistant on a Form

Reference Datasets on pgvector (extension for PostgreSQL)

Suggestion Assistant in Roam