@nosana/types 0.1.6 → 0.1.12

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.
Files changed (29) hide show
  1. package/dist/Jobs/Diagnostics/index.d.ts +2 -0
  2. package/dist/Jobs/Diagnostics/index.js +3 -0
  3. package/dist/Jobs/Diagnostics/index.js.map +1 -0
  4. package/dist/Jobs/Diagnostics/reason.d.ts +5 -0
  5. package/dist/Jobs/Diagnostics/reason.js +2 -0
  6. package/dist/Jobs/Diagnostics/reason.js.map +1 -0
  7. package/dist/Jobs/Diagnostics/state.d.ts +18 -0
  8. package/dist/Jobs/Diagnostics/state.js +2 -0
  9. package/dist/Jobs/Diagnostics/state.js.map +1 -0
  10. package/dist/Jobs/Flows/index.d.ts +6 -0
  11. package/dist/Jobs/JobDefinition/args/index.d.ts +3 -0
  12. package/dist/Jobs/JobDefinition/args/index.js +1 -0
  13. package/dist/Jobs/JobDefinition/args/index.js.map +1 -1
  14. package/dist/Jobs/JobDefinition/args/literals.d.ts +1 -1
  15. package/dist/Jobs/JobDefinition/args/restart_policy.d.ts +10 -0
  16. package/dist/Jobs/JobDefinition/args/restart_policy.js +7 -0
  17. package/dist/Jobs/JobDefinition/args/restart_policy.js.map +1 -0
  18. package/dist/Jobs/JobDefinition/meta/index.d.ts +1 -1
  19. package/dist/Jobs/JobDefinition/operations/index.d.ts +10 -1
  20. package/dist/Jobs/JobDefinition/operations/index.js +2 -1
  21. package/dist/Jobs/JobDefinition/operations/index.js.map +1 -1
  22. package/dist/Jobs/Logs/index.d.ts +1 -0
  23. package/dist/Jobs/index.d.ts +1 -0
  24. package/dist/Jobs/index.js +179 -123
  25. package/dist/Jobs/index.js.map +1 -1
  26. package/dist/Schemas/api.d.ts +284 -140
  27. package/dist/Schemas/job.js +168 -3
  28. package/dist/Schemas/job.js.map +1 -1
  29. package/package.json +1 -1
