Skip to main content

Manage relevance safely

Relevance Studio gives every ready collection a draft-and-publish workflow for synonyms and curations. Drafts do not affect live search. Publication is restricted to administrators and owners, and every live configuration is retained as an immutable version.

Before you begin​

  • Finish the collection's first successful indexing run.
  • Confirm representative documents appear in Search Studio.
  • Sign in as an editor, administrator, or owner to change a draft. Editors cannot publish or roll back.
  • Back up PostgreSQL and Typesense together before production upgrades or recovery work.

Select the collection​

Open Relevance Studio, then use the searchable collection selector. Only ready collections are listed. The status bar shows whether the saved draft differs from the current live version and whether the draft can be published.

Add a synonym set​

  1. Open Synonyms and select Add synonym set.
  2. Enter a descriptive name.
  3. Add at least two unique equivalent terms, such as laptop, notebook, and portable computer.
  4. Add the set to the draft and select Save draft.

Duplicate terms are rejected case-insensitively. The saved set remains inactive until an administrator or owner publishes the draft.

Add a curation rule​

  1. Open Curations and select Add curation rule.
  2. Choose Exact query when the full normalized query must match, or Query contains phrase when a configured phrase may appear inside a longer query.
  3. Add up to ten unique alternative phrases to the same rule.
  4. Search the active collection in the document picker.
  5. Choose Pin to move a document to the front or Hide to remove it for the matching query.
  6. Reorder pinned documents with the arrow controls. The displayed order becomes the result order.
  7. Check the live preview, add the rule to the draft, and select Save draft.

The picker shows a useful document title when one is available and always shows the stable document ID. The preview queries the active collection and applies the current draft pin/hide actions locally; it is not a live change.

Review and publish​

Before publication, review the synonym and curation counts, all phrases, the selected documents, and the preview. Publishing then:

  1. validates the latest draft revision;
  2. rejects an unchanged draft;
  3. applies the managed synonym and curation sets to Typesense;
  4. records an immutable live version; and
  5. adds an entry to the project audit trail.

Confirm representative searches in Search Studio or through the public search API after publication. If publication fails, Indexlume records a sanitized error and attempts to restore the previous Typesense configuration.

Roll back​

Open History, select an earlier configuration, review the confirmation, and choose Roll back. Indexlume publishes that configuration as a new version. Existing history is never deleted or rewritten.

Rebuild behavior​

Upload rebuilds, PostgreSQL snapshots, and relational-projection snapshots reapply the published relevance configuration before the new physical collection is promoted. A failed relevance deployment prevents promotion, leaving the previous active generation available.

Troubleshooting​

No collection appears​

Only ready collections are shown. Resolve the initial indexing failure or wait for the active generation to finish, then refresh.

A document is missing from the picker​

Search for a term in an indexed field and confirm the document is visible in Search Studio. Source rows that have not been indexed are not selectable.

The draft has a revision conflict​

Another session saved a newer draft. Reload, review the latest state, reapply the intended change, and save again. Indexlume does not overwrite concurrent work silently.

Publish or rollback is disabled​

Only owners and administrators can change live relevance. Ask a user with one of those roles to review and publish the saved draft.

A rebuilt collection lacks the rules​

Inspect the failed indexing job and do not promote a physical collection manually. Indexlume treats relevance application as part of promotion and keeps the previous generation active when it fails.

Licensing boundary​

Indexlume's original application code and documentation owned by Junaid Tariq are Apache-2.0 licensed. Typesense Server remains independently GPL-3.0 licensed. Relevance Studio uses Typesense APIs and does not change or relicense Typesense.