Add metadata

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

What's Metadata of a Knowledge base?

Metadata is currently only supported for Q&A or External knowledge base integrations and when invoked through the Knowledge base node in a flow.

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

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

Including Metadata

To include metadata for your knowledge base content, enter the supporting JSON schema that will act as a filter. For example:

{
  "documentId": "",
  "policyholderId": "",
  "documentType": "",
  "coverageType": "",
  "effectiveDate": "",
  "language": "",
  "state": "",
  "sensitive": true
}

  • Select Metadata tab of a selected Q&A or External Knowledge base

  • Select ✨ Auto-generate

  • Enter/paste sample JSON schema

  • Click Generate

  • Click Save

For a Q&A Knowledge base, complete the following to provide the metadata attributes to applicable question entries. For example:

  • Select the Q&A tab

  • Expand a question > Select + Add metadata

  • Enter any applicable values for the metadata > Repeat as needed

  • Click Save > Select Publish tab

  • Publish a new version

After providing metadata, you can now apply the filters on the Knowledge base node's side panel when the node is hit in a flow.

Last updated