LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+ script
      • Touchpoint components
        • Carousel modality
        • Video modality
    • Terms & concepts
    • Generative AI
    • Developer
  • Build
    • Workspace setup
    • Flows
      • Intro to flows & variables
      • The Canvas
      • Flow settings
      • Nodes
      • Flow appearance
    • Resources
      • Actions
        • Implementation
        • Request model
      • Analytics tags
      • Context variables
      • Data requests
        • Implementation
        • Response model
        • Request model
      • Knowledge bases
        • Ingest content
        • Add metadata
        • Support citations
        • Employ KB
      • Lifecycle hooks
        • Implementation
      • Modalities
      • Secrets
      • Slots (custom)
        • Adding values
        • Translating slots
      • Voice+ scripts
        • Add + download script
        • Deploy script + install SDK
        • Create Voice+ flow
    • Integrations
      • Channels
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Bandwidth
        • Genesys
        • Twilio
        • Zendesk Sunshine
      • LLM services
        • Amazon Bedrock
        • Anthropic
        • Azure OpenAI
        • Cerebras
        • Cohere
        • Google Vertex AI
        • Groq
        • NVIDIA
        • OpenAI
        • xAI
      • NLP
        • Amazon Lex
        • Google Dialogflow
        • Google Dialogflow CX
        • Custom NLP
    • Translations
  • Deploy & test
    • Applications
      • Attach flows
      • Assign default behavior
      • Add channels
        • API
          • REST API
        • Alexa
        • Amazon Chime SDK
        • Amazon Connect
        • AWS End User Messaging SMS
        • AWS End User Messaging Social
        • Genesys
        • Genesys SMS
        • Messenger
        • Microsoft Teams
        • Slack
        • SMS via Bandwidth
        • Twilio SMS
        • Twilio Voice
        • WhatsApp via Twilio
        • Zendesk Sunshine
      • Deploy
      • Optional: Set lifecycle
      • Optional: Set languages
    • Test
      • Test a conversation
      • Automated tests
      • Test an external integration
  • Analyze
    • Conversations
    • Analytics
      • Creating dashboards
      • Formulas & multi-metrics
      • Canvas analytics
    • Training
  • Workspace Settings
    • Escalation channels
    • Resource tags
    • Audit
  • Admin
    • Access control
      • Roles & permissions
    • Notifications
    • FAQ
    • Contact support
Powered by GitBook
On this page
  • What are citations of a Knowledge base?
  • Create citation modality
  • Citation setup in flow
  1. Build
  2. Resources
  3. Knowledge bases

Support citations

Display in-line citations in chat using responses from your knowledge base

Last updated 14 days ago

What are citations of a Knowledge base?

Citations are references that point to the original source of information when your conversational AI delivers a response from a knowledge base. Citations show where the information comes from, allowing users to verify an answer's accuracy and explore its sources.

In the AI's response, citations will appear inline with number indicators [1] and an accompanying sources section to correlate with each numbered citation.

Citations are currently best optimized for Documents, External, or Custom knowledge base types.


Create citation modality

To appropriately render citations in your AI's response using , first create a citation modality:

  • Select Resources > Modalities in your workspace menu

  • Select New modality > Provide a name (e.g., KBCitation)

  • Select Auto-generate

  • Paste sample JSON schema provided below

  • Click Set schema

  • Click Save

Citation modality schema:

[
  {
    "content": "",
    "fileName": "",
    "pageNumber": 1,
    "score": 1
  }
]

Citation setup in flow

Once your modality is created, you'll set up your Knowledge base with citation support in a flow:

  • Select Flows in your workspace menu > Choose or create a flow

  • Add a Knowledge base node to the Canvas > Assign the knowledge base created in your workspace to the node

  • Enter {System.utterance} in the node's Question field

  • Expand the node's Settings section > Enable Include citation

  • From the Match edge of the Knowledge base node, add and link a User choice node

  • Select Add functionality on the User choice node > Choose Modalities

  • Select the modality you created in the previous step (e.g., KBCitation) > Toggle ON Enable

  • Set the modality's payload value to {Response.sources}

  • Click Save

On the User choice node, add {Response.answer) as a message > Assign a to the node

Note that while using the widget in your workspace, the citation modality will not render for test chats. Instead, a build of your application to launch the Touchpoint configurator and experience it live.

Once you've created a build and deployed your application, access the Touchpoint configurator from to install the Touchpoint SDK to your site.

✨
Touchpoint
custom Yes/No slot
Test
deploy
deployment details