@scenario-labs/sdk 0.3.0 → 1.1.0

package/resources/search.d.mts

@@ -1,5 +1,5 @@
 import { APIResource } from "../core/resource.mjs";
-import { APIPromise } from "../core/api-promise.mjs";
+import { PagePromise, SearchHitsOffset, type SearchHitsOffsetParams } from "../core/pagination.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Search extends APIResource {
     /**
@@ -8,383 +8,313 @@ export declare class Search extends APIResource {
      *
      * `image`, `images` are mutually exclusive.
      */
-    assetSearch(params: SearchAssetSearchParams, options?: RequestOptions): APIPromise<SearchAssetSearchResponse>;
+    assetSearch(params: SearchAssetSearchParams, options?: RequestOptions): PagePromise<SearchAssetSearchResponsesSearchHitsOffset, SearchAssetSearchResponse>;
     /**
      * Search for models. At least one of the following fields must have a value:
      * `query`, `filter`, `image`, or `images`.
      *
      * `image`, and `images` are mutually exclusive.
      */
-    modelSearch(params: SearchModelSearchParams, options?: RequestOptions): APIPromise<SearchModelSearchResponse>;
+    modelSearch(params: SearchModelSearchParams, options?: RequestOptions): PagePromise<SearchModelSearchResponsesSearchHitsOffset, SearchModelSearchResponse>;
 }
