twelvelabs-js 1.2.3 → 1.2.5

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 (350) hide show
  1. package/Client.d.ts +14 -38
  2. package/Client.js +22 -42
  3. package/api/client/requests/AnalyzeRequest.d.ts +50 -29
  4. package/api/client/requests/AnalyzeStreamRequest.d.ts +50 -29
  5. package/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +130 -4
  6. package/api/resources/analyzeAsync/resources/tasks/client/Client.js +142 -13
  7. package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +188 -14
  8. package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +8 -2
  9. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +7 -2
  10. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +1 -0
  11. package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +4 -2
  12. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +2 -1
  13. package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +1 -0
  14. package/api/resources/assets/client/Client.d.ts +48 -1
  15. package/api/resources/assets/client/Client.js +156 -9
  16. package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +3 -1
  17. package/api/resources/assets/client/requests/AssetsUpdateUserMetadataRequest.d.ts +18 -0
  18. package/api/resources/assets/client/requests/index.d.ts +1 -0
  19. package/api/resources/embed/client/Client.js +2 -2
  20. package/api/resources/embed/resources/tasks/client/Client.js +8 -8
  21. package/api/resources/embed/resources/v2/client/Client.js +2 -2
  22. package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +1 -1
  23. package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +7 -7
  24. package/api/resources/entityCollections/client/Client.js +10 -10
  25. package/api/resources/entityCollections/resources/entities/client/Client.js +18 -18
  26. package/api/resources/indexes/client/Client.js +10 -10
  27. package/api/resources/indexes/resources/indexedAssets/client/Client.js +12 -12
  28. package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +3 -0
  29. package/api/resources/indexes/resources/videos/client/Client.js +8 -8
  30. package/api/resources/indexes/resources/videos/types/VideosRetrieveResponse.d.ts +3 -1
  31. package/api/resources/multipartUpload/client/Client.d.ts +2 -2
  32. package/api/resources/multipartUpload/client/Client.js +12 -12
  33. package/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  34. package/api/resources/search/client/Client.js +4 -4
  35. package/api/resources/tasks/client/Client.d.ts +0 -3
  36. package/api/resources/tasks/client/Client.js +8 -13
  37. package/api/resources/tasks/client/requests/TasksCreateRequest.d.ts +1 -1
  38. package/api/resources/tasks/index.d.ts +0 -1
  39. package/api/resources/tasks/index.js +0 -1
  40. package/api/types/AnalyzeMaxTokens.d.ts +1 -1
  41. package/api/types/AnalyzePromptV2.d.ts +13 -0
  42. package/api/types/AnalyzeRequestModelName.d.ts +15 -0
  43. package/api/types/AnalyzeRequestModelName.js +10 -0
  44. package/api/types/AnalyzeStreamRequestModelName.d.ts +15 -0
  45. package/api/types/AnalyzeStreamRequestModelName.js +10 -0
  46. package/api/types/AnalyzeTaskError.d.ts +16 -2
  47. package/api/types/AnalyzeTaskResponse.d.ts +11 -2
  48. package/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -3
  49. package/api/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +16 -0
  50. package/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +11 -0
  51. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +14 -1
  52. package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +2 -0
  53. package/api/types/AnalyzeTaskResponseVideoSource.d.ts +2 -0
  54. package/api/types/AnalyzeTaskResultUsage.d.ts +1 -1
  55. package/api/types/AnalyzeTextPrompt.d.ts +1 -5
  56. package/api/types/AnalyzeTimeRange.d.ts +12 -0
  57. package/api/types/Asset.d.ts +2 -0
  58. package/api/types/AsyncResponseFormat.d.ts +83 -8
  59. package/api/types/AsyncResponseFormatSegmentTimeFormat.d.ts +20 -0
  60. package/api/types/AsyncResponseFormatSegmentTimeFormat.js +11 -0
  61. package/api/types/FinishReason.d.ts +3 -3
  62. package/api/types/IndexedAssetDetailed.d.ts +1 -1
  63. package/api/types/NonStreamAnalyzeResponse.d.ts +2 -0
  64. package/api/types/SegmentDefinition.d.ts +12 -0
  65. package/api/types/SegmentField.d.ts +29 -3
  66. package/api/types/SegmentFieldFormat.d.ts +24 -0
  67. package/api/types/SegmentFieldFormat.js +11 -0
  68. package/api/types/SegmentFieldItems.d.ts +1 -1
  69. package/api/types/SegmentFieldType.d.ts +4 -1
  70. package/api/types/SegmentFieldType.js +1 -0
  71. package/api/types/StreamEndResponse.d.ts +2 -0
  72. package/api/types/SyncResponseFormat.d.ts +70 -7
  73. package/api/types/TokenUsage.d.ts +3 -1
  74. package/api/types/UserMetadata.d.ts +3 -12
  75. package/api/types/VideoVector.d.ts +2 -0
  76. package/api/types/index.d.ts +8 -5
  77. package/api/types/index.js +8 -5
  78. package/dist/Client.d.ts +14 -38
  79. package/dist/Client.js +22 -42
  80. package/dist/api/client/requests/AnalyzeRequest.d.ts +50 -29
  81. package/dist/api/client/requests/AnalyzeStreamRequest.d.ts +50 -29
  82. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +130 -4
  83. package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.js +142 -13
  84. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +188 -14
  85. package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +8 -2
  86. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +7 -2
  87. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +1 -0
  88. package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +4 -2
  89. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +2 -1
  90. package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +1 -0
  91. package/dist/api/resources/assets/client/Client.d.ts +48 -1
  92. package/dist/api/resources/assets/client/Client.js +156 -9
  93. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +3 -1
  94. package/dist/api/resources/assets/client/requests/AssetsUpdateUserMetadataRequest.d.ts +18 -0
  95. package/dist/api/resources/assets/client/requests/index.d.ts +1 -0
  96. package/dist/api/resources/embed/client/Client.js +2 -2
  97. package/dist/api/resources/embed/resources/tasks/client/Client.js +8 -8
  98. package/dist/api/resources/embed/resources/v2/client/Client.js +2 -2
  99. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +1 -1
  100. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +7 -7
  101. package/dist/api/resources/entityCollections/client/Client.js +10 -10
  102. package/dist/api/resources/entityCollections/resources/entities/client/Client.js +18 -18
  103. package/dist/api/resources/indexes/client/Client.js +10 -10
  104. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +12 -12
  105. package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +3 -0
  106. package/dist/api/resources/indexes/resources/videos/client/Client.js +8 -8
  107. package/dist/api/resources/indexes/resources/videos/types/VideosRetrieveResponse.d.ts +3 -1
  108. package/dist/api/resources/multipartUpload/client/Client.d.ts +2 -2
  109. package/dist/api/resources/multipartUpload/client/Client.js +12 -12
  110. package/dist/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  111. package/dist/api/resources/search/client/Client.js +4 -4
  112. package/dist/api/resources/tasks/client/Client.d.ts +0 -3
  113. package/dist/api/resources/tasks/client/Client.js +8 -13
  114. package/dist/api/resources/tasks/client/requests/TasksCreateRequest.d.ts +1 -1
  115. package/dist/api/resources/tasks/index.d.ts +0 -1
  116. package/dist/api/resources/tasks/index.js +0 -1
  117. package/dist/api/types/AnalyzeMaxTokens.d.ts +1 -1
  118. package/dist/api/types/AnalyzePromptV2.d.ts +13 -0
  119. package/dist/api/types/AnalyzeRequestModelName.d.ts +15 -0
  120. package/dist/api/types/AnalyzeRequestModelName.js +10 -0
  121. package/dist/api/types/AnalyzeStreamRequestModelName.d.ts +15 -0
  122. package/dist/api/types/AnalyzeStreamRequestModelName.js +10 -0
  123. package/dist/api/types/AnalyzeTaskError.d.ts +16 -2
  124. package/dist/api/types/AnalyzeTaskResponse.d.ts +11 -2
  125. package/dist/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -3
  126. package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +16 -0
  127. package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +11 -0
  128. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +14 -1
  129. package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +2 -0
  130. package/dist/api/types/AnalyzeTaskResponseVideoSource.d.ts +2 -0
  131. package/dist/api/types/AnalyzeTaskResultUsage.d.ts +1 -1
  132. package/dist/api/types/AnalyzeTextPrompt.d.ts +1 -5
  133. package/dist/api/types/AnalyzeTimeRange.d.ts +12 -0
  134. package/dist/api/types/Asset.d.ts +2 -0
  135. package/dist/api/types/AsyncResponseFormat.d.ts +83 -8
  136. package/dist/api/types/AsyncResponseFormatSegmentTimeFormat.d.ts +20 -0
  137. package/dist/api/types/AsyncResponseFormatSegmentTimeFormat.js +11 -0
  138. package/dist/api/types/FinishReason.d.ts +3 -3
  139. package/dist/api/types/IndexedAssetDetailed.d.ts +1 -1
  140. package/dist/api/types/NonStreamAnalyzeResponse.d.ts +2 -0
  141. package/dist/api/types/SegmentDefinition.d.ts +12 -0
  142. package/dist/api/types/SegmentField.d.ts +29 -3
  143. package/dist/api/types/SegmentFieldFormat.d.ts +24 -0
  144. package/dist/api/types/SegmentFieldFormat.js +11 -0
  145. package/dist/api/types/SegmentFieldItems.d.ts +1 -1
  146. package/dist/api/types/SegmentFieldType.d.ts +4 -1
  147. package/dist/api/types/SegmentFieldType.js +1 -0
  148. package/dist/api/types/StreamEndResponse.d.ts +2 -0
  149. package/dist/api/types/SyncResponseFormat.d.ts +70 -7
  150. package/dist/api/types/TokenUsage.d.ts +3 -1
  151. package/dist/api/types/UserMetadata.d.ts +3 -12
  152. package/dist/api/types/VideoVector.d.ts +2 -0
  153. package/dist/api/types/index.d.ts +8 -5
  154. package/dist/api/types/index.js +8 -5
  155. package/dist/serialization/client/requests/AnalyzeRequest.d.ts +8 -3
  156. package/dist/serialization/client/requests/AnalyzeRequest.js +8 -3
  157. package/dist/serialization/client/requests/AnalyzeStreamRequest.d.ts +8 -3
  158. package/dist/serialization/client/requests/AnalyzeStreamRequest.js +8 -3
  159. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +5 -0
  160. package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +5 -0
  161. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +1 -1
  162. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +1 -1
  163. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +1 -1
  164. package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +1 -1
  165. package/dist/serialization/resources/assets/client/index.d.ts +1 -0
  166. package/dist/{api/resources/tasks/resources/transfers → serialization/resources/assets/client}/index.js +1 -1
  167. package/dist/serialization/resources/assets/client/requests/AssetsUpdateUserMetadataRequest.d.ts +13 -0
  168. package/dist/serialization/resources/assets/client/requests/AssetsUpdateUserMetadataRequest.js +44 -0
  169. package/dist/serialization/resources/assets/client/requests/index.d.ts +1 -0
  170. package/dist/serialization/resources/assets/client/requests/index.js +5 -0
  171. package/dist/serialization/resources/assets/index.d.ts +1 -0
  172. package/dist/serialization/resources/assets/index.js +1 -0
  173. package/dist/serialization/resources/index.d.ts +1 -0
  174. package/dist/serialization/resources/index.js +1 -0
  175. package/dist/serialization/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +2 -0
  176. package/dist/serialization/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.js +2 -0
  177. package/dist/serialization/resources/indexes/resources/videos/types/VideosRetrieveResponse.d.ts +1 -0
  178. package/dist/serialization/resources/indexes/resources/videos/types/VideosRetrieveResponse.js +1 -0
  179. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  180. package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  181. package/dist/serialization/types/AnalyzePromptV2.d.ts +14 -0
  182. package/dist/serialization/types/{ImportLogVideoStatus.js → AnalyzePromptV2.js} +5 -8
  183. package/dist/serialization/types/AnalyzeRequestModelName.d.ts +10 -0
  184. package/{api/resources/tasks/resources/index.js → dist/serialization/types/AnalyzeRequestModelName.js} +6 -2
  185. package/dist/serialization/types/AnalyzeStreamRequestModelName.d.ts +10 -0
  186. package/dist/serialization/types/AnalyzeStreamRequestModelName.js +41 -0
  187. package/dist/serialization/types/AnalyzeTaskResponse.d.ts +1 -0
  188. package/dist/serialization/types/AnalyzeTaskResponse.js +1 -0
  189. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +5 -0
  190. package/dist/serialization/types/AnalyzeTaskResponseRequestParams.js +5 -0
  191. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +14 -0
  192. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.js +45 -0
  193. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +15 -0
  194. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +46 -0
  195. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +1 -0
  196. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +1 -0
  197. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +2 -0
  198. package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +2 -0
  199. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +1 -0
  200. package/dist/serialization/types/AnalyzeTaskResponseVideoSource.js +1 -0
  201. package/dist/serialization/types/AnalyzeTimeRange.d.ts +13 -0
  202. package/{serialization/types/ImportLogFailedFilesItem.js → dist/serialization/types/AnalyzeTimeRange.js} +4 -4
  203. package/dist/serialization/types/Asset.d.ts +2 -0
  204. package/dist/serialization/types/Asset.js +2 -0
  205. package/dist/serialization/types/AsyncResponseFormat.d.ts +2 -0
  206. package/dist/serialization/types/AsyncResponseFormat.js +2 -0
  207. package/dist/serialization/types/AsyncResponseFormatSegmentTimeFormat.d.ts +10 -0
  208. package/dist/serialization/types/{VideoItem.js → AsyncResponseFormatSegmentTimeFormat.js} +2 -6
  209. package/dist/serialization/types/NonStreamAnalyzeResponse.d.ts +2 -0
  210. package/dist/serialization/types/NonStreamAnalyzeResponse.js +2 -0
  211. package/dist/serialization/types/SegmentDefinition.d.ts +2 -0
  212. package/dist/serialization/types/SegmentDefinition.js +2 -0
  213. package/dist/serialization/types/SegmentField.d.ts +2 -0
  214. package/dist/serialization/types/SegmentField.js +2 -0
  215. package/dist/serialization/types/SegmentFieldFormat.d.ts +10 -0
  216. package/dist/serialization/types/SegmentFieldFormat.js +41 -0
  217. package/dist/serialization/types/SegmentFieldType.d.ts +1 -1
  218. package/dist/serialization/types/SegmentFieldType.js +1 -1
  219. package/dist/serialization/types/StreamEndResponse.d.ts +2 -0
  220. package/dist/serialization/types/StreamEndResponse.js +2 -0
  221. package/dist/serialization/types/TokenUsage.d.ts +2 -1
  222. package/dist/serialization/types/TokenUsage.js +2 -1
  223. package/dist/serialization/types/VideoVector.d.ts +1 -0
  224. package/dist/serialization/types/VideoVector.js +1 -0
  225. package/dist/serialization/types/index.d.ts +8 -5
  226. package/dist/serialization/types/index.js +8 -5
  227. package/dist/version.d.ts +1 -1
  228. package/dist/version.js +1 -1
  229. package/package.json +1 -1
  230. package/reference.md +171 -186
  231. package/serialization/client/requests/AnalyzeRequest.d.ts +8 -3
  232. package/serialization/client/requests/AnalyzeRequest.js +8 -3
  233. package/serialization/client/requests/AnalyzeStreamRequest.d.ts +8 -3
  234. package/serialization/client/requests/AnalyzeStreamRequest.js +8 -3
  235. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +5 -0
  236. package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +5 -0
  237. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +1 -1
  238. package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +1 -1
  239. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +1 -1
  240. package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +1 -1
  241. package/serialization/resources/assets/client/index.d.ts +1 -0
  242. package/{api/resources/tasks/resources/transfers → serialization/resources/assets/client}/index.js +1 -1
  243. package/serialization/resources/assets/client/requests/AssetsUpdateUserMetadataRequest.d.ts +13 -0
  244. package/serialization/resources/assets/client/requests/AssetsUpdateUserMetadataRequest.js +44 -0
  245. package/serialization/resources/assets/client/requests/index.d.ts +1 -0
  246. package/serialization/resources/assets/client/requests/index.js +5 -0
  247. package/serialization/resources/assets/index.d.ts +1 -0
  248. package/serialization/resources/assets/index.js +1 -0
  249. package/serialization/resources/index.d.ts +1 -0
  250. package/serialization/resources/index.js +1 -0
  251. package/serialization/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +2 -0
  252. package/serialization/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.js +2 -0
  253. package/serialization/resources/indexes/resources/videos/types/VideosRetrieveResponse.d.ts +1 -0
  254. package/serialization/resources/indexes/resources/videos/types/VideosRetrieveResponse.js +1 -0
  255. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
  256. package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
  257. package/serialization/types/AnalyzePromptV2.d.ts +14 -0
  258. package/{dist/serialization/types/VideoItemFailed.js → serialization/types/AnalyzePromptV2.js} +5 -5
  259. package/serialization/types/AnalyzeRequestModelName.d.ts +10 -0
  260. package/{dist/api/resources/tasks/resources/index.js → serialization/types/AnalyzeRequestModelName.js} +6 -2
  261. package/serialization/types/AnalyzeStreamRequestModelName.d.ts +10 -0
  262. package/serialization/types/AnalyzeStreamRequestModelName.js +41 -0
  263. package/serialization/types/AnalyzeTaskResponse.d.ts +1 -0
  264. package/serialization/types/AnalyzeTaskResponse.js +1 -0
  265. package/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +5 -0
  266. package/serialization/types/AnalyzeTaskResponseRequestParams.js +5 -0
  267. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +14 -0
  268. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.js +45 -0
  269. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +15 -0
  270. package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +46 -0
  271. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +1 -0
  272. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +1 -0
  273. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +2 -0
  274. package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +2 -0
  275. package/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +1 -0
  276. package/serialization/types/AnalyzeTaskResponseVideoSource.js +1 -0
  277. package/serialization/types/AnalyzeTimeRange.d.ts +13 -0
  278. package/{dist/serialization/types/ImportLogFailedFilesItem.js → serialization/types/AnalyzeTimeRange.js} +4 -4
  279. package/serialization/types/Asset.d.ts +2 -0
  280. package/serialization/types/Asset.js +2 -0
  281. package/serialization/types/AsyncResponseFormat.d.ts +2 -0
  282. package/serialization/types/AsyncResponseFormat.js +2 -0
  283. package/serialization/types/AsyncResponseFormatSegmentTimeFormat.d.ts +10 -0
  284. package/serialization/types/{VideoItem.js → AsyncResponseFormatSegmentTimeFormat.js} +2 -6
  285. package/serialization/types/NonStreamAnalyzeResponse.d.ts +2 -0
  286. package/serialization/types/NonStreamAnalyzeResponse.js +2 -0
  287. package/serialization/types/SegmentDefinition.d.ts +2 -0
  288. package/serialization/types/SegmentDefinition.js +2 -0
  289. package/serialization/types/SegmentField.d.ts +2 -0
  290. package/serialization/types/SegmentField.js +2 -0
  291. package/serialization/types/SegmentFieldFormat.d.ts +10 -0
  292. package/serialization/types/SegmentFieldFormat.js +41 -0
  293. package/serialization/types/SegmentFieldType.d.ts +1 -1
  294. package/serialization/types/SegmentFieldType.js +1 -1
  295. package/serialization/types/StreamEndResponse.d.ts +2 -0
  296. package/serialization/types/StreamEndResponse.js +2 -0
  297. package/serialization/types/TokenUsage.d.ts +2 -1
  298. package/serialization/types/TokenUsage.js +2 -1
  299. package/serialization/types/VideoVector.d.ts +1 -0
  300. package/serialization/types/VideoVector.js +1 -0
  301. package/serialization/types/index.d.ts +8 -5
  302. package/serialization/types/index.js +8 -5
  303. package/version.d.ts +1 -1
  304. package/version.js +1 -1
  305. package/api/resources/tasks/resources/index.d.ts +0 -1
  306. package/api/resources/tasks/resources/transfers/client/Client.d.ts +0 -57
  307. package/api/resources/tasks/resources/transfers/client/Client.js +0 -217
  308. package/api/resources/tasks/resources/transfers/client/index.d.ts +0 -1
  309. package/api/resources/tasks/resources/transfers/client/index.js +0 -2
  310. package/api/resources/tasks/resources/transfers/index.d.ts +0 -1
  311. package/api/types/ImportLog.d.ts +0 -21
  312. package/api/types/ImportLogFailedFilesItem.d.ts +0 -9
  313. package/api/types/ImportLogVideoStatus.d.ts +0 -14
  314. package/api/types/VideoItem.d.ts +0 -14
  315. package/api/types/VideoItemFailed.d.ts +0 -14
  316. package/dist/api/resources/tasks/resources/index.d.ts +0 -1
  317. package/dist/api/resources/tasks/resources/transfers/client/Client.d.ts +0 -57
  318. package/dist/api/resources/tasks/resources/transfers/client/Client.js +0 -217
  319. package/dist/api/resources/tasks/resources/transfers/client/index.d.ts +0 -1
  320. package/dist/api/resources/tasks/resources/transfers/client/index.js +0 -2
  321. package/dist/api/resources/tasks/resources/transfers/index.d.ts +0 -1
  322. package/dist/api/types/ImportLog.d.ts +0 -21
  323. package/dist/api/types/ImportLogFailedFilesItem.d.ts +0 -9
  324. package/dist/api/types/ImportLogVideoStatus.d.ts +0 -14
  325. package/dist/api/types/VideoItem.d.ts +0 -14
  326. package/dist/api/types/VideoItemFailed.d.ts +0 -14
  327. package/dist/serialization/types/ImportLog.d.ts +0 -19
  328. package/dist/serialization/types/ImportLog.js +0 -50
  329. package/dist/serialization/types/ImportLogFailedFilesItem.d.ts +0 -13
  330. package/dist/serialization/types/ImportLogVideoStatus.d.ts +0 -17
  331. package/dist/serialization/types/VideoItem.d.ts +0 -14
  332. package/dist/serialization/types/VideoItemFailed.d.ts +0 -14
  333. package/serialization/types/ImportLog.d.ts +0 -19
  334. package/serialization/types/ImportLog.js +0 -50
  335. package/serialization/types/ImportLogFailedFilesItem.d.ts +0 -13
  336. package/serialization/types/ImportLogVideoStatus.d.ts +0 -17
  337. package/serialization/types/ImportLogVideoStatus.js +0 -48
  338. package/serialization/types/VideoItem.d.ts +0 -14
  339. package/serialization/types/VideoItemFailed.d.ts +0 -14
  340. package/serialization/types/VideoItemFailed.js +0 -45
  341. /package/api/{types/ImportLog.js → resources/assets/client/requests/AssetsUpdateUserMetadataRequest.js} +0 -0
  342. /package/api/types/{ImportLogFailedFilesItem.js → AnalyzePromptV2.js} +0 -0
  343. /package/api/types/{ImportLogVideoStatus.js → AnalyzeTaskResponseRequestParamsPromptV2.js} +0 -0
  344. /package/api/types/{VideoItem.js → AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js} +0 -0
  345. /package/api/types/{VideoItemFailed.js → AnalyzeTimeRange.js} +0 -0
  346. /package/dist/api/{types/ImportLog.js → resources/assets/client/requests/AssetsUpdateUserMetadataRequest.js} +0 -0
  347. /package/dist/api/types/{ImportLogFailedFilesItem.js → AnalyzePromptV2.js} +0 -0
  348. /package/dist/api/types/{ImportLogVideoStatus.js → AnalyzeTaskResponseRequestParamsPromptV2.js} +0 -0
  349. /package/dist/api/types/{VideoItem.js → AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js} +0 -0
  350. /package/dist/api/types/{VideoItemFailed.js → AnalyzeTimeRange.js} +0 -0
