twelvelabs-js 1.2.2 → 1.2.3

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 (573) hide show
  1. package/Client.d.ts +2 -0
  2. package/Client.js +4 -2
  3. package/README.md +20 -1
  4. package/api/client/requests/AnalyzeRequest.d.ts +1 -1
  5. package/api/client/requests/AnalyzeStreamRequest.d.ts +1 -1
  6. package/api/errors/ConflictError.d.ts +1 -2
  7. package/api/errors/index.d.ts +1 -1
  8. package/api/errors/index.js +1 -1
  9. package/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +39 -2
  10. package/api/resources/analyzeAsync/resources/tasks/client/Client.js +54 -13
  11. package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +74 -3
  12. package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +26 -1
  13. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  14. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +9 -0
  15. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +13 -0
  16. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
  17. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +7 -0
  18. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +9 -0
  19. package/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  20. package/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  21. package/api/resources/assets/client/Client.d.ts +17 -6
  22. package/api/resources/assets/client/Client.js +41 -13
  23. package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
  24. package/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
  25. package/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
  26. package/api/resources/assets/client/requests/index.d.ts +1 -0
  27. package/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
  28. package/api/resources/embed/client/Client.js +1 -1
  29. package/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
  30. package/api/resources/embed/resources/tasks/client/Client.js +5 -5
  31. package/api/resources/embed/resources/v2/client/Client.js +1 -1
  32. package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +12 -2
  33. package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +15 -5
  34. package/api/resources/entityCollections/client/Client.js +5 -5
  35. package/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
  36. package/api/resources/entityCollections/resources/entities/client/Client.js +100 -9
  37. package/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
  38. package/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
  39. package/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
  40. package/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
  41. package/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  42. package/api/resources/entityCollections/resources/entities/types/index.js +1 -0
  43. package/api/resources/indexes/client/Client.js +5 -5
  44. package/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
  45. package/api/resources/indexes/resources/indexedAssets/client/Client.js +126 -15
  46. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
  47. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
  48. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
  49. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
  50. package/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
  51. package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
  52. package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
  53. package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
  54. package/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  55. package/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  56. package/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
  57. package/api/resources/indexes/resources/videos/client/Client.js +35 -15
  58. package/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
  59. package/api/resources/multipartUpload/client/Client.d.ts +2 -2
  60. package/api/resources/multipartUpload/client/Client.js +7 -7
  61. package/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
  62. package/api/resources/search/client/Client.js +2 -2
  63. package/api/resources/tasks/client/Client.js +4 -4
  64. package/api/resources/tasks/resources/transfers/client/Client.js +3 -3
  65. package/api/types/AnalyzeTaskResponse.d.ts +4 -0
  66. package/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -0
  67. package/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
  68. package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
  69. package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
  70. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +11 -0
  71. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
  72. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +10 -0
  73. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
  74. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
  75. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
  76. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
  77. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
  78. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
  79. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
  80. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
  81. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
  82. package/api/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
  83. package/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
  84. package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
  85. package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
  86. package/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
  87. package/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
  88. package/api/types/AnalyzeTaskResult.d.ts +10 -1
  89. package/api/types/Asset.d.ts +5 -0
  90. package/api/types/AssetDetail.d.ts +11 -0
  91. package/api/types/AssetDetail.js +5 -0
  92. package/api/types/AssetHls.d.ts +21 -0
  93. package/api/types/AssetHls.js +5 -0
  94. package/api/types/AssetHlsStatus.d.ts +19 -0
  95. package/api/types/AssetHlsStatus.js +12 -0
  96. package/api/types/AssetMethod.d.ts +3 -1
  97. package/api/types/AssetMethod.js +1 -0
  98. package/api/types/AssetThumbnail.d.ts +21 -0
  99. package/api/types/AssetThumbnail.js +5 -0
  100. package/api/types/AssetThumbnailStatus.d.ts +19 -0
  101. package/api/types/AssetThumbnailStatus.js +12 -0
  102. package/api/types/AsyncResponseFormat.d.ts +89 -0
  103. package/api/types/AsyncResponseFormat.js +5 -0
  104. package/api/types/AsyncResponseFormatType.d.ts +13 -0
  105. package/api/types/AsyncResponseFormatType.js +10 -0
  106. package/api/types/ConflictErrorBody.d.ts +11 -0
  107. package/api/types/ConflictErrorBody.js +5 -0
  108. package/api/types/Entity.d.ts +2 -0
  109. package/api/types/IndexedAsset.d.ts +2 -0
  110. package/api/types/IndexedAssetSummary.d.ts +12 -0
  111. package/api/types/IndexedAssetSummary.js +5 -0
  112. package/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
  113. package/api/types/IndexedAssetSummaryIndex.js +5 -0
  114. package/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
  115. package/api/types/IndexedAssetsListRequestDuration.js +5 -0
  116. package/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
  117. package/api/types/IndexedAssetsListRequestFps.js +5 -0
  118. package/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
  119. package/api/types/IndexedAssetsListRequestHeight.js +5 -0
  120. package/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
  121. package/api/types/IndexedAssetsListRequestSize.js +5 -0
  122. package/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
  123. package/api/types/IndexedAssetsListRequestWidth.js +5 -0
  124. package/api/types/InternalEntity.d.ts +23 -1
  125. package/api/types/MediaSource.d.ts +1 -1
  126. package/api/types/One.d.ts +1 -1
  127. package/api/types/SegmentDefinition.d.ts +17 -0
  128. package/api/types/SegmentDefinition.js +5 -0
  129. package/api/types/SegmentField.d.ts +19 -0
  130. package/api/types/SegmentField.js +5 -0
  131. package/api/types/SegmentFieldItems.d.ts +10 -0
  132. package/api/types/SegmentFieldItems.js +5 -0
  133. package/api/types/SegmentFieldItemsType.d.ts +10 -0
  134. package/api/types/SegmentFieldItemsType.js +12 -0
  135. package/api/types/SegmentFieldType.d.ts +14 -0
  136. package/api/types/SegmentFieldType.js +13 -0
  137. package/api/types/SmeMediaSource.d.ts +19 -0
  138. package/api/types/SmeMediaSource.js +5 -0
  139. package/api/types/SmeMediaSourceMediaType.d.ts +10 -0
  140. package/api/types/SmeMediaSourceMediaType.js +9 -0
  141. package/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +2 -2
  142. package/api/types/SyncResponseFormat.js +5 -0
  143. package/{dist/api/types/ResponseFormatType.d.ts → api/types/SyncResponseFormatType.d.ts} +2 -2
  144. package/{dist/api/types/ResponseFormatType.js → api/types/SyncResponseFormatType.js} +2 -2
  145. package/api/types/VideosListRequestDuration.d.ts +7 -0
  146. package/api/types/VideosListRequestDuration.js +5 -0
  147. package/api/types/VideosListRequestFps.d.ts +7 -0
  148. package/api/types/VideosListRequestFps.js +5 -0
  149. package/api/types/VideosListRequestHeight.d.ts +7 -0
  150. package/api/types/VideosListRequestHeight.js +5 -0
  151. package/api/types/VideosListRequestSize.d.ts +7 -0
  152. package/api/types/VideosListRequestSize.js +5 -0
  153. package/api/types/VideosListRequestWidth.d.ts +7 -0
  154. package/api/types/VideosListRequestWidth.js +5 -0
  155. package/api/types/index.d.ts +40 -2
  156. package/api/types/index.js +40 -2
  157. package/dist/Client.d.ts +2 -0
  158. package/dist/Client.js +4 -2
  159. package/dist/api/client/requests/AnalyzeRequest.d.ts +1 -1
  160. package/dist/api/client/requests/AnalyzeStreamRequest.d.ts +1 -1
  161. package/dist/api/errors/ConflictError.d.ts +1 -2
  162. package/dist/api/errors/index.d.ts +1 -1
  163. package/dist/api/errors/index.js +1 -1
  164. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +39 -2
  165. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.js +54 -13
  166. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +74 -3
  167. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +26 -1
  168. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  169. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +9 -0
  170. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +13 -0
  171. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
  172. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +7 -0
  173. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +9 -0
  174. package/dist/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  175. package/dist/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  176. package/dist/api/resources/assets/client/Client.d.ts +17 -6
  177. package/dist/api/resources/assets/client/Client.js +41 -13
  178. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
  179. package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
  180. package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.js +5 -0
  181. package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
  182. package/dist/api/resources/assets/client/requests/index.d.ts +1 -0
  183. package/dist/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
  184. package/dist/api/resources/embed/client/Client.js +1 -1
  185. package/dist/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
  186. package/dist/api/resources/embed/resources/tasks/client/Client.js +5 -5
  187. package/dist/api/resources/embed/resources/v2/client/Client.js +1 -1
  188. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +12 -2
  189. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +15 -5
  190. package/dist/api/resources/entityCollections/client/Client.js +5 -5
  191. package/dist/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
  192. package/dist/api/resources/entityCollections/resources/entities/client/Client.js +100 -9
  193. package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
  194. package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js +5 -0
  195. package/dist/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
  196. package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
  197. package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
  198. package/dist/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  199. package/dist/api/resources/entityCollections/resources/entities/types/index.js +1 -0
  200. package/dist/api/resources/indexes/client/Client.js +5 -5
  201. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
  202. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +126 -15
  203. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
  204. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
  205. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
  206. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
  207. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
  208. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
  209. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
  210. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
  211. package/dist/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  212. package/dist/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  213. package/dist/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
  214. package/dist/api/resources/indexes/resources/videos/client/Client.js +35 -15
  215. package/dist/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
  216. package/dist/api/resources/multipartUpload/client/Client.d.ts +2 -2
  217. package/dist/api/resources/multipartUpload/client/Client.js +7 -7
  218. package/dist/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
  219. package/dist/api/resources/search/client/Client.js +2 -2
  220. package/dist/api/resources/tasks/client/Client.js +4 -4
  221. package/dist/api/resources/tasks/resources/transfers/client/Client.js +3 -3
  222. package/dist/api/types/AnalyzeTaskResponse.d.ts +4 -0
  223. package/dist/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -0
  224. package/dist/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
  225. package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
  226. package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
  227. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +11 -0
  228. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
  229. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +10 -0
  230. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
  231. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
  232. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
  233. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
  234. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
  235. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
  236. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
  237. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
  238. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
  239. package/dist/api/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
  240. package/dist/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
  241. package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
  242. package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
  243. package/dist/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
  244. package/dist/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
  245. package/dist/api/types/AnalyzeTaskResult.d.ts +10 -1
  246. package/dist/api/types/Asset.d.ts +5 -0
  247. package/dist/api/types/AssetDetail.d.ts +11 -0
  248. package/dist/api/types/AssetDetail.js +5 -0
  249. package/dist/api/types/AssetHls.d.ts +21 -0
  250. package/dist/api/types/AssetHls.js +5 -0
  251. package/dist/api/types/AssetHlsStatus.d.ts +19 -0
  252. package/dist/api/types/AssetHlsStatus.js +12 -0
  253. package/dist/api/types/AssetMethod.d.ts +3 -1
  254. package/dist/api/types/AssetMethod.js +1 -0
  255. package/dist/api/types/AssetThumbnail.d.ts +21 -0
  256. package/dist/api/types/AssetThumbnail.js +5 -0
  257. package/dist/api/types/AssetThumbnailStatus.d.ts +19 -0
  258. package/dist/api/types/AssetThumbnailStatus.js +12 -0
  259. package/dist/api/types/AsyncResponseFormat.d.ts +89 -0
  260. package/dist/api/types/AsyncResponseFormat.js +5 -0
  261. package/dist/api/types/AsyncResponseFormatType.d.ts +13 -0
  262. package/dist/api/types/AsyncResponseFormatType.js +10 -0
  263. package/dist/api/types/ConflictErrorBody.d.ts +11 -0
  264. package/dist/api/types/ConflictErrorBody.js +5 -0
  265. package/dist/api/types/Entity.d.ts +2 -0
  266. package/dist/api/types/IndexedAsset.d.ts +2 -0
  267. package/dist/api/types/IndexedAssetSummary.d.ts +12 -0
  268. package/dist/api/types/IndexedAssetSummary.js +5 -0
  269. package/dist/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
  270. package/dist/api/types/IndexedAssetSummaryIndex.js +5 -0
  271. package/dist/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
  272. package/dist/api/types/IndexedAssetsListRequestDuration.js +5 -0
  273. package/dist/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
  274. package/dist/api/types/IndexedAssetsListRequestFps.js +5 -0
  275. package/dist/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
  276. package/dist/api/types/IndexedAssetsListRequestHeight.js +5 -0
  277. package/dist/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
  278. package/dist/api/types/IndexedAssetsListRequestSize.js +5 -0
  279. package/dist/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
  280. package/dist/api/types/IndexedAssetsListRequestWidth.js +5 -0
  281. package/dist/api/types/InternalEntity.d.ts +23 -1
  282. package/dist/api/types/MediaSource.d.ts +1 -1
  283. package/dist/api/types/One.d.ts +1 -1
  284. package/dist/api/types/SegmentDefinition.d.ts +17 -0
  285. package/dist/api/types/SegmentDefinition.js +5 -0
  286. package/dist/api/types/SegmentField.d.ts +19 -0
  287. package/dist/api/types/SegmentField.js +5 -0
  288. package/dist/api/types/SegmentFieldItems.d.ts +10 -0
  289. package/dist/api/types/SegmentFieldItems.js +5 -0
  290. package/dist/api/types/SegmentFieldItemsType.d.ts +10 -0
  291. package/dist/api/types/SegmentFieldItemsType.js +12 -0
  292. package/dist/api/types/SegmentFieldType.d.ts +14 -0
  293. package/dist/api/types/SegmentFieldType.js +13 -0
  294. package/dist/api/types/SmeMediaSource.d.ts +19 -0
  295. package/dist/api/types/SmeMediaSource.js +5 -0
  296. package/dist/api/types/SmeMediaSourceMediaType.d.ts +10 -0
  297. package/dist/api/types/SmeMediaSourceMediaType.js +9 -0
  298. package/dist/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +2 -2
  299. package/dist/api/types/SyncResponseFormat.js +5 -0
  300. package/{api/types/ResponseFormatType.d.ts → dist/api/types/SyncResponseFormatType.d.ts} +2 -2
  301. package/{api/types/ResponseFormatType.js → dist/api/types/SyncResponseFormatType.js} +2 -2
  302. package/dist/api/types/VideosListRequestDuration.d.ts +7 -0
  303. package/dist/api/types/VideosListRequestDuration.js +5 -0
  304. package/dist/api/types/VideosListRequestFps.d.ts +7 -0
  305. package/dist/api/types/VideosListRequestFps.js +5 -0
  306. package/dist/api/types/VideosListRequestHeight.d.ts +7 -0
  307. package/dist/api/types/VideosListRequestHeight.js +5 -0
  308. package/dist/api/types/VideosListRequestSize.d.ts +7 -0
  309. package/dist/api/types/VideosListRequestSize.js +5 -0
  310. package/dist/api/types/VideosListRequestWidth.d.ts +7 -0
  311. package/dist/api/types/VideosListRequestWidth.js +5 -0
  312. package/dist/api/types/index.d.ts +40 -2
  313. package/dist/api/types/index.js +40 -2
  314. package/dist/serialization/client/requests/AnalyzeRequest.d.ts +2 -2
  315. package/dist/serialization/client/requests/AnalyzeRequest.js +2 -2
  316. package/dist/serialization/client/requests/AnalyzeStreamRequest.d.ts +2 -2
  317. package/dist/serialization/client/requests/AnalyzeStreamRequest.js +2 -2
  318. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +10 -6
  319. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +10 -6
  320. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  321. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
  322. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
  323. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
  324. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
  325. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
  326. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  327. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  328. package/dist/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
  329. package/dist/serialization/resources/assets/types/AssetsListResponse.js +2 -2
  330. package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
  331. package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
  332. package/dist/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  333. package/dist/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
  334. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
  335. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
  336. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
  337. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
  338. package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  339. package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  340. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  341. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  342. package/dist/serialization/types/AnalyzeTaskResponse.d.ts +4 -0
  343. package/dist/serialization/types/AnalyzeTaskResponse.js +4 -0
  344. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +19 -0
  345. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.js +50 -0
  346. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
  347. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
  348. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +15 -0
  349. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +46 -0
  350. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +17 -0
  351. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +52 -0
  352. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
  353. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
  354. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
  355. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
  356. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
  357. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
  358. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
  359. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
  360. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +18 -0
  361. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.js +49 -0
  362. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
  363. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
  364. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
  365. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
  366. package/dist/serialization/types/AnalyzeTaskResult.d.ts +1 -2
  367. package/dist/serialization/types/AnalyzeTaskResult.js +1 -2
  368. package/dist/serialization/types/Asset.d.ts +2 -0
  369. package/dist/serialization/types/Asset.js +2 -0
  370. package/dist/serialization/types/AssetDetail.d.ts +16 -0
  371. package/dist/serialization/types/AssetDetail.js +49 -0
  372. package/dist/serialization/types/AssetHls.d.ts +14 -0
  373. package/dist/serialization/types/AssetHls.js +45 -0
  374. package/dist/serialization/types/AssetHlsStatus.d.ts +10 -0
  375. package/dist/serialization/types/AssetHlsStatus.js +41 -0
  376. package/dist/serialization/types/AssetMethod.d.ts +1 -1
  377. package/dist/serialization/types/AssetMethod.js +1 -1
  378. package/dist/serialization/types/AssetThumbnail.d.ts +14 -0
  379. package/dist/serialization/types/AssetThumbnail.js +45 -0
  380. package/dist/serialization/types/AssetThumbnailStatus.d.ts +10 -0
  381. package/dist/serialization/types/AssetThumbnailStatus.js +41 -0
  382. package/dist/serialization/types/AsyncResponseFormat.d.ts +16 -0
  383. package/dist/serialization/types/AsyncResponseFormat.js +47 -0
  384. package/dist/serialization/types/AsyncResponseFormatType.d.ts +10 -0
  385. package/dist/serialization/types/AsyncResponseFormatType.js +41 -0
  386. package/dist/serialization/types/ConflictErrorBody.d.ts +14 -0
  387. package/dist/serialization/types/ConflictErrorBody.js +45 -0
  388. package/dist/serialization/types/Entity.d.ts +1 -0
  389. package/dist/serialization/types/Entity.js +1 -0
  390. package/dist/serialization/types/IndexedAsset.d.ts +1 -0
  391. package/dist/serialization/types/IndexedAsset.js +1 -0
  392. package/dist/serialization/types/IndexedAssetSummary.d.ts +14 -0
  393. package/dist/serialization/types/IndexedAssetSummary.js +45 -0
  394. package/dist/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
  395. package/dist/serialization/types/IndexedAssetSummaryIndex.js +44 -0
  396. package/dist/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
  397. package/dist/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
  398. package/dist/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
  399. package/dist/serialization/types/IndexedAssetsListRequestFps.js +44 -0
  400. package/dist/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
  401. package/dist/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
  402. package/dist/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
  403. package/dist/serialization/types/IndexedAssetsListRequestSize.js +44 -0
  404. package/dist/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
  405. package/dist/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
  406. package/dist/serialization/types/InternalEntity.d.ts +10 -2
  407. package/dist/serialization/types/InternalEntity.js +11 -5
  408. package/dist/serialization/types/SegmentDefinition.d.ts +17 -0
  409. package/dist/serialization/types/SegmentDefinition.js +48 -0
  410. package/dist/serialization/types/SegmentField.d.ts +18 -0
  411. package/dist/serialization/types/SegmentField.js +49 -0
  412. package/dist/serialization/types/SegmentFieldItems.d.ts +13 -0
  413. package/dist/serialization/types/SegmentFieldItems.js +44 -0
  414. package/dist/serialization/types/SegmentFieldItemsType.d.ts +10 -0
  415. package/dist/serialization/types/SegmentFieldItemsType.js +41 -0
  416. package/dist/serialization/types/SegmentFieldType.d.ts +10 -0
  417. package/dist/serialization/types/SegmentFieldType.js +41 -0
  418. package/dist/serialization/types/SmeMediaSource.d.ts +17 -0
  419. package/dist/serialization/types/SmeMediaSource.js +48 -0
  420. package/dist/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
  421. package/dist/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
  422. package/dist/serialization/types/SyncResponseFormat.d.ts +14 -0
  423. package/{serialization/types/ResponseFormat.js → dist/serialization/types/SyncResponseFormat.js} +4 -4
  424. package/dist/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
  425. package/dist/serialization/types/SyncResponseFormatType.js +41 -0
  426. package/dist/serialization/types/VideosListRequestDuration.d.ts +13 -0
  427. package/dist/serialization/types/VideosListRequestDuration.js +44 -0
  428. package/dist/serialization/types/VideosListRequestFps.d.ts +13 -0
  429. package/dist/serialization/types/VideosListRequestFps.js +44 -0
  430. package/dist/serialization/types/VideosListRequestHeight.d.ts +13 -0
  431. package/dist/serialization/types/VideosListRequestHeight.js +44 -0
  432. package/dist/serialization/types/VideosListRequestSize.d.ts +13 -0
  433. package/dist/serialization/types/VideosListRequestSize.js +44 -0
  434. package/dist/serialization/types/VideosListRequestWidth.d.ts +13 -0
  435. package/dist/serialization/types/VideosListRequestWidth.js +44 -0
  436. package/dist/serialization/types/index.d.ts +40 -2
  437. package/dist/serialization/types/index.js +40 -2
  438. package/dist/version.d.ts +1 -1
  439. package/dist/version.js +1 -1
  440. package/dist/wrapper/resources/IndexesVideosWrapper.js +29 -14
  441. package/package.json +1 -1
  442. package/reference.md +219 -35
  443. package/serialization/client/requests/AnalyzeRequest.d.ts +2 -2
  444. package/serialization/client/requests/AnalyzeRequest.js +2 -2
  445. package/serialization/client/requests/AnalyzeStreamRequest.d.ts +2 -2
  446. package/serialization/client/requests/AnalyzeStreamRequest.js +2 -2
  447. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +10 -6
  448. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +10 -6
  449. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  450. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
  451. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
  452. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
  453. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
  454. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
  455. package/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  456. package/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  457. package/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
  458. package/serialization/resources/assets/types/AssetsListResponse.js +2 -2
  459. package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
  460. package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
  461. package/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  462. package/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
  463. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
  464. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
  465. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
  466. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
  467. package/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  468. package/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  469. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  470. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  471. package/serialization/types/AnalyzeTaskResponse.d.ts +4 -0
  472. package/serialization/types/AnalyzeTaskResponse.js +4 -0
  473. package/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +19 -0
  474. package/serialization/types/AnalyzeTaskResponseRequestParams.js +50 -0
  475. package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
  476. package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
  477. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +15 -0
  478. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +46 -0
  479. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +17 -0
  480. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +52 -0
  481. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
  482. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
  483. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
  484. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
  485. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
  486. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
  487. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
  488. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
  489. package/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +18 -0
  490. package/serialization/types/AnalyzeTaskResponseVideoSource.js +49 -0
  491. package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
  492. package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
  493. package/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
  494. package/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
  495. package/serialization/types/AnalyzeTaskResult.d.ts +1 -2
  496. package/serialization/types/AnalyzeTaskResult.js +1 -2
  497. package/serialization/types/Asset.d.ts +2 -0
  498. package/serialization/types/Asset.js +2 -0
  499. package/serialization/types/AssetDetail.d.ts +16 -0
  500. package/serialization/types/AssetDetail.js +49 -0
  501. package/serialization/types/AssetHls.d.ts +14 -0
  502. package/serialization/types/AssetHls.js +45 -0
  503. package/serialization/types/AssetHlsStatus.d.ts +10 -0
  504. package/serialization/types/AssetHlsStatus.js +41 -0
  505. package/serialization/types/AssetMethod.d.ts +1 -1
  506. package/serialization/types/AssetMethod.js +1 -1
  507. package/serialization/types/AssetThumbnail.d.ts +14 -0
  508. package/serialization/types/AssetThumbnail.js +45 -0
  509. package/serialization/types/AssetThumbnailStatus.d.ts +10 -0
  510. package/serialization/types/AssetThumbnailStatus.js +41 -0
  511. package/serialization/types/AsyncResponseFormat.d.ts +16 -0
  512. package/serialization/types/AsyncResponseFormat.js +47 -0
  513. package/serialization/types/AsyncResponseFormatType.d.ts +10 -0
  514. package/serialization/types/AsyncResponseFormatType.js +41 -0
  515. package/serialization/types/ConflictErrorBody.d.ts +14 -0
  516. package/serialization/types/ConflictErrorBody.js +45 -0
  517. package/serialization/types/Entity.d.ts +1 -0
  518. package/serialization/types/Entity.js +1 -0
  519. package/serialization/types/IndexedAsset.d.ts +1 -0
  520. package/serialization/types/IndexedAsset.js +1 -0
  521. package/serialization/types/IndexedAssetSummary.d.ts +14 -0
  522. package/serialization/types/IndexedAssetSummary.js +45 -0
  523. package/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
  524. package/serialization/types/IndexedAssetSummaryIndex.js +44 -0
  525. package/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
  526. package/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
  527. package/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
  528. package/serialization/types/IndexedAssetsListRequestFps.js +44 -0
  529. package/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
  530. package/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
  531. package/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
  532. package/serialization/types/IndexedAssetsListRequestSize.js +44 -0
  533. package/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
  534. package/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
  535. package/serialization/types/InternalEntity.d.ts +10 -2
  536. package/serialization/types/InternalEntity.js +11 -5
  537. package/serialization/types/SegmentDefinition.d.ts +17 -0
  538. package/serialization/types/SegmentDefinition.js +48 -0
  539. package/serialization/types/SegmentField.d.ts +18 -0
  540. package/serialization/types/SegmentField.js +49 -0
  541. package/serialization/types/SegmentFieldItems.d.ts +13 -0
  542. package/serialization/types/SegmentFieldItems.js +44 -0
  543. package/serialization/types/SegmentFieldItemsType.d.ts +10 -0
  544. package/serialization/types/SegmentFieldItemsType.js +41 -0
  545. package/serialization/types/SegmentFieldType.d.ts +10 -0
  546. package/serialization/types/SegmentFieldType.js +41 -0
  547. package/serialization/types/SmeMediaSource.d.ts +17 -0
  548. package/serialization/types/SmeMediaSource.js +48 -0
  549. package/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
  550. package/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
  551. package/serialization/types/SyncResponseFormat.d.ts +14 -0
  552. package/{dist/serialization/types/ResponseFormat.js → serialization/types/SyncResponseFormat.js} +4 -4
  553. package/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
  554. package/serialization/types/SyncResponseFormatType.js +41 -0
  555. package/serialization/types/VideosListRequestDuration.d.ts +13 -0
  556. package/serialization/types/VideosListRequestDuration.js +44 -0
  557. package/serialization/types/VideosListRequestFps.d.ts +13 -0
  558. package/serialization/types/VideosListRequestFps.js +44 -0
  559. package/serialization/types/VideosListRequestHeight.d.ts +13 -0
  560. package/serialization/types/VideosListRequestHeight.js +44 -0
  561. package/serialization/types/VideosListRequestSize.d.ts +13 -0
  562. package/serialization/types/VideosListRequestSize.js +44 -0
  563. package/serialization/types/VideosListRequestWidth.d.ts +13 -0
  564. package/serialization/types/VideosListRequestWidth.js +44 -0
  565. package/serialization/types/index.d.ts +40 -2
  566. package/serialization/types/index.js +40 -2
  567. package/version.d.ts +1 -1
  568. package/version.js +1 -1
  569. package/wrapper/resources/IndexesVideosWrapper.js +29 -14
  570. package/dist/serialization/types/ResponseFormat.d.ts +0 -14
  571. package/serialization/types/ResponseFormat.d.ts +0 -14
  572. /package/api/{types/ResponseFormat.js → resources/assets/client/requests/AssetsDeleteRequest.js} +0 -0
  573. /package/{dist/api/types/ResponseFormat.js → api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js} +0 -0
