feat(nodes): move output metadata to BaseInvocationOutput

Author: psychedelicious

invokeai/app/invocations/baseinvocation.py

@@ -25,7 +25,7 @@
 )
 
 import semver
-from pydantic import BaseModel, ConfigDict, Field, TypeAdapter, create_model
+from pydantic import BaseModel, ConfigDict, Field, JsonValue, TypeAdapter, create_model
 from pydantic.fields import FieldInfo
 from pydantic_core import PydanticUndefined
 
@@ -100,6 +100,12 @@ class BaseInvocationOutput(BaseModel):
     All invocation outputs must use the `@invocation_output` decorator to provide their unique type.
     """
 
+    output_meta: Optional[dict[str, JsonValue]] = Field(
+        default=None,
+        description="Optional dictionary of metadata for the invocation output, unrelated to the invocation's actual output value. This is not exposed as an output field.",
+        json_schema_extra={"field_kind": FieldKind.NodeAttribute},
+    )
+
     @staticmethod
     def json_schema_extra(schema: dict[str, Any], model_class: Type[BaseInvocationOutput]) -> None:
         """Adds various UI-facing attributes to the invocation output's OpenAPI schema."""
@@ -235,12 +241,6 @@ def invoke_internal(self, context: InvocationContext, services: "InvocationServi
         json_schema_extra={"field_kind": FieldKind.NodeAttribute},
     )
 
-    output_metadata: Optional[dict[str, Any]] = Field(
-        default=None,
-        description="Optional metadata dictionary for the invocation",
-        json_schema_extra={"field_kind": FieldKind.NodeAttribute},
-    )
-
     UIConfig: ClassVar[UIConfigBase]
 
     model_config = ConfigDict(
@@ -360,12 +360,11 @@ def get_output_types(cls) -> Iterable[str]:
     "use_cache",
     "type",
     "workflow",
-    "output_metadata",
 }
 
 RESERVED_INPUT_FIELD_NAMES = {"metadata", "board"}
 
-RESERVED_OUTPUT_FIELD_NAMES = {"type"}
+RESERVED_OUTPUT_FIELD_NAMES = {"type", "output_meta"}
 
 
 class _Model(BaseModel):

invokeai/app/util/custom_openapi.py

@@ -61,6 +61,10 @@ def openapi() -> dict[str, Any]:
         # We need to manually add all outputs to the schema - pydantic doesn't add them because they aren't used directly.
         for output in InvocationRegistry.get_output_classes():
             json_schema = output.model_json_schema(mode="serialization", ref_template="#/components/schemas/{model}")
+            # Remove output_metadata that is only used on back-end from the schema
+            if "output_meta" in json_schema["properties"]:
+                json_schema["properties"].pop("output_meta")
+
             move_defs_to_top_level(openapi_schema, json_schema)
             openapi_schema["components"]["schemas"][output.__name__] = json_schema
 
@@ -70,9 +74,6 @@ def openapi() -> dict[str, Any]:
             json_schema = invocation.model_json_schema(
                 mode="serialization", ref_template="#/components/schemas/{model}"
             )
-            # Remove output_metadata that is only used on back-end from the schema
-            if "output_metadata" in json_schema["properties"]:
-                json_schema["properties"].pop("output_metadata")
             move_defs_to_top_level(openapi_schema, json_schema)
             output_title = invocation.get_output_annotation().__name__
             outputs_ref = {"$ref": f"#/components/schemas/{output_title}"}