Skip to main content

Indexing Document Tags

A Tags Enhancement enables the platform to add or remove tags from documents based on user events. Tags are managed through the Zeta Alpha UI and indexed as document enhancements.

This guide shows you how to configure a tags enhancement for your data ingestion workflows.

Info: This guide presents an example configuration for a Tags Enhancement connector. For a complete set of configuration options, see the Tags Enhancement Configuration Reference.

Prerequisites​

Before you begin, ensure you have:

  1. Access to the Zeta Alpha Platform UI
  2. A tenant created
  3. An index created

Step 1: Create the Tags Enhancement Configuration​

To create a tags enhancement connector, define a configuration file with the following fields:

  • name: (string) The name of the enhancement content source.
  • description: (string) A description of the enhancement.
  • is_indexable: (boolean) Whether the enhancement is indexable.
  • connector: (string) The connector type. Set it to tags_enhancement.
  • connector_configuration: (object) The configuration of the enhancement:
    • enhancement_id: (string) The id of the enhancement. Must be "tags".

Example Configuration​

{
    "name": "Document Tags Enhancement",
    "description": "User-managed tags for documents",
    "is_indexable": true,
    "connector": "tags_enhancement",
    "connector_configuration": {
        "enhancement_id": "tags"
    }
}

Step 2: Create the Tags Enhancement Content Source​

To create the tags enhancement content source in the Zeta Alpha Platform UI:

  1. Navigate to your tenant and click View next to your target index
  2. Click View under Content Sources for the index
  3. Click Create Content Source
  4. Paste your JSON configuration
  5. Click Submit

Purpose of Tags Enhancement​

The tags enhancement connector indexes user-applied tags as document enhancements, enabling:

  1. Filtered search: Users can filter search results to show only documents with specific tags
  2. Agent operations: AI agents can operate on tag-filtered document sets
  3. Faceted navigation: Tags appear as facets in the search interface for easy filtering
  4. Combined queries: Tags can be combined with other search criteria for precise filtering