-/**
- * Search result for asset search
- */
+export type SearchAssetSearchResponsesSearchHitsOffset = SearchHitsOffset<SearchAssetSearchResponse>;
+export type SearchModelSearchResponsesSearchHitsOffset = SearchHitsOffset<SearchModelSearchResponse>;
 export interface SearchAssetSearchResponse {
-    hits: Array<SearchAssetSearchResponse.Hit>;
     /**
-     * Maximum number of documents returned
+     * Unique identifier for the asset (e.g., "asset_GTrL3mq4SXWyMxkOHRxlpw")
      */
-    limit: number;
+    id: string;
     /**
-     * Number of documents skipped
+     * User ID of the asset creator/author
      */
-    offset: number;
+    authorId: string;
     /**
-     * Estimated total number of hits
+     * Array of collection IDs this asset belongs to
      */
-    estimatedTotalHits?: number;
+    collectionIds: Array<string>;
     /**
-     * Number of results on each page
+     * Creation timestamp in ISO 8601 format (e.g., "2025-01-16T11:19:41.579Z")
      */
-    hitsPerPage?: number;
+    createdAt: string;
     /**
-     * Current search results page
+     * Metadata containing detailed information about the asset's properties and
+     * generation parameters
      */
-    page?: number;
+    metadata: SearchAssetSearchResponse.Metadata;
+    /**
+     * MIME type of the asset (e.g., "image/png", "image/jpeg")
+     */
+    mimeType: string;
+    /**
+     * Array of detected NSFW categories
+     */
+    nsfw: Array<string>;
+    /**
+     * Project ID of the asset owner
+     */
+    ownerId: string;
+    /**
+     * Privacy setting of the asset ("public", "private", or "unlisted")
+     */
+    privacy: string;
+    /**
+     * Array of user-assigned tags for categorization
+     */
+    tags: Array<string>;
+    /**
+     * Team ID of the asset owner
+     */
+    teamId: string;
+    /**
+     * Last modification timestamp in ISO 8601 format (e.g.,
+     * "2025-01-16T11:19:41.579Z")
+     */
+    updatedAt: string;
+    /**
+     * Signed URL of the asset
+     */
+    url: string;
+    /**
+     * Textual description of the asset. Can be either:
+     *
+     * - User-provided description for training images
+     * - Automatically generated caption for images and videos assets
+     * - Automatically generated description for audio assets
+     */
+    description?: string;
+    /**
+     * Score assigned to the asset based on usage and popularity
+     */
+    score?: number;
     /**
-     * Exhaustive total number of matches
+     * Thumbnail preview of the asset 3D, video...
      */
-    totalHits?: number;
+    thumbnail?: SearchAssetSearchResponse.Thumbnail;
     /**
-     * Exhaustive total number of search result pages
+     * Transcription of the asset. Can be either:
+     *
+     * - Automatically generated transcription for audio assets with speech
      */
-    totalPages?: number;
+    transcription?: string;
 }
 export declare namespace SearchAssetSearchResponse {
-    interface Hit {
+    /**
+     * Metadata containing detailed information about the asset's properties and
+     * generation parameters
+     */
+    interface Metadata {
         /**
-         * Unique identifier for the asset (e.g., "asset_GTrL3mq4SXWyMxkOHRxlpw")
+         * Aspect ratio of the asset (e.g., "1:1", "16:9")
          */
-        id: string;
+        aspectRatio?: string;
         /**
-         * User ID of the asset creator/author
+         * ID of the base model used for generation
          */
-        authorId: string;
+        baseModelId?: string;
         /**
-         * Array of collection IDs this asset belongs to
+         * Guidance scale used for diffusion models to control prompt adherence
          */
-        collectionIds: Array<string>;
+        guidance?: number;
         /**
-         * Creation timestamp in ISO 8601 format (e.g., "2025-01-16T11:19:41.579Z")
+         * Height of the asset in pixels
          */
-        createdAt: string;
+        height?: number;
         /**
-         * Metadata containing detailed information about the asset's properties and
-         * generation parameters
+         * Classification of the asset (e.g., "image", "video")
          */
-        metadata: Hit.Metadata;
+        kind?: string;
         /**
-         * MIME type of the asset (e.g., "image/png", "image/jpeg")
+         * ID of the specific model used if asset is model-based
          */
-        mimeType: string;
+        modelId?: string;
         /**
-         * Array of detected NSFW categories
+         * Type of model used for generation (e.g., "sd-1_5", "flux.1")
          */
-        nsfw: Array<string>;
+        modelType?: string;
         /**
-         * Project ID of the asset owner
+         * Custom name given to the asset
          */
-        ownerId: string;
+        name?: string;
         /**
-         * Privacy setting of the asset ("public", "private", or "unlisted")
+         * Negative prompt used during generation to specify what to avoid
          */
-        privacy: string;
+        negativePrompt?: string;
         /**
-         * Array of user-assigned tags for categorization
+         * For Flux models: controls the influence of the negative prompt
          */
-        tags: Array<string>;
+        negativePromptStrength?: number;
         /**
-         * Team ID of the asset owner
+         * Number of inference steps used during generation
          */
-        teamId: string;
+        numInferenceSteps?: number;
         /**
-         * Last modification timestamp in ISO 8601 format (e.g.,
-         * "2025-01-16T11:19:41.579Z")
+         * ID of the parent job that created this asset
          */
-        updatedAt: string;
+        parentJobId?: string;
         /**
-         * Signed URL of the asset
+         * Text prompt used to generate the asset
          */
-        url: string;
+        prompt?: string;
         /**
-         * Textual description of the asset. Can be either:
-         *
-         * - User-provided description for training images
-         * - Automatically generated caption for images and videos assets
-         * - Automatically generated description for audio assets
+         * Scheduler algorithm used during generation
          */
-        description?: string;
+        scheduler?: string;
         /**
-         * Score assigned to the asset based on usage and popularity
+         * Random seed used for generation, enables reproducibility
          */
-        score?: number;
+        seed?: string;
         /**
-         * Thumbnail preview of the asset 3D, video...
+         * File size of the asset in bytes
          */
-        thumbnail?: Hit.Thumbnail;
+        size?: number;
         /**
-         * Transcription of the asset. Can be either:
-         *
-         * - Automatically generated transcription for audio assets with speech
+         * Text used to generate the asset: mainly for speech to text
          */
-        transcription?: string;
-    }
-    namespace Hit {
+        text?: string;
         /**
-         * Metadata containing detailed information about the asset's properties and
-         * generation parameters
+         * Thumbnail image information for the asset. Ex. Canvas thumbnail
          */
-        interface Metadata {
-            /**
-             * Aspect ratio of the asset (e.g., "1:1", "16:9")
-             */
-            aspectRatio?: string;
-            /**
-             * ID of the base model used for generation
-             */
-            baseModelId?: string;
-            /**
-             * Guidance scale used for diffusion models to control prompt adherence
-             */
-            guidance?: number;
-            /**
-             * Height of the asset in pixels
-             */
-            height?: number;
-            /**
-             * Classification of the asset (e.g., "image", "video")
-             */
-            kind?: string;
-            /**
-             * ID of the specific model used if asset is model-based
-             */
-            modelId?: string;
-            /**
-             * Type of model used for generation (e.g., "sd-1_5", "flux.1")
-             */
-            modelType?: string;
-            /**
-             * Custom name given to the asset
-             */
-            name?: string;
-            /**
-             * Negative prompt used during generation to specify what to avoid
-             */
-            negativePrompt?: string;
-            /**
-             * For Flux models: controls the influence of the negative prompt
-             */
-            negativePromptStrength?: number;
-            /**
-             * Number of inference steps used during generation
-             */
-            numInferenceSteps?: number;
-            /**
-             * ID of the parent job that created this asset
-             */
-            parentJobId?: string;
-            /**
-             * Text prompt used to generate the asset
-             */
-            prompt?: string;
-            /**
-             * Scheduler algorithm used during generation
-             */
-            scheduler?: string;
-            /**
-             * Random seed used for generation, enables reproducibility
-             */
-            seed?: string;
-            /**
-             * File size of the asset in bytes
-             */
-            size?: number;
-            /**
-             * Text used to generate the asset: mainly for speech to text
-             */
-            text?: string;
-            /**
-             * Thumbnail image information for the asset. Ex. Canvas thumbnail
-             */
-            thumbnail?: Metadata.Thumbnail;
-            /**
-             * Specific type/category of the asset (e.g., "canvas", "inference-txt")
-             */
-            type?: string;
-            /**
-             * Width of the asset in pixels
-             */
-            width?: number;
-        }
-        namespace Metadata {
-            /**
-             * Thumbnail image information for the asset. Ex. Canvas thumbnail
-             */
-            interface Thumbnail {
-                /**
-                 * ID of the asset used as thumbnail
-                 */
-                assetId: string;
-            }
-        }
+        thumbnail?: Metadata.Thumbnail;
         /**
-         * Thumbnail preview of the asset 3D, video...
+         * Specific type/category of the asset (e.g., "canvas", "inference-txt")
+         */
+        type?: string;
+        /**
+         * Width of the asset in pixels
+         */
+        width?: number;
+    }
+    namespace Metadata {
+        /**
+         * Thumbnail image information for the asset. Ex. Canvas thumbnail
          */
         interface Thumbnail {
             /**
              * ID of the asset used as thumbnail
              */
             assetId: string;
-            /**
-             * Signed URL of the thumbnail
-             */
-            url: string;
         }
     }
+    /**
+     * Thumbnail preview of the asset 3D, video...
+     */
+    interface Thumbnail {
+        /**
+         * ID of the asset used as thumbnail
+         */
+        assetId: string;
+        /**
+         * Signed URL of the thumbnail
+         */
+        url: string;
+    }
 }
-/**
- * Search result for model search
- */
 export interface SearchModelSearchResponse {
-    hits: Array<SearchModelSearchResponse.Hit>;
     /**
-     * Maximum number of documents returned
+     * Unique identifier for the model (e.g., "model_GTrL3mq4SXWyMxkOHRxlpw")
      */
-    limit: number;
+    id: string;
     /**
-     * Number of documents skipped
+     * User ID of the model creator/author
      */
-    offset: number;
+    authorId: string;
     /**
-     * Estimated total number of hits
+     * Array of model capabilities
      */
-    estimatedTotalHits?: number;
+    capabilities: Array<string>;
     /**
-     * Number of results on each page
+     * Array of collection IDs this model belongs to
      */
-    hitsPerPage?: number;
+    collectionIds: Array<string>;
     /**
-     * Current search results page
+     * Array of concept models associated with this model Each concept contains a
+     * reference to its source model
      */
-    page?: number;
+    concepts: Array<SearchModelSearchResponse.Concept>;
+    /**
+     * Creation timestamp in ISO 8601 format (e.g., "2025-01-16T11:19:41.579Z")
+     */
+    createdAt: string;
+    /**
+     * Array of example asset IDs associated with this model
+     */
+    exampleAssetIds: Array<string>;
+    /**
+     * Display name of the model
+     */
+    name: string;
+    /**
+     * Project ID of the model owner
+     */
+    ownerId: string;
+    /**
+     * Privacy setting of the model ("public", "private", or "unlisted")
+     */
+    privacy: string;
+    /**
+     * Short description of the model
+     */
+    shortDescription: string;
+    /**
+     * Source/origin of the model (e.g., "training", "import")
+     */
+    source: string;
+    /**
+     * Array of user-assigned tags for categorization
+     */
+    tags: Array<string>;
+    /**
+     * Team ID of the model owner
+     */
+    teamId: string;
     /**
-     * Exhaustive total number of matches
+     * Number of images used to train this model
      */
-    totalHits?: number;
+    trainingImagesNumber: number;
     /**
-     * Exhaustive total number of search result pages
+     * Type of the model (e.g., "sd-1_5", "flux.1")
      */
-    totalPages?: number;
+    type: string;
+    /**
+     * Last modification timestamp in ISO 8601 format (e.g.,
+     * "2025-01-16T11:19:41.579Z")
+     */
+    updatedAt: string;
+    /**
+     * ID of the parent model this model was derived from
+     */
+    parentModelId?: string;
+    /**
+     * Score assigned to the model based on usage and popularity
+     */
+    score?: number;
+    /**
+     * Thumbnail image information for the model
+     */
+    thumbnail?: SearchModelSearchResponse.Thumbnail;
 }
 export declare namespace SearchModelSearchResponse {
-    interface Hit {
-        /**
-         * Unique identifier for the model (e.g., "model_GTrL3mq4SXWyMxkOHRxlpw")
-         */
-        id: string;
-        /**
-         * User ID of the model creator/author
-         */
-        authorId: string;
-        /**
-         * Array of model capabilities
-         */
-        capabilities: Array<string>;
-        /**
-         * Array of collection IDs this model belongs to
-         */
-        collectionIds: Array<string>;
-        /**
-         * Array of concept models associated with this model Each concept contains a
-         * reference to its source model
-         */
-        concepts: Array<Hit.Concept>;
-        /**
-         * Creation timestamp in ISO 8601 format (e.g., "2025-01-16T11:19:41.579Z")
-         */
-        createdAt: string;
-        /**
-         * Array of example asset IDs associated with this model
-         */
-        exampleAssetIds: Array<string>;
-        /**
-         * Display name of the model
-         */
-        name: string;
-        /**
-         * Project ID of the model owner
-         */
-        ownerId: string;
-        /**
-         * Privacy setting of the model ("public", "private", or "unlisted")
-         */
-        privacy: string;
-        /**
-         * Short description of the model
-         */
-        shortDescription: string;
-        /**
-         * Source/origin of the model (e.g., "training", "import")
-         */
-        source: string;
+    interface Concept {
         /**
-         * Array of user-assigned tags for categorization
+         * ID of the concept's source model
          */
-        tags: Array<string>;
-        /**
-         * Team ID of the model owner
-         */
-        teamId: string;
-        /**
-         * Number of images used to train this model
-         */
-        trainingImagesNumber: number;
-        /**
-         * Type of the model (e.g., "sd-1_5", "flux.1")
-         */
-        type: string;
-        /**
-         * Last modification timestamp in ISO 8601 format (e.g.,
-         * "2025-01-16T11:19:41.579Z")
-         */
-        updatedAt: string;
-        /**
-         * ID of the parent model this model was derived from
-         */
-        parentModelId?: string;
-        /**
-         * Score assigned to the model based on usage and popularity
-         */
-        score?: number;
+        modelId: string;
+    }
+    /**
+     * Thumbnail image information for the model
+     */
+    interface Thumbnail {
         /**
-         * Thumbnail image information for the model
+         * ID of the asset used as thumbnail
          */
-        thumbnail?: Hit.Thumbnail;
-    }
-    namespace Hit {
-        interface Concept {
-            /**
-             * ID of the concept's source model
-             */
-            modelId: string;
-        }
+        assetId: string;
         /**
-         * Thumbnail image information for the model
+         * Signed URL of the thumbnail
          */
-        interface Thumbnail {
-            /**
-             * ID of the asset used as thumbnail
-             */
-            assetId: string;
-            /**
-             * Signed URL of the thumbnail
-             */
-            url: string;
-        }
+        url: string;
     }
 }
-export interface SearchAssetSearchParams {
+export interface SearchAssetSearchParams extends SearchHitsOffsetParams {
     /**
      * Query param: If set to true, returns the original asset without transformation
      */
@@ -420,11 +350,6 @@ export interface SearchAssetSearchParams {
      * Body param: Maximum number of documents returned. Must be used with `offset`.
      */
     limit?: number;
-    /**
-     * Body param: Number of documents to skip. Must be used with `limit`. Starts
-     * from 0.
-     */
-    offset?: number;
     /**
      * Body param: Request a specific page of results. Must be used with `hitsPerPage`.
      */
@@ -472,7 +397,7 @@ export declare namespace SearchAssetSearchParams {
         unlike?: Array<string>;
     }
 }
-export interface SearchModelSearchParams {
+export interface SearchModelSearchParams extends SearchHitsOffsetParams {
     /**
      * Query param: If set to true, returns the original asset without transformation
      */
@@ -512,11 +437,6 @@ export interface SearchModelSearchParams {
      * Body param: Maximum number of documents returned. Must be used with `offset`.
      */
     limit?: number;
-    /**
-     * Body param: Number of documents to skip. Must be used with `limit`. Starts
-     * from 0.
-     */
-    offset?: number;
     /**
      * Body param: Request a specific page of results. Must be used with `hitsPerPage`.
      */
@@ -565,6 +485,6 @@ export declare namespace SearchModelSearchParams {
     }
 }
 export declare namespace Search {
-    export { type SearchAssetSearchResponse as SearchAssetSearchResponse, type SearchModelSearchResponse as SearchModelSearchResponse, type SearchAssetSearchParams as SearchAssetSearchParams, type SearchModelSearchParams as SearchModelSearchParams, };
+    export { type SearchAssetSearchResponse as SearchAssetSearchResponse, type SearchModelSearchResponse as SearchModelSearchResponse, type SearchAssetSearchResponsesSearchHitsOffset as SearchAssetSearchResponsesSearchHitsOffset, type SearchModelSearchResponsesSearchHitsOffset as SearchModelSearchResponsesSearchHitsOffset, type SearchAssetSearchParams as SearchAssetSearchParams, type SearchModelSearchParams as SearchModelSearchParams, };
 }
 //# sourceMappingURL=search.d.mts.map