twelvelabs-js 1.2.0 → 1.2.1

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 (246) hide show
  1. package/Client.d.ts +2 -51
  2. package/Client.js +4 -167
  3. package/api/client/requests/index.d.ts +0 -2
  4. package/api/resources/assets/client/Client.js +4 -4
  5. package/api/resources/embed/client/Client.js +1 -1
  6. package/api/resources/embed/client/requests/EmbedCreateRequest.d.ts +2 -2
  7. package/api/resources/embed/resources/tasks/client/Client.js +4 -4
  8. package/api/resources/embed/resources/tasks/client/requests/TasksCreateRequest.d.ts +2 -2
  9. package/api/resources/embed/resources/v2/client/Client.d.ts +64 -1
  10. package/api/resources/embed/resources/v2/client/Client.js +65 -2
  11. package/api/resources/embed/resources/v2/client/requests/CreateEmbeddingsRequest.d.ts +84 -1
  12. package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +14 -0
  13. package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +17 -3
  14. package/api/resources/embed/resources/v2/resources/tasks/client/requests/CreateAsyncEmbeddingRequest.d.ts +14 -0
  15. package/api/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.d.ts +4 -2
  16. package/api/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.js +1 -0
  17. package/api/resources/entityCollections/client/Client.js +5 -5
  18. package/api/resources/entityCollections/resources/entities/client/Client.js +8 -8
  19. package/api/resources/indexes/client/Client.js +5 -5
  20. package/api/resources/indexes/resources/indexedAssets/client/Client.js +5 -5
  21. package/api/resources/indexes/resources/videos/client/Client.js +4 -4
  22. package/api/resources/indexes/types/IndexesCreateRequestModelsItem.d.ts +2 -2
  23. package/api/resources/multipartUpload/client/Client.js +5 -5
  24. package/api/resources/search/client/Client.d.ts +3 -6
  25. package/api/resources/search/client/Client.js +5 -8
  26. package/api/resources/search/client/requests/SearchCreateRequest.d.ts +9 -1
  27. package/api/resources/tasks/client/Client.js +4 -4
  28. package/api/resources/tasks/resources/transfers/client/Client.js +3 -3
  29. package/api/types/AudioInputRequest.d.ts +13 -1
  30. package/api/types/AudioInputRequestEmbeddingTypeItem.d.ts +8 -0
  31. package/api/types/AudioInputRequestEmbeddingTypeItem.js +10 -0
  32. package/api/types/ChunkInfo.d.ts +1 -1
  33. package/api/types/CompletedChunk.d.ts +1 -1
  34. package/api/types/CreateAssetUploadResponse.d.ts +1 -1
  35. package/api/types/EmbeddingData.d.ts +7 -6
  36. package/api/types/EmbeddingDataEmbeddingOption.d.ts +2 -1
  37. package/api/types/EmbeddingDataEmbeddingOption.js +1 -0
  38. package/api/types/EmbeddingMediaMetadata.d.ts +5 -2
  39. package/api/types/EmbeddingMultiInputMetadata.d.ts +8 -0
  40. package/api/types/ImageInputRequest.d.ts +1 -1
  41. package/api/types/MultiInputMediaSource.d.ts +27 -0
  42. package/api/types/MultiInputMediaSourceMediaType.d.ts +12 -0
  43. package/api/types/MultiInputMediaSourceMediaType.js +9 -0
  44. package/api/types/MultiInputRequest.d.ts +20 -0
  45. package/api/types/SummarizeChapterResult.d.ts +2 -0
  46. package/api/types/SummarizeChapterResultSummarizeType.d.ts +10 -0
  47. package/api/types/SummarizeChapterResultSummarizeType.js +9 -0
  48. package/api/types/SummarizeHighlightResult.d.ts +2 -0
  49. package/api/types/SummarizeHighlightResultSummarizeType.d.ts +10 -0
  50. package/api/types/{GistRequestTypesItem.js → SummarizeHighlightResultSummarizeType.js} +3 -5
  51. package/api/types/SummarizeSummaryResult.d.ts +2 -0
  52. package/api/types/SummarizeSummaryResultSummarizeType.d.ts +10 -0
  53. package/api/types/SummarizeSummaryResultSummarizeType.js +9 -0
  54. package/api/types/TextImageInputRequest.d.ts +1 -1
  55. package/api/types/TextInputRequest.d.ts +1 -1
  56. package/api/types/VideoInputRequest.d.ts +13 -1
  57. package/api/types/VideoInputRequestEmbeddingTypeItem.d.ts +8 -0
  58. package/api/types/VideoInputRequestEmbeddingTypeItem.js +10 -0
  59. package/api/types/index.d.ts +9 -3
  60. package/api/types/index.js +9 -3
  61. package/dist/Client.d.ts +2 -51
  62. package/dist/Client.js +4 -167
  63. package/dist/api/client/requests/index.d.ts +0 -2
  64. package/dist/api/resources/assets/client/Client.js +4 -4
  65. package/dist/api/resources/embed/client/Client.js +1 -1
  66. package/dist/api/resources/embed/client/requests/EmbedCreateRequest.d.ts +2 -2
  67. package/dist/api/resources/embed/resources/tasks/client/Client.js +4 -4
  68. package/dist/api/resources/embed/resources/tasks/client/requests/TasksCreateRequest.d.ts +2 -2
  69. package/dist/api/resources/embed/resources/v2/client/Client.d.ts +64 -1
  70. package/dist/api/resources/embed/resources/v2/client/Client.js +65 -2
  71. package/dist/api/resources/embed/resources/v2/client/requests/CreateEmbeddingsRequest.d.ts +84 -1
  72. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +14 -0
  73. package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +17 -3
  74. package/dist/api/resources/embed/resources/v2/resources/tasks/client/requests/CreateAsyncEmbeddingRequest.d.ts +14 -0
  75. package/dist/api/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.d.ts +4 -2
  76. package/dist/api/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.js +1 -0
  77. package/dist/api/resources/entityCollections/client/Client.js +5 -5
  78. package/dist/api/resources/entityCollections/resources/entities/client/Client.js +8 -8
  79. package/dist/api/resources/indexes/client/Client.js +5 -5
  80. package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +5 -5
  81. package/dist/api/resources/indexes/resources/videos/client/Client.js +4 -4
  82. package/dist/api/resources/indexes/types/IndexesCreateRequestModelsItem.d.ts +2 -2
  83. package/dist/api/resources/multipartUpload/client/Client.js +5 -5
  84. package/dist/api/resources/search/client/Client.d.ts +3 -6
  85. package/dist/api/resources/search/client/Client.js +5 -8
  86. package/dist/api/resources/search/client/requests/SearchCreateRequest.d.ts +9 -1
  87. package/dist/api/resources/tasks/client/Client.js +4 -4
  88. package/dist/api/resources/tasks/resources/transfers/client/Client.js +3 -3
  89. package/dist/api/types/AudioInputRequest.d.ts +13 -1
  90. package/dist/api/types/AudioInputRequestEmbeddingTypeItem.d.ts +8 -0
  91. package/dist/api/types/AudioInputRequestEmbeddingTypeItem.js +10 -0
  92. package/dist/api/types/ChunkInfo.d.ts +1 -1
  93. package/dist/api/types/CompletedChunk.d.ts +1 -1
  94. package/dist/api/types/CreateAssetUploadResponse.d.ts +1 -1
  95. package/dist/api/types/EmbeddingData.d.ts +7 -6
  96. package/dist/api/types/EmbeddingDataEmbeddingOption.d.ts +2 -1
  97. package/dist/api/types/EmbeddingDataEmbeddingOption.js +1 -0
  98. package/dist/api/types/EmbeddingMediaMetadata.d.ts +5 -2
  99. package/dist/api/types/EmbeddingMultiInputMetadata.d.ts +8 -0
  100. package/dist/api/types/ImageInputRequest.d.ts +1 -1
  101. package/dist/api/types/MultiInputMediaSource.d.ts +27 -0
  102. package/dist/api/types/MultiInputMediaSourceMediaType.d.ts +12 -0
  103. package/dist/api/types/MultiInputMediaSourceMediaType.js +9 -0
  104. package/dist/api/types/MultiInputRequest.d.ts +20 -0
  105. package/dist/api/types/SummarizeChapterResult.d.ts +2 -0
  106. package/dist/api/types/SummarizeChapterResultSummarizeType.d.ts +10 -0
  107. package/dist/api/types/SummarizeChapterResultSummarizeType.js +9 -0
  108. package/dist/api/types/SummarizeHighlightResult.d.ts +2 -0
  109. package/dist/api/types/SummarizeHighlightResultSummarizeType.d.ts +10 -0
  110. package/dist/api/types/{GistRequestTypesItem.js → SummarizeHighlightResultSummarizeType.js} +3 -5
  111. package/dist/api/types/SummarizeSummaryResult.d.ts +2 -0
  112. package/dist/api/types/SummarizeSummaryResultSummarizeType.d.ts +10 -0
  113. package/dist/api/types/SummarizeSummaryResultSummarizeType.js +9 -0
  114. package/dist/api/types/TextImageInputRequest.d.ts +1 -1
  115. package/dist/api/types/TextInputRequest.d.ts +1 -1
  116. package/dist/api/types/VideoInputRequest.d.ts +13 -1
  117. package/dist/api/types/VideoInputRequestEmbeddingTypeItem.d.ts +8 -0
  118. package/dist/api/types/VideoInputRequestEmbeddingTypeItem.js +10 -0
  119. package/dist/api/types/index.d.ts +9 -3
  120. package/dist/api/types/index.js +9 -3
  121. package/dist/serialization/client/requests/index.d.ts +0 -2
  122. package/dist/serialization/client/requests/index.js +1 -5
  123. package/dist/serialization/resources/embed/resources/v2/client/requests/CreateEmbeddingsRequest.d.ts +2 -0
  124. package/dist/serialization/resources/embed/resources/v2/client/requests/CreateEmbeddingsRequest.js +2 -0
  125. package/dist/serialization/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.d.ts +1 -1
  126. package/dist/serialization/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.js +1 -1
  127. package/dist/serialization/types/AudioInputRequest.d.ts +2 -0
  128. package/dist/serialization/types/AudioInputRequest.js +2 -0
  129. package/dist/serialization/types/AudioInputRequestEmbeddingTypeItem.d.ts +10 -0
  130. package/dist/serialization/{client/requests/GistRequest.js → types/AudioInputRequestEmbeddingTypeItem.js} +3 -7
  131. package/dist/serialization/types/EmbeddingDataEmbeddingOption.d.ts +1 -1
  132. package/dist/serialization/types/EmbeddingDataEmbeddingOption.js +1 -1
  133. package/dist/serialization/types/EmbeddingMediaMetadata.d.ts +5 -1
  134. package/dist/serialization/types/EmbeddingMediaMetadata.js +2 -0
  135. package/dist/serialization/types/EmbeddingMultiInputMetadata.d.ts +11 -0
  136. package/{serialization/types/GistRequestTypesItem.js → dist/serialization/types/EmbeddingMultiInputMetadata.js} +2 -2
  137. package/dist/serialization/types/MultiInputMediaSource.d.ts +17 -0
  138. package/dist/serialization/types/MultiInputMediaSource.js +48 -0
  139. package/dist/serialization/types/MultiInputMediaSourceMediaType.d.ts +10 -0
  140. package/dist/serialization/types/{GistRequestTypesItem.js → MultiInputMediaSourceMediaType.js} +2 -2
  141. package/dist/serialization/types/MultiInputRequest.d.ts +14 -0
  142. package/dist/serialization/types/{Gist.js → MultiInputRequest.js} +5 -8
  143. package/dist/serialization/types/SummarizeChapterResult.d.ts +2 -0
  144. package/dist/serialization/types/SummarizeChapterResult.js +2 -0
  145. package/dist/serialization/types/SummarizeChapterResultSummarizeType.d.ts +10 -0
  146. package/{serialization/client/requests/GistRequest.js → dist/serialization/types/SummarizeChapterResultSummarizeType.js} +3 -7
  147. package/dist/serialization/types/SummarizeHighlightResult.d.ts +2 -0
  148. package/dist/serialization/types/SummarizeHighlightResult.js +2 -0
  149. package/dist/serialization/types/SummarizeHighlightResultSummarizeType.d.ts +10 -0
  150. package/dist/serialization/types/SummarizeHighlightResultSummarizeType.js +41 -0
  151. package/dist/serialization/types/SummarizeSummaryResult.d.ts +2 -0
  152. package/dist/serialization/types/SummarizeSummaryResult.js +2 -0
  153. package/dist/serialization/types/SummarizeSummaryResultSummarizeType.d.ts +10 -0
  154. package/dist/serialization/types/SummarizeSummaryResultSummarizeType.js +41 -0
  155. package/dist/serialization/types/VideoInputRequest.d.ts +2 -0
  156. package/dist/serialization/types/VideoInputRequest.js +2 -0
  157. package/dist/serialization/types/VideoInputRequestEmbeddingTypeItem.d.ts +10 -0
  158. package/dist/serialization/types/VideoInputRequestEmbeddingTypeItem.js +41 -0
  159. package/dist/serialization/types/index.d.ts +9 -3
  160. package/dist/serialization/types/index.js +9 -3
  161. package/dist/version.d.ts +1 -1
  162. package/dist/version.js +1 -1
  163. package/dist/wrapper/TwelveLabs.d.ts +0 -2
  164. package/dist/wrapper/TwelveLabs.js +0 -2
  165. package/dist/wrapper/resources/SearchWrapper.d.ts +18 -3
  166. package/dist/wrapper/resources/SearchWrapper.js +158 -3
  167. package/package.json +1 -1
  168. package/reference.md +5 -7
  169. package/serialization/client/requests/index.d.ts +0 -2
  170. package/serialization/client/requests/index.js +1 -5
  171. package/serialization/resources/embed/resources/v2/client/requests/CreateEmbeddingsRequest.d.ts +2 -0
  172. package/serialization/resources/embed/resources/v2/client/requests/CreateEmbeddingsRequest.js +2 -0
  173. package/serialization/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.d.ts +1 -1
  174. package/serialization/resources/embed/resources/v2/types/CreateEmbeddingsRequestInputType.js +1 -1
  175. package/serialization/types/AudioInputRequest.d.ts +2 -0
  176. package/serialization/types/AudioInputRequest.js +2 -0
  177. package/serialization/types/AudioInputRequestEmbeddingTypeItem.d.ts +10 -0
  178. package/serialization/types/AudioInputRequestEmbeddingTypeItem.js +41 -0
  179. package/serialization/types/EmbeddingDataEmbeddingOption.d.ts +1 -1
  180. package/serialization/types/EmbeddingDataEmbeddingOption.js +1 -1
  181. package/serialization/types/EmbeddingMediaMetadata.d.ts +5 -1
  182. package/serialization/types/EmbeddingMediaMetadata.js +2 -0
  183. package/serialization/types/EmbeddingMultiInputMetadata.d.ts +11 -0
  184. package/serialization/types/EmbeddingMultiInputMetadata.js +41 -0
  185. package/serialization/types/MultiInputMediaSource.d.ts +17 -0
  186. package/serialization/types/MultiInputMediaSource.js +48 -0
  187. package/serialization/types/MultiInputMediaSourceMediaType.d.ts +10 -0
  188. package/serialization/types/MultiInputMediaSourceMediaType.js +41 -0
  189. package/serialization/types/MultiInputRequest.d.ts +14 -0
  190. package/serialization/types/{Gist.js → MultiInputRequest.js} +5 -8
  191. package/serialization/types/SummarizeChapterResult.d.ts +2 -0
  192. package/serialization/types/SummarizeChapterResult.js +2 -0
  193. package/serialization/types/SummarizeChapterResultSummarizeType.d.ts +10 -0
  194. package/serialization/types/SummarizeChapterResultSummarizeType.js +41 -0
  195. package/serialization/types/SummarizeHighlightResult.d.ts +2 -0
  196. package/serialization/types/SummarizeHighlightResult.js +2 -0
  197. package/serialization/types/SummarizeHighlightResultSummarizeType.d.ts +10 -0
  198. package/serialization/types/SummarizeHighlightResultSummarizeType.js +41 -0
  199. package/serialization/types/SummarizeSummaryResult.d.ts +2 -0
  200. package/serialization/types/SummarizeSummaryResult.js +2 -0
  201. package/serialization/types/SummarizeSummaryResultSummarizeType.d.ts +10 -0
  202. package/serialization/types/SummarizeSummaryResultSummarizeType.js +41 -0
  203. package/serialization/types/VideoInputRequest.d.ts +2 -0
  204. package/serialization/types/VideoInputRequest.js +2 -0
  205. package/serialization/types/VideoInputRequestEmbeddingTypeItem.d.ts +10 -0
  206. package/serialization/types/VideoInputRequestEmbeddingTypeItem.js +41 -0
  207. package/serialization/types/index.d.ts +9 -3
  208. package/serialization/types/index.js +9 -3
  209. package/version.d.ts +1 -1
  210. package/version.js +1 -1
  211. package/wrapper/TwelveLabs.d.ts +0 -2
  212. package/wrapper/TwelveLabs.js +0 -2
  213. package/wrapper/resources/SearchWrapper.d.ts +18 -3
  214. package/wrapper/resources/SearchWrapper.js +158 -3
  215. package/api/client/requests/GistRequest.d.ts +0 -22
  216. package/api/client/requests/SummarizeRequest.d.ts +0 -51
  217. package/api/types/Gist.d.ts +0 -18
  218. package/api/types/GistRequestTypesItem.d.ts +0 -9
  219. package/api/types/SummarizeResponse.d.ts +0 -16
  220. package/dist/api/client/requests/GistRequest.d.ts +0 -22
  221. package/dist/api/client/requests/SummarizeRequest.d.ts +0 -51
  222. package/dist/api/types/Gist.d.ts +0 -18
  223. package/dist/api/types/Gist.js +0 -5
  224. package/dist/api/types/GistRequestTypesItem.d.ts +0 -9
  225. package/dist/api/types/SummarizeResponse.d.ts +0 -16
  226. package/dist/api/types/SummarizeResponse.js +0 -5
  227. package/dist/serialization/client/requests/GistRequest.d.ts +0 -14
  228. package/dist/serialization/client/requests/SummarizeRequest.d.ts +0 -18
  229. package/dist/serialization/client/requests/SummarizeRequest.js +0 -49
  230. package/dist/serialization/types/Gist.d.ts +0 -17
  231. package/dist/serialization/types/GistRequestTypesItem.d.ts +0 -10
  232. package/dist/serialization/types/SummarizeResponse.d.ts +0 -22
  233. package/dist/serialization/types/SummarizeResponse.js +0 -53
  234. package/serialization/client/requests/GistRequest.d.ts +0 -14
  235. package/serialization/client/requests/SummarizeRequest.d.ts +0 -18
  236. package/serialization/client/requests/SummarizeRequest.js +0 -49
  237. package/serialization/types/Gist.d.ts +0 -17
  238. package/serialization/types/GistRequestTypesItem.d.ts +0 -10
  239. package/serialization/types/SummarizeResponse.d.ts +0 -22
  240. package/serialization/types/SummarizeResponse.js +0 -53
  241. /package/api/{client/requests/GistRequest.js → types/EmbeddingMultiInputMetadata.js} +0 -0
  242. /package/api/{client/requests/SummarizeRequest.js → types/MultiInputMediaSource.js} +0 -0
  243. /package/api/types/{Gist.js → MultiInputRequest.js} +0 -0
  244. /package/{api/types/SummarizeResponse.js → dist/api/types/EmbeddingMultiInputMetadata.js} +0 -0
  245. /package/dist/api/{client/requests/GistRequest.js → types/MultiInputMediaSource.js} +0 -0
  246. /package/dist/api/{client/requests/SummarizeRequest.js → types/MultiInputRequest.js} +0 -0
