fal-endpoint-types 1.3.7 → 1.3.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fal-endpoint-types",
3
- "version": "1.3.7",
3
+ "version": "1.3.9",
4
4
  "description": "TypeScript types for Fal AI endpoints generated from the OpenAPI schemas.",
5
5
  "homepage": "https://github.com/rawpixel-vincent/fal-endpoint-types#readme",
6
6
  "bugs": {
@@ -1,3 +1,16 @@
1
+ export interface WhisperChunk_1 {
2
+ /**
3
+ * Text
4
+ * @description Transcription of the chunk
5
+ */
6
+ text: string;
7
+ /**
8
+ * Timestamp
9
+ * @description Start and end timestamp of the chunk
10
+ */
11
+ timestamp: [number, number];
12
+ }
13
+
1
14
  export interface WhisperChunk {
2
15
  /**
3
16
  * Speaker
@@ -117,12 +130,6 @@ export interface VideoFile_1 {
117
130
  * @description The duration of the video
118
131
  */
119
132
  duration?: number;
120
- /**
121
- * File Data
122
- * Format: binary
123
- * @description File data
124
- */
125
- file_data?: string;
126
133
  /**
127
134
  * File Name
128
135
  * @description The name of the file. It will be auto-generated if not provided.
@@ -174,6 +181,12 @@ export interface VideoFile {
174
181
  * @description The duration of the video
175
182
  */
176
183
  duration?: number;
184
+ /**
185
+ * File Data
186
+ * Format: binary
187
+ * @description File data
188
+ */
189
+ file_data?: string;
177
190
  /**
178
191
  * File Name
179
192
  * @description The name of the file. It will be auto-generated if not provided.
@@ -541,20 +554,6 @@ export interface V2VValidation {
541
554
  }
542
555
 
543
556
  export interface UsageInfo_1 {
544
- /** Completion Tokens */
545
- completion_tokens?: number;
546
- /** Cost */
547
- cost: number;
548
- /** Prompt Tokens */
549
- prompt_tokens?: number;
550
- /**
551
- * Total Tokens
552
- * @default 0
553
- */
554
- total_tokens?: number;
555
- }
556
-
557
- export interface UsageInfo {
558
557
  /**
559
558
  * Decode Time Ms
560
559
  * @description Time taken for decoding in milliseconds
@@ -582,6 +581,20 @@ export interface UsageInfo {
582
581
  ttft_ms: number;
583
582
  }
584
583
 
584
+ export interface UsageInfo {
585
+ /** Completion Tokens */
586
+ completion_tokens?: number;
587
+ /** Cost */
588
+ cost: number;
589
+ /** Prompt Tokens */
590
+ prompt_tokens?: number;
591
+ /**
592
+ * Total Tokens
593
+ * @default 0
594
+ */
595
+ total_tokens?: number;
596
+ }
597
+
585
598
  export interface Turn {
586
599
  /** Speaker Id */
587
600
  speaker_id: number;
@@ -842,19 +855,6 @@ export interface StructuredInstruction {
842
855
  text_render?: { [x: string]: any }[];
843
856
  }
844
857
 
845
- export interface SpeechTimestamp {
846
- /**
847
- * End Time
848
- * @description The end time of the speech in seconds.
849
- */
850
- end: number;
851
- /**
852
- * Start Time
853
- * @description The start time of the speech in seconds.
854
- */
855
- start: number;
856
- }
857
-
858
858
  export interface Speaker {
859
859
  /** Audio Url */
860
860
  audio_url: string;
@@ -1041,6 +1041,36 @@ export interface Resolution {
1041
1041
  width: number;
1042
1042
  }
1043
1043
 
1044
+ export interface RelightParameters {
1045
+ /**
1046
+ * Bg Source
1047
+ * @description Direction of the light source (used for IC-light).
1048
+ * @default Left
1049
+ * @enum {string}
1050
+ */
1051
+ bg_source?: 'Left' | 'Right' | 'Top' | 'Bottom';
1052
+ /**
1053
+ * Cfg
1054
+ * @description Classifier-free guidance scale for relighting.
1055
+ * @default 2
1056
+ */
1057
+ cfg?: number;
1058
+ /**
1059
+ * Relight Prompt
1060
+ * @description Text prompt describing the desired lighting condition.
1061
+ * @example Sunlight
1062
+ * @example Red and Blue Neon Light
1063
+ * @example Warm indoor lighting
1064
+ */
1065
+ relight_prompt: string;
1066
+ /**
1067
+ * Use Sky Mask
1068
+ * @description Whether to use sky masking for outdoor scenes.
1069
+ * @default false
1070
+ */
1071
+ use_sky_mask?: boolean;
1072
+ }
1073
+
1044
1074
  export interface Region {
1045
1075
  /**
1046
1076
  * X1
@@ -1231,6 +1261,34 @@ export interface PointPromptBase {
1231
1261
  y?: number;
1232
1262
  }
1233
1263
 
1264
+ export interface PointPrompt_1 {
1265
+ /**
1266
+ * Frame Index
1267
+ * @description The frame index to interact with.
1268
+ * @default 0
1269
+ */
1270
+ frame_index?: number;
1271
+ /**
1272
+ * Label
1273
+ * @description Label of the prompt. 1 for foreground, 0 for background
1274
+ * @default 1
1275
+ * @enum {integer}
1276
+ */
1277
+ label?: 0 | 1;
1278
+ /**
1279
+ * X
1280
+ * @description X Coordinate of the prompt
1281
+ * @default 305
1282
+ */
1283
+ x?: number;
1284
+ /**
1285
+ * Y
1286
+ * @description Y Coordinate of the prompt
1287
+ * @default 350
1288
+ */
1289
+ y?: number;
1290
+ }
1291
+
1234
1292
  export interface PointPrompt {
1235
1293
  /**
1236
1294
  * Frame Index
@@ -1758,7 +1816,7 @@ export interface LoRAInput_2 {
1758
1816
  export interface LoRAInput_1 {
1759
1817
  /**
1760
1818
  * Path
1761
- * @description URL, HuggingFace repo ID (owner/repo), or local path to LoRA weights.
1819
+ * @description URL, HuggingFace repo ID (owner/repo) to lora weights.
1762
1820
  */
1763
1821
  path: string;
1764
1822
  /**
@@ -1767,12 +1825,17 @@ export interface LoRAInput_1 {
1767
1825
  * @default 1
1768
1826
  */
1769
1827
  scale?: number;
1828
+ /**
1829
+ * Weight Name
1830
+ * @description Name of the LoRA weight. Only used if `path` is a HuggingFace repository, and is only required when the repository contains multiple LoRA weights.
1831
+ */
1832
+ weight_name?: string;
1770
1833
  }
1771
1834
 
1772
1835
  export interface LoRAInput {
1773
1836
  /**
1774
1837
  * Path
1775
- * @description URL, HuggingFace repo ID (owner/repo) to lora weights.
1838
+ * @description URL, HuggingFace repo ID (owner/repo), or local path to LoRA weights.
1776
1839
  */
1777
1840
  path: string;
1778
1841
  /**
@@ -1781,11 +1844,6 @@ export interface LoRAInput {
1781
1844
  * @default 1
1782
1845
  */
1783
1846
  scale?: number;
1784
- /**
1785
- * Weight Name
1786
- * @description Name of the LoRA weight. Only used if `path` is a HuggingFace repository, and is only required when the repository contains multiple LoRA weights.
1787
- */
1788
- weight_name?: string;
1789
1847
  }
1790
1848
 
1791
1849
  export interface Lighting {
@@ -2722,6 +2780,38 @@ export interface ControlNetUnion {
2722
2780
  variant?: string;
2723
2781
  }
2724
2782
 
2783
+ export interface ControlNet_2 {
2784
+ /**
2785
+ * Conditioning Scale
2786
+ * @description The scale of the control net weight. This is used to scale the control net weight
2787
+ * before merging it with the base model.
2788
+ * @default 1
2789
+ */
2790
+ conditioning_scale?: number;
2791
+ /**
2792
+ * Control Image Url
2793
+ * @description URL of the image to be used as the control image.
2794
+ */
2795
+ control_image_url: string;
2796
+ /**
2797
+ * End Percentage
2798
+ * @description The percentage of the image to end applying the controlnet in terms of the total timesteps.
2799
+ * @default 1
2800
+ */
2801
+ end_percentage?: number;
2802
+ /**
2803
+ * Path
2804
+ * @description URL or the path to the control net weights.
2805
+ */
2806
+ path: string;
2807
+ /**
2808
+ * Start Percentage
2809
+ * @description The percentage of the image to start applying the controlnet in terms of the total timesteps.
2810
+ * @default 0
2811
+ */
2812
+ start_percentage?: number;
2813
+ }
2814
+
2725
2815
  export interface ControlNet_1 {
2726
2816
  /**
2727
2817
  * Conditioning Scale
@@ -2854,6 +2944,24 @@ export interface ControlLoraWeight {
2854
2944
  scale?: Record<string, number> | number;
2855
2945
  }
2856
2946
 
2947
+ export interface CompletionUsage {
2948
+ /**
2949
+ * Completion Tokens
2950
+ * @description Number of tokens in the completion
2951
+ */
2952
+ completion_tokens: number;
2953
+ /**
2954
+ * Prompt Tokens
2955
+ * @description Number of tokens in the prompt
2956
+ */
2957
+ prompt_tokens: number;
2958
+ /**
2959
+ * Total Tokens
2960
+ * @description Total tokens used
2961
+ */
2962
+ total_tokens: number;
2963
+ }
2964
+
2857
2965
  export interface ColorPaletteMember {
2858
2966
  /**
2859
2967
  * Color Weight
@@ -3037,6 +3145,39 @@ export interface BoxPromptBase {
3037
3145
  y_min?: number;
3038
3146
  }
3039
3147
 
3148
+ export interface BoxPrompt_1 {
3149
+ /**
3150
+ * Frame Index
3151
+ * @description The frame index to interact with.
3152
+ * @default 0
3153
+ */
3154
+ frame_index?: number;
3155
+ /**
3156
+ * X Max
3157
+ * @description X Max Coordinate of the prompt
3158
+ * @default 0
3159
+ */
3160
+ x_max?: number;
3161
+ /**
3162
+ * X Min
3163
+ * @description X Min Coordinate of the box
3164
+ * @default 0
3165
+ */
3166
+ x_min?: number;
3167
+ /**
3168
+ * Y Max
3169
+ * @description Y Max Coordinate of the prompt
3170
+ * @default 0
3171
+ */
3172
+ y_max?: number;
3173
+ /**
3174
+ * Y Min
3175
+ * @description Y Min Coordinate of the box
3176
+ * @default 0
3177
+ */
3178
+ y_min?: number;
3179
+ }
3180
+
3040
3181
  export interface BoxPrompt {
3041
3182
  /**
3042
3183
  * Frame Index