package/dist/Schemas/api.d.ts CHANGED
@@ -662,28 +662,31 @@ export interface paths {
662
662
  deployment: string;
663
663
  ipfs_definition_hash: string;
664
664
  job_definition: {
665
- version: string;
665
+ /** @enum {string} */
666
+ version: "0.1";
666
667
  /** @enum {string} */
667
668
  type: "container";
668
669
  logistics?: {
669
- send?: {
670
+ send: {
670
671
  /**
671
- * @description api-listen - we have an api listenening for the job poster to send the job description
672
- * api - we recieve an api endpoint to query and it will return the job description
672
+ * @description api - we receive and send via an endpoint endpoint
673
+ * api-listen - we create an endpoint to listen for incoming requests
673
674
  * @enum {string}
674
675
  */
675
676
  type: "api" | "api-listen";
677
+ /** @description Make all properties in T optional */
676
678
  args: {
677
679
  endpoint?: string;
678
680
  };
679
681
  };
680
- receive?: {
682
+ receive: {
681
683
  /**
682
- * @description api-listen - we have an api that listen for request from the job poster, so we can return the result to them
683
- * api - we get an api to post the result to
684
+ * @description api - we receive and send via an endpoint endpoint
685
+ * api-listen - we create an endpoint to listen for incoming requests
684
686
  * @enum {string}
685
687
  */
686
688
  type: "api" | "api-listen";
689
+ /** @description Make all properties in T optional */
687
690
  args: {
688
691
  endpoint?: string;
689
692
  };
@@ -692,11 +695,14 @@ export interface paths {
692
695
  deployment_id?: string;
693
696
  meta?: {
694
697
  trigger?: string;
698
+ /** @description Construct a type with a set of properties K of type T */
695
699
  system_resources?: {
696
700
  [key: string]: string | number;
697
701
  };
698
702
  } & {
699
- [key: string]: unknown;
703
+ [key: string]: string | number | {
704
+ [key: string]: string | number;
705
+ };
700
706
  };
701
707
  global?: {
702
708
  image?: string;
@@ -710,11 +716,6 @@ export interface paths {
710
716
  [key: string]: string;
711
717
  };
712
718
  };
713
- /**
714
- * @description **********************
715
- * Job Definition Types *
716
- * **********************
717
- */
718
719
  ops: {
719
720
  /** @enum {string} */
720
721
  type: "container/run" | "container/create-volume";
@@ -729,10 +730,11 @@ export interface paths {
729
730
  }[];
730
731
  expose?: number | string | {
731
732
  __spread__: string;
732
- } | (number | string | {
733
- port: number | string;
733
+ chunked?: boolean;
734
+ } | {
735
+ port: number;
734
736
  /** @enum {string} */
735
- type?: "web" | "api" | "websocket" | "webapi" | "none";
737
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
736
738
  health_checks?: ({
737
739
  /** @enum {string} */
738
740
  type: "http";
@@ -752,19 +754,44 @@ export interface paths {
752
754
  expected_response: string;
753
755
  continuous: boolean;
754
756
  })[];
755
- } | {
757
+ } | (number | string | {
756
758
  __spread__: string;
759
+ chunked?: boolean;
760
+ } | {
761
+ port: number;
762
+ /** @enum {string} */
763
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
764
+ health_checks?: ({
765
+ /** @enum {string} */
766
+ type: "http";
767
+ path: string;
768
+ /** @enum {string} */
769
+ method: "GET" | "POST" | "PUT" | "DELETE";
770
+ expected_status: number;
771
+ /** @description Construct a type with a set of properties K of type T */
772
+ headers?: {
773
+ [key: string]: string;
774
+ };
775
+ body?: unknown;
776
+ continuous: boolean;
777
+ } | {
778
+ /** @enum {string} */
779
+ type: "websocket";
780
+ expected_response: string;
781
+ continuous: boolean;
782
+ })[];
757
783
  })[];
758
- private?: boolean;
759
784
  gpu?: boolean;
760
785
  work_dir?: string;
761
- output?: string;
762
786
  entrypoint?: string | string[];
763
787
  env?: {
764
788
  [key: string]: string;
765
789
  };
766
- required_vram?: number;
767
- resources?: (({
790
+ private?: boolean;
791
+ resources?: ({
792
+ __spread__: string;
793
+ chunked?: boolean;
794
+ } | {
768
795
  /** @enum {string} */
769
796
  type: "S3";
770
797
  target: string;
@@ -776,7 +803,7 @@ export interface paths {
776
803
  ACCESS_KEY_ID: string;
777
804
  SECRET_ACCESS_KEY: string;
778
805
  };
779
- } & Record<string, never>) | ({
806
+ } | {
780
807
  /** @enum {string} */
781
808
  type: "S3";
782
809
  target: string;
@@ -788,7 +815,7 @@ export interface paths {
788
815
  ACCESS_KEY_ID: string;
789
816
  SECRET_ACCESS_KEY: string;
790
817
  };
791
- } & Record<string, never>) | ({
818
+ } | {
792
819
  /** @enum {string} */
793
820
  type: "S3";
794
821
  target: string;
@@ -803,7 +830,7 @@ export interface paths {
803
830
  ACCESS_KEY_ID: string;
804
831
  SECRET_ACCESS_KEY: string;
805
832
  };
806
- } & Record<string, never>) | {
833
+ } | {
807
834
  /** @enum {string} */
808
835
  type: "HF";
809
836
  target: string;
@@ -816,8 +843,6 @@ export interface paths {
816
843
  type: "Ollama";
817
844
  model: string;
818
845
  target?: string;
819
- } | {
820
- __spread__: string;
821
846
  } | "__remove-if-empty__")[];
822
847
  authentication?: {
823
848
  docker?: {
@@ -1832,28 +1857,31 @@ export interface components {
1832
1857
  deployment: string;
1833
1858
  ipfs_definition_hash: string;
1834
1859
  job_definition: {
1835
- version: string;
1860
+ /** @enum {string} */
1861
+ version: "0.1";
1836
1862
  /** @enum {string} */
1837
1863
  type: "container";
1838
1864
  logistics?: {
1839
- send?: {
1865
+ send: {
1840
1866
  /**
1841
- * @description api-listen - we have an api listenening for the job poster to send the job description
1842
- * api - we recieve an api endpoint to query and it will return the job description
1867
+ * @description api - we receive and send via an endpoint endpoint
1868
+ * api-listen - we create an endpoint to listen for incoming requests
1843
1869
  * @enum {string}
1844
1870
  */
1845
1871
  type: "api" | "api-listen";
1872
+ /** @description Make all properties in T optional */
1846
1873
  args: {
1847
1874
  endpoint?: string;
1848
1875
  };
1849
1876
  };
1850
- receive?: {
1877
+ receive: {
1851
1878
  /**
1852
- * @description api-listen - we have an api that listen for request from the job poster, so we can return the result to them
1853
- * api - we get an api to post the result to
1879
+ * @description api - we receive and send via an endpoint endpoint
1880
+ * api-listen - we create an endpoint to listen for incoming requests
1854
1881
  * @enum {string}
1855
1882
  */
1856
1883
  type: "api" | "api-listen";
1884
+ /** @description Make all properties in T optional */
1857
1885
  args: {
1858
1886
  endpoint?: string;
1859
1887
  };
@@ -1862,11 +1890,14 @@ export interface components {
1862
1890
  deployment_id?: string;
1863
1891
  meta?: {
1864
1892
  trigger?: string;
1893
+ /** @description Construct a type with a set of properties K of type T */
1865
1894
  system_resources?: {
1866
1895
  [key: string]: string | number;
1867
1896
  };
1868
1897
  } & {
1869
- [key: string]: unknown;
1898
+ [key: string]: string | number | {
1899
+ [key: string]: string | number;
1900
+ };
1870
1901
  };
1871
1902
  global?: {
1872
1903
  image?: string;
@@ -1880,11 +1911,6 @@ export interface components {
1880
1911
  [key: string]: string;
1881
1912
  };
1882
1913
  };
1883
- /**
1884
- * @description **********************
1885
- * Job Definition Types *
1886
- * **********************
1887
- */
1888
1914
  ops: {
1889
1915
  /** @enum {string} */
1890
1916
  type: "container/run" | "container/create-volume";
@@ -1899,10 +1925,11 @@ export interface components {
1899
1925
  }[];
1900
1926
  expose?: number | string | {
1901
1927
  __spread__: string;
1902
- } | (number | string | {
1903
- port: number | string;
1928
+ chunked?: boolean;
1929
+ } | {
1930
+ port: number;
1904
1931
  /** @enum {string} */
1905
- type?: "web" | "api" | "websocket" | "webapi" | "none";
1932
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
1906
1933
  health_checks?: ({
1907
1934
  /** @enum {string} */
1908
1935
  type: "http";
@@ -1922,19 +1949,44 @@ export interface components {
1922
1949
  expected_response: string;
1923
1950
  continuous: boolean;
1924
1951
  })[];
1925
- } | {
1952
+ } | (number | string | {
1926
1953
  __spread__: string;
1954
+ chunked?: boolean;
1955
+ } | {
1956
+ port: number;
1957
+ /** @enum {string} */
1958
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
1959
+ health_checks?: ({
1960
+ /** @enum {string} */
1961
+ type: "http";
1962
+ path: string;
1963
+ /** @enum {string} */
1964
+ method: "GET" | "POST" | "PUT" | "DELETE";
1965
+ expected_status: number;
1966
+ /** @description Construct a type with a set of properties K of type T */
1967
+ headers?: {
1968
+ [key: string]: string;
1969
+ };
1970
+ body?: unknown;
1971
+ continuous: boolean;
1972
+ } | {
1973
+ /** @enum {string} */
1974
+ type: "websocket";
1975
+ expected_response: string;
1976
+ continuous: boolean;
1977
+ })[];
1927
1978
  })[];
1928
- private?: boolean;
1929
1979
  gpu?: boolean;
1930
1980
  work_dir?: string;
1931
- output?: string;
1932
1981
  entrypoint?: string | string[];
1933
1982
  env?: {
1934
1983
  [key: string]: string;
1935
1984
  };
1936
- required_vram?: number;
1937
- resources?: (({
1985
+ private?: boolean;
1986
+ resources?: ({
1987
+ __spread__: string;
1988
+ chunked?: boolean;
1989
+ } | {
1938
1990
  /** @enum {string} */
1939
1991
  type: "S3";
1940
1992
  target: string;
@@ -1946,7 +1998,7 @@ export interface components {
1946
1998
  ACCESS_KEY_ID: string;
1947
1999
  SECRET_ACCESS_KEY: string;
1948
2000
  };
1949
- } & Record<string, never>) | ({
2001
+ } | {
1950
2002
  /** @enum {string} */
1951
2003
  type: "S3";
1952
2004
  target: string;
@@ -1958,7 +2010,7 @@ export interface components {
1958
2010
  ACCESS_KEY_ID: string;
1959
2011
  SECRET_ACCESS_KEY: string;
1960
2012
  };
1961
- } & Record<string, never>) | ({
2013
+ } | {
1962
2014
  /** @enum {string} */
1963
2015
  type: "S3";
1964
2016
  target: string;
@@ -1973,7 +2025,7 @@ export interface components {
1973
2025
  ACCESS_KEY_ID: string;
1974
2026
  SECRET_ACCESS_KEY: string;
1975
2027
  };
1976
- } & Record<string, never>) | {
2028
+ } | {
1977
2029
  /** @enum {string} */
1978
2030
  type: "HF";
1979
2031
  target: string;
@@ -1986,8 +2038,6 @@ export interface components {
1986
2038
  type: "Ollama";
1987
2039
  model: string;
1988
2040
  target?: string;
1989
- } | {
1990
- __spread__: string;
1991
2041
  } | "__remove-if-empty__")[];
1992
2042
  authentication?: {
1993
2043
  docker?: {
@@ -2024,10 +2074,14 @@ export interface components {
2024
2074
  tx: string;
2025
2075
  job: string;
2026
2076
  deployment: string;
2077
+ market: string;
2027
2078
  revision: number;
2028
- status: "PENDING" | "CONFIRMED" | "COMPLETED";
2079
+ state: "QUEUED" | "RUNNING" | "COMPLETED" | "STOPPED";
2080
+ time_start: number;
2029
2081
  /** Format: date-time */
2030
2082
  created_at: string;
2083
+ /** Format: date-time */
2084
+ updated_at: string;
2031
2085
  }[];
2032
2086
  events: {
2033
2087
  category: "Deployment" | "Event";
@@ -2050,12 +2104,17 @@ export interface components {
2050
2104
  /** Format: date-time */
2051
2105
  updated_at: string;
2052
2106
  } & ({
2053
- strategy: "SIMPLE" | "SIMPLE-EXTEND" | "INFINITE";
2107
+ strategy: "SIMPLE" | "SIMPLE-EXTEND";
2054
2108
  } | {
2055
2109
  /** @enum {string} */
2056
2110
  strategy: "SCHEDULED";
2057
2111
  /** @description Cron expression for scheduled deployments */
2058
2112
  schedule: string;
2113
+ } | {
2114
+ timeout: number;
2115
+ /** @enum {string} */
2116
+ strategy: "INFINITE";
2117
+ rotation_time: number;
2059
2118
  });
2060
2119
  /** Deployments */
2061
2120
  Deployments: components["schemas"]["Deployment"][];
@@ -2068,32 +2127,36 @@ export interface components {
2068
2127
  name: string;
2069
2128
  market: string;
2070
2129
  replicas: number;
2130
+ /** @description Timeout in minutes, must be at least 1 minute. */
2071
2131
  timeout: number;
2072
2132
  vault?: string;
2073
2133
  confidential?: boolean;
2074
2134
  job_definition: {
2075
- version: string;
2135
+ /** @enum {string} */
2136
+ version: "0.1";
2076
2137
  /** @enum {string} */
2077
2138
  type: "container";
2078
2139
  logistics?: {
2079
- send?: {
2140
+ send: {
2080
2141
  /**
2081
- * @description api-listen - we have an api listenening for the job poster to send the job description
2082
- * api - we recieve an api endpoint to query and it will return the job description
2142
+ * @description api - we receive and send via an endpoint endpoint
2143
+ * api-listen - we create an endpoint to listen for incoming requests
2083
2144
  * @enum {string}
2084
2145
  */
2085
2146
  type: "api" | "api-listen";
2147
+ /** @description Make all properties in T optional */
2086
2148
  args: {
2087
2149
  endpoint?: string;
2088
2150
  };
2089
2151
  };
2090
- receive?: {
2152
+ receive: {
2091
2153
  /**
2092
- * @description api-listen - we have an api that listen for request from the job poster, so we can return the result to them
2093
- * api - we get an api to post the result to
2154
+ * @description api - we receive and send via an endpoint endpoint
2155
+ * api-listen - we create an endpoint to listen for incoming requests
2094
2156
  * @enum {string}
2095
2157
  */
2096
2158
  type: "api" | "api-listen";
2159
+ /** @description Make all properties in T optional */
2097
2160
  args: {
2098
2161
  endpoint?: string;
2099
2162
  };
@@ -2102,11 +2165,14 @@ export interface components {
2102
2165
  deployment_id?: string;
2103
2166
  meta?: {
2104
2167
  trigger?: string;
2168
+ /** @description Construct a type with a set of properties K of type T */
2105
2169
  system_resources?: {
2106
2170
  [key: string]: string | number;
2107
2171
  };
2108
2172
  } & {
2109
- [key: string]: unknown;
2173
+ [key: string]: string | number | {
2174
+ [key: string]: string | number;
2175
+ };
2110
2176
  };
2111
2177
  global?: {
2112
2178
  image?: string;
@@ -2120,11 +2186,6 @@ export interface components {
2120
2186
  [key: string]: string;
2121
2187
  };
2122
2188
  };
2123
- /**
2124
- * @description **********************
2125
- * Job Definition Types *
2126
- * **********************
2127
- */
2128
2189
  ops: {
2129
2190
  /** @enum {string} */
2130
2191
  type: "container/run" | "container/create-volume";
@@ -2139,10 +2200,11 @@ export interface components {
2139
2200
  }[];
2140
2201
  expose?: number | string | {
2141
2202
  __spread__: string;
2142
- } | (number | string | {
2143
- port: number | string;
2203
+ chunked?: boolean;
2204
+ } | {
2205
+ port: number;
2144
2206
  /** @enum {string} */
2145
- type?: "web" | "api" | "websocket" | "webapi" | "none";
2207
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
2146
2208
  health_checks?: ({
2147
2209
  /** @enum {string} */
2148
2210
  type: "http";
@@ -2162,19 +2224,44 @@ export interface components {
2162
2224
  expected_response: string;
2163
2225
  continuous: boolean;
2164
2226
  })[];
2165
- } | {
2227
+ } | (number | string | {
2166
2228
  __spread__: string;
2229
+ chunked?: boolean;
2230
+ } | {
2231
+ port: number;
2232
+ /** @enum {string} */
2233
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
2234
+ health_checks?: ({
2235
+ /** @enum {string} */
2236
+ type: "http";
2237
+ path: string;
2238
+ /** @enum {string} */
2239
+ method: "GET" | "POST" | "PUT" | "DELETE";
2240
+ expected_status: number;
2241
+ /** @description Construct a type with a set of properties K of type T */
2242
+ headers?: {
2243
+ [key: string]: string;
2244
+ };
2245
+ body?: unknown;
2246
+ continuous: boolean;
2247
+ } | {
2248
+ /** @enum {string} */
2249
+ type: "websocket";
2250
+ expected_response: string;
2251
+ continuous: boolean;
2252
+ })[];
2167
2253
  })[];
2168
- private?: boolean;
2169
2254
  gpu?: boolean;
2170
2255
  work_dir?: string;
2171
- output?: string;
2172
2256
  entrypoint?: string | string[];
2173
2257
  env?: {
2174
2258
  [key: string]: string;
2175
2259
  };
2176
- required_vram?: number;
2177
- resources?: (({
2260
+ private?: boolean;
2261
+ resources?: ({
2262
+ __spread__: string;
2263
+ chunked?: boolean;
2264
+ } | {
2178
2265
  /** @enum {string} */
2179
2266
  type: "S3";
2180
2267
  target: string;
@@ -2186,7 +2273,7 @@ export interface components {
2186
2273
  ACCESS_KEY_ID: string;
2187
2274
  SECRET_ACCESS_KEY: string;
2188
2275
  };
2189
- } & Record<string, never>) | ({
2276
+ } | {
2190
2277
  /** @enum {string} */
2191
2278
  type: "S3";
2192
2279
  target: string;
@@ -2198,7 +2285,7 @@ export interface components {
2198
2285
  ACCESS_KEY_ID: string;
2199
2286
  SECRET_ACCESS_KEY: string;
2200
2287
  };
2201
- } & Record<string, never>) | ({
2288
+ } | {
2202
2289
  /** @enum {string} */
2203
2290
  type: "S3";
2204
2291
  target: string;
@@ -2213,7 +2300,7 @@ export interface components {
2213
2300
  ACCESS_KEY_ID: string;
2214
2301
  SECRET_ACCESS_KEY: string;
2215
2302
  };
2216
- } & Record<string, never>) | {
2303
+ } | {
2217
2304
  /** @enum {string} */
2218
2305
  type: "HF";
2219
2306
  target: string;
@@ -2226,8 +2313,6 @@ export interface components {
2226
2313
  type: "Ollama";
2227
2314
  model: string;
2228
2315
  target?: string;
2229
- } | {
2230
- __spread__: string;
2231
2316
  } | "__remove-if-empty__")[];
2232
2317
  authentication?: {
2233
2318
  docker?: {
@@ -2256,12 +2341,19 @@ export interface components {
2256
2341
  }[];
2257
2342
  };
2258
2343
  } & ({
2259
- strategy: "SIMPLE" | "SIMPLE-EXTEND" | "INFINITE";
2344
+ strategy: "SIMPLE" | "SIMPLE-EXTEND";
2260
2345
  } | {
2261
2346
  /** @enum {string} */
2262
2347
  strategy: "SCHEDULED";
2263
2348
  /** @description Cron expression for scheduled deployments */
2264
2349
  schedule: string;
2350
+ } | {
2351
+ /** @description Timeout in minutes, must be at least 60 minute. */
2352
+ timeout: number;
2353
+ /** @enum {string} */
2354
+ strategy: "INFINITE";
2355
+ /** @description Rotation time in seconds. Must be at least 10 minutes less than timeout to allow for proper rotation. */
2356
+ rotation_time?: number;
2265
2357
  });
2266
2358
  /** Endpoint */
2267
2359
  Endpoint: {
@@ -2288,10 +2380,14 @@ export interface components {
2288
2380
  tx: string;
2289
2381
  job: string;
2290
2382
  deployment: string;
2383
+ market: string;
2291
2384
  revision: number;
2292
- status: "PENDING" | "CONFIRMED" | "COMPLETED";
2385
+ state: "QUEUED" | "RUNNING" | "COMPLETED" | "STOPPED";
2386
+ time_start: number;
2293
2387
  /** Format: date-time */
2294
2388
  created_at: string;
2389
+ /** Format: date-time */
2390
+ updated_at: string;
2295
2391
  };
2296
2392
  /** PublicKey */
2297
2393
  PublicKey: string;
@@ -2300,6 +2396,9 @@ export interface components {
2300
2396
  task: "LIST" | "EXTEND" | "STOP";
2301
2397
  deploymentId: string;
2302
2398
  tx?: string;
2399
+ job?: string;
2400
+ limit?: number;
2401
+ active_revision?: number;
2303
2402
  /** Format: date-time */
2304
2403
  due_at: string;
2305
2404
  /** Format: date-time */
@@ -2325,28 +2424,31 @@ export interface components {
2325
2424
  deployment: string;
2326
2425
  ipfs_definition_hash: string;
2327
2426
  job_definition: {
2328
- version: string;
2427
+ /** @enum {string} */
2428
+ version: "0.1";
2329
2429
  /** @enum {string} */
2330
2430
  type: "container";
2331
2431
  logistics?: {
2332
- send?: {
2432
+ send: {
2333
2433
  /**
2334
- * @description api-listen - we have an api listenening for the job poster to send the job description
2335
- * api - we recieve an api endpoint to query and it will return the job description
2434
+ * @description api - we receive and send via an endpoint endpoint
2435
+ * api-listen - we create an endpoint to listen for incoming requests
2336
2436
  * @enum {string}
2337
2437
  */
2338
2438
  type: "api" | "api-listen";
2439
+ /** @description Make all properties in T optional */
2339
2440
  args: {
2340
2441
  endpoint?: string;
2341
2442
  };
2342
2443
  };
2343
- receive?: {
2444
+ receive: {
2344
2445
  /**
2345
- * @description api-listen - we have an api that listen for request from the job poster, so we can return the result to them
2346
- * api - we get an api to post the result to
2446
+ * @description api - we receive and send via an endpoint endpoint
2447
+ * api-listen - we create an endpoint to listen for incoming requests
2347
2448
  * @enum {string}
2348
2449
  */
2349
2450
  type: "api" | "api-listen";
2451
+ /** @description Make all properties in T optional */
2350
2452
  args: {
2351
2453
  endpoint?: string;
2352
2454
  };
@@ -2355,11 +2457,14 @@ export interface components {
2355
2457
  deployment_id?: string;
2356
2458
  meta?: {
2357
2459
  trigger?: string;
2460
+ /** @description Construct a type with a set of properties K of type T */
2358
2461
  system_resources?: {
2359
2462
  [key: string]: string | number;
2360
2463
  };
2361
2464
  } & {
2362
- [key: string]: unknown;
2465
+ [key: string]: string | number | {
2466
+ [key: string]: string | number;
2467
+ };
2363
2468
  };
2364
2469
  global?: {
2365
2470
  image?: string;
@@ -2373,11 +2478,6 @@ export interface components {
2373
2478
  [key: string]: string;
2374
2479
  };
2375
2480
  };
2376
- /**
2377
- * @description **********************
2378
- * Job Definition Types *
2379
- * **********************
2380
- */
2381
2481
  ops: {
2382
2482
  /** @enum {string} */
2383
2483
  type: "container/run" | "container/create-volume";
@@ -2392,10 +2492,11 @@ export interface components {
2392
2492
  }[];
2393
2493
  expose?: number | string | {
2394
2494
  __spread__: string;
2395
- } | (number | string | {
2396
- port: number | string;
2495
+ chunked?: boolean;
2496
+ } | {
2497
+ port: number;
2397
2498
  /** @enum {string} */
2398
- type?: "web" | "api" | "websocket" | "webapi" | "none";
2499
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
2399
2500
  health_checks?: ({
2400
2501
  /** @enum {string} */
2401
2502
  type: "http";
@@ -2415,19 +2516,44 @@ export interface components {
2415
2516
  expected_response: string;
2416
2517
  continuous: boolean;
2417
2518
  })[];
2418
- } | {
2519
+ } | (number | string | {
2419
2520
  __spread__: string;
2521
+ chunked?: boolean;
2522
+ } | {
2523
+ port: number;
2524
+ /** @enum {string} */
2525
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
2526
+ health_checks?: ({
2527
+ /** @enum {string} */
2528
+ type: "http";
2529
+ path: string;
2530
+ /** @enum {string} */
2531
+ method: "GET" | "POST" | "PUT" | "DELETE";
2532
+ expected_status: number;
2533
+ /** @description Construct a type with a set of properties K of type T */
2534
+ headers?: {
2535
+ [key: string]: string;
2536
+ };
2537
+ body?: unknown;
2538
+ continuous: boolean;
2539
+ } | {
2540
+ /** @enum {string} */
2541
+ type: "websocket";
2542
+ expected_response: string;
2543
+ continuous: boolean;
2544
+ })[];
2420
2545
  })[];
2421
- private?: boolean;
2422
2546
  gpu?: boolean;
2423
2547
  work_dir?: string;
2424
- output?: string;
2425
2548
  entrypoint?: string | string[];
2426
2549
  env?: {
2427
2550
  [key: string]: string;
2428
2551
  };
2429
- required_vram?: number;
2430
- resources?: (({
2552
+ private?: boolean;
2553
+ resources?: ({
2554
+ __spread__: string;
2555
+ chunked?: boolean;
2556
+ } | {
2431
2557
  /** @enum {string} */
2432
2558
  type: "S3";
2433
2559
  target: string;
@@ -2439,7 +2565,7 @@ export interface components {
2439
2565
  ACCESS_KEY_ID: string;
2440
2566
  SECRET_ACCESS_KEY: string;
2441
2567
  };
2442
- } & Record<string, never>) | ({
2568
+ } | {
2443
2569
  /** @enum {string} */
2444
2570
  type: "S3";
2445
2571
  target: string;
@@ -2451,7 +2577,7 @@ export interface components {
2451
2577
  ACCESS_KEY_ID: string;
2452
2578
  SECRET_ACCESS_KEY: string;
2453
2579
  };
2454
- } & Record<string, never>) | ({
2580
+ } | {
2455
2581
  /** @enum {string} */
2456
2582
  type: "S3";
2457
2583
  target: string;
@@ -2466,7 +2592,7 @@ export interface components {
2466
2592
  ACCESS_KEY_ID: string;
2467
2593
  SECRET_ACCESS_KEY: string;
2468
2594
  };
2469
- } & Record<string, never>) | {
2595
+ } | {
2470
2596
  /** @enum {string} */
2471
2597
  type: "HF";
2472
2598
  target: string;
@@ -2479,8 +2605,6 @@ export interface components {
2479
2605
  type: "Ollama";
2480
2606
  model: string;
2481
2607
  target?: string;
2482
- } | {
2483
- __spread__: string;
2484
2608
  } | "__remove-if-empty__")[];
2485
2609
  authentication?: {
2486
2610
  docker?: {
@@ -2513,28 +2637,31 @@ export interface components {
2513
2637
  };
2514
2638
  /** JobDefinition */
2515
2639
  JobDefinition: {
2516
- version: string;
2640
+ /** @enum {string} */
2641
+ version: "0.1";
2517
2642
  /** @enum {string} */
2518
2643
  type: "container";
2519
2644
  logistics?: {
2520
- send?: {
2645
+ send: {
2521
2646
  /**
2522
- * @description api-listen - we have an api listenening for the job poster to send the job description
2523
- * api - we recieve an api endpoint to query and it will return the job description
2647
+ * @description api - we receive and send via an endpoint endpoint
2648
+ * api-listen - we create an endpoint to listen for incoming requests
2524
2649
  * @enum {string}
2525
2650
  */
2526
2651
  type: "api" | "api-listen";
2652
+ /** @description Make all properties in T optional */
2527
2653
  args: {
2528
2654
  endpoint?: string;
2529
2655
  };
2530
2656
  };
2531
- receive?: {
2657
+ receive: {
2532
2658
  /**
2533
- * @description api-listen - we have an api that listen for request from the job poster, so we can return the result to them
2534
- * api - we get an api to post the result to
2659
+ * @description api - we receive and send via an endpoint endpoint
2660
+ * api-listen - we create an endpoint to listen for incoming requests
2535
2661
  * @enum {string}
2536
2662
  */
2537
2663
  type: "api" | "api-listen";
2664
+ /** @description Make all properties in T optional */
2538
2665
  args: {
2539
2666
  endpoint?: string;
2540
2667
  };
@@ -2543,11 +2670,14 @@ export interface components {
2543
2670
  deployment_id?: string;
2544
2671
  meta?: {
2545
2672
  trigger?: string;
2673
+ /** @description Construct a type with a set of properties K of type T */
2546
2674
  system_resources?: {
2547
2675
  [key: string]: string | number;
2548
2676
  };
2549
2677
  } & {
2550
- [key: string]: unknown;
2678
+ [key: string]: string | number | {
2679
+ [key: string]: string | number;
2680
+ };
2551
2681
  };
2552
2682
  global?: {
2553
2683
  image?: string;
@@ -2561,11 +2691,6 @@ export interface components {
2561
2691
  [key: string]: string;
2562
2692
  };
2563
2693
  };
2564
- /**
2565
- * @description **********************
2566
- * Job Definition Types *
2567
- * **********************
2568
- */
2569
2694
  ops: {
2570
2695
  /** @enum {string} */
2571
2696
  type: "container/run" | "container/create-volume";
@@ -2580,10 +2705,11 @@ export interface components {
2580
2705
  }[];
2581
2706
  expose?: number | string | {
2582
2707
  __spread__: string;
2583
- } | (number | string | {
2584
- port: number | string;
2708
+ chunked?: boolean;
2709
+ } | {
2710
+ port: number;
2585
2711
  /** @enum {string} */
2586
- type?: "web" | "api" | "websocket" | "webapi" | "none";
2712
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
2587
2713
  health_checks?: ({
2588
2714
  /** @enum {string} */
2589
2715
  type: "http";
@@ -2603,19 +2729,44 @@ export interface components {
2603
2729
  expected_response: string;
2604
2730
  continuous: boolean;
2605
2731
  })[];
2606
- } | {
2732
+ } | (number | string | {
2607
2733
  __spread__: string;
2734
+ chunked?: boolean;
2735
+ } | {
2736
+ port: number;
2737
+ /** @enum {string} */
2738
+ type?: "api" | "web" | "websocket" | "webapi" | "none";
2739
+ health_checks?: ({
2740
+ /** @enum {string} */
2741
+ type: "http";
2742
+ path: string;
2743
+ /** @enum {string} */
2744
+ method: "GET" | "POST" | "PUT" | "DELETE";
2745
+ expected_status: number;
2746
+ /** @description Construct a type with a set of properties K of type T */
2747
+ headers?: {
2748
+ [key: string]: string;
2749
+ };
2750
+ body?: unknown;
2751
+ continuous: boolean;
2752
+ } | {
2753
+ /** @enum {string} */
2754
+ type: "websocket";
2755
+ expected_response: string;
2756
+ continuous: boolean;
2757
+ })[];
2608
2758
  })[];
2609
- private?: boolean;
2610
2759
  gpu?: boolean;
2611
2760
  work_dir?: string;
2612
- output?: string;
2613
2761
  entrypoint?: string | string[];
2614
2762
  env?: {
2615
2763
  [key: string]: string;
2616
2764
  };
2617
- required_vram?: number;
2618
- resources?: (({
2765
+ private?: boolean;
2766
+ resources?: ({
2767
+ __spread__: string;
2768
+ chunked?: boolean;
2769
+ } | {
2619
2770
  /** @enum {string} */
2620
2771
  type: "S3";
2621
2772
  target: string;
@@ -2627,7 +2778,7 @@ export interface components {
2627
2778
  ACCESS_KEY_ID: string;
2628
2779
  SECRET_ACCESS_KEY: string;
2629
2780
  };
2630
- } & Record<string, never>) | ({
2781
+ } | {
2631
2782
  /** @enum {string} */
2632
2783
  type: "S3";
2633
2784
  target: string;
@@ -2639,7 +2790,7 @@ export interface components {
2639
2790
  ACCESS_KEY_ID: string;
2640
2791
  SECRET_ACCESS_KEY: string;
2641
2792
  };
2642
- } & Record<string, never>) | ({
2793
+ } | {
2643
2794
  /** @enum {string} */
2644
2795
  type: "S3";
2645
2796
  target: string;
@@ -2654,7 +2805,7 @@ export interface components {
2654
2805
  ACCESS_KEY_ID: string;
2655
2806
  SECRET_ACCESS_KEY: string;
2656
2807
  };
2657
- } & Record<string, never>) | {
2808
+ } | {
2658
2809
  /** @enum {string} */
2659
2810
  type: "HF";
2660
2811
  target: string;
@@ -2667,8 +2818,6 @@ export interface components {
2667
2818
  type: "Ollama";
2668
2819
  model: string;
2669
2820
  target?: string;
2670
- } | {
2671
- __spread__: string;
2672
2821
  } | "__remove-if-empty__")[];
2673
2822
  authentication?: {
2674
2823
  docker?: {
@@ -2696,12 +2845,7 @@ export interface components {
2696
2845
  };
2697
2846
  }[];
2698
2847
  };
2699
- /**
2700
- * JobResults
2701
- * @description **********************
2702
- * Job Result Types *
2703
- * **********************
2704
- */
2848
+ /** JobResults */
2705
2849
  JobResults: {
2706
2850
  status: string;
2707
2851
  startTime: number;