@scenario-labs/sdk 2.6.0 → 3.0.0

package/src/resources/models/examples.ts

@@ -14,9 +14,9 @@ export class Examples extends APIResource {
     params: ExampleUpdateParams,
     options?: RequestOptions,
   ): APIPromise<ExampleUpdateResponse> {
-    const { originalAssets, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.put(path`/models/${modelID}/examples`, {
-      query: { originalAssets },
+      query: { originalAssets, projectId },
       body,
       ...options,
     });
@@ -313,6 +313,14 @@ export namespace ExampleUpdateResponse {
        */
       preview?: Asset.Preview;
 
+      /**
+       * SlopGuard detection result, computed asynchronously after generation.
+       *
+       * `details` (the per-dimension reasons and suggestions) is returned only when the
+       * asset is read with `withSlopGuardDetails=true`.
+       */
+      slopGuard?: Asset.SlopGuard;
+
       /**
        * The asset's thumbnail.
        *
@@ -1229,6 +1237,140 @@ export namespace ExampleUpdateResponse {
         url: string;
       }
 
+      /**
+       * SlopGuard detection result, computed asynchronously after generation.
+       *
+       * `details` (the per-dimension reasons and suggestions) is returned only when the
+       * asset is read with `withSlopGuardDetails=true`.
+       */
+      export interface SlopGuard {
+        /**
+         * ISO-8601 timestamp of when scoring ran
+         */
+        computedAt: string;
+
+        /**
+         * Whether scoring succeeded or errored
+         */
+        status: 'error' | 'scored';
+
+        /**
+         * Rubric/model version that produced this result
+         */
+        version: string;
+
+        /**
+         * Generic AI-quality sub-score
+         */
+        aiQualityScore?: number;
+
+        /**
+         * Ids of briefs that contributed
+         */
+        appliedBriefIds?: Array<string>;
+
+        /**
+         * Brief-compliance sub-score (omitted when no brief applied)
+         */
+        briefComplianceScore?: number;
+
+        /**
+         * Per-dimension reasons and suggestions, as produced by the detector.
+         *
+         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * project that owns it — the brief-compliance text paraphrases that project's
+         * brief, so a cross-project read of a public asset gets the summary alone. Also
+         * omitted when the archived verdict is unavailable (asset scored by an older
+         * version, or an unreadable archive).
+         */
+        details?: SlopGuard.Details;
+
+        /**
+         * Error message when status is 'error' (truncated)
+         */
+        error?: string;
+
+        /**
+         * 0–100 composite score (present when status is 'scored')
+         */
+        overallScore?: number;
+
+        /**
+         * Sensitivity used for the verdict
+         */
+        sensitivity?: 'high' | 'low' | 'medium';
+
+        /**
+         * pass / warn / fail (present when status is 'scored')
+         */
+        verdict?: 'fail' | 'pass' | 'warn';
+      }
+
+      export namespace SlopGuard {
+        /**
+         * Per-dimension reasons and suggestions, as produced by the detector.
+         *
+         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * project that owns it — the brief-compliance text paraphrases that project's
+         * brief, so a cross-project read of a public asset gets the summary alone. Also
+         * omitted when the archived verdict is unavailable (asset scored by an older
+         * version, or an unreadable archive).
+         */
+        export interface Details {
+          /**
+           * Always-on generic AI-quality dimension
+           */
+          aiQuality: Details.AIQuality;
+
+          /**
+           * Brief-compliance dimension; omitted when no brief applied
+           */
+          briefCompliance?: Details.BriefCompliance;
+        }
+
+        export namespace Details {
+          /**
+           * Always-on generic AI-quality dimension
+           */
+          export interface AIQuality {
+            /**
+             * Why the image scored as it did
+             */
+            reasons: Array<string>;
+
+            /**
+             * 0–100; higher is better (more compliant / less AI-looking)
+             */
+            score: number;
+
+            /**
+             * Actionable suggestions to improve the score
+             */
+            suggestions: Array<string>;
+          }
+
+          /**
+           * Brief-compliance dimension; omitted when no brief applied
+           */
+          export interface BriefCompliance {
+            /**
+             * Why the image scored as it did
+             */
+            reasons: Array<string>;
+
+            /**
+             * 0–100; higher is better (more compliant / less AI-looking)
+             */
+            score: number;
+
+            /**
+             * Actionable suggestions to improve the score
+             */
+            suggestions: Array<string>;
+          }
+        }
+      }
+
       /**
        * The asset's thumbnail.
        *
@@ -2534,6 +2676,27 @@ export namespace ExampleUpdateResponse {
 
         cuDiscount: number;
 
+        /**
+         * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
+         * top of the generation itself, such as `slop-detection`.
+         *
+         * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
+         * values here.
+         *
+         * Two caveats when displaying it:
+         *
+         * - These are a remaining refundable balance, not a receipt: a job that failed or
+         *   was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
+         *   still shows the main action's original charge.
+         * - `ip-detection` is part of the shape but is never populated today: that fee is
+         *   charged outside the job and reported once, as
+         *   `ipDetection.creativeUnitsCharged`, in the response of the request that ran
+         *   it.
+         *
+         * Absent when the job paid for no add-on.
+         */
+        cuCostDetails?: Billing.CuCostDetails;
+
         /**
          * When true, the credits charged for this job are not automatically refunded if
          * the generation fails, because the model used does not support refund-on-failure.
@@ -2541,6 +2704,33 @@ export namespace ExampleUpdateResponse {
          */
         disableRefund?: boolean;
       }
+
+      export namespace Billing {
+        /**
+         * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
+         * top of the generation itself, such as `slop-detection`.
+         *
+         * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
+         * values here.
+         *
+         * Two caveats when displaying it:
+         *
+         * - These are a remaining refundable balance, not a receipt: a job that failed or
+         *   was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
+         *   still shows the main action's original charge.
+         * - `ip-detection` is part of the shape but is never populated today: that fee is
+         *   charged outside the job and reported once, as
+         *   `ipDetection.creativeUnitsCharged`, in the response of the request that ran
+         *   it.
+         *
+         * Absent when the job paid for no add-on.
+         */
+        export interface CuCostDetails {
+          'ip-detection'?: number;
+
+          'slop-detection'?: number;
+        }
+      }
     }
   }
 }
