Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Enable synthesized response in Virtual Agent API

You can now enable synthesized response in the conversations with the primary bot.

Before you begin

Role required: admin

Procedure

  1. Navigate to All, and then enter sys_cs_provider.list in the filter.

  2. Select the VA Bot to Bot Provider record.

  3. In the Provider Properties related tab, do the following:

    1. Select and open the synthesized_text_citation_strategy system property to configure the output text.
FieldDescription
NameName of the custom adapter property: synthesized_text_citation_strategy.
Value

Property value that controls how Virtual Agent API sends the synthesized text response with citation labels and links.

If you want to configure the way citations are displayed in the response, then choose any of the following options:

  • endnotes (default): With this selection, the citation label and links are displayed at the end of synthesized text response.
  • inline-link: With this selection, the citation links are attached to the citation reference ([1], [2]..).
  • inline-link-with-endnotes: With this selection, the synthesized response is displayed with both endnotes and inline-link.
  • none: With this selection, the citation label and links aren't displayed in the synthesized text response. The third-party chat systems can use their own logic using citations to render the output text from the synthesized response.
2.  Select and open the **synthesized\_carousel\_strategy** system property to configure the picker.
FieldDescription
NameName of the custom adapter property: synthesized_carousel_strategy.
ValueProperty value that controls how Virtual Agent API sends the synthesized text response with carousel. - replace-label \(default\): With this selection, Virtual Agent API sends the synthesized text response in labels. - separate-control: With this selection, Virtual Agent API sends the synthesized text response in a separate output text control and the carousel with the options.
3.  Click **Update**.

Parent Topic:Using Virtual Agent API