twelvelabs-js 1.2.2 → 1.2.4

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 (629) hide show
  1. package/Client.d.ts +14 -36
  2. package/Client.js +22 -40
  3. package/README.md +20 -1
  4. package/api/client/requests/AnalyzeRequest.d.ts +43 -30
  5. package/api/client/requests/AnalyzeStreamRequest.d.ts +43 -30
  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 +96 -2
  10. package/api/resources/analyzeAsync/resources/tasks/client/Client.js +118 -17
  11. package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +176 -3
  12. package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +32 -1
  13. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +15 -0
  14. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +10 -0
  15. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +15 -0
  16. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
  17. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +8 -0
  18. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +10 -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 +20 -6
  22. package/api/resources/assets/client/Client.js +48 -17
  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 +2 -2
  29. package/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
  30. package/api/resources/embed/resources/tasks/client/Client.js +9 -9
  31. package/api/resources/embed/resources/v2/client/Client.js +2 -2
  32. package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +13 -3
  33. package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +19 -9
  34. package/api/resources/entityCollections/client/Client.js +10 -10
  35. package/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
  36. package/api/resources/entityCollections/resources/entities/client/Client.js +108 -17
  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 +10 -10
  44. package/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
  45. package/api/resources/indexes/resources/indexedAssets/client/Client.js +131 -20
  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 +39 -19
  58. package/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
  59. package/api/resources/multipartUpload/client/Client.d.ts +3 -3
  60. package/api/resources/multipartUpload/client/Client.js +13 -13
  61. package/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
  62. package/api/resources/search/client/Client.js +4 -4
  63. package/api/resources/tasks/client/Client.js +8 -8
  64. package/api/resources/tasks/resources/transfers/client/Client.js +6 -6
  65. package/api/types/AnalyzePromptV2.d.ts +13 -0
  66. package/api/types/AnalyzePromptV2.js +5 -0
  67. package/api/types/AnalyzeRequestModelName.d.ts +15 -0
  68. package/api/types/AnalyzeRequestModelName.js +10 -0
  69. package/api/types/AnalyzeStreamRequestModelName.d.ts +15 -0
  70. package/api/types/AnalyzeStreamRequestModelName.js +10 -0
  71. package/api/types/AnalyzeTaskResponse.d.ts +6 -0
  72. package/api/types/AnalyzeTaskResponseRequestParams.d.ts +39 -0
  73. package/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
  74. package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
  75. package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
  76. package/api/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +16 -0
  77. package/api/types/AnalyzeTaskResponseRequestParamsPromptV2.js +5 -0
  78. package/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +11 -0
  79. package/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +5 -0
  80. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +24 -0
  81. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
  82. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +12 -0
  83. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
  84. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
  85. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
  86. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
  87. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
  88. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
  89. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
  90. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
  91. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
  92. package/api/types/AnalyzeTaskResponseVideoSource.d.ts +21 -0
  93. package/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
  94. package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
  95. package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
  96. package/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
  97. package/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
  98. package/api/types/AnalyzeTaskResult.d.ts +10 -1
  99. package/api/types/AnalyzeTaskResultUsage.d.ts +1 -1
  100. package/api/types/AnalyzeTimeRange.d.ts +12 -0
  101. package/api/types/AnalyzeTimeRange.js +5 -0
  102. package/api/types/Asset.d.ts +5 -0
  103. package/api/types/AssetDetail.d.ts +11 -0
  104. package/api/types/AssetDetail.js +5 -0
  105. package/api/types/AssetHls.d.ts +21 -0
  106. package/api/types/AssetHls.js +5 -0
  107. package/api/types/AssetHlsStatus.d.ts +19 -0
  108. package/api/types/AssetHlsStatus.js +12 -0
  109. package/api/types/AssetMethod.d.ts +3 -1
  110. package/api/types/AssetMethod.js +1 -0
  111. package/api/types/AssetThumbnail.d.ts +21 -0
  112. package/api/types/AssetThumbnail.js +5 -0
  113. package/api/types/AssetThumbnailStatus.d.ts +19 -0
  114. package/api/types/AssetThumbnailStatus.js +12 -0
  115. package/api/types/AsyncResponseFormat.d.ts +117 -0
  116. package/api/types/AsyncResponseFormat.js +5 -0
  117. package/api/types/AsyncResponseFormatType.d.ts +13 -0
  118. package/api/types/AsyncResponseFormatType.js +10 -0
  119. package/api/types/ConflictErrorBody.d.ts +11 -0
  120. package/api/types/ConflictErrorBody.js +5 -0
  121. package/api/types/Entity.d.ts +2 -0
  122. package/api/types/IndexedAsset.d.ts +2 -0
  123. package/api/types/IndexedAssetSummary.d.ts +12 -0
  124. package/api/types/IndexedAssetSummary.js +5 -0
  125. package/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
  126. package/api/types/IndexedAssetSummaryIndex.js +5 -0
  127. package/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
  128. package/api/types/IndexedAssetsListRequestDuration.js +5 -0
  129. package/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
  130. package/api/types/IndexedAssetsListRequestFps.js +5 -0
  131. package/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
  132. package/api/types/IndexedAssetsListRequestHeight.js +5 -0
  133. package/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
  134. package/api/types/IndexedAssetsListRequestSize.js +5 -0
  135. package/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
  136. package/api/types/IndexedAssetsListRequestWidth.js +5 -0
  137. package/api/types/InternalEntity.d.ts +23 -1
  138. package/api/types/MediaSource.d.ts +1 -1
  139. package/api/types/One.d.ts +1 -1
  140. package/api/types/SegmentDefinition.d.ts +28 -0
  141. package/api/types/SegmentDefinition.js +5 -0
  142. package/api/types/SegmentField.d.ts +19 -0
  143. package/api/types/SegmentField.js +5 -0
  144. package/api/types/SegmentFieldItems.d.ts +10 -0
  145. package/api/types/SegmentFieldItems.js +5 -0
  146. package/api/types/SegmentFieldItemsType.d.ts +10 -0
  147. package/api/types/SegmentFieldItemsType.js +12 -0
  148. package/api/types/SegmentFieldType.d.ts +14 -0
  149. package/api/types/SegmentFieldType.js +13 -0
  150. package/api/types/SmeMediaSource.d.ts +19 -0
  151. package/api/types/SmeMediaSource.js +5 -0
  152. package/api/types/SmeMediaSourceMediaType.d.ts +10 -0
  153. package/api/types/SmeMediaSourceMediaType.js +9 -0
  154. package/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +27 -8
  155. package/api/types/SyncResponseFormat.js +5 -0
  156. package/{dist/api/types/ResponseFormatType.d.ts → api/types/SyncResponseFormatType.d.ts} +2 -2
  157. package/{dist/api/types/ResponseFormatType.js → api/types/SyncResponseFormatType.js} +2 -2
  158. package/api/types/TokenUsage.d.ts +3 -1
  159. package/api/types/VideosListRequestDuration.d.ts +7 -0
  160. package/api/types/VideosListRequestDuration.js +5 -0
  161. package/api/types/VideosListRequestFps.d.ts +7 -0
  162. package/api/types/VideosListRequestFps.js +5 -0
  163. package/api/types/VideosListRequestHeight.d.ts +7 -0
  164. package/api/types/VideosListRequestHeight.js +5 -0
  165. package/api/types/VideosListRequestSize.d.ts +7 -0
  166. package/api/types/VideosListRequestSize.js +5 -0
  167. package/api/types/VideosListRequestWidth.d.ts +7 -0
  168. package/api/types/VideosListRequestWidth.js +5 -0
  169. package/api/types/index.d.ts +46 -2
  170. package/api/types/index.js +46 -2
  171. package/dist/Client.d.ts +14 -36
  172. package/dist/Client.js +22 -40
  173. package/dist/api/client/requests/AnalyzeRequest.d.ts +43 -30
  174. package/dist/api/client/requests/AnalyzeStreamRequest.d.ts +43 -30
  175. package/dist/api/errors/ConflictError.d.ts +1 -2
  176. package/dist/api/errors/index.d.ts +1 -1
  177. package/dist/api/errors/index.js +1 -1
  178. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +96 -2
  179. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.js +118 -17
  180. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +176 -3
  181. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +32 -1
  182. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +15 -0
  183. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +10 -0
  184. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +15 -0
  185. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
  186. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +8 -0
  187. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +10 -0
  188. package/dist/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  189. package/dist/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  190. package/dist/api/resources/assets/client/Client.d.ts +20 -6
  191. package/dist/api/resources/assets/client/Client.js +48 -17
  192. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
  193. package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
  194. package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.js +5 -0
  195. package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
  196. package/dist/api/resources/assets/client/requests/index.d.ts +1 -0
  197. package/dist/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
  198. package/dist/api/resources/embed/client/Client.js +2 -2
  199. package/dist/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
  200. package/dist/api/resources/embed/resources/tasks/client/Client.js +9 -9
  201. package/dist/api/resources/embed/resources/v2/client/Client.js +2 -2
  202. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +13 -3
  203. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +19 -9
  204. package/dist/api/resources/entityCollections/client/Client.js +10 -10
  205. package/dist/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
  206. package/dist/api/resources/entityCollections/resources/entities/client/Client.js +108 -17
  207. package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
  208. package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js +5 -0
  209. package/dist/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
  210. package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
  211. package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
  212. package/dist/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  213. package/dist/api/resources/entityCollections/resources/entities/types/index.js +1 -0
  214. package/dist/api/resources/indexes/client/Client.js +10 -10
  215. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
  216. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +131 -20
  217. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
  218. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
  219. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
  220. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
  221. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
  222. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
  223. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
  224. package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
  225. package/dist/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  226. package/dist/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  227. package/dist/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
  228. package/dist/api/resources/indexes/resources/videos/client/Client.js +39 -19
  229. package/dist/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
  230. package/dist/api/resources/multipartUpload/client/Client.d.ts +3 -3
  231. package/dist/api/resources/multipartUpload/client/Client.js +13 -13
  232. package/dist/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
  233. package/dist/api/resources/search/client/Client.js +4 -4
  234. package/dist/api/resources/tasks/client/Client.js +8 -8
  235. package/dist/api/resources/tasks/resources/transfers/client/Client.js +6 -6
  236. package/dist/api/types/AnalyzePromptV2.d.ts +13 -0
  237. package/dist/api/types/AnalyzePromptV2.js +5 -0
  238. package/dist/api/types/AnalyzeRequestModelName.d.ts +15 -0
  239. package/dist/api/types/AnalyzeRequestModelName.js +10 -0
  240. package/dist/api/types/AnalyzeStreamRequestModelName.d.ts +15 -0
  241. package/dist/api/types/AnalyzeStreamRequestModelName.js +10 -0
  242. package/dist/api/types/AnalyzeTaskResponse.d.ts +6 -0
  243. package/dist/api/types/AnalyzeTaskResponseRequestParams.d.ts +39 -0
  244. package/dist/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
  245. package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
  246. package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
  247. package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +16 -0
  248. package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2.js +5 -0
  249. package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +11 -0
  250. package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +5 -0
  251. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +24 -0
  252. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
  253. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +12 -0
  254. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
  255. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
  256. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
  257. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
  258. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
  259. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
  260. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
  261. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
  262. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
  263. package/dist/api/types/AnalyzeTaskResponseVideoSource.d.ts +21 -0
  264. package/dist/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
  265. package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
  266. package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
  267. package/dist/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
  268. package/dist/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
  269. package/dist/api/types/AnalyzeTaskResult.d.ts +10 -1
  270. package/dist/api/types/AnalyzeTaskResultUsage.d.ts +1 -1
  271. package/dist/api/types/AnalyzeTimeRange.d.ts +12 -0
  272. package/dist/api/types/AnalyzeTimeRange.js +5 -0
  273. package/dist/api/types/Asset.d.ts +5 -0
  274. package/dist/api/types/AssetDetail.d.ts +11 -0
  275. package/dist/api/types/AssetDetail.js +5 -0
  276. package/dist/api/types/AssetHls.d.ts +21 -0
  277. package/dist/api/types/AssetHls.js +5 -0
  278. package/dist/api/types/AssetHlsStatus.d.ts +19 -0
  279. package/dist/api/types/AssetHlsStatus.js +12 -0
  280. package/dist/api/types/AssetMethod.d.ts +3 -1
  281. package/dist/api/types/AssetMethod.js +1 -0
  282. package/dist/api/types/AssetThumbnail.d.ts +21 -0
  283. package/dist/api/types/AssetThumbnail.js +5 -0
  284. package/dist/api/types/AssetThumbnailStatus.d.ts +19 -0
  285. package/dist/api/types/AssetThumbnailStatus.js +12 -0
  286. package/dist/api/types/AsyncResponseFormat.d.ts +117 -0
  287. package/dist/api/types/AsyncResponseFormat.js +5 -0
  288. package/dist/api/types/AsyncResponseFormatType.d.ts +13 -0
  289. package/dist/api/types/AsyncResponseFormatType.js +10 -0
  290. package/dist/api/types/ConflictErrorBody.d.ts +11 -0
  291. package/dist/api/types/ConflictErrorBody.js +5 -0
  292. package/dist/api/types/Entity.d.ts +2 -0
  293. package/dist/api/types/IndexedAsset.d.ts +2 -0
  294. package/dist/api/types/IndexedAssetSummary.d.ts +12 -0
  295. package/dist/api/types/IndexedAssetSummary.js +5 -0
  296. package/dist/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
  297. package/dist/api/types/IndexedAssetSummaryIndex.js +5 -0
  298. package/dist/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
  299. package/dist/api/types/IndexedAssetsListRequestDuration.js +5 -0
  300. package/dist/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
  301. package/dist/api/types/IndexedAssetsListRequestFps.js +5 -0
  302. package/dist/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
  303. package/dist/api/types/IndexedAssetsListRequestHeight.js +5 -0
  304. package/dist/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
  305. package/dist/api/types/IndexedAssetsListRequestSize.js +5 -0
  306. package/dist/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
  307. package/dist/api/types/IndexedAssetsListRequestWidth.js +5 -0
  308. package/dist/api/types/InternalEntity.d.ts +23 -1
  309. package/dist/api/types/MediaSource.d.ts +1 -1
  310. package/dist/api/types/One.d.ts +1 -1
  311. package/dist/api/types/SegmentDefinition.d.ts +28 -0
  312. package/dist/api/types/SegmentDefinition.js +5 -0
  313. package/dist/api/types/SegmentField.d.ts +19 -0
  314. package/dist/api/types/SegmentField.js +5 -0
  315. package/dist/api/types/SegmentFieldItems.d.ts +10 -0
  316. package/dist/api/types/SegmentFieldItems.js +5 -0
  317. package/dist/api/types/SegmentFieldItemsType.d.ts +10 -0
  318. package/dist/api/types/SegmentFieldItemsType.js +12 -0
  319. package/dist/api/types/SegmentFieldType.d.ts +14 -0
  320. package/dist/api/types/SegmentFieldType.js +13 -0
  321. package/dist/api/types/SmeMediaSource.d.ts +19 -0
  322. package/dist/api/types/SmeMediaSource.js +5 -0
  323. package/dist/api/types/SmeMediaSourceMediaType.d.ts +10 -0
  324. package/dist/api/types/SmeMediaSourceMediaType.js +9 -0
  325. package/dist/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +27 -8
  326. package/dist/api/types/SyncResponseFormat.js +5 -0
  327. package/{api/types/ResponseFormatType.d.ts → dist/api/types/SyncResponseFormatType.d.ts} +2 -2
  328. package/{api/types/ResponseFormatType.js → dist/api/types/SyncResponseFormatType.js} +2 -2
  329. package/dist/api/types/TokenUsage.d.ts +3 -1
  330. package/dist/api/types/VideosListRequestDuration.d.ts +7 -0
  331. package/dist/api/types/VideosListRequestDuration.js +5 -0
  332. package/dist/api/types/VideosListRequestFps.d.ts +7 -0
  333. package/dist/api/types/VideosListRequestFps.js +5 -0
  334. package/dist/api/types/VideosListRequestHeight.d.ts +7 -0
  335. package/dist/api/types/VideosListRequestHeight.js +5 -0
  336. package/dist/api/types/VideosListRequestSize.d.ts +7 -0
  337. package/dist/api/types/VideosListRequestSize.js +5 -0
  338. package/dist/api/types/VideosListRequestWidth.d.ts +7 -0
  339. package/dist/api/types/VideosListRequestWidth.js +5 -0
  340. package/dist/api/types/index.d.ts +46 -2
  341. package/dist/api/types/index.js +46 -2
  342. package/dist/serialization/client/requests/AnalyzeRequest.d.ts +10 -5
  343. package/dist/serialization/client/requests/AnalyzeRequest.js +10 -5
  344. package/dist/serialization/client/requests/AnalyzeStreamRequest.d.ts +10 -5
  345. package/dist/serialization/client/requests/AnalyzeStreamRequest.js +10 -5
  346. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +15 -6
  347. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +15 -6
  348. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  349. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
  350. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
  351. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
  352. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
  353. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
  354. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  355. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  356. package/dist/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
  357. package/dist/serialization/resources/assets/types/AssetsListResponse.js +2 -2
  358. package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
  359. package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
  360. package/dist/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  361. package/dist/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
  362. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
  363. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
  364. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
  365. package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
  366. package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  367. package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  368. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  369. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  370. package/dist/serialization/types/AnalyzePromptV2.d.ts +14 -0
  371. package/dist/serialization/types/AnalyzePromptV2.js +45 -0
  372. package/dist/serialization/types/AnalyzeRequestModelName.d.ts +10 -0
  373. package/dist/serialization/types/AnalyzeRequestModelName.js +41 -0
  374. package/dist/serialization/types/AnalyzeStreamRequestModelName.d.ts +10 -0
  375. package/dist/serialization/types/AnalyzeStreamRequestModelName.js +41 -0
  376. package/dist/serialization/types/AnalyzeTaskResponse.d.ts +5 -0
  377. package/dist/serialization/types/AnalyzeTaskResponse.js +5 -0
  378. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +24 -0
  379. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.js +55 -0
  380. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
  381. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
  382. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +14 -0
  383. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.js +45 -0
  384. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +15 -0
  385. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +46 -0
  386. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +16 -0
  387. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +47 -0
  388. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +19 -0
  389. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +54 -0
  390. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
  391. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
  392. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
  393. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
  394. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
  395. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
  396. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
  397. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
  398. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
  399. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.js +50 -0
  400. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
  401. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
  402. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
  403. package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
  404. package/dist/serialization/types/AnalyzeTaskResult.d.ts +1 -2
  405. package/dist/serialization/types/AnalyzeTaskResult.js +1 -2
  406. package/dist/serialization/types/AnalyzeTimeRange.d.ts +13 -0
  407. package/dist/serialization/types/AnalyzeTimeRange.js +44 -0
  408. package/dist/serialization/types/Asset.d.ts +2 -0
  409. package/dist/serialization/types/Asset.js +2 -0
  410. package/dist/serialization/types/AssetDetail.d.ts +16 -0
  411. package/dist/serialization/types/AssetDetail.js +49 -0
  412. package/dist/serialization/types/AssetHls.d.ts +14 -0
  413. package/dist/serialization/types/AssetHls.js +45 -0
  414. package/dist/serialization/types/AssetHlsStatus.d.ts +10 -0
  415. package/dist/serialization/types/AssetHlsStatus.js +41 -0
  416. package/dist/serialization/types/AssetMethod.d.ts +1 -1
  417. package/dist/serialization/types/AssetMethod.js +1 -1
  418. package/dist/serialization/types/AssetThumbnail.d.ts +14 -0
  419. package/dist/serialization/types/AssetThumbnail.js +45 -0
  420. package/dist/serialization/types/AssetThumbnailStatus.d.ts +10 -0
  421. package/dist/serialization/types/AssetThumbnailStatus.js +41 -0
  422. package/dist/serialization/types/AsyncResponseFormat.d.ts +16 -0
  423. package/dist/serialization/types/AsyncResponseFormat.js +47 -0
  424. package/dist/serialization/types/AsyncResponseFormatType.d.ts +10 -0
  425. package/dist/serialization/types/AsyncResponseFormatType.js +41 -0
  426. package/dist/serialization/types/ConflictErrorBody.d.ts +14 -0
  427. package/dist/serialization/types/ConflictErrorBody.js +45 -0
  428. package/dist/serialization/types/Entity.d.ts +1 -0
  429. package/dist/serialization/types/Entity.js +1 -0
  430. package/dist/serialization/types/IndexedAsset.d.ts +1 -0
  431. package/dist/serialization/types/IndexedAsset.js +1 -0
  432. package/dist/serialization/types/IndexedAssetSummary.d.ts +14 -0
  433. package/dist/serialization/types/IndexedAssetSummary.js +45 -0
  434. package/dist/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
  435. package/dist/serialization/types/IndexedAssetSummaryIndex.js +44 -0
  436. package/dist/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
  437. package/dist/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
  438. package/dist/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
  439. package/dist/serialization/types/IndexedAssetsListRequestFps.js +44 -0
  440. package/dist/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
  441. package/dist/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
  442. package/dist/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
  443. package/dist/serialization/types/IndexedAssetsListRequestSize.js +44 -0
  444. package/dist/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
  445. package/dist/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
  446. package/dist/serialization/types/InternalEntity.d.ts +10 -2
  447. package/dist/serialization/types/InternalEntity.js +11 -5
  448. package/dist/serialization/types/SegmentDefinition.d.ts +19 -0
  449. package/dist/serialization/types/SegmentDefinition.js +50 -0
  450. package/dist/serialization/types/SegmentField.d.ts +18 -0
  451. package/dist/serialization/types/SegmentField.js +49 -0
  452. package/dist/serialization/types/SegmentFieldItems.d.ts +13 -0
  453. package/dist/serialization/types/SegmentFieldItems.js +44 -0
  454. package/dist/serialization/types/SegmentFieldItemsType.d.ts +10 -0
  455. package/dist/serialization/types/SegmentFieldItemsType.js +41 -0
  456. package/dist/serialization/types/SegmentFieldType.d.ts +10 -0
  457. package/dist/serialization/types/SegmentFieldType.js +41 -0
  458. package/dist/serialization/types/SmeMediaSource.d.ts +17 -0
  459. package/dist/serialization/types/SmeMediaSource.js +48 -0
  460. package/dist/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
  461. package/dist/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
  462. package/dist/serialization/types/SyncResponseFormat.d.ts +14 -0
  463. package/{serialization/types/ResponseFormat.js → dist/serialization/types/SyncResponseFormat.js} +4 -4
  464. package/dist/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
  465. package/dist/serialization/types/SyncResponseFormatType.js +41 -0
  466. package/dist/serialization/types/TokenUsage.d.ts +2 -1
  467. package/dist/serialization/types/TokenUsage.js +2 -1
  468. package/dist/serialization/types/VideosListRequestDuration.d.ts +13 -0
  469. package/dist/serialization/types/VideosListRequestDuration.js +44 -0
  470. package/dist/serialization/types/VideosListRequestFps.d.ts +13 -0
  471. package/dist/serialization/types/VideosListRequestFps.js +44 -0
  472. package/dist/serialization/types/VideosListRequestHeight.d.ts +13 -0
  473. package/dist/serialization/types/VideosListRequestHeight.js +44 -0
  474. package/dist/serialization/types/VideosListRequestSize.d.ts +13 -0
  475. package/dist/serialization/types/VideosListRequestSize.js +44 -0
  476. package/dist/serialization/types/VideosListRequestWidth.d.ts +13 -0
  477. package/dist/serialization/types/VideosListRequestWidth.js +44 -0
  478. package/dist/serialization/types/index.d.ts +46 -2
  479. package/dist/serialization/types/index.js +46 -2
  480. package/dist/version.d.ts +1 -1
  481. package/dist/version.js +1 -1
  482. package/dist/wrapper/resources/IndexesVideosWrapper.js +29 -14
  483. package/package.json +1 -1
  484. package/reference.md +233 -68
  485. package/serialization/client/requests/AnalyzeRequest.d.ts +10 -5
  486. package/serialization/client/requests/AnalyzeRequest.js +10 -5
  487. package/serialization/client/requests/AnalyzeStreamRequest.d.ts +10 -5
  488. package/serialization/client/requests/AnalyzeStreamRequest.js +10 -5
  489. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +15 -6
  490. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +15 -6
  491. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
  492. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
  493. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
  494. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
  495. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
  496. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
  497. package/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
  498. package/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
  499. package/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
  500. package/serialization/resources/assets/types/AssetsListResponse.js +2 -2
  501. package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
  502. package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
  503. package/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
  504. package/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
  505. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
  506. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
  507. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
  508. package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
  509. package/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
  510. package/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
  511. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  512. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  513. package/serialization/types/AnalyzePromptV2.d.ts +14 -0
  514. package/serialization/types/AnalyzePromptV2.js +45 -0
  515. package/serialization/types/AnalyzeRequestModelName.d.ts +10 -0
  516. package/serialization/types/AnalyzeRequestModelName.js +41 -0
  517. package/serialization/types/AnalyzeStreamRequestModelName.d.ts +10 -0
  518. package/serialization/types/AnalyzeStreamRequestModelName.js +41 -0
  519. package/serialization/types/AnalyzeTaskResponse.d.ts +5 -0
  520. package/serialization/types/AnalyzeTaskResponse.js +5 -0
  521. package/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +24 -0
  522. package/serialization/types/AnalyzeTaskResponseRequestParams.js +55 -0
  523. package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
  524. package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
  525. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +14 -0
  526. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.js +45 -0
  527. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +15 -0
  528. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +46 -0
  529. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +16 -0
  530. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +47 -0
  531. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +19 -0
  532. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +54 -0
  533. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
  534. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
  535. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
  536. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
  537. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
  538. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
  539. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
  540. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
  541. package/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
  542. package/serialization/types/AnalyzeTaskResponseVideoSource.js +50 -0
  543. package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
  544. package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
  545. package/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
  546. package/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
  547. package/serialization/types/AnalyzeTaskResult.d.ts +1 -2
  548. package/serialization/types/AnalyzeTaskResult.js +1 -2
  549. package/serialization/types/AnalyzeTimeRange.d.ts +13 -0
  550. package/serialization/types/AnalyzeTimeRange.js +44 -0
  551. package/serialization/types/Asset.d.ts +2 -0
  552. package/serialization/types/Asset.js +2 -0
  553. package/serialization/types/AssetDetail.d.ts +16 -0
  554. package/serialization/types/AssetDetail.js +49 -0
  555. package/serialization/types/AssetHls.d.ts +14 -0
  556. package/serialization/types/AssetHls.js +45 -0
  557. package/serialization/types/AssetHlsStatus.d.ts +10 -0
  558. package/serialization/types/AssetHlsStatus.js +41 -0
  559. package/serialization/types/AssetMethod.d.ts +1 -1
  560. package/serialization/types/AssetMethod.js +1 -1
  561. package/serialization/types/AssetThumbnail.d.ts +14 -0
  562. package/serialization/types/AssetThumbnail.js +45 -0
  563. package/serialization/types/AssetThumbnailStatus.d.ts +10 -0
  564. package/serialization/types/AssetThumbnailStatus.js +41 -0
  565. package/serialization/types/AsyncResponseFormat.d.ts +16 -0
  566. package/serialization/types/AsyncResponseFormat.js +47 -0
  567. package/serialization/types/AsyncResponseFormatType.d.ts +10 -0
  568. package/serialization/types/AsyncResponseFormatType.js +41 -0
  569. package/serialization/types/ConflictErrorBody.d.ts +14 -0
  570. package/serialization/types/ConflictErrorBody.js +45 -0
  571. package/serialization/types/Entity.d.ts +1 -0
  572. package/serialization/types/Entity.js +1 -0
  573. package/serialization/types/IndexedAsset.d.ts +1 -0
  574. package/serialization/types/IndexedAsset.js +1 -0
  575. package/serialization/types/IndexedAssetSummary.d.ts +14 -0
  576. package/serialization/types/IndexedAssetSummary.js +45 -0
  577. package/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
  578. package/serialization/types/IndexedAssetSummaryIndex.js +44 -0
  579. package/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
  580. package/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
  581. package/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
  582. package/serialization/types/IndexedAssetsListRequestFps.js +44 -0
  583. package/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
  584. package/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
  585. package/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
  586. package/serialization/types/IndexedAssetsListRequestSize.js +44 -0
  587. package/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
  588. package/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
  589. package/serialization/types/InternalEntity.d.ts +10 -2
  590. package/serialization/types/InternalEntity.js +11 -5
  591. package/serialization/types/SegmentDefinition.d.ts +19 -0
  592. package/serialization/types/SegmentDefinition.js +50 -0
  593. package/serialization/types/SegmentField.d.ts +18 -0
  594. package/serialization/types/SegmentField.js +49 -0
  595. package/serialization/types/SegmentFieldItems.d.ts +13 -0
  596. package/serialization/types/SegmentFieldItems.js +44 -0
  597. package/serialization/types/SegmentFieldItemsType.d.ts +10 -0
  598. package/serialization/types/SegmentFieldItemsType.js +41 -0
  599. package/serialization/types/SegmentFieldType.d.ts +10 -0
  600. package/serialization/types/SegmentFieldType.js +41 -0
  601. package/serialization/types/SmeMediaSource.d.ts +17 -0
  602. package/serialization/types/SmeMediaSource.js +48 -0
  603. package/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
  604. package/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
  605. package/serialization/types/SyncResponseFormat.d.ts +14 -0
  606. package/{dist/serialization/types/ResponseFormat.js → serialization/types/SyncResponseFormat.js} +4 -4
  607. package/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
  608. package/serialization/types/SyncResponseFormatType.js +41 -0
  609. package/serialization/types/TokenUsage.d.ts +2 -1
  610. package/serialization/types/TokenUsage.js +2 -1
  611. package/serialization/types/VideosListRequestDuration.d.ts +13 -0
  612. package/serialization/types/VideosListRequestDuration.js +44 -0
  613. package/serialization/types/VideosListRequestFps.d.ts +13 -0
  614. package/serialization/types/VideosListRequestFps.js +44 -0
  615. package/serialization/types/VideosListRequestHeight.d.ts +13 -0
  616. package/serialization/types/VideosListRequestHeight.js +44 -0
  617. package/serialization/types/VideosListRequestSize.d.ts +13 -0
  618. package/serialization/types/VideosListRequestSize.js +44 -0
  619. package/serialization/types/VideosListRequestWidth.d.ts +13 -0
  620. package/serialization/types/VideosListRequestWidth.js +44 -0
  621. package/serialization/types/index.d.ts +46 -2
  622. package/serialization/types/index.js +46 -2
  623. package/version.d.ts +1 -1
  624. package/version.js +1 -1
  625. package/wrapper/resources/IndexesVideosWrapper.js +29 -14
  626. package/dist/serialization/types/ResponseFormat.d.ts +0 -14
  627. package/serialization/types/ResponseFormat.d.ts +0 -14
  628. /package/api/{types/ResponseFormat.js → resources/assets/client/requests/AssetsDeleteRequest.js} +0 -0
  629. /package/{dist/api/types/ResponseFormat.js → api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js} +0 -0