package/Client.d.ts CHANGED
@@ -46,61 +46,12 @@ export declare class TwelvelabsApiClient {
46
46
  get entityCollections(): EntityCollections;
47
47
  get embed(): Embed;
48
48
  get search(): Search;
49
- /**
50
- *
51
- * <Note title="Deprecation notice">
52
- * This endpoint will be sunset and removed. Use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint. Pass the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
53
- * </Note>
54
- *
55
- * This endpoint analyzes videos and generates summaries, chapters, or highlights. Optionally, you can provide a prompt to customize the output.
56
- *
57
- * <Note title="Note">
58
- * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
59
- * </Note>
60
- *
61
- * @param {TwelvelabsApi.SummarizeRequest} request
62
- * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
63
- *
64
- * @throws {@link TwelvelabsApi.BadRequestError}
65
- * @throws {@link TwelvelabsApi.TooManyRequestsError}
66
- *
67
- * @example
68
- * await client.summarize({
69
- * videoId: "6298d673f1090f1100476d4c",
70
- * type: "summary",
71
- * prompt: "Generate a summary of this video for a social media post, up to two sentences.",
72
- * temperature: 0.2
73
- * })
74
- */
75
- summarize(request: TwelvelabsApi.SummarizeRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.SummarizeResponse>;
76
- private __summarize;
77
- /**
78
- * <Note title="Deprecation notice">
79
- * This endpoint will be sunset and removed on February 15, 2026. Instead, use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint, passing the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
80
- * </Note>
81
- *
82
- * This method analyzes videos and generates titles, topics, and hashtags.
83
- *
84
- * @param {TwelvelabsApi.GistRequest} request
85
- * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
86
- *
87
- * @throws {@link TwelvelabsApi.BadRequestError}
88
- * @throws {@link TwelvelabsApi.TooManyRequestsError}
89
- *
90
- * @example
91
- * await client.gist({
92
- * videoId: "6298d673f1090f1100476d4c",
93
- * types: ["title", "topic"]
94
- * })
95
- */
96
- gist(request: TwelvelabsApi.GistRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.Gist>;
97
- private __gist;
98
49
  /**
99
50
  * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
100
51
  *
101
52
  * <Note title="Notes">
102
53
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
103
- * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
54
+ * - This endpoint supports streaming responses.
104
55
  * </Note>
105
56
  */
106
57
  analyzeStream(request: TwelvelabsApi.AnalyzeStreamRequest, requestOptions?: TwelvelabsApiClient.RequestOptions): core.HttpResponsePromise<core.Stream<TwelvelabsApi.StreamAnalyzeResponse>>;
@@ -110,7 +61,7 @@ export declare class TwelvelabsApiClient {
110
61
  *
111
62
  * <Note title="Notes">
112
63
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
113
- * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
64
+ * - This endpoint supports streaming responses.
114
65
  * </Note>
115
66
  *
116
67
  * @param {TwelvelabsApi.AnalyzeRequest} request
package/Client.js CHANGED
@@ -94,175 +94,12 @@ class TwelvelabsApiClient {
94
94
  var _a;
95
95
  return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_7.Search(this._options)));
96
96
  }
97
- /**
98
- *
99
- * <Note title="Deprecation notice">
100
- * This endpoint will be sunset and removed. Use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint. Pass the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
101
- * </Note>
102
- *
103
- * This endpoint analyzes videos and generates summaries, chapters, or highlights. Optionally, you can provide a prompt to customize the output.
104
- *
105
- * <Note title="Note">
106
- * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
107
- * </Note>
108
- *
109
- * @param {TwelvelabsApi.SummarizeRequest} request
110
- * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
111
- *
112
- * @throws {@link TwelvelabsApi.BadRequestError}
113
- * @throws {@link TwelvelabsApi.TooManyRequestsError}
114
- *
115
- * @example
116
- * await client.summarize({
117
- * videoId: "6298d673f1090f1100476d4c",
118
- * type: "summary",
119
- * prompt: "Generate a summary of this video for a social media post, up to two sentences.",
120
- * temperature: 0.2
121
- * })
122
- */
123
- summarize(request, requestOptions) {
124
- return core.HttpResponsePromise.fromPromise(this.__summarize(request, requestOptions));
125
- }
126
- __summarize(request, requestOptions) {
127
- return __awaiter(this, void 0, void 0, function* () {
128
- var _a, _b;
129
- const _response = yield core.fetcher({
130
- 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, "summarize"),
131
- method: "POST",
132
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
133
- contentType: "application/json",
134
- requestType: "json",
135
- body: serializers.SummarizeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
136
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
137
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
138
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
139
- });
140
- if (_response.ok) {
141
- return {
142
- data: serializers.SummarizeResponse.parseOrThrow(_response.body, {
143
- unrecognizedObjectKeys: "passthrough",
144
- allowUnrecognizedUnionMembers: true,
145
- allowUnrecognizedEnumValues: true,
146
- breadcrumbsPrefix: ["response"],
147
- }),
148
- rawResponse: _response.rawResponse,
149
- };
150
- }
151
- if (_response.error.reason === "status-code") {
152
- switch (_response.error.statusCode) {
153
- case 400:
154
- throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
155
- case 429:
156
- throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
157
- default:
158
- throw new errors.TwelvelabsApiError({
159
- statusCode: _response.error.statusCode,
160
- body: _response.error.body,
161
- rawResponse: _response.rawResponse,
162
- });
163
- }
164
- }
165
- switch (_response.error.reason) {
166
- case "non-json":
167
- throw new errors.TwelvelabsApiError({
168
- statusCode: _response.error.statusCode,
169
- body: _response.error.rawBody,
170
- rawResponse: _response.rawResponse,
171
- });
172
- case "timeout":
173
- throw new errors.TwelvelabsApiTimeoutError("Timeout exceeded when calling POST /summarize.");
174
- case "unknown":
175
- throw new errors.TwelvelabsApiError({
176
- message: _response.error.errorMessage,
177
- rawResponse: _response.rawResponse,
178
- });
179
- }
180
- });
181
- }
182
- /**
183
- * <Note title="Deprecation notice">
184
- * This endpoint will be sunset and removed on February 15, 2026. Instead, use the [`POST`](/v1.3/api-reference/analyze-videos/analyze) method of the `/analyze` endpoint, passing the [`response_format`](/v1.3/api-reference/analyze-videos/analyze#request.body.response_format) parameter to specify the format of the response as structured JSON. For migration instructions, see the [Release notes](/v1.3/docs/get-started/release-notes#predefined-formats-for-video-analysis-will-be-sunset-and-removed) page.
185
- * </Note>
186
- *
187
- * This method analyzes videos and generates titles, topics, and hashtags.
188
- *
189
- * @param {TwelvelabsApi.GistRequest} request
190
- * @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
191
- *
192
- * @throws {@link TwelvelabsApi.BadRequestError}
193
- * @throws {@link TwelvelabsApi.TooManyRequestsError}
194
- *
195
- * @example
196
- * await client.gist({
197
- * videoId: "6298d673f1090f1100476d4c",
198
- * types: ["title", "topic"]
199
- * })
200
- */
201
- gist(request, requestOptions) {
202
- return core.HttpResponsePromise.fromPromise(this.__gist(request, requestOptions));
203
- }
204
- __gist(request, requestOptions) {
205
- return __awaiter(this, void 0, void 0, function* () {
206
- var _a, _b;
207
- const _response = yield core.fetcher({
208
- 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, "gist"),
209
- method: "POST",
210
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
211
- contentType: "application/json",
212
- requestType: "json",
213
- body: serializers.GistRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
214
- timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
215
- maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
216
- abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
217
- });
218
- if (_response.ok) {
219
- return {
220
- data: serializers.Gist.parseOrThrow(_response.body, {
221
- unrecognizedObjectKeys: "passthrough",
222
- allowUnrecognizedUnionMembers: true,
223
- allowUnrecognizedEnumValues: true,
224
- breadcrumbsPrefix: ["response"],
225
- }),
226
- rawResponse: _response.rawResponse,
227
- };
228
- }
229
- if (_response.error.reason === "status-code") {
230
- switch (_response.error.statusCode) {
231
- case 400:
232
- throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
233
- case 429:
234
- throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
235
- default:
236
- throw new errors.TwelvelabsApiError({
237
- statusCode: _response.error.statusCode,
238
- body: _response.error.body,
239
- rawResponse: _response.rawResponse,
240
- });
241
- }
242
- }
243
- switch (_response.error.reason) {
244
- case "non-json":
245
- throw new errors.TwelvelabsApiError({
246
- statusCode: _response.error.statusCode,
247
- body: _response.error.rawBody,
248
- rawResponse: _response.rawResponse,
249
- });
250
- case "timeout":
251
- throw new errors.TwelvelabsApiTimeoutError("Timeout exceeded when calling POST /gist.");
252
- case "unknown":
253
- throw new errors.TwelvelabsApiError({
254
- message: _response.error.errorMessage,
255
- rawResponse: _response.rawResponse,
256
- });
257
- }
258
- });
259
- }
260
97
  /**
261
98
  * This endpoint analyzes your videos and creates fully customizable text based on your prompts, including but not limited to tables of content, action items, memos, and detailed analyses.
262
99
  *
263
100
  * <Note title="Notes">
264
101
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
265
- * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
102
+ * - This endpoint supports streaming responses.
266
103
  * </Note>
267
104
  */
