MAINT: Updating backend to use registry to create converters (microsoft#2112)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: rlundeen2

frontend/src/components/Chat/ChatWindow.test.tsx

@@ -2247,9 +2247,9 @@ describe("ChatWindow Integration", () => {
           parameters: [
             {
               name: "encoding_func",
-              type_name: "Literal['b64encode', 'urlsafe_b64encode']",
+              type_name: "str",
               required: false,
-              default_value: "b64encode",
+              default: "b64encode",
               choices: ["b64encode", "urlsafe_b64encode"],
             },
           ],

frontend/src/components/Chat/ConverterPanel.test.tsx

@@ -37,7 +37,7 @@ const MOCK_CATALOG = {
       supported_input_types: ['text'],
       supported_output_types: ['text'],
       parameters: [
-        { name: 'caesar_offset', type_name: 'int', required: true, default_value: null, choices: null, description: 'Offset value.' },
+        { name: 'caesar_offset', type_name: 'int', required: true, default: null, choices: null, description: 'Offset value.' },
       ],
       is_llm_based: false,
       description: 'Caesar cipher encoding.',
@@ -63,7 +63,7 @@ const MOCK_CATALOG = {
       supported_input_types: ['text'],
       supported_output_types: ['text'],
       parameters: [
-        { name: 'uppercase', type_name: 'bool', required: false, default_value: 'false', choices: null, description: 'Use uppercase.' },
+        { name: 'uppercase', type_name: 'bool', required: false, default: 'false', choices: null, description: 'Use uppercase.' },
       ],
       is_llm_based: false,
       description: 'Bool param test.',
@@ -73,7 +73,7 @@ const MOCK_CATALOG = {
       supported_input_types: ['text'],
       supported_output_types: ['text'],
       parameters: [
-        { name: 'mode', type_name: 'str', required: false, default_value: 'fast', choices: ['fast', 'slow'], description: 'Speed mode.' },
+        { name: 'mode', type_name: 'str', required: false, default: 'fast', choices: ['fast', 'slow'], description: 'Speed mode.' },
       ],
       is_llm_based: false,
       description: 'Choice param test.',
@@ -83,7 +83,7 @@ const MOCK_CATALOG = {
       supported_input_types: ['text'],
       supported_output_types: ['text'],
       parameters: [
-        { name: 'template_file_path', type_name: 'str', required: false, default_value: null, choices: null, description: 'Path to template.' },
+        { name: 'template_file_path', type_name: 'str', required: false, default: null, choices: null, description: 'Path to template.' },
       ],
       is_llm_based: false,
       description: 'File path param test.',
@@ -773,7 +773,7 @@ describe('ConverterPanel edge cases', () => {
     expect(screen.getByTestId('converter-tab-custom_type')).toBeInTheDocument()
   })
 
-  it('handles converters with Optional[bool] param type', async () => {
+  it('handles optional bool params (rendered as a bool Switch)', async () => {
     const catalogWithOptionalBool = {
       items: [
         ...MOCK_CATALOG.items,
@@ -782,7 +782,7 @@ describe('ConverterPanel edge cases', () => {
           supported_input_types: ['text'],
           supported_output_types: ['text'],
           parameters: [
-            { name: 'flag', type_name: 'Optional[bool]', required: false, default_value: 'true', choices: null, description: 'Optional bool.' },
+            { name: 'flag', type_name: 'bool', required: false, default: 'true', choices: null, description: 'Optional bool.' },
           ],
           is_llm_based: false,
           description: 'Optional bool param test.',
@@ -795,7 +795,7 @@ describe('ConverterPanel edge cases', () => {
     await waitForList()
     await openComboboxAndSelect('OptBoolConverter')
 
-    // Should render a Switch (not a text input) for Optional[bool] (line 410-416)
+    // An Optional[bool] constructor param surfaces as type_name 'bool', so it renders a Switch (not a text input).
     const switchEl = screen.getByTestId('param-flag')
     expect(switchEl).toBeInTheDocument()
   })
@@ -808,7 +808,7 @@ describe('ConverterPanel edge cases', () => {
           supported_input_types: ['text'],
           supported_output_types: ['text'],
           parameters: [
-            { name: 'config_file_path', type_name: 'str', required: true, default_value: null, choices: null, description: 'Config file path.' },
+            { name: 'config_file_path', type_name: 'str', required: true, default: null, choices: null, description: 'Config file path.' },
           ],
           is_llm_based: true,
           description: 'Required file param test.',

frontend/src/components/Chat/ConverterPanel/ConverterPanel.tsx

@@ -166,8 +166,8 @@ export default function ConverterPanel({ onClose, previewText = '', attachmentDa
     const newConverter = converters.find((c) => c.converter_type === type)
     const defaults: Record<string, string> = {}
     for (const p of newConverter?.parameters ?? []) {
-      if (p.default_value != null) {
-        defaults[p.name] = p.default_value
+      if (p.default != null) {
+        defaults[p.name] = p.default
       }
     }
     setParamValues(defaults)

frontend/src/components/Chat/ConverterPanel/ConverterParams.tsx

@@ -1,10 +1,10 @@
 import { Button, Input, Select, Switch, Text, Tooltip } from '@fluentui/react-components'
 import { ChevronDownRegular, ChevronRightRegular, InfoRegular } from '@fluentui/react-icons'
-import type { ConverterCatalogEntry, ConverterParameterSchema } from '../../../types'
+import type { ConverterCatalogEntry, Parameter } from '../../../types'
 import { useConverterPanelStyles } from './ConverterPanel.styles'
 
 interface ParamInputProps {
-  param: ConverterParameterSchema
+  param: Parameter
   value: string
   isMissing: boolean
   onChange: (name: string, value: string) => void
@@ -13,7 +13,7 @@ interface ParamInputProps {
 function ConverterParameterChoiceViewer({ param, value, onChange }: ParamInputProps) {
   return (
     <Select
-      value={value ?? param.default_value ?? ''}
+      value={value ?? param.default ?? ''}
       onChange={(_, data) => onChange(param.name, data.value)}
       data-testid={`param-${param.name}`}
     >
@@ -33,7 +33,7 @@ function ParameterFileViewer({ param, value, isMissing, onChange, onBrowse }: Pa
     <div className={styles.filePickerRow}>
       <Input
         value={value ?? ''}
-        placeholder={param.default_value ?? 'Select a file...'}
+        placeholder={param.default ?? 'Select a file...'}
         onChange={(_, data) => onChange(param.name, data.value)}
         className={isMissing ? styles.paramInputError : undefined}
         data-testid={`param-${param.name}`}
@@ -56,7 +56,7 @@ function ConverterParameterViewer({ param, value, isMissing, onChange }: ParamIn
   return (
     <Input
       value={value ?? ''}
-      placeholder={param.default_value ?? undefined}
+      placeholder={param.default ?? undefined}
       onChange={(_, data) => onChange(param.name, data.value)}
       className={isMissing ? styles.paramInputError : undefined}
       data-testid={`param-${param.name}`}
@@ -103,11 +103,11 @@ export default function ConverterParams({ converter, paramValues, paramsExpanded
                 </Tooltip>
               )}
             </span>
-            {param.type_name === 'bool' || param.type_name === 'Optional[bool]' ? (
+            {param.type_name === 'bool' ? (
               <Switch
-                checked={(paramValues[param.name] ?? param.default_value ?? 'false').toLowerCase() === 'true'}
+                checked={(paramValues[param.name] ?? param.default ?? 'false').toLowerCase() === 'true'}
                 onChange={(_, data) => onParamChange(param.name, data.checked ? 'true' : 'false')}
-                label={(paramValues[param.name] ?? param.default_value ?? 'false').toLowerCase() === 'true' ? 'True' : 'False'}
+                label={(paramValues[param.name] ?? param.default ?? 'false').toLowerCase() === 'true' ? 'True' : 'False'}
                 data-testid={`param-${param.name}`}
               />
             ) : param.choices ? (
@@ -120,8 +120,8 @@ export default function ConverterParams({ converter, paramValues, paramsExpanded
             {isMissing && (
               <Text size={100} className={styles.paramErrorText}>Required</Text>
             )}
-            {param.type_name !== 'bool' && param.type_name !== 'Optional[bool]' && !param.choices && (
-              <Text size={100} className={styles.hintText}>{param.type_name.replace(/^Optional\[(.+)\]$/, '$1')}</Text>
+            {param.type_name !== 'bool' && !param.choices && (
+              <Text size={100} className={styles.hintText}>{param.type_name}</Text>
             )}
           </div>
         )

frontend/src/types/index.ts

@@ -100,34 +100,41 @@ export interface CreateTargetRequest {
 
 // --- Converters ---
 
+export interface ConverterIdentifier {
+  class_name: string
+  class_module: string
+  hash: string
+  pyrit_version: string
+  supported_input_types?: string[] | null
+  supported_output_types?: string[] | null
+  // Converter-specific constructor params are inlined at the top level.
+  [key: string]: unknown
+}
+
 export interface ConverterInstance {
   converter_id: string
-  converter_type: string
-  display_name?: string | null
-  supported_input_types: string[]
-  supported_output_types: string[]
-  converter_specific_params?: Record<string, unknown> | null
-  sub_converter_ids?: string[] | null
+  identifier: ConverterIdentifier
 }
 
 export interface ConverterListResponse {
   items: ConverterInstance[]
 }
 
-export interface ConverterParameterSchema {
+export interface Parameter {
   name: string
   type_name: string
   required: boolean
-  default_value?: string | null
+  default?: string | null
   choices?: string[] | null
+  is_list?: boolean
   description?: string | null
 }
 
 export interface ConverterCatalogEntry {
   converter_type: string
   supported_input_types: string[]
   supported_output_types: string[]
-  parameters: ConverterParameterSchema[]
+  parameters: Parameter[]
   is_llm_based: boolean
   description?: string | null
 }

pyrit/backend/mappers/converter_mappers.py

@@ -4,54 +4,33 @@
 """
 Converter mappers – domain → DTO translation for converter-related models.
 
-Identity vs. presentation:
-``ConverterIdentifier`` is the typed, lossless
-*identity* projection of a converter's ``ComponentIdentifier``;
-``ConverterInstance`` is the backend *presentation* view (adds ``converter_id``
-binding, ``display_name``, and ``sub_converter_ids``).
+``ConverterInstance`` pairs the registry instance id with the converter's
+``ConverterIdentifier`` — the typed, lossless identity projection of the
+converter's ``ComponentIdentifier`` — which is the single source of truth on the
+wire for the converter's class, supported data types, and constructor params.
 """
 
 from pyrit.backend.models import ConverterInstance
 from pyrit.models import ConverterIdentifier
 from pyrit.prompt_converter import PromptConverter
 
 
-def converter_object_to_instance(
-    converter_id: str,
-    converter_obj: PromptConverter,
-    *,
-    sub_converter_ids: list[str] | None = None,
-) -> ConverterInstance:
+def converter_object_to_instance(converter_id: str, converter_obj: PromptConverter) -> ConverterInstance:
     """
     Build a ConverterInstance DTO from a registry converter object.
 
-    Extracts only the frontend-relevant fields from the internal identifier,
-    avoiding leakage of internal PyRIT core structures.
+    Pairs the registry instance id with the converter's ``ConverterIdentifier``,
+    the typed identity/configuration projection used as the single source of truth
+    on the wire.
 
     Args:
         converter_id: The unique converter instance identifier.
         converter_obj: The domain PromptConverter object from the registry.
-        sub_converter_ids: Optional list of registered converter IDs for sub-converters.
 
     Returns:
-        ConverterInstance DTO with metadata derived from the object.
+        ConverterInstance DTO wrapping the converter's identifier.
     """
-    converter_identifier = ConverterIdentifier.from_component_identifier(converter_obj.get_identifier())
-
-    supported_input = converter_identifier.supported_input_types
-    supported_output = converter_identifier.supported_output_types
-
-    # supported_input/output_types are promoted to typed fields and mirrored into
-    # params; strip them so only converter-specific params remain.
-    promoted_param_names = set(ConverterIdentifier._promoted_param_fields())
-    converter_specific = {k: v for k, v in converter_identifier.params.items() if k not in promoted_param_names} or None
-
     return ConverterInstance(
         converter_id=converter_id,
-        converter_type=converter_identifier.class_name,
-        display_name=None,
-        supported_input_types=list(supported_input) if supported_input else [],
-        supported_output_types=list(supported_output) if supported_output else [],
-        converter_specific_params=converter_specific,
-        sub_converter_ids=sub_converter_ids,
+        identifier=ConverterIdentifier.from_component_identifier(converter_obj.get_identifier()),
     )

pyrit/backend/models/converters.py

@@ -11,14 +11,13 @@
 
 from pydantic import BaseModel, Field
 
-from pyrit.models import PromptDataType
+from pyrit.models import ConverterIdentifier, Parameter, PromptDataType
 
 __all__ = [
     "ConverterCatalogEntry",
     "ConverterCatalogResponse",
     "ConverterInstance",
     "ConverterInstanceListResponse",
-    "ConverterParameterSchema",
     "CreateConverterRequest",
     "CreateConverterResponse",
     "ConverterPreviewRequest",
@@ -32,17 +31,6 @@
 # ============================================================================
 
 
-class ConverterParameterSchema(BaseModel):
-    """Schema for a single converter constructor parameter."""
-
-    name: str = Field(..., description="Parameter name")
-    type_name: str = Field(..., description="Human-readable type (e.g. 'str', 'int', 'Literal[...]')")
-    required: bool = Field(..., description="Whether the parameter must be provided")
-    default_value: str | None = Field(None, description="String representation of default value, if any")
-    choices: list[str] | None = Field(None, description="Allowed values for Literal types")
-    description: str | None = Field(None, description="Parameter description from docstring")
-
-
 class ConverterCatalogEntry(BaseModel):
     """A converter type available from the backend registry."""
 
@@ -53,7 +41,7 @@ class ConverterCatalogEntry(BaseModel):
     supported_output_types: list[str] = Field(
         default_factory=list, description="Output data types produced by this converter type"
     )
-    parameters: list[ConverterParameterSchema] = Field(
+    parameters: list[Parameter] = Field(
         default_factory=list, description="Constructor parameters for dynamic form generation"
     )
     is_llm_based: bool = Field(False, description="Whether this converter requires an LLM target")
@@ -72,23 +60,16 @@ class ConverterCatalogResponse(BaseModel):
 
 
 class ConverterInstance(BaseModel):
-    """A registered converter instance."""
+    """
+    A registered converter instance.
+
+    Pairs the registry instance id with the converter's ``ConverterIdentifier`` —
+    the typed identity/configuration projection that is the single source of truth
+    for the converter's class, supported data types, and constructor params.
+    """
 
     converter_id: str = Field(..., description="Unique converter instance identifier")
-    converter_type: str = Field(..., description="Converter class name (e.g., 'Base64Converter')")
-    display_name: str | None = Field(None, description="Human-readable display name")
-    supported_input_types: list[str] = Field(
-        default_factory=list, description="Input data types supported by this converter"
-    )
-    supported_output_types: list[str] = Field(
-        default_factory=list, description="Output data types produced by this converter"
-    )
-    converter_specific_params: dict[str, Any] | None = Field(
-        None, description="Additional converter-specific parameters"
-    )
-    sub_converter_ids: list[str] | None = Field(
-        None, description="Converter IDs of sub-converters (for pipelines/composites)"
-    )
+    identifier: ConverterIdentifier = Field(..., description="The converter's identity/configuration projection")
 
 
 class ConverterInstanceListResponse(BaseModel):

pyrit/backend/models/initializers.py

@@ -4,9 +4,9 @@
 """
 REST envelopes for the initializer endpoints.
 
-Canonical initializer catalog types (``RegisteredInitializer``,
-``InitializerParameterSummary``) live in ``pyrit.models.catalog.initializer``
-and should be imported from there directly.
+Canonical initializer catalog types (``RegisteredInitializer``) live in
+``pyrit.models.catalog.initializer`` and should be imported from there directly.
+Initializer parameters are described by the shared ``pyrit.models.Parameter``.
 """
 
 from pydantic import BaseModel, Field

pyrit/backend/models/scenarios.py

@@ -5,9 +5,9 @@
 REST envelopes for the scenario endpoints.
 
 Canonical scenario catalog/run types (``RegisteredScenario``,
-``ScenarioParameterSummary``, ``ScenarioRunSummary``, ``RunScenarioRequest``)
-live in ``pyrit.models.catalog.scenario`` and should be imported from there
-directly.
+``ScenarioRunSummary``, ``RunScenarioRequest``) live in
+``pyrit.models.catalog.scenario`` and should be imported from there directly.
+Scenario parameters are described by the shared ``pyrit.models.Parameter``.
 """
 
 from pydantic import BaseModel, Field