@@ -74,7 +74,8 @@ class Tasks {
74
74
  * status: "queued",
75
75
  * videoUrl: "https://example.com/video.mp4",
76
76
  * assetId: "69abc123def456789012abcd",
77
- * analysisMode: "time_based_metadata"
77
+ * videoId: "6298d673f1090f1100476d4c",
78
+ * analysisMode: "general"
78
79
  * })
79
80
  */
80
81
  list(request = {}, requestOptions) {
@@ -83,7 +84,7 @@ class Tasks {
83
84
  __list() {
84
85
  return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
85
86
  var _a, _b;
86
- const { page, pageLimit, status, videoUrl, assetId, analysisMode } = request;
87
+ const { page, pageLimit, status, videoUrl, assetId, videoId, analysisMode } = request;
87
88
  const _queryParams = {};
88
89
  if (page != null) {
89
90
  _queryParams["page"] = page.toString();
@@ -102,17 +103,20 @@ class Tasks {
102
103
  if (assetId != null) {
103
104
  _queryParams["asset_id"] = assetId;
104
105
  }
106
+ if (videoId != null) {
107
+ _queryParams["video_id"] = videoId;
108
+ }
105
109
  if (analysisMode != null) {
106
110
  _queryParams["analysis_mode"] = serializers.analyzeAsync.TasksListRequestAnalysisMode.jsonOrThrow(analysisMode, { unrecognizedObjectKeys: "strip" });
107
111
  }
108
112
  const _response = yield core.fetcher({
109
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"),
110
114
  method: "GET",
111
- 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),
115
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.5", "User-Agent": "twelvelabs-js/1.2.5", "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),
112
116
  contentType: "application/json",
113
117
  queryParameters: _queryParams,
114
118
  requestType: "json",
115
- 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,
116
120
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
117
121
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
118
122
  });
@@ -157,7 +161,7 @@ class Tasks {
157
161
  });
158
162
  }
159
163
  /**
160
- * 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.
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.
161
165
  *
162
166
  * <Accordion title="Input requirements">
163
167
  * - Minimum duration: 4 seconds
@@ -168,8 +172,8 @@ class Tasks {
168
172
  * </Accordion>
169
173
  *
170
174
  * **When to use this method**:
171
- * - Generate custom text from your video using a prompt (Pegasus 1.2 only)
172
- * - Extract timestamped metadata with custom fields from your video (Pegasus 1.5 only)
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)
173
177
  * - Analyze videos longer than 1 hour
174
178
  * - Process videos asynchronously without blocking your application
175
179
  *
@@ -194,6 +198,7 @@ class Tasks {
194
198
  *
195
199
  * @example
196
200
  * await client.analyzeAsync.tasks.create({
201
+ * customId: "prod-segment-analysis-42",
197
202
  * video: {
198
203
  * type: "url",
199
204
  * url: "https://example.com/video.mp4"
@@ -234,6 +239,130 @@ class Tasks {
234
239
  * minSegmentDuration: 5,
235
240
  * maxSegmentDuration: 30
236
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
+ * analysisMode: "time_based_metadata",
288
+ * responseFormat: {
289
+ * type: "segment_definitions",
290
+ * segmentDefinitions: [{
291
+ * id: "scenes",
292
+ * description: "Detect scenes and label them.",
293
+ * fields: [{
294
+ * name: "label",
295
+ * type: "string",
296
+ * description: "A short label for this scene."
297
+ * }, {
298
+ * name: "highlight_at",
299
+ * type: "timestamp",
300
+ * description: "The single most representative moment in this scene.",
301
+ * format: "seconds"
302
+ * }]
303
+ * }],
304
+ * segmentTimeFormat: "hh:mm:ss"
305
+ * }
306
+ * })
307
+ *
308
+ * @example
309
+ * await client.analyzeAsync.tasks.create({
310
+ * modelName: "pegasus1.5",
311
+ * video: {
312
+ * type: "url",
313
+ * url: "https://example.com/video.mp4"
314
+ * },
315
+ * promptV2: {
316
+ * inputText: "Is there a <@tiger-1> in the video?",
317
+ * mediaSources: [{
318
+ * name: "tiger-1",
319
+ * mediaType: "image",
320
+ * url: "https://example.com/tiger.jpg"
321
+ * }]
322
+ * },
323
+ * maxTokens: 4096
324
+ * })
325
+ *
326
+ * @example
327
+ * await client.analyzeAsync.tasks.create({
328
+ * modelName: "pegasus1.5",
329
+ * video: {
330
+ * type: "url",
331
+ * url: "https://example.com/video.mp4"
332
+ * },
333
+ * prompt: "Identify intro, main content, and outro clips.",
334
+ * responseFormat: {
335
+ * type: "json_schema",
336
+ * jsonSchema: {
337
+ * "type": "object",
338
+ * "properties": {
339
+ * "clip_start": {
340
+ * "type": "timestamp",
341
+ * "format": "seconds"
342
+ * },
343
+ * "events": {
344
+ * "type": "array",
345
+ * "items": {
346
+ * "type": "object",
347
+ * "properties": {
348
+ * "intro_end": {
349
+ * "type": "timestamp",
350
+ * "format": "hh:mm:ss"
351
+ * },
352
+ * "outro_start": {
353
+ * "type": "timestamp",
354
+ * "format": "hh:mm:ss.fff"
355
+ * },
356
+ * "label": {
357
+ * "type": "string"
358
+ * }
359
+ * }
360
+ * }
361
+ * }
362
+ * }
363
+ * }
364
+ * }
365
+ * })
237
366
  */
238
367
  create(request, requestOptions) {
239
368
  return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -244,13 +373,13 @@ class Tasks {
244
373
  const _response = yield core.fetcher({
245
374
  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"),
246
375
  method: "POST",
247
- 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),
376
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.5", "User-Agent": "twelvelabs-js/1.2.5", "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),
248
377
  contentType: "application/json",
249
378
  requestType: "json",
250
379
  body: serializers.analyzeAsync.CreateAsyncAnalyzeRequest.jsonOrThrow(request, {
251
380
  unrecognizedObjectKeys: "strip",
252
381
  }),
253
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
382
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
254
383
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
255
384
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
256
385
  });
@@ -325,10 +454,10 @@ class Tasks {
325
454
  const _response = yield core.fetcher({
326
455
  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)}`),
327
456
  method: "GET",
328
- 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),
457
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.5", "User-Agent": "twelvelabs-js/1.2.5", "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),
329
458
  contentType: "application/json",
330
459
  requestType: "json",
331
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
460
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
332
461
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
333
462
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
334
463
  });
@@ -393,10 +522,10 @@ class Tasks {
393
522
  const _response = yield core.fetcher({
394
523
  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)}`),
395
524
  method: "DELETE",
396
- 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),
525
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.5", "User-Agent": "twelvelabs-js/1.2.5", "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),
397
526
  contentType: "application/json",