@@ -71,7 +71,11 @@ class Tasks {
71
71
  * await client.analyzeAsync.tasks.list({
72
72
  * page: 1,
73
73
  * pageLimit: 10,
74
- * status: "queued"
74
+ * status: "queued",
75
+ * videoUrl: "https://example.com/video.mp4",
76
+ * assetId: "69abc123def456789012abcd",
77
+ * videoId: "6298d673f1090f1100476d4c",
78
+ * analysisMode: "general"
75
79
  * })
76
80
  */
77
81
  list(request = {}, requestOptions) {
@@ -80,7 +84,7 @@ class Tasks {
80
84
  __list() {
81
85
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
82
86
  var _a, _b;
83
- const { page, pageLimit, status } = request;
87
+ const { page, pageLimit, status, videoUrl, assetId, videoId, analysisMode } = request;
84
88
  const _queryParams = {};
85
89
  if (page != null) {
86
90
  _queryParams["page"] = page.toString();
@@ -93,14 +97,26 @@ class Tasks {
93
97
  unrecognizedObjectKeys: "strip",
94
98
  });
95
99
  }
100
+ if (videoUrl != null) {
101
+ _queryParams["video_url"] = videoUrl;
102
+ }
103
+ if (assetId != null) {
104
+ _queryParams["asset_id"] = assetId;
105
+ }
106
+ if (videoId != null) {
107
+ _queryParams["video_id"] = videoId;
108
+ }
109
+ if (analysisMode != null) {
110
+ _queryParams["analysis_mode"] = serializers.analyzeAsync.TasksListRequestAnalysisMode.jsonOrThrow(analysisMode, { unrecognizedObjectKeys: "strip" });
111
+ }
96
112
  const _response = yield core.fetcher({
97
113
  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/tasks"),
98
114
  method: "GET",
99
- 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),
115
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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),
100
116
  contentType: "application/json",
101
117
  queryParameters: _queryParams,
102
118
  requestType: "json",
103
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
119
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
104
120
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
105
121
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
106
122
  });
@@ -145,7 +161,7 @@ class Tasks {
145
161
  });