@@ -2824,6 +3014,14 @@ export namespace ExampleListResponse {
        */
       preview?: Asset.Preview;
 
+      /**
+       * SlopGuard detection result, computed asynchronously after generation.
+       *
+       * `details` (the per-dimension reasons and suggestions) is returned only when the
+       * asset is read with `withSlopGuardDetails=true`.
+       */
+      slopGuard?: Asset.SlopGuard;
+
       /**
        * The asset's thumbnail.
        *
@@ -3740,6 +3938,140 @@ export namespace ExampleListResponse {
         url: string;
       }
 
+      /**
+       * SlopGuard detection result, computed asynchronously after generation.
+       *
+       * `details` (the per-dimension reasons and suggestions) is returned only when the
+       * asset is read with `withSlopGuardDetails=true`.
+       */
+      export interface SlopGuard {
+        /**
+         * ISO-8601 timestamp of when scoring ran
+         */
+        computedAt: string;
+
+        /**
+         * Whether scoring succeeded or errored
+         */
+        status: 'error' | 'scored';
+
+        /**
+         * Rubric/model version that produced this result
+         */
+        version: string;
+
+        /**
+         * Generic AI-quality sub-score
+         */
+        aiQualityScore?: number;
+
+        /**
+         * Ids of briefs that contributed
+         */
+        appliedBriefIds?: Array<string>;
+
+        /**
+         * Brief-compliance sub-score (omitted when no brief applied)
+         */
+        briefComplianceScore?: number;
+
+        /**
+         * Per-dimension reasons and suggestions, as produced by the detector.
+         *
+         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * project that owns it — the brief-compliance text paraphrases that project's
+         * brief, so a cross-project read of a public asset gets the summary alone. Also
+         * omitted when the archived verdict is unavailable (asset scored by an older
+         * version, or an unreadable archive).
+         */
+        details?: SlopGuard.Details;
+
+        /**
+         * Error message when status is 'error' (truncated)
+         */
+        error?: string;
+
+        /**
+         * 0–100 composite score (present when status is 'scored')
+         */
+        overallScore?: number;
+
+        /**
+         * Sensitivity used for the verdict
+         */
+        sensitivity?: 'high' | 'low' | 'medium';
+
+        /**
+         * pass / warn / fail (present when status is 'scored')
+         */
+        verdict?: 'fail' | 'pass' | 'warn';
+      }
+
+      export namespace SlopGuard {
+        /**
+         * Per-dimension reasons and suggestions, as produced by the detector.
+         *
+         * Returned only when the asset is read with `withSlopGuardDetails=true` by the
+         * project that owns it — the brief-compliance text paraphrases that project's
+         * brief, so a cross-project read of a public asset gets the summary alone. Also
+         * omitted when the archived verdict is unavailable (asset scored by an older
+         * version, or an unreadable archive).
+         */
+        export interface Details {
+          /**
+           * Always-on generic AI-quality dimension
+           */
+          aiQuality: Details.AIQuality;
+
+          /**
+           * Brief-compliance dimension; omitted when no brief applied
+           */
+          briefCompliance?: Details.BriefCompliance;
+        }
+
+        export namespace Details {
+          /**
+           * Always-on generic AI-quality dimension
+           */
+          export interface AIQuality {
+            /**
+             * Why the image scored as it did
+             */
+            reasons: Array<string>;
+
+            /**
+             * 0–100; higher is better (more compliant / less AI-looking)
+             */
+            score: number;
+
+            /**
+             * Actionable suggestions to improve the score
+             */
+            suggestions: Array<string>;
+          }
+
+          /**
+           * Brief-compliance dimension; omitted when no brief applied
+           */
+          export interface BriefCompliance {
+            /**
+             * Why the image scored as it did
+             */
+            reasons: Array<string>;
+
+            /**
+             * 0–100; higher is better (more compliant / less AI-looking)
+             */
+            score: number;
+
+            /**
+             * Actionable suggestions to improve the score
+             */
+            suggestions: Array<string>;
+          }
+        }
+      }
+
       /**
        * The asset's thumbnail.
        *
@@ -5045,6 +5377,27 @@ export namespace ExampleListResponse {
 
         cuDiscount: number;
 
+        /**
+         * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
+         * top of the generation itself, such as `slop-detection`.
+         *
+         * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
+         * values here.
+         *
+         * Two caveats when displaying it:
+         *
+         * - These are a remaining refundable balance, not a receipt: a job that failed or
+         *   was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
+         *   still shows the main action's original charge.
+         * - `ip-detection` is part of the shape but is never populated today: that fee is
+         *   charged outside the job and reported once, as
+         *   `ipDetection.creativeUnitsCharged`, in the response of the request that ran
+         *   it.
+         *
+         * Absent when the job paid for no add-on.
+         */
+        cuCostDetails?: Billing.CuCostDetails;
+
         /**
          * When true, the credits charged for this job are not automatically refunded if
          * the generation fails, because the model used does not support refund-on-failure.
@@ -5052,13 +5405,41 @@ export namespace ExampleListResponse {
          */
         disableRefund?: boolean;
       }
