LogoLogo
  • GETTING STARTED
    • Welcome to the NLX platform
    • How NLX works
    • Guides
      • Analytics dashboard
      • Chat
      • Generative Journey (Slots)
      • Model Context Protocol
      • Voice
      • Voice+
      • 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 (beta)
        • Apply 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
  • Test & Deploy
    • 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's Metadata of a Knowledge base?
  • Including Metadata
  1. Build
  2. Resources
  3. Knowledge bases

Add metadata (beta)

Easily apply metadata filters for retrieval requests to your knowledge base in NLX

Last updated 9 days ago

What's Metadata of a Knowledge base?

Metadata is currently only supported for External (custom) .

Metadata refers to the optional filters or parameters placed on the retrieval request when your Knowledge base is called via a . This is useful as your data can become massive in scale.

Imagine, for example, you have a large collection of insurance documents, but for a specific user query, you only want to search within the user's insurance policy. In this case, you can use Metadata to tag each document (e.g., by user ID group) and apply a filter during retrieval. This ensures only the matching insurance document is searched, improving speed and relevance.


Including Metadata

To include metadata for your knowledge base content, enter supporting JSON schema. For example:

{
  "documentId": "",
  "policyholderId": "",
  "documentType": "",
  "coverageType": "",
  "effectiveDate": "",
  "language": "",
  "state": ""
}
  • Select Metadata tab of a selected Knowledge base

  • Select Auto-generate

  • Enter/paste sample JSON schema

  • Click Generate

  • Click Save

After providing metadata, you can reference your metadata filters on the side panel when the node is hit in a flow.

✨
knowledge base integrations
Knowledge base node
Knowledge base node's