@scenario-labs/sdk 3.0.0 → 3.2.0

package/src/resources/usages.ts

@@ -31,7 +31,7 @@ export interface UsageListResponse {
 
   nsfwUsages?: Array<UsageListResponse.NsfwUsage>;
 
-  slopUsages?: Array<UsageListResponse.SlopUsage>;
+  qualityGateUsages?: Array<UsageListResponse.QualityGateUsage>;
 
   usages?: Array<UsageListResponse.Usage>;
 }
@@ -282,7 +282,7 @@ export namespace UsageListResponse {
 
     /**
      * Compute Units consumed per billing action, when a breakdown is available
-     * (example: `{ "slop-detection": 12 }`). Values are included in `value`.
+     * (example: `{ "quality-gate": 12 }`). Values are included in `value`.
      */
     costDetails?: unknown;
   }
@@ -660,12 +660,12 @@ export namespace UsageListResponse {
           /**
            * 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).
@@ -1028,7 +1028,9 @@ export namespace UsageListResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -1056,8 +1058,9 @@ export namespace UsageListResponse {
             maxDuration?: number;
 
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
 
@@ -1074,8 +1077,9 @@ export namespace UsageListResponse {
             min?: number;
 
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
 
@@ -1255,7 +1259,9 @@ export namespace UsageListResponse {
                * The asset kind of the input. Only taken into account for \`file\` and
                * \`file_array\` input types. If model provides multiple kinds, the input will be
                * not able to create the asset on the flight on API side with dataurl without
-               * data:kind, prefix
+               * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+               * a model does not declare one, \`image\` is returned, which is the kind used at
+               * generation time.
                */
               kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -1283,8 +1289,9 @@ export namespace UsageListResponse {
               maxDuration?: number;
 
               /**
-               * The maximum allowed length for \`string\` inputs. Also applies to each item in
-               * \`string_array\`.
+               * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+               * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+               * ITEMS instead — the length of each item is not constrained.
                */
               maxLength?: number;
 
@@ -1301,8 +1308,9 @@ export namespace UsageListResponse {
               min?: number;
 
               /**
-               * The minimum allowed length for string inputs. Also applies to each item in
-               * \`string_array\`.
+               * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+               * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+               * ITEMS instead — the length of each item is not constrained.
                */
               minLength?: number;
 
@@ -1756,13 +1764,13 @@ export namespace UsageListResponse {
   }
 
   /**
-   * A SlopGuard verdict series: one per bucket (total | pass | warn | fail).
+   * A Quality Gate verdict series: one per bucket (total | pass | warn | fail).
    */
-  export interface SlopUsage {
+  export interface QualityGateUsage {
     /**
      * The data points
      */
-    points: Array<SlopUsage.Point>;
+    points: Array<QualityGateUsage.Point>;
 
     /**
      * The verdict bucket: "total", "pass", "warn", or "fail"
@@ -1770,9 +1778,9 @@ export namespace UsageListResponse {
     verdict: string;
   }
 
-  export namespace SlopUsage {
+  export namespace QualityGateUsage {
     /**
-     * One time-bucket point in a SlopGuard verdict series.
+     * One time-bucket point in a Quality Gate verdict series.
      */
     export interface Point {
       /**
@@ -1885,11 +1893,11 @@ export interface UsageListParams {
 
   /**
    * When set, points whose numeric fields are all zero are removed from `usages`,
-   * `modelUsages`, `assetUsages`, `nsfwUsages` and `slopUsages`. The parent entry
-   * (model, kind, label, usageName) is preserved with `points: []` so callers still
-   * see every row. Useful on wide windows × fine granularities × many models, where
-   * the zero-fill can push the response past the 6 MB API Gateway sync limit. The
-   * bare `?dropZeroPoints` form, plus any value (`true`, `1`, `yes`, `on`, …)
+   * `modelUsages`, `assetUsages`, `nsfwUsages` and `qualityGateUsages`. The parent
+   * entry (model, kind, label, usageName) is preserved with `points: []` so callers
+   * still see every row. Useful on wide windows × fine granularities × many models,
+   * where the zero-fill can push the response past the 6 MB API Gateway sync limit.
+   * The bare `?dropZeroPoints` form, plus any value (`true`, `1`, `yes`, `on`, …)
    * enables it; absent or explicit falsy literals (`false`, `0`, `no`, `off`)
    * disable it. Default disabled for backwards compatibility.
    */
@@ -1914,8 +1922,7 @@ export interface UsageListParams {
   startDate?: string;
 
   /**
-   * The teamId used for ownership resource management. Either to assert ownership or
-   * to set the owner of the resource(s)
+   * The team identifier for usage data. If omitted, the default team will be used.
    */
   teamId?: string;
 
@@ -1928,11 +1935,17 @@ export interface UsageListParams {
   /**
    * The type of the usage data. Can be one or more comma separated values. Can be
    * any of the following values: usages, activity, consumption, model-usages,
-   * asset-usages, nsfw-usages, slop-usages. Default is all types. If bad type or
-   * empty, all types will be returned.
+   * asset-usages, nsfw-usages, quality-gate-usages. Default is all types. If bad
+   * type or empty, all types will be returned.
    */
   type?: Array<
-    'usages' | 'activity' | 'consumption' | 'model-usages' | 'asset-usages' | 'nsfw-usages' | 'slop-usages'
+    | 'usages'
+    | 'activity'
+    | 'consumption'
+    | 'model-usages'
+    | 'asset-usages'
+    | 'nsfw-usages'
+    | 'quality-gate-usages'
   >;
 
   /**