398
527
  requestType: "json",
399
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
528
+ timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
400
529
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
401
530
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
402
531
  });
@@ -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"
@@ -45,23 +46,158 @@ import * as TwelvelabsApi from "../../../../../../index";
45
46
  * minSegmentDuration: 5,
46
47
  * maxSegmentDuration: 30
47
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
+ * analysisMode: "time_based_metadata",
95
+ * responseFormat: {
96
+ * type: "segment_definitions",
97
+ * segmentDefinitions: [{
98
+ * id: "scenes",
99
+ * description: "Detect scenes and label them.",
100
+ * fields: [{
101
+ * name: "label",
102
+ * type: "string",
103
+ * description: "A short label for this scene."
104
+ * }, {
105
+ * name: "highlight_at",
106
+ * type: "timestamp",
107
+ * description: "The single most representative moment in this scene.",
108
+ * format: "seconds"
109
+ * }]
110
+ * }],
111
+ * segmentTimeFormat: "hh:mm:ss"
112
+ * }
113
+ * }
114
+ *
115
+ * @example
116
+ * {
117
+ * modelName: "pegasus1.5",
118
+ * video: {
119
+ * type: "url",
120
+ * url: "https://example.com/video.mp4"
121
+ * },
122
+ * promptV2: {
123
+ * inputText: "Is there a <@tiger-1> in the video?",
124
+ * mediaSources: [{
125
+ * name: "tiger-1",
126
+ * mediaType: "image",
127
+ * url: "https://example.com/tiger.jpg"
128
+ * }]
129
+ * },
130
+ * maxTokens: 4096
131
+ * }
132
+ *
133
+ * @example
134
+ * {
135
+ * modelName: "pegasus1.5",
136
+ * video: {
137
+ * type: "url",
138
+ * url: "https://example.com/video.mp4"
139
+ * },
140
+ * prompt: "Identify intro, main content, and outro clips.",
141
+ * responseFormat: {
142
+ * type: "json_schema",
143
+ * jsonSchema: {
144
+ * "type": "object",
145
+ * "properties": {
146
+ * "clip_start": {
147
+ * "type": "timestamp",
148
+ * "format": "seconds"
149
+ * },
150
+ * "events": {
151
+ * "type": "array",
152
+ * "items": {
153
+ * "type": "object",
154
+ * "properties": {
155
+ * "intro_end": {
156
+ * "type": "timestamp",
157
+ * "format": "hh:mm:ss"
158
+ * },
159
+ * "outro_start": {
160
+ * "type": "timestamp",
161
+ * "format": "hh:mm:ss.fff"
162
+ * },
163
+ * "label": {
164
+ * "type": "string"
165
+ * }
166
+ * }
167
+ * }
168
+ * }
169
+ * }
170
+ * }
171
+ * }
172
+ * }
48
173
  */
