Customize the Notes Connector

A Notes connector enables you to ingest user-created notes from the Zeta Alpha UI into your index. This guide shows you how to create and configure a Notes connector for your data ingestion workflows.

Info: This guide presents an example configuration for a Notes connector. For a complete set of configuration options, see the Notes Connector 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 Notes Basic Configuration

To create a Notes connector, define a configuration file with the following basic fields:

• is_document_owner: (boolean) Indicates whether this connector "owns" the crawled documents. When set to true, other connectors cannot crawl the same documents.
• content_source_name: (string, optional) Custom name for the content source.
• logo_url: (string, optional) The URL of a logo to display on document cards

Example Configuration

{
    "name": "User Notes",
    "description": "Notes created by users in the UI",
    "is_indexable": true,
    "connector": "notes",
    "connector_configuration": {
        "is_document_owner": true,
        "content_source_name": "Notes",
        "logo_url": "https://example.com/notes-logo.png"
    }
}

Step 2: Add Field Mapping Configuration

When users create notes, the connector extracts document metadata and content. You can map these note fields to your index fields using the field_mappings configuration.

Example Field Mappings

The following example shows field mappings for the default index fields:

{
    ...
    "connector_configuration": {
        ...
        "field_mappings": [
            {
                "content_source_field_name": "identifier",
                "index_field_name": "DCMI.identifier"
            },
            {
                "content_source_field_name": "created_at",
                "index_field_name": "DCMI.created"
            },
            {
                "content_source_field_name": "last_updated_at",
                "index_field_name": "DCMI.modified"
            },
            {
                "content_source_field_name": "format",
                "index_field_name": "DCMI.format"
            },
            {
                "content_source_field_name": "references",
                "index_field_name": "DCMI.references"
            },
            {
                "content_source_field_name": "summary",
                "index_field_name": "DCMI.abstract"
            },
            {
                "content_source_field_name": "uri",
                "index_field_name": "uri"
            },
            {
                "content_source_field_name": "document_content_type",
                "index_field_name": "document_content_type"
            },
            {
                "content_source_field_name": "document_content",
                "index_field_name": "document_content"
            }
        ],
        ...
    }
}

Step 3: Create the Notes Content Source

To create your Notes connector 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

How Users Create Notes

Once the Notes connector is configured, users can create notes through the Zeta Alpha UI:

1. Users navigate to a document or create a standalone note
2. They write content in Markdown format
3. Notes are automatically saved and ingested into the platform

Document Access Control

Notes are automatically assigned access rights based on the user who created them. Users can also choose to share the note with:

• Individual teammates
• Entire teams they belong to

When shared with a team, all team members gain access to the note.

Use Cases

The Notes connector is ideal for:

1. Personal annotations: Users can annotate documents with their own insights
2. Research notes: Capture thoughts and observations while reading
3. Collaborative notes: Share notes with team members
4. Highlighted passages: Save important excerpts from documents
5. Conversation memory: Store summaries and insights from conversations with AI agents

Note Types

Different types of notes are supported:

• Document notes: General notes associated with a document
• Tag notes: Notes attached to specific tag
• Standalone notes: Independent notes not tied to a specific document

Crawling Behavior

The Notes connector processes user-created notes, extracting:

• Note content (Markdown format)
• Creation and modification timestamps
• References to related documents (if applicable)
• Annotation highlights (if applicable)
• Format and type information
• Access control metadata

Notes are indexed for full-text search, making it easy for users to find their annotations and observations across all their documents.