@scenario-labs/sdk 2.7.0 → 3.1.0

package/resources/models/examples.d.ts

@@ -166,6 +166,13 @@ export declare namespace ExampleUpdateResponse {
              * Contains the assetId and the url of the preview.
              */
             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.
              *
@@ -737,11 +744,11 @@ export declare namespace ExampleUpdateResponse {
                     /**
                      * Camera eye position in the splat's world frame.
                      */
-                    position: Array<unknown>;
+                    position: Array<number>;
                     /**
                      * Look-at point in the splat's world frame.
                      */
-                    target: Array<unknown>;
+                    target: Array<number>;
                     /**
                      * Vertical field of view in degrees (defaults to 50 in the renderer).
                      */
@@ -781,6 +788,121 @@ export declare namespace ExampleUpdateResponse {
                 assetId: string;
                 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`.
+             */
+            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';
+            }
+            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).
+                 */
+                interface Details {
+                    /**
+                     * Always-on generic AI-quality dimension
+                     */
+                    aiQuality: Details.AIQuality;
+                    /**
+                     * Brief-compliance dimension; omitted when no brief applied
+                     */
+                    briefCompliance?: Details.BriefCompliance;
+                }
+                namespace Details {
+                    /**
+                     * Always-on generic AI-quality dimension
+                     */
+                    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
+                     */
+                    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.
              *
@@ -1743,6 +1865,26 @@ export declare namespace ExampleUpdateResponse {
             interface Billing {
                 cuCost: number;
                 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.
@@ -1750,6 +1892,31 @@ export declare namespace ExampleUpdateResponse {
                  */
                 disableRefund?: boolean;
             }
+            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.
+                 */
+                interface CuCostDetails {
+                    'ip-detection'?: number;
+                    'slop-detection'?: number;
+                }
+            }
         }
     }
 }
@@ -1908,6 +2075,13 @@ export declare namespace ExampleListResponse {
              * Contains the assetId and the url of the preview.
              */
             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.
              *
@@ -2479,11 +2653,11 @@ export declare namespace ExampleListResponse {
                     /**
                      * Camera eye position in the splat's world frame.
                      */
-                    position: Array<unknown>;
+                    position: Array<number>;
                     /**
                      * Look-at point in the splat's world frame.
                      */
-                    target: Array<unknown>;
+                    target: Array<number>;
                     /**
                      * Vertical field of view in degrees (defaults to 50 in the renderer).
                      */
@@ -2523,6 +2697,121 @@ export declare namespace ExampleListResponse {
                 assetId: string;
                 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`.
+             */
+            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';
+            }
+            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).
+                 */
+                interface Details {
+                    /**
+                     * Always-on generic AI-quality dimension
+                     */
+                    aiQuality: Details.AIQuality;
+                    /**
+                     * Brief-compliance dimension; omitted when no brief applied
+                     */
+                    briefCompliance?: Details.BriefCompliance;
+                }
+                namespace Details {
+                    /**
+                     * Always-on generic AI-quality dimension
+                     */
+                    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
+                     */
+                    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.
              *
@@ -3485,6 +3774,26 @@ export declare namespace ExampleListResponse {
             interface Billing {
                 cuCost: number;
                 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.
@@ -3492,6 +3801,31 @@ export declare namespace ExampleListResponse {
                  */
                 disableRefund?: boolean;
             }
+            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.
+                 */
+                interface CuCostDetails {
+                    'ip-detection'?: number;
+                    'slop-detection'?: number;
+                }
+            }
         }
     }
 }
@@ -3505,12 +3839,22 @@ 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 {
     /**
      * 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 {
     export { type ExampleUpdateResponse as ExampleUpdateResponse, type ExampleListResponse as ExampleListResponse, type ExampleUpdateParams as ExampleUpdateParams, type ExampleListParams as ExampleListParams, };