Data Services Annotations

Data Services Query API
1

The Query API Documentation states that:

Model Migration

  1. All annotations enable_approximate_match_search and enable_case_insensitive_search must be replaced with the indexed annotation, without any value.
  1. Will this be automatically covered by Model Migration in the SME?
  2. Will the old annotations be removed?
  3. Will the display of String Fields in the Filter as a Multi-Select (A12-13607) for which enable_approximate_match_search is also used still be supported?
2

Hi @malcolm-silver-ice,

Annotations enable_approximate_match_search and enable_case_insensitive_search will no longer be needed, therefore we need to create a way how to migrate them, but I do not know what is the migration path for removing unnecessary annotations in A12. It is not DM migration topic because the DM metamodel was not changed. I think having this migration in SME is the only sensible place where to remove these annotations that are no longer needed.
I must say that I do not understand this feature: A12-13607, but we have all features from previous version implemented. I will call you to double-check this one.

3

The usage of annotations for indexing seems to have switched from indexed = true to index a Field and all the data in that column to indexed = false to exclude a Field from the index (A12S-5640).

This seems to make migration of existing workspaces easier as no annotations need to be added or changed to retain the default selection of indexed Fields.

However, if old annotations are removed during migration, the hook for A12-13607 might be lost. The Overview Engine was using this Data Services Annotation to provide a hook for querying the facet terms of a String Field using LIST_DOCUMENTS. Is the Overview Team already working on a solution?

4

Hi @malcolm-silver-ice,
These annotations will no longer be scanned by Data Services. However, Overview Engine’s filter selector on its own still depends on these annotations to keep the functionality of the filtering UI.
At least, for the state of 2025.06, these annotations still remain, Overview Engine will include a documentation about these annotations in A12-16954.

Therefore, there is NO migration needed for these annotations in 2025.06, we would also expect the previous behavior to be kept as-is. This may change in the upcoming releases, when Overview Engine reworks the filter selectors to expose more Query API functionalities to modelers/endusers.

5

Thanks for the update @tri-sheer-boulder