Skip to main content
Quick summary
allows you to customize how Suki generates clinical notes based on each provider’s preferences. Control how much detail (short and concise, balanced, or very detailed) and how it’s formatted (continuous paragraphs or bullet points).
Last updated:June 2026
Personalization is supported by: APIs, Web SDK, Mobile SDK
Personalization allows you to help providers customize how Suki generates their clinical notes. Every provider has different preferences, some want short bullet points, others want detailed paragraphs. Personalization ensures each provider gets notes that match their style. When you use personalization, you can customize two aspects of note generation:
  • How much detail: Short and concise, balanced, or very detailed notes
  • How it’s formatted: Continuous paragraphs (narrative) or bullet points
Once you set a provider’s preferences, Suki automatically applies them to all future notes for that provider. You set it once, and Suki remembers, no need to send preferences with every request. Using personalization, you get the following benefits:
  • Provider satisfaction: Notes match each provider’s preferred style and level of detail
  • Consistent documentation: Once set, preferences apply automatically to all future notes
  • Efficiency: Providers don’t need to manually adjust notes; they’re generated according to their preferences
  • Flexibility: Different providers can have different preferences based on their specialty and workflow
  • Better adoption: When notes match provider preferences, they’re more likely to use and trust the system

​
How it works

Settings are saved at the user level (not per session) and applied to all future note generation for that provider. The process:
  1. Set preferences: Use the Mobile SDK setPersonalizationPreferences method or the User Preferences API to configure a provider’s preferences
  2. Automatic application: Suki applies these settings to all future notes for that provider
  3. Update anytime: Update preferences at any time; the most recent settings always take effect
Settings are persistent and user-specific. You don’t need to send preferences with every session request.

​
How to set personalization preferences

Use the Mobile SDK or User Preferences API; the method depends on your integration. Mobile SDK Example:
Swift
let preferences: [String: AnyHashable] = [
    "verbosity": "CONCISE", // Options: CONCISE, BALANCED, DETAILED
    "section_format": [
        [
            "loinc": "10164-2",
            "style": "NARRATIVE" // Options: NARRATIVE, BULLETED
        ]
    ]
]

SukiAmbientCore.shared.setPersonalizationPreferences(preferences) { result in
    switch result {
    case .success:
        print("Preferences updated successfully")
    case .failure(let error):
        print("Error updating preferences: \(error)")
    }
}
API Example:
Python
import requests

url = "https://sdp.suki-stage.com/api/v1/user/preferences"

payload = { "personalization_preference": {
        "section_format": [
            {
                "loinc": "10164-2",
                "style": "NARRATIVE"
            }
        ],
        "verbosity": "CONCISE"
    } }
headers = {
    "sdp_suki_token": "<sdp_suki_token>",
    "sdp_provider_id": "<sdp_provider_id>",
    "Content-Type": "application/json"
}
When to set as personalization preferences:
  • After user registration (when a new provider is added)
  • When a provider requests changes
  • Before sessions start, ideally before audio streaming begins
The User Preferences API is a PATCH request, so you only need to send the fields you want to change. Update verbosity and section formats independently.

​
Personalization options

Customize two aspects of note generation:

​
Verbosity

How much detail is included. Applies to all note sections.
​
verbosity
string
default:"BALANCED"
Applies to: All note sections

​
Section style

Controls the formatting style for specific clinical sections. Set different styles for different sections as needed.
​
section_format
array
Applies to:
  • History of Present Illness (10164-2)
  • Assessment and Plan (51847-2)
  • Assessment (51848-0)
  • Plan (18776-5)
Example:
JSON
"section_format": [
  {
    "loinc": "10164-2",
    "style": "NARRATIVE"
  },
  {
    "loinc": "51848-0",
    "style": "BULLETED"
  }
]

​
Best practices

  • Set defaults early: Configure preferences when providers are first registered in your system
  • Offer a UI: Let providers choose their preferences through your application’s settings page
  • Explain options: Help providers understand the difference between verbosity levels and style options
  • Update when requested: Make it easy for providers to change their preferences as their needs evolve
  • Test with real notes: Verify that preferences produce notes that match provider expectations

User Preferences API

Set and update personalization preferences for providers
Last modified on June 30, 2026