49
174
  export interface CreateAsyncAnalyzeRequest {
50
175
  /**
51
176
  * The video understanding model to use for analysis.
52
- * - `pegasus1.2` (default): Analyzes pre-indexed videos. Pass a `video_id` to reference your video.
53
- * - `pegasus1.5`: Analyzes videos directly from a URL, asset, or base64 string. Supports video segmentation with custom segment definitions.
177
+ * - `pegasus1.2`: General analysis (prompt-based text generation).
178
+ * - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, and video segmentation. See the [Pegasus](/v1.3/docs/concepts/models/pegasus#context-window) page for token limits.
179
+ *
180
+ * **Default:** `pegasus1.2`
54
181
  */
55
182
  modelName?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestModelName;
183
+ /**
184
+ * 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.
185
+ *
186
+ * The platform stores this value unchanged and returns it in the following responses:
187
+ * - The [`GET`](/v1.3/api-reference/analyze-videos/retrieve-analysis-task-status-results) method of the `/analyze/tasks/{task_id}` endpoint
188
+ * - The [`GET`](/v1.3/api-reference/analyze-videos/list-async-analysis-tasks) method of the `/analyze/tasks` endpoint
189
+ * - The `analyze.task.ready` and `analyze.task.failed` webhook payloads
190
+ *
191
+ * **Format**: 1–64 characters. Alphanumeric, hyphens (`-`), and underscores (`_`) only. An empty string is rejected with a `400 Bad Request`.
192
+ *
193
+ * 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.
194
+ */
195
+ customId?: string;
56
196
  video: TwelvelabsApi.VideoContext;
57
197
  /**
58
- * A natural-language text that provides instructions for analyzing the video. Required for general-mode analysis. Not supported when `analysis_mode` is `time_based_metadata`.
198
+ * 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.
59
199
  *
60
- * <Note title="Notes">
61
- * - 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.
62
- * - Your prompts can be instructive or descriptive, or you can also phrase them as questions.
63
- * - The maximum length of a prompt is 2,000 tokens.
64
- * </Note>
200
+ * Your prompts can be instructive or descriptive, or you can phrase them as questions. Pegasus 1.2 limits prompts to 2,000 tokens. For Pegasus 1.5, this text counts toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
65
201
  *
66
202
  * **Examples**:
67
203
  *
@@ -69,26 +205,64 @@ export interface CreateAsyncAnalyzeRequest {
69
205
  * - 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.
70
206
  */
71
207
  prompt?: string;
72
- /** Sets the analysis mode to `time_based_metadata`, which segments your video into time-based intervals and extracts custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`. */
208
+ /**
209
+ * A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter.
210
+ *
211
+ * The prompt text and reference images count toward the [context window](/v1.3/docs/concepts/models/pegasus#context-window).
212
+ */
213
+ promptV2?: TwelvelabsApi.AnalyzePromptV2;
214
+ /**
215
+ * The analysis approach for this task.
216
+ * - `general`: Analyze the video and generate a response based on your prompt. Supports both free-form text and structured output via `response_format`.
217
+ * - `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`.
218
+ *
219
+ * **Default:** `general`
220
+ */
73
221
  analysisMode?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestAnalysisMode;
74
222
  temperature?: TwelvelabsApi.AnalyzeTemperature;
75
223
  /**
76
- * The maximum number of tokens to generate. The allowed range depends on the model:
77
- * - `pegasus1.2`: **Min:** 1, **Max:** 4,096
78
- * - `pegasus1.5`: **Min:** 2,048, **Max:** 32,768, **Default:** 32,768
224
+ * The maximum response length, in tokens. The allowed range depends on the model and analysis mode:
225
+ *
226
+ * | Model | Mode | Min | Max | Default |
227
+ * |-------|------|-----|-----|---------|
228
+ * | Pegasus 1.2 | — | 1 | 4,096 | 4096 |
229
+ * | Pegasus 1.5 | `general` | 512 | 98,304 | 4,096 |
230
+ * | Pegasus 1.5 | `time_based_metadata` | 2,048 | 98,304 | 32,768 |
79
231
  */
80
232
  maxTokens?: number;
81
233
  responseFormat?: TwelvelabsApi.AsyncResponseFormat;
82
234
  /**
83
- * Minimum duration for each extracted segment, in seconds. Set this to prevent the model from creating very short segments. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
235
+ * 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`.
84
236
  *
85
237
  * **Min:** 2
86
238
  */
87
239
  minSegmentDuration?: number;
88
240
  /**
89
- * Maximum duration for each extracted segment, in seconds. Set this to break 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`.
241
+ * 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`.
90
242
  *
91
243
  * **Min:** 2
92
244
  */
93
245
  maxSegmentDuration?: number;
246
+ /**
247
+ * 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`.
248
+ *
249
+ * <Note title="Notes">
250
+ * - If omitted, defaults to `0`.
251
+ * - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
252
+ * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
253
+ * - Together with `end_time`, this parameter determines the billable video duration. If you omit both, billing uses the full video duration. For details, see the [Frequently asked questions](/v1.3/docs/resources/frequently-asked-questions#how-is-video-segmentation-priced) page.
254
+ * </Note>
255
+ */
256
+ startTime?: number;
257
+ /**
258
+ * 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`.
259
+ *
260
+ * <Note title="Notes">
261
+ * - If omitted, defaults to the video duration.
262
+ * - 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.
263
+ * - Mutually exclusive with `response_format.segment_definitions[].time_ranges`.
264
+ * - Together with `start_time`, this parameter determines the billable video duration. If you omit both, billing uses the full video duration. For details, see the [Frequently asked questions](/v1.3/docs/resources/frequently-asked-questions#how-is-video-segmentation-priced) page.
265
+ * </Note>
266
+ */
267
+ endTime?: number;
94
268
  }