146
162
  }
147
163
  /**
148
- * This method asynchronously analyzes your videos and generates fully customizable text based on your prompts.
164
+ * This method asynchronously analyzes your videos. It supports two analysis modes: general analysis (prompt-based text generation) and video segmentation with custom segment definitions. Video segmentation requires Pegasus 1.5.
149
165
  *
150
166
  * <Accordion title="Input requirements">
151
167
  * - Minimum duration: 4 seconds
@@ -156,6 +172,8 @@ class Tasks {
156
172
  * </Accordion>
157
173
  *
158
174
  * **When to use this method**:
175
+ * - Generate custom text from your video using a prompt (general analysis)
176
+ * - Extract timestamped metadata with custom segment definitions from your video (Pegasus 1.5 only)
159
177
  * - Analyze videos longer than 1 hour
160
178
  * - Process videos asynchronously without blocking your application
161
179
  *
@@ -180,6 +198,7 @@ class Tasks {
180
198
  *
181
199
  * @example
182
200
  * await client.analyzeAsync.tasks.create({
201
+ * customId: "prod-segment-analysis-42",
183
202
  * video: {
184
203
  * type: "url",
185
204
  * url: "https://example.com/video.mp4"
@@ -188,6 +207,93 @@ class Tasks {
188
207
  * temperature: 0.2,
189
208
  * maxTokens: 1000
190
209
  * })
210
+ *
211
+ * @example
212
+ * await client.analyzeAsync.tasks.create({
213
+ * modelName: "pegasus1.5",
214
+ * video: {
215
+ * type: "url",
216
+ * url: "https://example.com/video.mp4"
217
+ * },
218
+ * analysisMode: "time_based_metadata",
219
+ * responseFormat: {
220
+ * type: "segment_definitions",
221
+ * segmentDefinitions: [{
222
+ * id: "scene",
223
+ * description: "A distinct scene or setting change in the video",
224
+ * fields: [{
225
+ * name: "sentiment",
226
+ * type: "string",
227
+ * description: "The emotional tone of this segment",
228
+ * enum: ["positive", "negative", "neutral"]
229
+ * }, {
230
+ * name: "key_objects",
231
+ * type: "array",
232
+ * description: "Notable objects visible in this segment",
233
+ * items: {
234
+ * type: "string"
235
+ * }
236
+ * }]
237
+ * }]
238
+ * },
239
+ * minSegmentDuration: 5,
240
+ * maxSegmentDuration: 30
241
+ * })
242
+ *
243
+ * @example
244
+ * await client.analyzeAsync.tasks.create({
245
+ * modelName: "pegasus1.5",
246
+ * video: {
247
+ * type: "url",
248
+ * url: "https://example.com/video.mp4"
249
+ * },
250
+ * prompt: "Summarize the key events in this clip.",
251
+ * maxTokens: 4096,
252
+ * startTime: 10,
253
+ * endTime: 60
254
+ * })
255
+ *
256
+ * @example
257
+ * await client.analyzeAsync.tasks.create({
258
+ * modelName: "pegasus1.5",
259
+ * video: {
260
+ * type: "url",
261
+ * url: "https://example.com/video.mp4"
262
+ * },
263
+ * analysisMode: "time_based_metadata",
264
+ * responseFormat: {
265
+ * type: "segment_definitions",
266
+ * segmentDefinitions: [{
267
+ * id: "scenes",
268
+ * description: "Scene changes.",
269
+ * timeRanges: [{
270
+ * startTime: 0,
271
+ * endTime: 4
272
+ * }, {
273
+ * startTime: 10,
274
+ * endTime: 14
275
+ * }]
276
+ * }]
277
+ * }
278
+ * })
279
+ *
280
+ * @example
281
+ * await client.analyzeAsync.tasks.create({
282
+ * modelName: "pegasus1.5",
283
+ * video: {
284
+ * type: "url",
285
+ * url: "https://example.com/video.mp4"
286
+ * },
287
+ * promptV2: {
288
+ * inputText: "Is there a <@tiger-1> in the video?",
289
+ * mediaSources: [{
290
+ * name: "tiger-1",
291
+ * mediaType: "image",
292
+ * url: "https://example.com/tiger.jpg"
293
+ * }]
294
+ * },
295
+ * maxTokens: 4096
296
+ * })
191
297
  */