268
105
  analyzeStream(request, requestOptions) {
@@ -274,7 +111,7 @@ class TwelvelabsApiClient {
274
111
  const _response = yield core.fetcher({
275
112
  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"),
276
113
  method: "POST",
277
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
114
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
278
115
  contentType: "application/json",
279
116
  requestType: "json",
280
117
  body: Object.assign(Object.assign({}, serializers.AnalyzeStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: true }),
@@ -340,7 +177,7 @@ class TwelvelabsApiClient {
340
177
  *
341
178
  * <Note title="Notes">
342
179
  * - This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
343
- * - This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Analyze videos](/v1.3/docs/guides/analyze-videos) page.
180
+ * - This endpoint supports streaming responses.
344
181
  * </Note>
345
182
  *
346
183
  * @param {TwelvelabsApi.AnalyzeRequest} request
@@ -386,7 +223,7 @@ class TwelvelabsApiClient {
386
223
  const _response = yield core.fetcher({
387
224
  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"),
388
225
  method: "POST",
389
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
226
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
390
227
  contentType: "application/json",
391
228
  requestType: "json",
392
229
  body: Object.assign(Object.assign({}, serializers.AnalyzeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: false }),
@@ -1,4 +1,2 @@
1
- export { type SummarizeRequest } from "./SummarizeRequest";
2
- export { type GistRequest } from "./GistRequest";
3
1
  export { type AnalyzeStreamRequest } from "./AnalyzeStreamRequest";
4
2
  export { type AnalyzeRequest } from "./AnalyzeRequest";
@@ -108,7 +108,7 @@ class Assets {
108
108
  const _response = yield core.fetcher({
109
109
  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, "assets"),
110
110
  method: "GET",
111
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
111
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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
112
  contentType: "application/json",
113
113
  queryParameters: _queryParams,
114
114
  requestType: "json",
@@ -221,7 +221,7 @@ class Assets {
221
221
  const _response = yield core.fetcher({
222
222
  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, "assets"),
223
223
  method: "POST",
224
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
224
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
225
225
  requestType: "file",
226
226
  duplex: _maybeEncodedRequest.duplex,
227
227
  body: _maybeEncodedRequest.body,
@@ -289,7 +289,7 @@ class Assets {
289
289
  const _response = yield core.fetcher({
290
290
  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, `assets/${encodeURIComponent(assetId)}`),
291
291
  method: "GET",
292
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
292
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
293
293
  contentType: "application/json",
294
294
  requestType: "json",
295
295
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -356,7 +356,7 @@ class Assets {
356
356
  const _response = yield core.fetcher({
357
357
  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, `assets/${encodeURIComponent(assetId)}`),
358
358
  method: "DELETE",
359
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
359
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
360
360
  contentType: "application/json",
361
361
  requestType: "json",
362
362
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -144,7 +144,7 @@ class Embed {
144
144
  const _response = yield core.fetcher({
145
145
  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, "embed"),
146
146
  method: "POST",
147
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
147
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
148
148
  requestType: "file",
149
149
  duplex: _maybeEncodedRequest.duplex,
150
150
  body: _maybeEncodedRequest.body,
@@ -11,8 +11,8 @@ import * as fs from "fs";
11
11
  export interface EmbedCreateRequest {
12
12
  /**
13
13
  * The name of the model you want to use. The following models are available:
14
- * - `marengo3.0`: Enhanced model with sports intelligence and extended content support. For a list of the new features, see the [New in Marengo 3.0](/v1.3/docs/concepts/models/marengo#new-in-marengo-30) section.
15
- * - `Marengo-retrieval-2.7`: Video embedding model for multimodal search.
14
+ * - `marengo3.0`: Enhanced model with sports intelligence and extended content support.
15
+ * - `Marengo-retrieval-2.7`: **Deprecation notice**: Starting mid-March 2026, your videos will be automatically reindexed to Marengo 3.0. Marengo 2.7 will be deprecated once reindexing completes. See the [Migration guide](/v1.3/docs/get-started/migration-guide) for details.
16
16
  */
17
17
  modelName: string;
18
18
  /**
@@ -108,7 +108,7 @@ class Tasks {
108
108
  const _response = yield core.fetcher({
109
109
  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, "embed/tasks"),
110
110
  method: "GET",
111
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
111
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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
112
  contentType: "application/json",
113
113
  queryParameters: _queryParams,
114
114
  requestType: "json",
@@ -239,7 +239,7 @@ class Tasks {
239
239
  const _response = yield core.fetcher({
240
240
  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, "embed/tasks"),
241
241
  method: "POST",
242
- headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
242
+ headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
243
243
  requestType: "file",
244
244
  duplex: _maybeEncodedRequest.duplex,
245
245
  body: _maybeEncodedRequest.body,
@@ -315,7 +315,7 @@ class Tasks {
315
315
  const _response = yield core.fetcher({
316
316
  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, `embed/tasks/${encodeURIComponent(taskId)}/status`),
317
317
  method: "GET",
318
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
318
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
319
319
  contentType: "application/json",
320
320
  requestType: "json",
321
321
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -398,7 +398,7 @@ class Tasks {
398
398
  const _response = yield core.fetcher({
399
399
  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, `embed/tasks/${encodeURIComponent(taskId)}`),
400
400
  method: "GET",
401
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
401
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
402
402
  contentType: "application/json",
403
403
  queryParameters: _queryParams,
404
404
  requestType: "json",
@@ -12,8 +12,8 @@ import * as TwelvelabsApi from "../../../../../../index";
12
12
  export interface TasksCreateRequest {
13
13
  /**
14
14
  * The name of the model you want to use. The following models are available:
15
- * - `marengo3.0`: Enhanced model with sports intelligence and extended content support. For a list of the new features, see the [New in Marengo 3.0](/v1.3/docs/concepts/models/marengo#new-in-marengo-30) section.
16
- * - `Marengo-retrieval-2.7`: Video embedding model for multimodal search.
15
+ * - `marengo3.0`: Enhanced model with sports intelligence and extended content support.
16
+ * - `Marengo-retrieval-2.7`: **Deprecation notice**: Starting mid-March 2026, your videos will be automatically reindexed to Marengo 3.0. Marengo 2.7 will be deprecated once reindexing completes. See the [Migration guide](/v1.3/docs/get-started/migration-guide) for details.
17
17
  */
18
18
  modelName: string;
19
19
  videoFile?: File | fs.ReadStream | Blob | undefined;
@@ -37,7 +37,7 @@ export declare class V2 {
37
37
  *
38
38
  * **When to use this endpoint**:
39
39
  * - Create embeddings for text, images, audio, or video content
40
- * - Get immediate results without waiting for background processing
40
+ * - Retrieve immediate results without waiting for background processing
41
41
  * - Process audio or video content up to 10 minutes in duration
42
42
  *
43
43
  * **Do not use this endpoint for**:
@@ -180,6 +180,69 @@ export declare class V2 {
180
180
  * embeddingScope: ["asset"]
181
181
  * }
182
182
  * })
183
+ *
184
+ * @example
185
+ * await client.embed.v2.create({
186
+ * inputType: "video",
187
+ * modelName: "marengo3.0",
188
+ * video: {
189
+ * mediaSource: {
190
+ * url: "https://user-bucket.com/video/clip.mp4"
191
+ * },
192
+ * embeddingOption: ["visual", "audio"],
193
+ * embeddingScope: ["clip"],
194
+ * embeddingType: ["separate_embedding", "fused_embedding"]
195
+ * }
196
+ * })
197
+ *
198
+ * @example
199
+ * await client.embed.v2.create({
200
+ * inputType: "multi_input",
201
+ * modelName: "marengo3.0",
202
+ * multiInput: {
203
+ * inputText: "A person cooking in the kitchen",
204
+ * mediaSources: [{
205
+ * mediaType: "image",
206
+ * url: "https://user-bucket.com/images/person.jpg"
207
+ * }, {
208
+ * mediaType: "image",
209
+ * url: "https://user-bucket.com/images/kitchen.jpg"
210
+ * }]
211
+ * }
212
+ * })
213
+ *
214
+ * @example
215
+ * await client.embed.v2.create({
216
+ * inputType: "multi_input",
217
+ * modelName: "marengo3.0",
218
+ * multiInput: {
219
+ * inputText: "A person wearing <@outfit> and holding <@accessory>",
220
+ * mediaSources: [{
221
+ * name: "outfit",
222
+ * mediaType: "image",
223
+ * url: "https://user-bucket.com/images/outfit.jpg"
224
+ * }, {
225
+ * name: "accessory",
226
+ * mediaType: "image",
227
+ * url: "https://user-bucket.com/images/accessory.jpg"
228
+ * }]
229
+ * }
230
+ * })
231
+ *
232
+ * @example
233
+ * await client.embed.v2.create({
234
+ * inputType: "multi_input",
235
+ * modelName: "marengo3.0",
236
+ * multiInput: {
237
+ * mediaSources: [{
238
+ * mediaType: "image",
239
+ * url: "https://user-bucket.com/images/image1.jpg"
240
+ * }, {
241
+ * mediaType: "image",
242
+ * base64String: "iVBORw0KGgoAAAANSUhEUgAA..."
243
+ * }]
244
+ * }
245
+ * })
183
246
  */
184
247
  create(request: TwelvelabsApi.embed.CreateEmbeddingsRequest, requestOptions?: V2.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.EmbeddingSuccessResponse>;
185
248
  private __create;
@@ -73,7 +73,7 @@ class V2 {
73
73
  *
74
74
  * **When to use this endpoint**:
75
75
  * - Create embeddings for text, images, audio, or video content
76
- * - Get immediate results without waiting for background processing
76
+ * - Retrieve immediate results without waiting for background processing
77
77
  * - Process audio or video content up to 10 minutes in duration
78
78
  *
79
79
  * **Do not use this endpoint for**:
@@ -216,6 +216,69 @@ class V2 {
216
216
  * embeddingScope: ["asset"]
217
217
  * }
218
218
  * })
219
+ *
220
+ * @example
221
+ * await client.embed.v2.create({
222
+ * inputType: "video",
223
+ * modelName: "marengo3.0",
224
+ * video: {
225
+ * mediaSource: {
226
+ * url: "https://user-bucket.com/video/clip.mp4"
227
+ * },
228
+ * embeddingOption: ["visual", "audio"],
229
+ * embeddingScope: ["clip"],
230
+ * embeddingType: ["separate_embedding", "fused_embedding"]
231
+ * }
232
+ * })
233
+ *
234
+ * @example
235
+ * await client.embed.v2.create({
236
+ * inputType: "multi_input",
237
+ * modelName: "marengo3.0",
238
+ * multiInput: {
239
+ * inputText: "A person cooking in the kitchen",
240
+ * mediaSources: [{
241
+ * mediaType: "image",
242
+ * url: "https://user-bucket.com/images/person.jpg"
243
+ * }, {
244
+ * mediaType: "image",
245
+ * url: "https://user-bucket.com/images/kitchen.jpg"
246
+ * }]
247
+ * }
248
+ * })
249
+ *
250
+ * @example
251
+ * await client.embed.v2.create({
252
+ * inputType: "multi_input",
253
+ * modelName: "marengo3.0",
254
+ * multiInput: {
255
+ * inputText: "A person wearing <@outfit> and holding <@accessory>",
256
+ * mediaSources: [{
257
+ * name: "outfit",
258
+ * mediaType: "image",
259
+ * url: "https://user-bucket.com/images/outfit.jpg"
260
+ * }, {
261
+ * name: "accessory",
262
+ * mediaType: "image",
263
+ * url: "https://user-bucket.com/images/accessory.jpg"
264
+ * }]
265
+ * }
266
+ * })
267
+ *
268
+ * @example
269
+ * await client.embed.v2.create({
270
+ * inputType: "multi_input",
271
+ * modelName: "marengo3.0",
272
+ * multiInput: {
273
+ * mediaSources: [{
274
+ * mediaType: "image",
275
+ * url: "https://user-bucket.com/images/image1.jpg"
276
+ * }, {
277
+ * mediaType: "image",
278
+ * base64String: "iVBORw0KGgoAAAANSUhEUgAA..."
279
+ * }]
280
+ * }
281
+ * })
219
282
  */
220
283
  create(request, requestOptions) {
221
284
  return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
@@ -226,7 +289,7 @@ class V2 {
226
289
  const _response = yield core.fetcher({
227
290
  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, "embed-v2"),
228
291
  method: "POST",
229
- headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.0", "User-Agent": "twelvelabs-js/1.2.0", "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),
292
+ headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.1", "User-Agent": "twelvelabs-js/1.2.1", "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),
230
293
  contentType: "application/json",
231
294
  requestType: "json",
232
295
  body: serializers.embed.CreateEmbeddingsRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),