@@ -10,7 +10,8 @@ import * as TwelvelabsApi from "../../../../../../index";
10
10
  * status: "queued",
11
11
  * videoUrl: "https://example.com/video.mp4",
12
12
  * assetId: "69abc123def456789012abcd",
13
- * analysisMode: "time_based_metadata"
13
+ * videoId: "6298d673f1090f1100476d4c",
14
+ * analysisMode: "general"
14
15
  * }
15
16
  *
16
17
  * @example
@@ -20,7 +21,8 @@ import * as TwelvelabsApi from "../../../../../../index";
20
21
  * status: "queued",
21
22
  * videoUrl: "https://example.com/video.mp4",
22
23
  * assetId: "69abc123def456789012abcd",
23
- * analysisMode: "time_based_metadata"
24
+ * videoId: "6298d673f1090f1100476d4c",
25
+ * analysisMode: "general"
24
26
  * }
25
27
  */
26
28
  export interface TasksListRequest {
@@ -50,6 +52,10 @@ export interface TasksListRequest {
50
52
  * Filter tasks by asset ID.
51
53
  */
52
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;
53
59
  /**
54
60
  * Filter tasks by the analysis mode used when creating the task.
55
61
  */
@@ -2,9 +2,14 @@
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
4
  /**
5
- * Sets the analysis mode to `time_based_metadata`, which segments your video into time-based intervals and extracts custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`.
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`
6
10
  */
7
- export type CreateAsyncAnalyzeRequestAnalysisMode = "time_based_metadata";
11
+ export type CreateAsyncAnalyzeRequestAnalysisMode = "general" | "time_based_metadata";
8
12
  export declare const CreateAsyncAnalyzeRequestAnalysisMode: {
13
+ readonly General: "general";
9
14
  readonly TimeBasedMetadata: "time_based_metadata";
10
15
  };
@@ -5,5 +5,6 @@
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.CreateAsyncAnalyzeRequestAnalysisMode = void 0;
7
7
  exports.CreateAsyncAnalyzeRequestAnalysisMode = {
8
+ General: "general",
8
9
  TimeBasedMetadata: "time_based_metadata",
9
10
  };
@@ -3,8 +3,10 @@
3
3
  */
4
4
  /**
5
5
  * The video understanding model to use for analysis.
6
- * - `pegasus1.2` (default): Analyzes pre-indexed videos. Pass a `video_id` to reference your video.
7
- * - `pegasus1.5`: Analyzes videos directly from a URL, asset, or base64 string. Supports video segmentation with custom segment definitions.
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, and video segmentation. See the [Pegasus](/v1.3/docs/concepts/models/pegasus#context-window) page for token limits.
8
+ *
9
+ * **Default:** `pegasus1.2`
8
10
  */
9
11
  export type CreateAsyncAnalyzeRequestModelName = "pegasus1.2" | "pegasus1.5";
10
12
  export declare const CreateAsyncAnalyzeRequestModelName: {
@@ -1,7 +1,8 @@
1
1
  /**
2
2
  * This file was auto-generated by Fern from our API Definition.
3
3
  */
4
- export type TasksListRequestAnalysisMode = "time_based_metadata";
4
+ export type TasksListRequestAnalysisMode = "general" | "time_based_metadata";
5
5
  export declare const TasksListRequestAnalysisMode: {
6
+ readonly General: "general";
6
7
  readonly TimeBasedMetadata: "time_based_metadata";
7
8
  };
@@ -5,5 +5,6 @@
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  exports.TasksListRequestAnalysisMode = void 0;
7
7
  exports.TasksListRequestAnalysisMode = {
8
+ General: "general",
8
9
  TimeBasedMetadata: "time_based_metadata",
9
10
  };
@@ -52,7 +52,10 @@ export declare class Assets {
52
52
  * - **Local file**: Set the `method` parameter to `direct` and use the `file` parameter to specify the file.
53
53
  * - **Publicly accessible URL**: Set the `method` parameter to `url` and use the `url` parameter to specify the URL of your file.
54
54
  *
55
- * **File size**: Up to 4 GB.
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
56
59
  *
57
60
  * **Additional requirements** depend on your workflow:
58
61
  * - **Search**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements)
@@ -112,6 +115,50 @@ export declare class Assets {
112
115
  */
113
116
  delete(assetId: string, request?: TwelvelabsApi.AssetsDeleteRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
114
117
  private __delete;
118
+ /**
119
+ * This method deletes the user-defined metadata of the specified asset.
120
+ *
121
+ * This action cannot be undone.
122
+ *
123
+ * @param {string} assetId - The unique identifier of the asset whose user-defined metadata to delete.
124
+ * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
125
+ *
126
+ * @throws {@link TwelvelabsApi.BadRequestError}
127
+ * @throws {@link TwelvelabsApi.NotFoundError}
128
+ *
129
+ * @example
130
+ * await client.assets.deleteUserMetadata("6298d673f1090f1100476d4c")
131
+ */
132
+ deleteUserMetadata(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
133
+ private __deleteUserMetadata;
134
+ /**
135
+ * This method updates the user-defined metadata of the specified asset. The platform merges your changes with the existing metadata:
136
+ * - A key with a value creates or replaces that key.
137
+ * - A key set to `null` deletes that key.
138
+ * - A key set to an empty string (`""`) is ignored.
139
+ * - A key you omit from the request keeps its current value.
140
+ *
141
+ * To replace all metadata, first delete it using [`DELETE`](/v1.3/api-reference/upload-content/direct-uploads/delete-asset-user-metadata) method of the `/assets/{asset_id}/user-metadata` endpoint, then use this method to set the new values.
142
+ *
143
+ * @param {string} assetId - The unique identifier of the asset whose user-defined metadata to update.
144
+ * @param {TwelvelabsApi.AssetsUpdateUserMetadataRequest} request
145
+ * @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
146
+ *
147
+ * @throws {@link TwelvelabsApi.BadRequestError}
148
+ * @throws {@link TwelvelabsApi.NotFoundError}
149
+ *
150
+ * @example
151
+ * await client.assets.updateUserMetadata("6298d673f1090f1100476d4c", {
152
+ * userMetadata: {
153
+ * "category": "recentlyAdded",
154
+ * "batchNumber": 5,
155
+ * "rating": 9.3,
156
+ * "needsReview": true
157
+ * }
158
+ * })
159
+ */
160
+ updateUserMetadata(assetId: string, request: TwelvelabsApi.AssetsUpdateUserMetadataRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
161
+ private __updateUserMetadata;
115
162
  protected _getCustomAuthorizationHeaders(): Promise<{
116
163
  "x-api-key": string;
117
164
  }>;