setInteractionOptions()

​

Usage

await api.setInteractionOptions({
  mode: {
    fallback: "in-person",
    options: ["in-person", "virtual"],
  },
  spokenLanguage: {
    fallback: "da",
    options: ["da", "en"],
  },
  templates: {
    sources: {
      personal: {
        enabled: true,
        sectionFields: {
          heading: { editable: true },
          description: { editable: true },
          miscPrompt: { visible: true, editable: true },
          outputSchema: { visible: true, editable: true },
        },
      },
      standard: {
        enabled: true,
        include: {
          regions: ["BEL"],
          families: ["soap"],
        },
        exclude: {
          regions: ["USA"],
          families: ["letter"],
        },
      },
      project: {
        enabled: true,
        include: {
          ids: ["7a0ab5b8-1f62-4f75-86a7-4fcd8fd07b5d"],
        },
        exclude: {
          ids: ["d7a7fd8c-8892-4475-81d3-3414b7d8e27d"],
        },
      },
      inline: {
        enabled: true,
        templates: [
          {
            id: "inline-soap",
            name: "Embedded SOAP",
            generation: {
              instructions: {
                prompt: "Generate a concise SOAP note for the current encounter.",
              },
              sections: [
                {
                  heading: "Subjective",
                  instructions: {
                    contentPrompt: "Summarize the patient's subjective symptoms.",
                  },
                },
              ],
            },
          },
        ],
      },
    },
    defaultTemplate: {
      behaviour: "force-first-document",
      template: {
        source: "inline",
        id: "inline-soap",
      },
      allowUserSelection: false,
    },
  },
  documents: {
    actions: {
      sync: false,
    },
    allowedLanguages: ["en", "da"],
    maxGenerated: 1,
  },
});

​

Prerequisites

• User must be authenticated.

​

Defaults and omitted values

​

Input validation

• mode.fallback: Must be either "in-person" or "virtual".
• mode.options: Must contain one or both of "in-person" and "virtual".
• spokenLanguage.fallback: Must be a valid language code when provided.
• spokenLanguage.options: Must be an array of valid language codes when provided. If you provide both fallback and options, fallback should be one of the listed options.
• templates.sources.personal.enabled: Must be a boolean when provided.
• templates.sources.personal.sectionFields: Optional object controlling field-level access in the guided template editor. heading and description accept an optional { editable?: boolean } object. miscPrompt and outputSchema accept an optional { visible?: boolean; editable?: boolean } object.
• templates.sources.standard.enabled: Must be a boolean when provided.
• templates.sources.standard.include.regions: Must be an array of ISO 3166-1 alpha-3 template region codes when provided.
• templates.sources.standard.include.families: Must be an array of standard template family identifiers when provided.
• templates.sources.standard.exclude.regions: Must be an array of ISO 3166-1 alpha-3 template region codes when provided.
• templates.sources.standard.exclude.families: Must be an array of standard template family identifiers when provided.
• templates.sources.project.enabled: Must be a boolean when provided.
• templates.sources.project.include.ids: Must be an array of project template UUID strings when provided.
• templates.sources.project.exclude.ids: Must be an array of project template UUID strings when provided.
• templates.sources.inline.enabled: Must be a boolean when provided.
• templates.sources.inline.templates: Must be an array of inline template objects when provided. Inline template IDs only need to be unique within the current setInteractionOptions() payload and are required only when referenced by another option.
• templates.defaultTemplate.behaviour: Must be "fallback" or "force-first-document" when provided.
• templates.defaultTemplate.template.source: Must be "standard", "project", or "inline" when provided.
• templates.defaultTemplate.template.id: Must be a valid template identifier for the selected source when provided. Standard templates use fully resolved identifiers such as "corti-soap-en"; inline templates use the local inline template ID.
• templates.defaultTemplate.allowUserSelection: Must be a boolean when provided. Set it to false to hide user controls for selecting and persisting a default template.
• documents.actions.sync: Must be a boolean when provided.
• documents.allowedLanguages: Must be an array of valid BCP 47 locale codes when provided. Region-less codes (e.g., "en", "da") are recommended; region variants (e.g., "en-US") are supported if the region-less code does not provide your desired results.
• documents.maxGenerated: Must be a number or "unlimited" when provided. 0 is treated as unlimited.

​

Possible errors

• UNAUTHORIZED: User not authenticated.
• INVALID_PAYLOAD: Invalid mode, language, template, or boolean value.
• INTERNAL_ERROR: Failed to apply interaction options.

​

Returns

​

Related reference

• API Reference Overview
• Supported Values
• Configuration Scenarios
• configureSession() (Deprecated)