192
298
  create(request, requestOptions) {
193
299
  return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -198,13 +304,13 @@ class Tasks {
198
304
  const _response = yield core.fetcher({
199
305
  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/tasks"),
200
306
  method: "POST",
201
- 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),
307
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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),
202
308
  contentType: "application/json",
203
309
  requestType: "json",
204
310
  body: serializers.analyzeAsync.CreateAsyncAnalyzeRequest.jsonOrThrow(request, {
205
311
  unrecognizedObjectKeys: "strip",
206
312
  }),
207
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
313
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
208
314
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
209
315
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
210
316
  });
@@ -279,10 +385,10 @@ class Tasks {
279
385
  const _response = yield core.fetcher({
280
386
  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/tasks/${encodeURIComponent(taskId)}`),
281
387
  method: "GET",
282
- 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),
388
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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),
283
389
  contentType: "application/json",
284
390
  requestType: "json",
285
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
391
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
286
392
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
287
393
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
288
394
  });
@@ -347,10 +453,10 @@ class Tasks {
347
453
  const _response = yield core.fetcher({
348
454
  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/tasks/${encodeURIComponent(taskId)}`),
349
455
  method: "DELETE",
350
- 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),
456
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "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),
351
457
  contentType: "application/json",
352
458
  requestType: "json",
353
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
459
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
354
460
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
355
461
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
356
462
  });