+
+      export namespace Billing {
+        /**
+         * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
+         * top of the generation itself, such as `slop-detection`.
+         *
+         * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
+         * values here.
+         *
+         * Two caveats when displaying it:
+         *
+         * - These are a remaining refundable balance, not a receipt: a job that failed or
+         *   was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
+         *   still shows the main action's original charge.
+         * - `ip-detection` is part of the shape but is never populated today: that fee is
+         *   charged outside the job and reported once, as
+         *   `ipDetection.creativeUnitsCharged`, in the response of the request that ran
+         *   it.
+         *
+         * Absent when the job paid for no add-on.
+         */
+        export interface CuCostDetails {
+          'ip-detection'?: number;
+
+          'slop-detection'?: number;
+        }
+      }
     }
   }
 }
 
 export interface ExampleUpdateParams {
   /**
-   * Body param: The list of asset ids to use as examples of the model
+   * Body param: The list of asset ids to use as examples of the model. Maximum of
+   * 150 asset ids.
    */
   assetIds: Array<string>;
 
@@ -5066,6 +5447,12 @@ export interface ExampleUpdateParams {
    * Query param: If set to true, returns the original asset without transformation
    */
   originalAssets?: boolean;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface ExampleListParams {
@@ -5073,6 +5460,12 @@ export interface ExampleListParams {
    * If set to true, returns the original asset without transformation
    */
   originalAssets?: boolean;
+
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export declare namespace Examples {

package/src/resources/models/index.ts

@@ -31,6 +31,7 @@ export {
   type ModelRetrieveParams,
   type ModelUpdateParams,
   type ModelListParams,
+  type ModelDeleteParams,
   type ModelCopyParams,
   type ModelDeleteImagesParams,
   type ModelDownloadParams,