Change SDK to use cai_add_default_manifest instead of sign_with_cai

This commit also updates the usage of the proto enums relating to CAI.

Author: Richard Kennedy

src/stability_sdk/api.py

@@ -122,7 +122,7 @@ def generate(
         guidance_strength: float = 0.0,
         preset: Optional[str] = None,
         return_request: bool = False,
-        sign_with_cai: bool = False,
+        cai_add_default_manifest: bool = False,
     ) -> Dict[int, List[Any]]:
         """
         Generate an image from a set of weighted prompts.
@@ -165,7 +165,7 @@ def generate(
         start_schedule = 1.0 - init_strength
         image_params = self._build_image_params(width, height, sampler, steps, seed, samples, cfg_scale, 
                                                 start_schedule, init_noise_scale, masked_area_init, 
-                                                guidance_preset, guidance_cuts, guidance_strength, sign_with_cai)
+                                                guidance_preset, guidance_cuts, guidance_strength, cai_add_default_manifest)
 
         extras = Struct()
         if preset and preset.lower() != 'none':
@@ -236,7 +236,7 @@ def inpaint(
         start_schedule = 1.0-init_strength
         image_params = self._build_image_params(width, height, sampler, steps, seed, samples, cfg_scale, 
                                                 start_schedule, init_noise_scale, masked_area_init, 
-                                                guidance_preset, guidance_cuts, guidance_strength, sign_with_cai=False)
+                                                guidance_preset, guidance_cuts, guidance_strength, cai_add_default_manifest=False)
 
         extras = Struct()
         if preset and preset.lower() != 'none':
@@ -539,7 +539,7 @@ def _adjust_request_for_retry(self, request: generation.Request, attempt: int):
 
     def _build_image_params(self, width, height, sampler, steps, seed, samples, cfg_scale, 
                             schedule_start, init_noise_scale, masked_area_init, 
-                            guidance_preset, guidance_cuts, guidance_strength, sign_with_cai):
+                            guidance_preset, guidance_cuts, guidance_strength, cai_add_default_manifest):
 
         if not seed:
             seed = [random.randrange(0, 4294967295)]
@@ -571,10 +571,10 @@ def _build_image_params(self, width, height, sampler, steps, seed, samples, cfg_
             )
         # empty CAI Parameters will result in images not being signed by the CAI server
         caip = generation.CAIParameters()
-        if sign_with_cai:
+        if cai_add_default_manifest:
             caip = generation.CAIParameters(
                 model_metadata=generation._CAIPARAMETERS_MODELMETADATA.values_by_name[
-                    'SIGN_WITH_ENGINE_ID'].number)
+                    'MODEL_METADATA_SIGN_WITH_ENGINE_ID'].number)
 
         return generation.ImageParameters(
             transform=None if sampler is None else generation.TransformType(diffusion=sampler),

src/stability_sdk/client.py

@@ -499,7 +499,7 @@ def process_cli(logger: logging.Logger = None,
         "--width", "-W", type=int, default=512, help="[512] width of image"
     )
     parser_generate.add_argument(
-        "--sign_with_cai", type=bool, default=False, help="Sign artifacts using C2PA to include providence data containing engine id"
+        "--cai_add_default_manifest", type=bool, default=False, help="Attatch a signed manifest to artifacts using C2PA. The default manifest will contain engine id and publisher name (Stability AI)"
     )
     parser_generate.add_argument(
         "--start_schedule",
@@ -634,7 +634,7 @@ def process_cli(logger: logging.Logger = None,
             "samples": args.num_samples,
             "init_image": args.init_image,
             "mask_image": args.mask_image,
-            "sign_with_cai": args.sign_with_cai,
+            "cai_add_default_manifest": args.cai_add_default_manifest,
         }
 
         if args.sampler:

src/stability_sdk/interfaces

@@ -103,17 +103,17 @@ def test_api_generate_cai_signing_set():
     class CAIMockStub(MockStub):
         def Generate(self, request: generation.Request, **kwargs) -> Generator[generation.Answer, None, None]:
             assert request.image.cai_parameters.model_metadata == \
-                generation._CAIPARAMETERS_MODELMETADATA.values_by_name['SIGN_WITH_ENGINE_ID'].number
+                generation._CAIPARAMETERS_MODELMETADATA.values_by_name['MODEL_METADATA_SIGN_WITH_ENGINE_ID'].number
             return super().Generate(request, **kwargs)
     api = Context(stub=CAIMockStub())
     width, height = 512, 768
-    results = api.generate(prompts=["foo bar"], weights=[1.0], width=width, height=height, sign_with_cai=True)
+    results = api.generate(prompts=["foo bar"], weights=[1.0], width=width, height=height, cai_add_default_manifest=True)
 
 def test_api_generate_cai_signing_unset():
     class CAIMockStub(MockStub):
         def Generate(self, request: generation.Request, **kwargs) -> Generator[generation.Answer, None, None]:
             assert request.image.cai_parameters.model_metadata == \
-                generation._CAIPARAMETERS_MODELMETADATA.values_by_name['METADATA_UNSPECIFIED'].number
+                generation._CAIPARAMETERS_MODELMETADATA.values_by_name['MODEL_METADATA_UNSPECIFIED'].number
             return super().Generate(request, **kwargs)
     api = Context(stub=CAIMockStub())
     width, height = 512, 768