@@ -362,12 +468,7 @@ class Tasks {
362
468
  case 404:
363
469
  throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
364
470
  case 409:
365
- throw new TwelvelabsApi.ConflictError(serializers.ErrorResponse.parseOrThrow(_response.error.body, {
366
- unrecognizedObjectKeys: "passthrough",
367
- allowUnrecognizedUnionMembers: true,
368
- allowUnrecognizedEnumValues: true,
369
- breadcrumbsPrefix: ["response"],
370
- }), _response.rawResponse);
471
+ throw new TwelvelabsApi.ConflictError(_response.error.body, _response.rawResponse);
371
472
  default:
372
473
  throw new errors.TwelvelabsApiError({
373
474
  statusCode: _response.error.statusCode,
@@ -5,6 +5,7 @@ import * as TwelvelabsApi from "../../../../../../index";
5
5
  /**
6
6
  * @example
7
7
  * {
8
+ * customId: "prod-segment-analysis-42",
8
9
  * video: {
9
10
  * type: "url",
10
11
  * url: "https://example.com/video.mp4"
@@ -13,11 +14,183 @@ import * as TwelvelabsApi from "../../../../../../index";
13
14
  * temperature: 0.2,
14
15
  * maxTokens: 1000
15
16
  * }
17
+ *
18
+ * @example
19
+ * {
20
+ * modelName: "pegasus1.5",
21
+ * video: {
22
+ * type: "url",
23
+ * url: "https://example.com/video.mp4"
24
+ * },
25
+ * analysisMode: "time_based_metadata",
26
+ * responseFormat: {
27
+ * type: "segment_definitions",
28
+ * segmentDefinitions: [{
29
+ * id: "scene",
30
+ * description: "A distinct scene or setting change in the video",
31
+ * fields: [{
32
+ * name: "sentiment",
33
+ * type: "string",
34
+ * description: "The emotional tone of this segment",
35
+ * enum: ["positive", "negative", "neutral"]
36
+ * }, {
37
+ * name: "key_objects",
38
+ * type: "array",
39
+ * description: "Notable objects visible in this segment",
40
+ * items: {
41
+ * type: "string"
42
+ * }
43
+ * }]
44
+ * }]
45
+ * },
46
+ * minSegmentDuration: 5,
47
+ * maxSegmentDuration: 30
48
+ * }
49
+ *
50
+ * @example
51
+ * {
52
+ * modelName: "pegasus1.5",
53
+ * video: {
54
+ * type: "url",
55
+ * url: "https://example.com/video.mp4"
56
+ * },
57
+ * prompt: "Summarize the key events in this clip.",
58
+ * maxTokens: 4096,
59
+ * startTime: 10,
60
+ * endTime: 60
61
+ * }
62
+ *
63
+ * @example
64
+ * {
65
+ * modelName: "pegasus1.5",
66
+ * video: {
67
+ * type: "url",
68
+ * url: "https://example.com/video.mp4"
69
+ * },
70
+ * analysisMode: "time_based_metadata",
71
+ * responseFormat: {
72
+ * type: "segment_definitions",
73
+ * segmentDefinitions: [{
74
+ * id: "scenes",
75
+ * description: "Scene changes.",
76
+ * timeRanges: [{
77
+ * startTime: 0,
78
+ * endTime: 4
79
+ * }, {
80
+ * startTime: 10,
81
+ * endTime: 14
82
+ * }]
83
+ * }]
84
+ * }
85
+ * }
86
+ *
87
+ * @example
88
+ * {
89
+ * modelName: "pegasus1.5",
90
+ * video: {
91
+ * type: "url",
92
+ * url: "https://example.com/video.mp4"
93
+ * },
94
+ * promptV2: {
95
+ * inputText: "Is there a <@tiger-1> in the video?",
96
+ * mediaSources: [{
97
+ * name: "tiger-1",
98
+ * mediaType: "image",
99
+ * url: "https://example.com/tiger.jpg"
100
+ * }]
101
+ * },
102
+ * maxTokens: 4096
103
+ * }
16
104
  */
17
105
  export interface CreateAsyncAnalyzeRequest {
106
+ /**
107
+ * The video understanding model to use for analysis.
108
+ * - `pegasus1.2`: General analysis (prompt-based text generation).
109
+ * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation.
110
+ *
111
+ * **Default:** `pegasus1.2`
112
+ */
113
+ modelName?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestModelName;
114
+ /**
115
+ * An optional identifier that you set when you create the task. Use this field to correlate tasks across responses, for example, to distinguish tasks by type or environment.
116
+ *
117
+ * The platform stores this value unchanged and returns it in the following responses:
118
+ * - The [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint
119
+ * - The [`GET`](/v1.3/api-reference/analyze-videos/list-async-analysis-tasks) method of the `/analyze/tasks` endpoint
120
+ * - The `analyze.task.ready` and `analyze.task.failed` webhook payloads
121
+ *
122
+ * **Format**: 1–64 characters. Alphanumeric, hyphens (`-`), and underscores (`_`) only. An empty string is rejected with a `400 Bad Request`.
123
+ *
124
+ * This field does not enforce uniqueness. You can submit multiple tasks with the same `custom_id`. To prevent duplicate task creation, use an `Idempotency-Key` header instead.
125
+ */
126
+ customId?: string;
18
127
  video: TwelvelabsApi.VideoContext;
19
- prompt: TwelvelabsApi.AnalyzeTextPrompt;
128
+ /**
129
+ * Natural-language instructions for analyzing the video. Required for general analysis (prompt-based text generation). Not supported when `analysis_mode` is `time_based_metadata`. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter.
130
+ *
131
+ * <Note title="Notes">
132
+ * - Even though the model behind this endpoint is trained to a high degree of accuracy, the preciseness of the generated text may vary based on the nature and quality of the video and the clarity of the prompt.
133
+ * - Your prompts can be instructive or descriptive, or you can also phrase them as questions.
134
+ * - The maximum length of a prompt is 2,000 tokens.
135
+ * </Note>
136
+ *
137
+ * **Examples**:
138
+ *
139
+ * - Based on this video, I want to generate five keywords for SEO (Search Engine Optimization).
140
+ * - I want to generate a description for my video with the following format: Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.
141
+ */
142
+ prompt?: string;
143
+ promptV2?: TwelvelabsApi.AnalyzePromptV2;
144
+ /**
145
+ * The analysis approach for this task.
146
+ * - `general`: Analyze the video and generate a response based on your prompt. Supports both free-form text and structured output via `response_format`.
147
+ * - `time_based_metadata`: Segment the video into time-based intervals and extract custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`.
148
+ *
149
+ * **Default:** `general`
150
+ */
151
+ analysisMode?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestAnalysisMode;
20
152
  temperature?: TwelvelabsApi.AnalyzeTemperature;
21
- maxTokens?: TwelvelabsApi.AnalyzeMaxTokens;
22
- responseFormat?: TwelvelabsApi.ResponseFormat;
153
+ /**
154
+ * The maximum number of tokens to generate. The allowed range depends on the model and analysis mode:
155
+ *
156
+ * | Model | Mode | Min | Max | Default |
157
+ * |-------|------|-----|-----|---------|
158
+ * | Pegasus 1.2 | — | 1 | 4,096 | 4096 |
159
+ * | Pegasus 1.5 | `general` | 512 | 65,536 | 4,096 |
160
+ * | Pegasus 1.5 | `time_based_metadata` | 2,048 | 65,536 | 32,768 |
161
+ */
162
+ maxTokens?: number;
163
+ responseFormat?: TwelvelabsApi.AsyncResponseFormat;
164
+ /**
165
+ * Minimum duration for each extracted segment, in seconds. Set this value to enforce a minimum segment length. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`. Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
166
+ *
167
+ * **Min:** 2
168
+ */
169
+ minSegmentDuration?: number;
170
+ /**
171
+ * Maximum duration for each extracted segment, in seconds. Set this value to split long continuous sections into shorter segments. Must be greater than or equal to `min_segment_duration`. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`. Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
172
+ *
173
+ * **Min:** 2
174
+ */
175
+ maxSegmentDuration?: number;
176
+ /**
177
+ * Start of the analysis window, in seconds. Use with `end_time` to analyze only a portion of the video. Requires `model_name` set to `pegasus1.5`.
178
+ *
179
+ * <Note title="Notes">
180
+ * - If omitted, defaults to `0`.
181
+ * - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
182
+ * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
183
+ * </Note>
184
+ */
185
+ startTime?: number;
186
+ /**
187
+ * End of the analysis window, in seconds. Use with `start_time` to analyze only a portion of the video. Requires `model_name` set to `pegasus1.5`.
188
+ *
189
+ * <Note title="Notes">
190
+ * - If omitted, defaults to the video duration.
191
+ * - Must be greater than `start_time` and less than or equal to the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
192
+ * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
193
+ * </Note>
194
+ */
195
+ endTime?: number;
23
196
  }
@@ -7,7 +7,22 @@ import * as TwelvelabsApi from "../../../../../../index";
7
7
  * {
8
8
  * page: 1,
9
9
  * pageLimit: 10,
10
- * status: "queued"
10
+ * status: "queued",
11
+ * videoUrl: "https://example.com/video.mp4",
12
+ * assetId: "69abc123def456789012abcd",
13
+ * videoId: "6298d673f1090f1100476d4c",
14
+ * analysisMode: "general"
15
+ * }
16
+ *
17
+ * @example
18
+ * {
19
+ * page: 1,
20
+ * pageLimit: 10,
21
+ * status: "queued",
22
+ * videoUrl: "https://example.com/video.mp4",
23
+ * assetId: "69abc123def456789012abcd",
24
+ * videoId: "6298d673f1090f1100476d4c",
25
+ * analysisMode: "general"
11
26
  * }
12
27
  */
13
28
  export interface TasksListRequest {
@@ -29,4 +44,20 @@ export interface TasksListRequest {
29
44
  * Possible values: `queued`, `pending`, `processing`, `ready`, `failed`.
30
45
  */
31
46
  status?: TwelvelabsApi.AnalyzeTaskStatus;
47
+ /**
48
+ * Filter tasks by exact video source URL.
49
+ */
50
+ videoUrl?: string;
51
+ /**
52
+ * Filter tasks by asset ID.
53
+ */
54
+ assetId?: string;
55
+ /**
56
+ * Filter tasks by video ID for pre-indexed videos (Pegasus 1.2 only). Deprecated — use `asset_id` instead.
57
+ */
58
+ videoId?: string;
59
+ /**
60
+ * Filter tasks by the analysis mode used when creating the task.
61
+ */
62
+ analysisMode?: TwelvelabsApi.analyzeAsync.TasksListRequestAnalysisMode;
32
63
  }
@@ -0,0 +1,15 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The analysis approach for this task.
6
+ * - `general`: Analyze the video and generate a response based on your prompt. Supports both free-form text and structured output via `response_format`.
7
+ * - `time_based_metadata`: Segment the video into time-based intervals and extract custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`.
8
+ *
9
+ * **Default:** `general`
10
+ */
11
+ export type CreateAsyncAnalyzeRequestAnalysisMode = "general" | "time_based_metadata";
12
+ export declare const CreateAsyncAnalyzeRequestAnalysisMode: {
13
+ readonly General: "general";
14
+ readonly TimeBasedMetadata: "time_based_metadata";
15
+ };
@@ -0,0 +1,10 @@
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.CreateAsyncAnalyzeRequestAnalysisMode = void 0;
7
+ exports.CreateAsyncAnalyzeRequestAnalysisMode = {
8
+ General: "general",
9
+ TimeBasedMetadata: "time_based_metadata",
10
+ };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ /**
5
+ * The video understanding model to use for analysis.
6
+ * - `pegasus1.2`: General analysis (prompt-based text generation).
7
+ * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation.
8
+ *
9
+ * **Default:** `pegasus1.2`
10
+ */
11
+ export type CreateAsyncAnalyzeRequestModelName = "pegasus1.2" | "pegasus1.5";
12
+ export declare const CreateAsyncAnalyzeRequestModelName: {
13
+ readonly Pegasus12: "pegasus1.2";
14
+ readonly Pegasus15: "pegasus1.5";
15
+ };
@@ -0,0 +1,10 @@
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.CreateAsyncAnalyzeRequestModelName = void 0;
7
+ exports.CreateAsyncAnalyzeRequestModelName = {
8
+ Pegasus12: "pegasus1.2",
9
+ Pegasus15: "pegasus1.5",
10
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * This file was auto-generated by Fern from our API Definition.
3
+ */
4
+ export type TasksListRequestAnalysisMode = "general" | "time_based_metadata";
5
+ export declare const TasksListRequestAnalysisMode: {
6
+ readonly General: "general";
7
+ readonly TimeBasedMetadata: "time_based_metadata";
8
+ };
@@ -0,0 +1,10 @@
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.TasksListRequestAnalysisMode = void 0;
7
+ exports.TasksListRequestAnalysisMode = {
8
+ General: "general",
9
+ TimeBasedMetadata: "time_based_metadata",
10
+ };
@@ -1 +1,4 @@
1
+ export * from "./TasksListRequestAnalysisMode";
1
2
  export * from "./TasksListResponse";
3
+ export * from "./CreateAsyncAnalyzeRequestModelName";
4
+ export * from "./CreateAsyncAnalyzeRequestAnalysisMode";
@@ -14,4 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./TasksListRequestAnalysisMode"), exports);
17
18
  __exportStar(require("./TasksListResponse"), exports);
19
+ __exportStar(require("./CreateAsyncAnalyzeRequestModelName"), exports);
20
+ __exportStar(require("./CreateAsyncAnalyzeRequestAnalysisMode"), exports);
@@ -38,10 +38,11 @@ export declare class Assets {
38
38
  * @example
39
39
  * await client.assets.list({
40
40
  * page: 1,
41
- * pageLimit: 10
41
+ * pageLimit: 10,
42
+ * filename: "meeting"
42
43
  * })
43
44
  */
44
- list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.Asset>>;
45
+ list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.AssetDetail>>;
45
46
  /**
46
47
  * This method creates an asset by uploading a file to the platform. Assets are media files that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.
47
48
  *
@@ -51,7 +52,10 @@ export declare class Assets {
51
52
  * - **Local file**: Set the `method` parameter to `direct` and use the `file` parameter to specify the file.
52
53
  * - **Publicly accessible URL**: Set the `method` parameter to `url` and use the `url` parameter to specify the URL of your file.
53
54
  *
54
- * **File size**: 200MB maximum for local file uploads, 4GB maximum for URL uploads.
55
+ * **Upload limits**:
56
+ * - **Video and audio, local files**: Up to 200 MB
57
+ * - **Video and audio, public URLs**: Up to 4 GB
58
+ * - **Images**: Up to 5 MB
55
59
  *
56
60
  * **Additional requirements** depend on your workflow:
57
61
  * - **Search**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements)
@@ -86,20 +90,30 @@ export declare class Assets {
86
90
  * @example
87
91
  * await client.assets.retrieve("6298d673f1090f1100476d4c")
88
92
  */
89
- retrieve(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.Asset>;
93
+ retrieve(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.AssetDetail>;
90
94
  private __retrieve;
91
95
  /**
92
96
  * This method deletes the specified asset. This action cannot be undone.
93
97
  *
98
+ * By default, the platform checks whether any indexed assets reference the asset. If references exist, the platform rejects the request with a `409 Conflict` error. To skip this check and delete the asset anyway, set the `force` query parameter to `true`. The platform unlinks any entity associations.
99
+ *
100
+ * Before deleting, you can inspect existing references:
101
+ * - [`GET`](/v1.3/api-reference/index-content/list-indexed-assets-by-asset) `/assets/{asset_id}/indexed-assets` returns a list of the indexed assets that will block deletion unless the `force` query parameter is set to `true`.
102
+ * - [`GET`](/v1.3/api-reference/entities/list-entities-by-asset) `/assets/{asset_id}/entities` returns a list of the entities whose associations the platform will unlink.
103
+ *
94
104
  * @param {string} assetId - The unique identifier of the asset to delete.
105
+ * @param {TwelvelabsApi.AssetsDeleteRequest} request
95
106
  * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
96
107
  *
97
108
  * @throws {@link TwelvelabsApi.BadRequestError}
109
+ * @throws {@link TwelvelabsApi.ConflictError}
98
110
  *
99
111
  * @example
100
- * await client.assets.delete("6298d673f1090f1100476d4c")
112
+ * await client.assets.delete("6298d673f1090f1100476d4c", {
113
+ * force: true
114
+ * })
101
115
  */
102
- delete(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
116
+ delete(assetId: string, request?: TwelvelabsApi.AssetsDeleteRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
103
117
  private __delete;
104
118
  protected _getCustomAuthorizationHeaders(): Promise<{
105
119
  "x-api-key": string;