Merge pull request #39 from redhat-community-ai-tools/GENIE-1076/story/display-names-instead-of-ids

GENIE-1076/story/display-names-instead-of-ids

Author: MayaCrmi

multi-agent/core/field_hints.py

@@ -25,6 +25,10 @@ class ActionHint(BaseModel):
         ..., 
         description="Name of the action to invoke"
     )
+    display_name: Optional[str] = Field(
+        None,
+        description="Display name for the field in the UI"
+    )
     hint_type: HintType = Field(
         ..., 
         description="Type of hint (populate, validate)"
@@ -33,9 +37,9 @@ class ActionHint(BaseModel):
         None,
         description="Target field in action output for population hints"
     )
-    label_field: Optional[str] = Field(
+    display_field: Optional[str] = Field(
         None,
-        description="Dot-notation path to display label (e.g., 'documents.name')"
+        description="Dot-notation path to display value (e.g., 'name' or 'name.x'). UI stores full object and uses this to display."
     )
     value_field: Optional[str] = Field(
         None,
@@ -96,9 +100,9 @@ class ApiHint(BaseModel):
         None,
         description="Target field in response for validation hints"
     )
-    label_field: Optional[str] = Field(
+    display_field: Optional[str] = Field(
         None,
-        description="Dot-notation path to display label (e.g., 'items.name')"
+        description="Dot-notation path to display value (e.g., 'name' or 'items.name'). UI stores full object and uses this to display."
     )
     value_field: Optional[str] = Field(
         None,

multi-agent/elements/retrievers/docs_dataflow/config.py

@@ -1,4 +1,4 @@
-from typing import Literal, Optional, List
+from typing import Dict, List, Literal, Optional
 from pydantic import Field
 from elements.retrievers.common.base_config import BaseRetrieverConfig
 from core.field_hints import ActionHint, HintType, SelectionType
@@ -31,16 +31,16 @@ class DocsDataflowRetrieverConfig(BaseRetrieverConfig):
         description="Request timeout in seconds"
     )
 
-    doc_ids: Optional[List[str]] = Field(
+    docs: Optional[List[Dict]] = Field(
         default=None,
-        description="Filter results to specific document IDs",
+        description="Filter results to specific documents",
         json_schema_extra=ActionHint(
             action_uid="dataflow.get_available_docs",
+            display_name="documents",
             hint_type=HintType.POPULATE,
             selection_type=SelectionType.MANUAL,
             field_mapping="documents",
-            label_field="name",
-            value_field="id",
+            display_field="name",
             multi_select=True,
             pagination=True,
             search=True,

multi-agent/elements/retrievers/docs_dataflow/docs_dataflow_retriever.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import Dict, List, Optional
 from elements.retrievers.common.base_retriever import BaseRetriever
 from elements.providers.dataflow_client.config import DataflowProviderConfig
 from elements.providers.dataflow_client.dataflow_provider_factory import DataflowProviderFactory
@@ -15,11 +15,11 @@ def __init__(
             top_k_results: int,
             threshold: float,
             timeout: float = 30.0,
-            doc_ids: Optional[List[str]] = None,
+            docs: Optional[List[Dict]] = None,
             tags: Optional[List[str]] = None,
     ):
         self.threshold = threshold
-        self.doc_ids = doc_ids
+        self.docs = docs
         self.tags = tags
         config = DataflowProviderConfig(
             top_k=top_k_results,
@@ -31,11 +31,14 @@ def __init__(
     def retrieve(self, query: str) -> List[dict]:
         context = get_current_context()
 
+        # Extract document IDs from docs list
+        doc_ids = [doc['id'] for doc in self.docs] if self.docs else None
+
         response = self._provider.query(
             query=query,
             scope=context.scope,
             logged_in_user=context.logged_in_user,
-            doc_ids=self.doc_ids,
+            doc_ids=doc_ids,
             tags=self.tags,
         )
 

multi-agent/elements/retrievers/docs_dataflow/docs_dataflow_retriever_factory.py

@@ -20,7 +20,7 @@ def create(self, cfg: DocsDataflowRetrieverConfig, **kwargs: Any) -> DocsDataflo
                 top_k_results=cfg.top_k_results,
                 threshold=cfg.threshold,
                 timeout=cfg.timeout,
-                doc_ids=cfg.doc_ids,
+                docs=cfg.docs,
                 tags=cfg.tags,
             )
         except Exception as e:

scripts/migrate_doc_ids.py

@@ -0,0 +1,161 @@
+#!/usr/bin/env python3
+"""
+Migration Script: Convert doc_ids field from string array to object array,
+and rename the field from doc_ids to docs.
+
+Old:
+    doc_ids: ["id1", "id2"]
+
+New:
+    docs: [{"id": "id1", "name": "Document 1"}, ...]
+"""
+
+import argparse
+import sys
+import json
+import os
+from datetime import datetime
+from typing import List, Dict
+import pymongo
+
+
+# ────────────────────────────────────────────────────────────────
+# Config
+# ────────────────────────────────────────────────────────────────
+
+MONGODB_IP = os.environ.get("MONGODB_IP", "localhost")
+MONGODB_PORT = os.environ.get("MONGODB_PORT", "27017")
+
+RETRIEVERS_DB = "UnifAI"
+SOURCES_DB = "data_sources"
+
+RETRIEVERS_COLLECTION = "resources"
+SOURCES_COLLECTION = "sources"
+
+RETRIEVER_TYPE = "docs_dataflow"
+CATEGORY = "retrievers"
+
+
+# ────────────────────────────────────────────────────────────────
+# Helpers
+# ────────────────────────────────────────────────────────────────
+
+def needs_migration(cfg: dict) -> bool:
+    # Needs migration if doc_ids field exists (should be renamed to docs)
+    if "doc_ids" in cfg:
+        return True
+    return False
+
+
+def convert_doc_ids(old: list, docs_map: dict) -> list:
+    out = []
+    for d in old or []:
+        if isinstance(d, str):
+            out.append({"id": d, "name": docs_map.get(d, d)})
+        elif isinstance(d, dict) and "id" in d:
+            if "name" not in d:
+                d["name"] = docs_map.get(d["id"], d["id"])
+            out.append(d)
+    return out
+
+
+# ────────────────────────────────────────────────────────────────
+# Migration
+# ────────────────────────────────────────────────────────────────
+
+def migrate(dry_run: bool):
+    client = pymongo.MongoClient(f"mongodb://{MONGODB_IP}:{MONGODB_PORT}/")
+
+    retrievers_db = client[RETRIEVERS_DB]
+    sources_db = client[SOURCES_DB]
+
+    retrievers = retrievers_db[RETRIEVERS_COLLECTION]
+    sources = sources_db[SOURCES_COLLECTION]
+
+    query = {"category": CATEGORY, "type": RETRIEVER_TYPE}
+    resources = list(retrievers.find(query))
+
+    print(f"Found {len(resources)} retrievers")
+
+    needed_ids = set()
+    for r in resources:
+        if needs_migration(r.get("cfg_dict", {})):
+            doc_ids = r.get("cfg_dict", {}).get("doc_ids") or []
+            for d in doc_ids:
+                if isinstance(d, str):
+                    needed_ids.add(d)
+
+    docs_map = {}
+    if needed_ids:
+        print(f"Need to resolve {len(needed_ids)} doc_ids")
+        for src in sources.find(
+            {"source_id": {"$in": list(needed_ids)}},
+            {"source_id": 1, "source_name": 1}
+        ):
+            docs_map[src["source_id"]] = src.get("source_name", src["source_id"])
+
+    stats = {"checked": 0, "migrated": 0, "skipped": 0}
+
+    for r in resources:
+        stats["checked"] += 1
+        rid = r.get("rid", r["_id"])
+        name = r.get("name", "unnamed")
+        cfg = r.get("cfg_dict", {})
+
+        print(f"\n[{rid}] {name}")
+
+        if not needs_migration(cfg):
+            print("  Skipped")
+            stats["skipped"] += 1
+            continue
+
+        old_ids = cfg.get("doc_ids", [])
+        new_docs = convert_doc_ids(old_ids, docs_map)
+
+        print(f"  Old doc_ids: {old_ids}")
+        print(f"  New docs: {new_docs}")
+
+        if dry_run:
+            print("  [DRY RUN] Would update (rename doc_ids -> docs)")
+            stats["migrated"] += 1
+            continue
+
+        retrievers.update_one(
+            {"_id": r["_id"]},
+            {
+                "$set": {"cfg_dict.docs": new_docs, "updated": datetime.utcnow()},
+                "$unset": {"cfg_dict.doc_ids": ""}
+            }
+        )
+
+        print("  ✓ Migrated")
+        stats["migrated"] += 1
+
+    client.close()
+    return stats
+
+
+# ────────────────────────────────────────────────────────────────
+# Main
+# ────────────────────────────────────────────────────────────────
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--apply", action="store_true")
+    args = parser.parse_args()
+    dry_run = not args.apply
+
+    if dry_run:
+        print("\n*** DRY RUN MODE ***\n")
+
+    stats = migrate(dry_run)
+
+    print("\nSummary")
+    print(stats)
+
+    if dry_run:
+        print("\nRun with --apply to commit changes.")
+
+
+if __name__ == "__main__":
+    main()

ui/client/src/components/agentic-ai/workspace/ElementData.tsx

@@ -4,6 +4,7 @@ import { Badge } from "@/components/ui/badge";
 import { FileText } from 'lucide-react';
 import { ElementInstance, ElementType, ElementSchema } from '../../../types/workspace';
 import { maskSecretFieldsInConfig } from '../../../utils/maskSecretFields';
+import { simplifyConfigForDisplay } from '../../../utils/displayUtils';
 import { useAgenticAI } from '@/contexts/AgenticAIContext';
 
 interface ElementDataProps {
@@ -28,9 +29,9 @@ export const ElementData: React.FC<ElementDataProps> = ({
     return getResourceName(ref);
   });
 
-  // Resolve refs in config for display
+  // Resolve refs in config for display, then simplify object arrays to just names
   const configWithResolvedRefs = element?.config 
-    ? resolveRefsInConfig(element.config)
+    ? simplifyConfigForDisplay(resolveRefsInConfig(element.config))
     : null;
 
   return (

ui/client/src/components/agentic-ai/workspace/ElementForm.tsx

@@ -78,15 +78,22 @@ export const ElementForm: React.FC<ElementFormProps> = ({
     });
   };
 
-  const handlePopulateResult = (fieldName: string, results: string[] | any, multiSelect: boolean) => {
+  const handlePopulateResult = (fieldName: string, results: any[], multiSelect: boolean) => {
     setPopulateResults(prev => ({
       ...prev,
       [fieldName]: results
     }));
 
-    // For multi-select, set the array of selected values
-    // For single select, set the first (and only) selected value
-    handleInputChange(fieldName, multiSelect || typeof results === 'object' ? results : results.length > 0 ? results[0] : "");
+    // For multi-select fields, store the full array of objects (or strings)
+    // For single select, store just the first item (can be object or string)
+    if (multiSelect) {
+      // Multi-select: always store as array
+      handleInputChange(fieldName, results);
+    } else {
+      // Single select: store single item (first in array, or empty string)
+      const singleResult = results.length > 0 ? results[0] : "";
+      handleInputChange(fieldName, singleResult);
+    }
   };
 
 

ui/client/src/components/agentic-ai/workspace/ElementGrid.tsx

@@ -22,6 +22,7 @@ import { ElementValidationResult } from '../../../types/validation';
 import { ElementData } from './ElementData';
 import { ValidationResultModal } from './ValidationResultModal';
 import { formatConfigValue } from '../../../utils/maskSecretFields';
+import { getDisplayValueFromItem } from '../../../utils/displayUtils';
 
 interface ElementGridProps {
   elements: ElementInstance[];
@@ -224,8 +225,8 @@ export const ElementGrid: React.FC<ElementGridProps> = ({
                         const fieldSchema = elementSchema?.config_schema?.properties?.[key];
                         const rawValue = element.config[key];
                         const displayValue = Array.isArray(rawValue)
-                          ? rawValue.map((item: any) => getResourceName(item)).join(', ')
-                          : getResourceName(rawValue);
+                          ? rawValue.map((item: any) => getDisplayValueFromItem(item, getResourceName)).join(', ')
+                          : getDisplayValueFromItem(rawValue, getResourceName);
                         return (
                           <div key={key} className="flex justify-between">
                             <span className="truncate">{key}:</span>