@@ -13,6 +13,6 @@ export interface MediaSource {
13
13
  * Use direct links to raw media files. Video hosting platforms and cloud storage sharing links are not supported.
14
14
  */
15
15
  url?: string;
16
- /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. */
16
+ /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. The asset status must be `ready`. Use the [Retrieve an asset](/v1.3/api-reference/upload-content/direct-uploads/retrieve) method to check the status. */
17
17
  assetId?: string;
18
18
  }
@@ -5,6 +5,6 @@
5
5
  * Provide the video via a unique identifier of an asset.
6
6
  */
7
7
  export interface One {
8
- /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. */
8
+ /** The unique identifier of an asset from a [direct](/v1.3/api-reference/upload-content/direct-uploads) or [multipart](/v1.3/api-reference/upload-content/multipart-uploads) upload. The asset status must be `ready`. Use the [Retrieve an asset](/v1.3/api-reference/upload-content/direct-uploads/retrieve) method to check the status. */
9
9
  assetId: string;
10
10
  }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as TwelvelabsApi from "../index";
5
+ /**
6
+ * Defines a type of segment to extract from the video.
7
+ */
8
+ export interface SegmentDefinition {
9
+ /** A unique identifier for this segment definition. */
10
+ id: string;
11
+ /** Describe what this type of segment looks like in the video. The model uses this text to identify matching segments. */
12
+ description: string;
13
+ /** Custom fields to extract for each segment instance. Maximum 20 fields. */
14
+ fields?: TwelvelabsApi.SegmentField[];
15
+ /** Reference images that help the model identify segments. Maximum 4 sources. */
16
+ mediaSources?: TwelvelabsApi.SmeMediaSource[];
17
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,19 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as TwelvelabsApi from "../index";
5
+ /**
6
+ * A custom field to extract for each segment.
7
+ */
8
+ export interface SegmentField {
9
+ /** The name of the field. */
10
+ name: string;
11
+ /** The data type of the field. */
12
+ type: TwelvelabsApi.SegmentFieldType;
13
+ /** Instructions that guide the model on what this field should contain and how to extract it from the video. */
14
+ description: string;
15
+ /** Allowed values for this field. Maximum 50 values. */
16
+ enum?: string[];
17
+ /** Required when `type` is `array`. Specifies the type of array elements. */
18
+ items?: TwelvelabsApi.SegmentFieldItems;
19
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as TwelvelabsApi from "../index";
5
+ /**
6
+ * Required when `type` is `array`. Specifies the type of array elements.
7
+ */
8
+ export interface SegmentFieldItems {
9
+ type: TwelvelabsApi.SegmentFieldItemsType;
10
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type SegmentFieldItemsType = "string" | "number" | "boolean" | "integer";
5
+ export declare const SegmentFieldItemsType: {
6
+ readonly String: "string";
7
+ readonly Number: "number";
8
+ readonly Boolean: "boolean";
9
+ readonly Integer: "integer";
10
+ };
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.SegmentFieldItemsType = void 0;
7
+ exports.SegmentFieldItemsType = {
8
+ String: "string",
9
+ Number: "number",
10
+ Boolean: "boolean",
11
+ Integer: "integer",
12
+ };
@@ -0,0 +1,14 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The data type of the field.
6
+ */
7
+ export type SegmentFieldType = "string" | "boolean" | "number" | "integer" | "array";
8
+ export declare const SegmentFieldType: {
9
+ readonly String: "string";
10
+ readonly Boolean: "boolean";
11
+ readonly Number: "number";
12
+ readonly Integer: "integer";
13
+ readonly Array: "array";
14
+ };
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.SegmentFieldType = void 0;
7
+ exports.SegmentFieldType = {
8
+ String: "string",
9
+ Boolean: "boolean",
10
+ Number: "number",
11
+ Integer: "integer",
12
+ Array: "array",
13
+ };
@@ -0,0 +1,19 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ import * as TwelvelabsApi from "../index";
5
+ /**
6
+ * A reference image that provides visual context for segment identification. Provide exactly one of `url`, `asset_id`, or `base64_string`.
7
+ */
8
+ export interface SmeMediaSource {
9
+ /** A descriptive name for this media source. */
10
+ name: string;
11
+ /** The media type. Only `image` is available. */
12
+ mediaType: TwelvelabsApi.SmeMediaSourceMediaType;
13
+ /** A publicly accessible HTTPS URL of the image. */
14
+ url?: string;
15
+ /** The unique identifier of an uploaded asset. */
16
+ assetId?: string;
17
+ /** Base64-encoded image data. The maximum size is 30MB. */
18
+ base64String?: string;
19
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,10 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The media type. Only `image` is available.
6
+ */
7
+ export type SmeMediaSourceMediaType = "image";
8
+ export declare const SmeMediaSourceMediaType: {
9
+ readonly Image: "image";
10
+ };
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.SmeMediaSourceMediaType = void 0;
7
+ exports.SmeMediaSourceMediaType = {
8
+ Image: "image",
9
+ };
@@ -5,9 +5,9 @@ import * as TwelvelabsApi from "../index";
5
5
  /**
6
6
  * Specifies the format of the response. When you omit this parameter, the platform returns unstructured text.
7
7
  */
8
- export interface ResponseFormat {
8
+ export interface SyncResponseFormat {
9
9
  /** Set this parameter to "json_schema" to receive structured JSON responses. */
10
- type: TwelvelabsApi.ResponseFormatType;
10
+ type: TwelvelabsApi.SyncResponseFormatType;
11
11
  /**
12
12
  * Contains the JSON schema that defines the response structure. The schema must adhere to the [JSON Schema Draft 2020-12](https://json-schema.org/draft/2020-12) specification.
13
13
  *
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,7 +4,7 @@
4
4
  /**
5
5
  * Set this parameter to "json_schema" to receive structured JSON responses.
6
6
  */
7
- export type ResponseFormatType = "json_schema";
8
- export declare const ResponseFormatType: {
7
+ export type SyncResponseFormatType = "json_schema";
8
+ export declare const SyncResponseFormatType: {
9
9
  readonly JsonSchema: "json_schema";
10
10
  };
@@ -3,7 +3,7 @@
3
3
  * This file was auto-generated by Fern from our API Definition.
4
4
  */
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.ResponseFormatType = void 0;
7
- exports.ResponseFormatType = {
6
+ exports.SyncResponseFormatType = void 0;
7
+ exports.SyncResponseFormatType = {
8
8
  JsonSchema: "json_schema",
9
9
  };
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface VideosListRequestDuration {
5
+ gte?: number;
6
+ lte?: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface VideosListRequestFps {
5
+ gte?: number;
6
+ lte?: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface VideosListRequestHeight {
5
+ gte?: number;
6
+ lte?: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface VideosListRequestSize {
5
+ gte?: number;
6
+ lte?: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export interface VideosListRequestWidth {
5
+ gte?: number;
6
+ lte?: number;
7
+ }
@@ -0,0 +1,5 @@
1
+ "use strict";
2
+ /**
3
+ * This file was auto-generated by Fern from our API Definition.
4
+ */
5
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,6 +1,17 @@
1
1
  export * from "./BadRequestErrorBody";
2
+ export * from "./IndexedAssetsListRequestDuration";
3
+ export * from "./IndexedAssetsListRequestFps";
4
+ export * from "./IndexedAssetsListRequestWidth";
5
+ export * from "./IndexedAssetsListRequestHeight";
6
+ export * from "./IndexedAssetsListRequestSize";
2
7
  export * from "./NotFoundErrorBody";
3
8
  export * from "./InternalServerErrorBody";
9
+ export * from "./VideosListRequestDuration";
10
+ export * from "./VideosListRequestFps";
11
+ export * from "./VideosListRequestWidth";
12
+ export * from "./VideosListRequestHeight";
13
+ export * from "./VideosListRequestSize";
14
+ export * from "./ConflictErrorBody";
4
15
  export * from "./ForbiddenErrorBody";
5
16
  export * from "./Url";
6
17
  export * from "./One";
@@ -115,12 +126,32 @@ export * from "./StreamEndResponseMetadata";
115
126
  export * from "./StreamEndResponse";
116
127
  export * from "./NonStreamAnalyzeResponse";
117
128
  export * from "./TokenUsage";
118
- export * from "./ResponseFormatType";
119
- export * from "./ResponseFormat";
129
+ export * from "./AsyncResponseFormatType";
130
+ export * from "./AsyncResponseFormat";
131
+ export * from "./SyncResponseFormatType";
132
+ export * from "./SyncResponseFormat";
133
+ export * from "./SegmentDefinition";
134
+ export * from "./SegmentFieldType";
135
+ export * from "./SegmentFieldItemsType";
136
+ export * from "./SegmentFieldItems";
137
+ export * from "./SegmentField";
138
+ export * from "./SmeMediaSourceMediaType";
139
+ export * from "./SmeMediaSource";
120
140
  export * from "./FinishReason";
121
141
  export * from "./VideoContext";
122
142
  export * from "./AnalyzeTaskStatus";
123
143
  export * from "./CreateAnalyzeTaskResponse";
144
+ export * from "./AnalyzeTaskResponseVideoSourceType";
145
+ export * from "./AnalyzeTaskResponseVideoSourceSystemMetadata";
146
+ export * from "./AnalyzeTaskResponseVideoSource";
147
+ export * from "./AnalyzeTaskResponseRequestParamsAnalysisMode";
148
+ export * from "./AnalyzeTaskResponseRequestParamsResponseFormatType";
149
+ export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems";
150
+ export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem";
151
+ export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem";
152
+ export * from "./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem";
153
+ export * from "./AnalyzeTaskResponseRequestParamsResponseFormat";
154
+ export * from "./AnalyzeTaskResponseRequestParams";
124
155
  export * from "./AnalyzeTaskResponse";
125
156
  export * from "./AnalyzeTaskResultUsage";
126
157
  export * from "./AnalyzeTaskResult";
@@ -129,6 +160,13 @@ export * from "./AnalyzeTaskWebhookInfo";
129
160
  export * from "./AssetMethod";
130
161
  export * from "./AssetStatus";
131
162
  export * from "./Asset";
163
+ export * from "./AssetDetail";
164
+ export * from "./AssetHlsStatus";
165
+ export * from "./AssetHls";
166
+ export * from "./AssetThumbnailStatus";
167
+ export * from "./AssetThumbnail";
168
+ export * from "./IndexedAssetSummaryIndex";
169
+ export * from "./IndexedAssetSummary";
132
170
  export * from "./CreateAssetUploadResponse";
133
171
  export * from "./CompletedChunkProofType";
134
172
  export * from "./CompletedChunk";
@@ -15,8 +15,19 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestErrorBody"), exports);
18
+ __exportStar(require("./IndexedAssetsListRequestDuration"), exports);
19
+ __exportStar(require("./IndexedAssetsListRequestFps"), exports);
20
+ __exportStar(require("./IndexedAssetsListRequestWidth"), exports);
21
+ __exportStar(require("./IndexedAssetsListRequestHeight"), exports);
22
+ __exportStar(require("./IndexedAssetsListRequestSize"), exports);
18
23
  __exportStar(require("./NotFoundErrorBody"), exports);
19
24
  __exportStar(require("./InternalServerErrorBody"), exports);
25
+ __exportStar(require("./VideosListRequestDuration"), exports);
26
+ __exportStar(require("./VideosListRequestFps"), exports);
27
+ __exportStar(require("./VideosListRequestWidth"), exports);
28
+ __exportStar(require("./VideosListRequestHeight"), exports);
29
+ __exportStar(require("./VideosListRequestSize"), exports);
30
+ __exportStar(require("./ConflictErrorBody"), exports);
20
31
  __exportStar(require("./ForbiddenErrorBody"), exports);
21
32
  __exportStar(require("./Url"), exports);
22
33
  __exportStar(require("./One"), exports);
@@ -131,12 +142,32 @@ __exportStar(require("./StreamEndResponseMetadata"), exports);
131
142
  __exportStar(require("./StreamEndResponse"), exports);
132
143
  __exportStar(require("./NonStreamAnalyzeResponse"), exports);
133
144
  __exportStar(require("./TokenUsage"), exports);
134
- __exportStar(require("./ResponseFormatType"), exports);
135
- __exportStar(require("./ResponseFormat"), exports);
145
+ __exportStar(require("./AsyncResponseFormatType"), exports);
146
+ __exportStar(require("./AsyncResponseFormat"), exports);
147
+ __exportStar(require("./SyncResponseFormatType"), exports);
148
+ __exportStar(require("./SyncResponseFormat"), exports);
149
+ __exportStar(require("./SegmentDefinition"), exports);
150
+ __exportStar(require("./SegmentFieldType"), exports);
151
+ __exportStar(require("./SegmentFieldItemsType"), exports);
152
+ __exportStar(require("./SegmentFieldItems"), exports);
153
+ __exportStar(require("./SegmentField"), exports);
154
+ __exportStar(require("./SmeMediaSourceMediaType"), exports);
155
+ __exportStar(require("./SmeMediaSource"), exports);
136
156
  __exportStar(require("./FinishReason"), exports);
137
157
  __exportStar(require("./VideoContext"), exports);
138
158
  __exportStar(require("./AnalyzeTaskStatus"), exports);
139
159
  __exportStar(require("./CreateAnalyzeTaskResponse"), exports);
160
+ __exportStar(require("./AnalyzeTaskResponseVideoSourceType"), exports);
161
+ __exportStar(require("./AnalyzeTaskResponseVideoSourceSystemMetadata"), exports);
162
+ __exportStar(require("./AnalyzeTaskResponseVideoSource"), exports);
163
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsAnalysisMode"), exports);
164
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatType"), exports);
165
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems"), exports);
166
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem"), exports);
167
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem"), exports);
168
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem"), exports);
169
+ __exportStar(require("./AnalyzeTaskResponseRequestParamsResponseFormat"), exports);
170
+ __exportStar(require("./AnalyzeTaskResponseRequestParams"), exports);
140
171
  __exportStar(require("./AnalyzeTaskResponse"), exports);
141
172
  __exportStar(require("./AnalyzeTaskResultUsage"), exports);
142
173
  __exportStar(require("./AnalyzeTaskResult"), exports);
@@ -145,6 +176,13 @@ __exportStar(require("./AnalyzeTaskWebhookInfo"), exports);
145
176
  __exportStar(require("./AssetMethod"), exports);
146
177
  __exportStar(require("./AssetStatus"), exports);
147
178
  __exportStar(require("./Asset"), exports);
179
+ __exportStar(require("./AssetDetail"), exports);
180
+ __exportStar(require("./AssetHlsStatus"), exports);
181
+ __exportStar(require("./AssetHls"), exports);
182
+ __exportStar(require("./AssetThumbnailStatus"), exports);
183
+ __exportStar(require("./AssetThumbnail"), exports);
184
+ __exportStar(require("./IndexedAssetSummaryIndex"), exports);
185
+ __exportStar(require("./IndexedAssetSummary"), exports);
148
186
  __exportStar(require("./CreateAssetUploadResponse"), exports);
149
187
  __exportStar(require("./CompletedChunkProofType"), exports);
150
188
  __exportStar(require("./CompletedChunk"), exports);
package/dist/Client.d.ts CHANGED
@@ -67,6 +67,7 @@ export declare class TwelvelabsApiClient {
67
67
  *
68
68
  * **Do not use this method for**:
69
69
  * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
70
+ * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
70
71
  *
71
72
  * <Note title="Notes">
72
73
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
@@ -92,6 +93,7 @@ export declare class TwelvelabsApiClient {
92
93
  *
93
94
  * **Do not use this method for**:
94
95
  * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
96
+ * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
95
97
  *
96
98
  * <Note title="Notes">
97
99
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
package/dist/Client.js CHANGED
@@ -117,6 +117,7 @@ class TwelvelabsApiClient {
117
117
  *
118
118
  * **Do not use this method for**:
119
119
  * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
120
+ * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
120
121
  *
121
122
  * <Note title="Notes">
122
123
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
@@ -131,7 +132,7 @@ class TwelvelabsApiClient {
131
132
  const _response = yield core.fetcher({
132
133
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
133
134
  method: "POST",
134
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
135
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
135
136
  contentType: "application/json",
136
137
  requestType: "json",
137
138
  body: Object.assign(Object.assign({}, serializers.AnalyzeStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: true }),
@@ -210,6 +211,7 @@ class TwelvelabsApiClient {
210
211
  *
211
212
  * **Do not use this method for**:
212
213
  * - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
214
+ * - Video segmentation. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with `model_name` set to `pegasus1.5` instead.
213
215
  *
214
216
  * <Note title="Notes">
215
217
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
@@ -258,7 +260,7 @@ class TwelvelabsApiClient {
258
260
  const _response = yield core.fetcher({
259
261
  url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
260
262
  method: "POST",
261
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.2", "User-Agent": "twelvelabs-js/1.2.2", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
263
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
262
264
  contentType: "application/json",
263
265
  requestType: "json",
264
266
  body: Object.assign(Object.assign({}, serializers.AnalyzeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: false }),
@@ -41,6 +41,6 @@ export interface AnalyzeRequest {
41
41
  video?: TwelvelabsApi.VideoContext;
42
42
  prompt: TwelvelabsApi.AnalyzeTextPrompt;
43
43
  temperature?: TwelvelabsApi.AnalyzeTemperature;
44
- responseFormat?: TwelvelabsApi.ResponseFormat;
44
+ responseFormat?: TwelvelabsApi.SyncResponseFormat;
45
45
  maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
46
46
  }
@@ -41,6 +41,6 @@ export interface AnalyzeStreamRequest {
41
41
  video?: TwelvelabsApi.VideoContext;
42
42
  prompt: TwelvelabsApi.AnalyzeTextPrompt;
43
43
  temperature?: TwelvelabsApi.AnalyzeTemperature;
44
- responseFormat?: TwelvelabsApi.ResponseFormat;
44
+ responseFormat?: TwelvelabsApi.SyncResponseFormat;
45
45
  maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
46
46
  }
@@ -2,8 +2,7 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  import * as errors from "../../errors/index";
5
- import * as TwelvelabsApi from "../index";
6
5
  import * as core from "../../core";
7
6
  export declare class ConflictError extends errors.TwelvelabsApiError {
8
- constructor(body: TwelvelabsApi.ErrorResponse, rawResponse?: core.RawResponse);
7
+ constructor(body?: unknown, rawResponse?: core.RawResponse);
9
8
  }
@@ -1,6 +1,6 @@
1
1
  export * from "./BadRequestError";
2
2
  export * from "./NotFoundError";
3
3
  export * from "./InternalServerError";
4
+ export * from "./ConflictError";
4
5
  export * from "./ForbiddenError";
5
6
  export * from "./TooManyRequestsError";
6
- export * from "./ConflictError";
@@ -17,6 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BadRequestError"), exports);
18
18
  __exportStar(require("./NotFoundError"), exports);
19
19
  __exportStar(require("./InternalServerError"), exports);
20
+ __exportStar(require("./ConflictError"), exports);
20
21
  __exportStar(require("./ForbiddenError"), exports);
21
22
  __exportStar(require("./TooManyRequestsError"), exports);
22
- __exportStar(require("./ConflictError"), exports);
@@ -37,13 +37,16 @@ export declare class Tasks {
37
37
  * await client.analyzeAsync.tasks.list({
38
38
  * page: 1,
39
39
  * pageLimit: 10,
40
- * status: "queued"
40
+ * status: "queued",
41
+ * videoUrl: "https://example.com/video.mp4",
42
+ * assetId: "69abc123def456789012abcd",
43
+ * analysisMode: "time_based_metadata"
41
44
  * })
42
45
  */
43
46
  list(request?: TwelvelabsApi.analyzeAsync.TasksListRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.analyzeAsync.TasksListResponse>;
44
47
  private __list;
45
48
  /**
46
- * This method asynchronously analyzes your videos and generates fully customizable text based on your prompts.
49
+ * This method asynchronously analyzes your videos. It supports two modes: general analysis (prompt-based text generation) with Pegasus 1.2 and video segmentation with Pegasus 1.5.
47
50
  *
48
51
  * <Accordion title="Input requirements">
49
52
  * - Minimum duration: 4 seconds
@@ -54,6 +57,8 @@ export declare class Tasks {
54
57
  * </Accordion>
55
58
  *
56
59
  * **When to use this method**:
60
+ * - Generate custom text from your video using a prompt (Pegasus 1.2 only)
61
+ * - Extract timestamped metadata with custom fields from your video (Pegasus 1.5 only)
57
62
  * - Analyze videos longer than 1 hour
58
63
  * - Process videos asynchronously without blocking your application
59
64
  *
@@ -86,6 +91,38 @@ export declare class Tasks {
86
91
  * temperature: 0.2,
87
92
  * maxTokens: 1000
88
93
  * })
94
+ *
95
+ * @example
96
+ * await client.analyzeAsync.tasks.create({
97
+ * modelName: "pegasus1.5",
98
+ * video: {
99
+ * type: "url",
100
+ * url: "https://example.com/video.mp4"
101
+ * },
102
+ * analysisMode: "time_based_metadata",
103
+ * responseFormat: {
104
+ * type: "segment_definitions",
105
+ * segmentDefinitions: [{
106
+ * id: "scene",
107
+ * description: "A distinct scene or setting change in the video",
108
+ * fields: [{
109
+ * name: "sentiment",
110
+ * type: "string",
111
+ * description: "The emotional tone of this segment",
112
+ * enum: ["positive", "negative", "neutral"]
113
+ * }, {
114
+ * name: "key_objects",
115
+ * type: "array",
116
+ * description: "Notable objects visible in this segment",
117
+ * items: {
118
+ * type: "string"
119
+ * }
120
+ * }]
121
+ * }]
122
+ * },
123
+ * minSegmentDuration: 5,
124
+ * maxSegmentDuration: 30
125
+ * })
89
126
  */
90
127
  create(request: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.CreateAnalyzeTaskResponse>;
91
128
  private __create;