@scenario-labs/sdk 0.1.2

package/src/resources/models/description.ts

@@ -0,0 +1,800 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Description extends APIResource {
+  /**
+   * Get the description of the given `modelId`
+   */
+  retrieve(
+    modelID: string,
+    query: DescriptionRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<DescriptionRetrieveResponse> {
+    return this._client.get(path`/models/${modelID}/description`, { query, ...options });
+  }
+
+  /**
+   * Update the markdown description of the given `modelId`
+   */
+  update(
+    modelID: string,
+    params: DescriptionUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<DescriptionUpdateResponse> {
+    const { originalAssets, ...body } = params;
+    return this._client.put(path`/models/${modelID}/description`, {
+      query: { originalAssets },
+      body,
+      ...options,
+    });
+  }
+}
+
+export interface DescriptionRetrieveResponse {
+  description: DescriptionRetrieveResponse.Description;
+}
+
+export namespace DescriptionRetrieveResponse {
+  export interface Description {
+    /**
+     * The list of assets referenced by the Markdown `{asset}` tag in the description.
+     */
+    assets: Array<Description.Asset>;
+
+    /**
+     * The list of models referenced by the Markdown `{model}` tag in the description.
+     */
+    models: Array<Description.Model>;
+
+    /**
+     * The markdown description of the model (ex: `# My model`). We allow the
+     * `{asset:<assetId>}` and `{model:<modelId>}` tags.
+     */
+    value: string;
+  }
+
+  export namespace Description {
+    export interface Asset {
+      /**
+       * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+       */
+      id: string;
+
+      /**
+       * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+       */
+      authorId: string;
+
+      /**
+       * The kind of asset
+       */
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+
+      /**
+       * The mime type of the asset (example: "image/png")
+       */
+      mimeType: string;
+
+      /**
+       * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
+       * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
+       */
+      ownerId: string;
+
+      /**
+       * The privacy of the asset
+       */
+      privacy: 'private' | 'public' | 'unlisted';
+
+      /**
+       * The properties of the asset, content may depend on the kind of asset returned
+       */
+      properties: Asset.Properties;
+
+      /**
+       * source of the asset
+       */
+      source:
+        | '3d23d'
+        | '3d23d:texture'
+        | '3d:texture'
+        | '3d:texture:albedo'
+        | '3d:texture:metallic'
+        | '3d:texture:mtl'
+        | '3d:texture:normal'
+        | '3d:texture:roughness'
+        | 'audio2audio'
+        | 'background-removal'
+        | 'canvas'
+        | 'canvas-drawing'
+        | 'canvas-export'
+        | 'detection'
+        | 'generative-fill'
+        | 'image-prompt-editing'
+        | 'img23d'
+        | 'img2img'
+        | 'img2video'
+        | 'inference-control-net'
+        | 'inference-control-net-img'
+        | 'inference-control-net-inpainting'
+        | 'inference-control-net-inpainting-ip-adapter'
+        | 'inference-control-net-ip-adapter'
+        | 'inference-control-net-reference'
+        | 'inference-control-net-texture'
+        | 'inference-img'
+        | 'inference-img-ip-adapter'
+        | 'inference-img-texture'
+        | 'inference-in-paint'
+        | 'inference-in-paint-ip-adapter'
+        | 'inference-reference'
+        | 'inference-reference-texture'
+        | 'inference-txt'
+        | 'inference-txt-ip-adapter'
+        | 'inference-txt-texture'
+        | 'patch'
+        | 'pixelization'
+        | 'reframe'
+        | 'restyle'
+        | 'segment'
+        | 'segmentation-image'
+        | 'segmentation-mask'
+        | 'skybox-3d'
+        | 'skybox-base-360'
+        | 'skybox-hdri'
+        | 'texture'
+        | 'texture:albedo'
+        | 'texture:ao'
+        | 'texture:edge'
+        | 'texture:height'
+        | 'texture:metallic'
+        | 'texture:normal'
+        | 'texture:smoothness'
+        | 'txt23d'
+        | 'txt2audio'
+        | 'txt2img'
+        | 'txt2video'
+        | 'unknown'
+        | 'uploaded'
+        | 'uploaded-3d'
+        | 'uploaded-audio'
+        | 'uploaded-avatar'
+        | 'uploaded-video'
+        | 'upscale'
+        | 'upscale-skybox'
+        | 'upscale-texture'
+        | 'upscale-video'
+        | 'vectorization'
+        | 'video2img'
+        | 'video2video';
+
+      /**
+       * Signed URL to get the asset content
+       */
+      url: string;
+
+      /**
+       * The original file url.
+       *
+       * Contains the url of the original file. without any conversion. Only available
+       * for some specific video, audio and threeD assets. Is only specified if the given
+       * asset data has been replaced with a new file during the creation of the asset.
+       */
+      originalFileUrl?: string;
+
+      /**
+       * The asset's preview.
+       *
+       * Contains the assetId and the url of the preview.
+       */
+      preview?: Asset.Preview;
+
+      /**
+       * The asset's thumbnail.
+       *
+       * Contains the assetId and the url of the thumbnail.
+       */
+      thumbnail?: Asset.Thumbnail;
+    }
+
+    export namespace Asset {
+      /**
+       * The properties of the asset, content may depend on the kind of asset returned
+       */
+      export interface Properties {
+        size: number;
+
+        /**
+         * Number of animation frames if animations exist
+         */
+        animationFrameCount?: number;
+
+        /**
+         * Bitrate of the media in bits per second
+         */
+        bitrate?: number;
+
+        /**
+         * Number of bones if skeleton exists
+         */
+        boneCount?: number;
+
+        /**
+         * Number of channels of the audio
+         */
+        channels?: number;
+
+        /**
+         * Classification of the audio
+         */
+        classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
+
+        /**
+         * Codec name of the media
+         */
+        codecName?: string;
+
+        /**
+         * Description of the audio
+         */
+        description?: string;
+
+        /**
+         * Bounding box dimensions [width, height, depth]
+         */
+        dimensions?: Array<unknown>;
+
+        /**
+         * Duration of the media in seconds
+         */
+        duration?: number;
+
+        /**
+         * Number of faces/triangles in the mesh
+         */
+        faceCount?: number;
+
+        /**
+         * Format of the mesh file (e.g. 'glb', etc.)
+         */
+        format?: string;
+
+        /**
+         * Frame rate of the video in frames per second
+         */
+        frameRate?: number;
+
+        /**
+         * Whether the mesh has animations
+         */
+        hasAnimations?: boolean;
+
+        /**
+         * Whether the mesh has normal vectors
+         */
+        hasNormals?: boolean;
+
+        /**
+         * Whether the mesh has bones/skeleton
+         */
+        hasSkeleton?: boolean;
+
+        /**
+         * Whether the mesh has UV coordinates
+         */
+        hasUVs?: boolean;
+
+        height?: number;
+
+        /**
+         * Number of frames in the video
+         */
+        nbFrames?: number;
+
+        /**
+         * Sample rate of the media in Hz
+         */
+        sampleRate?: number;
+
+        /**
+         * Transcription of the audio
+         */
+        transcription?: Properties.Transcription;
+
+        /**
+         * Number of vertices in the mesh
+         */
+        vertexCount?: number;
+
+        width?: number;
+      }
+
+      export namespace Properties {
+        /**
+         * Transcription of the audio
+         */
+        export interface Transcription {
+          text: string;
+        }
+      }
+
+      /**
+       * The asset's preview.
+       *
+       * Contains the assetId and the url of the preview.
+       */
+      export interface Preview {
+        assetId: string;
+
+        url: string;
+      }
+
+      /**
+       * The asset's thumbnail.
+       *
+       * Contains the assetId and the url of the thumbnail.
+       */
+      export interface Thumbnail {
+        assetId: string;
+
+        url: string;
+      }
+    }
+
+    export interface Model {
+      /**
+       * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The privacy of the model (default: private)
+       */
+      privacy: 'private' | 'public' | 'unlisted';
+
+      /**
+       * The model type (example: "flux.1-lora")
+       */
+      type:
+        | 'custom'
+        | 'flux.1'
+        | 'flux.1-composition'
+        | 'flux.1-kontext-dev'
+        | 'flux.1-kontext-lora'
+        | 'flux.1-krea-dev'
+        | 'flux.1-krea-lora'
+        | 'flux.1-lora'
+        | 'flux.1-pro'
+        | 'flux.1.1-pro-ultra'
+        | 'flux1.1-pro'
+        | 'gpt-image-1'
+        | 'sd-1_5'
+        | 'sd-1_5-composition'
+        | 'sd-1_5-lora'
+        | 'sd-xl'
+        | 'sd-xl-composition'
+        | 'sd-xl-lora';
+
+      /**
+       * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+       */
+      authorId?: string;
+
+      /**
+       * The model name (example: "Cinematic Realism")
+       */
+      name?: string;
+
+      /**
+       * The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
+       */
+      ownerId?: string;
+
+      /**
+       * The model short description (example: "This model generates highly detailed
+       * cinematic scenes.")
+       */
+      shortDescription?: string;
+    }
+  }
+}
+
+export interface DescriptionUpdateResponse {
+  description: DescriptionUpdateResponse.Description;
+}
+
+export namespace DescriptionUpdateResponse {
+  export interface Description {
+    /**
+     * The list of assets referenced by the Markdown `{asset}` tag in the description.
+     */
+    assets: Array<Description.Asset>;
+
+    /**
+     * The list of models referenced by the Markdown `{model}` tag in the description.
+     */
+    models: Array<Description.Model>;
+
+    /**
+     * The markdown description of the model (ex: `# My model`). We allow the
+     * `{asset:<assetId>}` and `{model:<modelId>}` tags.
+     */
+    value: string;
+  }
+
+  export namespace Description {
+    export interface Asset {
+      /**
+       * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+       */
+      id: string;
+
+      /**
+       * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+       */
+      authorId: string;
+
+      /**
+       * The kind of asset
+       */
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+
+      /**
+       * The mime type of the asset (example: "image/png")
+       */
+      mimeType: string;
+
+      /**
+       * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
+       * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
+       */
+      ownerId: string;
+
+      /**
+       * The privacy of the asset
+       */
+      privacy: 'private' | 'public' | 'unlisted';
+
+      /**
+       * The properties of the asset, content may depend on the kind of asset returned
+       */
+      properties: Asset.Properties;
+
+      /**
+       * source of the asset
+       */
+      source:
+        | '3d23d'
+        | '3d23d:texture'
+        | '3d:texture'
+        | '3d:texture:albedo'
+        | '3d:texture:metallic'
+        | '3d:texture:mtl'
+        | '3d:texture:normal'
+        | '3d:texture:roughness'
+        | 'audio2audio'
+        | 'background-removal'
+        | 'canvas'
+        | 'canvas-drawing'
+        | 'canvas-export'
+        | 'detection'
+        | 'generative-fill'
+        | 'image-prompt-editing'
+        | 'img23d'
+        | 'img2img'
+        | 'img2video'
+        | 'inference-control-net'
+        | 'inference-control-net-img'
+        | 'inference-control-net-inpainting'
+        | 'inference-control-net-inpainting-ip-adapter'
+        | 'inference-control-net-ip-adapter'
+        | 'inference-control-net-reference'
+        | 'inference-control-net-texture'
+        | 'inference-img'
+        | 'inference-img-ip-adapter'
+        | 'inference-img-texture'
+        | 'inference-in-paint'
+        | 'inference-in-paint-ip-adapter'
+        | 'inference-reference'
+        | 'inference-reference-texture'
+        | 'inference-txt'
+        | 'inference-txt-ip-adapter'
+        | 'inference-txt-texture'
+        | 'patch'
+        | 'pixelization'
+        | 'reframe'
+        | 'restyle'
+        | 'segment'
+        | 'segmentation-image'
+        | 'segmentation-mask'
+        | 'skybox-3d'
+        | 'skybox-base-360'
+        | 'skybox-hdri'
+        | 'texture'
+        | 'texture:albedo'
+        | 'texture:ao'
+        | 'texture:edge'
+        | 'texture:height'
+        | 'texture:metallic'
+        | 'texture:normal'
+        | 'texture:smoothness'
+        | 'txt23d'
+        | 'txt2audio'
+        | 'txt2img'
+        | 'txt2video'
+        | 'unknown'
+        | 'uploaded'
+        | 'uploaded-3d'
+        | 'uploaded-audio'
+        | 'uploaded-avatar'
+        | 'uploaded-video'
+        | 'upscale'
+        | 'upscale-skybox'
+        | 'upscale-texture'
+        | 'upscale-video'
+        | 'vectorization'
+        | 'video2img'
+        | 'video2video';
+
+      /**
+       * Signed URL to get the asset content
+       */
+      url: string;
+
+      /**
+       * The original file url.
+       *
+       * Contains the url of the original file. without any conversion. Only available
+       * for some specific video, audio and threeD assets. Is only specified if the given
+       * asset data has been replaced with a new file during the creation of the asset.
+       */
+      originalFileUrl?: string;
+
+      /**
+       * The asset's preview.
+       *
+       * Contains the assetId and the url of the preview.
+       */
+      preview?: Asset.Preview;
+
+      /**
+       * The asset's thumbnail.
+       *
+       * Contains the assetId and the url of the thumbnail.
+       */
+      thumbnail?: Asset.Thumbnail;
+    }
+
+    export namespace Asset {
+      /**
+       * The properties of the asset, content may depend on the kind of asset returned
+       */
+      export interface Properties {
+        size: number;
+
+        /**
+         * Number of animation frames if animations exist
+         */
+        animationFrameCount?: number;
+
+        /**
+         * Bitrate of the media in bits per second
+         */
+        bitrate?: number;
+
+        /**
+         * Number of bones if skeleton exists
+         */
+        boneCount?: number;
+
+        /**
+         * Number of channels of the audio
+         */
+        channels?: number;
+
+        /**
+         * Classification of the audio
+         */
+        classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
+
+        /**
+         * Codec name of the media
+         */
+        codecName?: string;
+
+        /**
+         * Description of the audio
+         */
+        description?: string;
+
+        /**
+         * Bounding box dimensions [width, height, depth]
+         */
+        dimensions?: Array<unknown>;
+
+        /**
+         * Duration of the media in seconds
+         */
+        duration?: number;
+
+        /**
+         * Number of faces/triangles in the mesh
+         */
+        faceCount?: number;
+
+        /**
+         * Format of the mesh file (e.g. 'glb', etc.)
+         */
+        format?: string;
+
+        /**
+         * Frame rate of the video in frames per second
+         */
+        frameRate?: number;
+
+        /**
+         * Whether the mesh has animations
+         */
+        hasAnimations?: boolean;
+
+        /**
+         * Whether the mesh has normal vectors
+         */
+        hasNormals?: boolean;
+
+        /**
+         * Whether the mesh has bones/skeleton
+         */
+        hasSkeleton?: boolean;
+
+        /**
+         * Whether the mesh has UV coordinates
+         */
+        hasUVs?: boolean;
+
+        height?: number;
+
+        /**
+         * Number of frames in the video
+         */
+        nbFrames?: number;
+
+        /**
+         * Sample rate of the media in Hz
+         */
+        sampleRate?: number;
+
+        /**
+         * Transcription of the audio
+         */
+        transcription?: Properties.Transcription;
+
+        /**
+         * Number of vertices in the mesh
+         */
+        vertexCount?: number;
+
+        width?: number;
+      }
+
+      export namespace Properties {
+        /**
+         * Transcription of the audio
+         */
+        export interface Transcription {
+          text: string;
+        }
+      }
+
+      /**
+       * The asset's preview.
+       *
+       * Contains the assetId and the url of the preview.
+       */
+      export interface Preview {
+        assetId: string;
+
+        url: string;
+      }
+
+      /**
+       * The asset's thumbnail.
+       *
+       * Contains the assetId and the url of the thumbnail.
+       */
+      export interface Thumbnail {
+        assetId: string;
+
+        url: string;
+      }
+    }
+
+    export interface Model {
+      /**
+       * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+       */
+      id: string;
+
+      /**
+       * The privacy of the model (default: private)
+       */
+      privacy: 'private' | 'public' | 'unlisted';
+
+      /**
+       * The model type (example: "flux.1-lora")
+       */
+      type:
+        | 'custom'
+        | 'flux.1'
+        | 'flux.1-composition'
+        | 'flux.1-kontext-dev'
+        | 'flux.1-kontext-lora'
+        | 'flux.1-krea-dev'
+        | 'flux.1-krea-lora'
+        | 'flux.1-lora'
+        | 'flux.1-pro'
+        | 'flux.1.1-pro-ultra'
+        | 'flux1.1-pro'
+        | 'gpt-image-1'
+        | 'sd-1_5'
+        | 'sd-1_5-composition'
+        | 'sd-1_5-lora'
+        | 'sd-xl'
+        | 'sd-xl-composition'
+        | 'sd-xl-lora';
+
+      /**
+       * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+       */
+      authorId?: string;
+
+      /**
+       * The model name (example: "Cinematic Realism")
+       */
+      name?: string;
+
+      /**
+       * The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
+       */
+      ownerId?: string;
+
+      /**
+       * The model short description (example: "This model generates highly detailed
+       * cinematic scenes.")
+       */
+      shortDescription?: string;
+    }
+  }
+}
+
+export interface DescriptionRetrieveParams {
+  /**
+   * If set to true, returns the original asset without transformation
+   */
+  originalAssets?: string;
+}
+
+export interface DescriptionUpdateParams {
+  /**
+   * Body param: The markdown description of the model (ex: `# My model`). Set to
+   * `null` to delete the description.
+   */
+  description: string;
+
+  /**
+   * Query param: If set to true, returns the original asset without transformation
+   */
+  originalAssets?: string;
+}
+
+export declare namespace Description {
+  export {
+    type DescriptionRetrieveResponse as DescriptionRetrieveResponse,
+    type DescriptionUpdateResponse as DescriptionUpdateResponse,
+    type DescriptionRetrieveParams as DescriptionRetrieveParams,
+    type DescriptionUpdateParams as DescriptionUpdateParams,
+  };
+}