twelvelabs-js 1.2.2 → 1.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +14 -36
- package/Client.js +22 -40
- package/README.md +20 -1
- package/api/client/requests/AnalyzeRequest.d.ts +43 -30
- package/api/client/requests/AnalyzeStreamRequest.d.ts +43 -30
- package/api/errors/ConflictError.d.ts +1 -2
- package/api/errors/index.d.ts +1 -1
- package/api/errors/index.js +1 -1
- package/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +96 -2
- package/api/resources/analyzeAsync/resources/tasks/client/Client.js +118 -17
- package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +176 -3
- package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +32 -1
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +15 -0
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +10 -0
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +15 -0
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
- package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +8 -0
- package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +10 -0
- package/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
- package/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
- package/api/resources/assets/client/Client.d.ts +20 -6
- package/api/resources/assets/client/Client.js +48 -17
- package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
- package/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
- package/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
- package/api/resources/assets/client/requests/index.d.ts +1 -0
- package/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
- package/api/resources/embed/client/Client.js +2 -2
- package/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
- package/api/resources/embed/resources/tasks/client/Client.js +9 -9
- package/api/resources/embed/resources/v2/client/Client.js +2 -2
- package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +13 -3
- package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +19 -9
- package/api/resources/entityCollections/client/Client.js +10 -10
- package/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
- package/api/resources/entityCollections/resources/entities/client/Client.js +108 -17
- package/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
- package/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
- package/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
- package/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
- package/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
- package/api/resources/entityCollections/resources/entities/types/index.js +1 -0
- package/api/resources/indexes/client/Client.js +10 -10
- package/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
- package/api/resources/indexes/resources/indexedAssets/client/Client.js +131 -20
- package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
- package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
- package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
- package/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
- package/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
- package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
- package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
- package/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
- package/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
- package/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
- package/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
- package/api/resources/indexes/resources/videos/client/Client.js +39 -19
- package/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
- package/api/resources/multipartUpload/client/Client.d.ts +3 -3
- package/api/resources/multipartUpload/client/Client.js +13 -13
- package/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
- package/api/resources/search/client/Client.js +4 -4
- package/api/resources/tasks/client/Client.js +8 -8
- package/api/resources/tasks/resources/transfers/client/Client.js +6 -6
- package/api/types/AnalyzePromptV2.d.ts +13 -0
- package/api/types/AnalyzePromptV2.js +5 -0
- package/api/types/AnalyzeRequestModelName.d.ts +15 -0
- package/api/types/AnalyzeRequestModelName.js +10 -0
- package/api/types/AnalyzeStreamRequestModelName.d.ts +15 -0
- package/api/types/AnalyzeStreamRequestModelName.js +10 -0
- package/api/types/AnalyzeTaskResponse.d.ts +6 -0
- package/api/types/AnalyzeTaskResponseRequestParams.d.ts +39 -0
- package/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
- package/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
- package/api/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +16 -0
- package/api/types/AnalyzeTaskResponseRequestParamsPromptV2.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +11 -0
- package/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +24 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +12 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
- package/api/types/AnalyzeTaskResponseVideoSource.d.ts +21 -0
- package/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
- package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
- package/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
- package/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
- package/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
- package/api/types/AnalyzeTaskResult.d.ts +10 -1
- package/api/types/AnalyzeTaskResultUsage.d.ts +1 -1
- package/api/types/AnalyzeTimeRange.d.ts +12 -0
- package/api/types/AnalyzeTimeRange.js +5 -0
- package/api/types/Asset.d.ts +5 -0
- package/api/types/AssetDetail.d.ts +11 -0
- package/api/types/AssetDetail.js +5 -0
- package/api/types/AssetHls.d.ts +21 -0
- package/api/types/AssetHls.js +5 -0
- package/api/types/AssetHlsStatus.d.ts +19 -0
- package/api/types/AssetHlsStatus.js +12 -0
- package/api/types/AssetMethod.d.ts +3 -1
- package/api/types/AssetMethod.js +1 -0
- package/api/types/AssetThumbnail.d.ts +21 -0
- package/api/types/AssetThumbnail.js +5 -0
- package/api/types/AssetThumbnailStatus.d.ts +19 -0
- package/api/types/AssetThumbnailStatus.js +12 -0
- package/api/types/AsyncResponseFormat.d.ts +117 -0
- package/api/types/AsyncResponseFormat.js +5 -0
- package/api/types/AsyncResponseFormatType.d.ts +13 -0
- package/api/types/AsyncResponseFormatType.js +10 -0
- package/api/types/ConflictErrorBody.d.ts +11 -0
- package/api/types/ConflictErrorBody.js +5 -0
- package/api/types/Entity.d.ts +2 -0
- package/api/types/IndexedAsset.d.ts +2 -0
- package/api/types/IndexedAssetSummary.d.ts +12 -0
- package/api/types/IndexedAssetSummary.js +5 -0
- package/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
- package/api/types/IndexedAssetSummaryIndex.js +5 -0
- package/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
- package/api/types/IndexedAssetsListRequestDuration.js +5 -0
- package/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
- package/api/types/IndexedAssetsListRequestFps.js +5 -0
- package/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
- package/api/types/IndexedAssetsListRequestHeight.js +5 -0
- package/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
- package/api/types/IndexedAssetsListRequestSize.js +5 -0
- package/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
- package/api/types/IndexedAssetsListRequestWidth.js +5 -0
- package/api/types/InternalEntity.d.ts +23 -1
- package/api/types/MediaSource.d.ts +1 -1
- package/api/types/One.d.ts +1 -1
- package/api/types/SegmentDefinition.d.ts +28 -0
- package/api/types/SegmentDefinition.js +5 -0
- package/api/types/SegmentField.d.ts +19 -0
- package/api/types/SegmentField.js +5 -0
- package/api/types/SegmentFieldItems.d.ts +10 -0
- package/api/types/SegmentFieldItems.js +5 -0
- package/api/types/SegmentFieldItemsType.d.ts +10 -0
- package/api/types/SegmentFieldItemsType.js +12 -0
- package/api/types/SegmentFieldType.d.ts +14 -0
- package/api/types/SegmentFieldType.js +13 -0
- package/api/types/SmeMediaSource.d.ts +19 -0
- package/api/types/SmeMediaSource.js +5 -0
- package/api/types/SmeMediaSourceMediaType.d.ts +10 -0
- package/api/types/SmeMediaSourceMediaType.js +9 -0
- package/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +27 -8
- package/api/types/SyncResponseFormat.js +5 -0
- package/{dist/api/types/ResponseFormatType.d.ts → api/types/SyncResponseFormatType.d.ts} +2 -2
- package/{dist/api/types/ResponseFormatType.js → api/types/SyncResponseFormatType.js} +2 -2
- package/api/types/TokenUsage.d.ts +3 -1
- package/api/types/VideosListRequestDuration.d.ts +7 -0
- package/api/types/VideosListRequestDuration.js +5 -0
- package/api/types/VideosListRequestFps.d.ts +7 -0
- package/api/types/VideosListRequestFps.js +5 -0
- package/api/types/VideosListRequestHeight.d.ts +7 -0
- package/api/types/VideosListRequestHeight.js +5 -0
- package/api/types/VideosListRequestSize.d.ts +7 -0
- package/api/types/VideosListRequestSize.js +5 -0
- package/api/types/VideosListRequestWidth.d.ts +7 -0
- package/api/types/VideosListRequestWidth.js +5 -0
- package/api/types/index.d.ts +46 -2
- package/api/types/index.js +46 -2
- package/dist/Client.d.ts +14 -36
- package/dist/Client.js +22 -40
- package/dist/api/client/requests/AnalyzeRequest.d.ts +43 -30
- package/dist/api/client/requests/AnalyzeStreamRequest.d.ts +43 -30
- package/dist/api/errors/ConflictError.d.ts +1 -2
- package/dist/api/errors/index.d.ts +1 -1
- package/dist/api/errors/index.js +1 -1
- package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.d.ts +96 -2
- package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.js +118 -17
- package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +176 -3
- package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +32 -1
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +15 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +10 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +15 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +8 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +10 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
- package/dist/api/resources/assets/client/Client.d.ts +20 -6
- package/dist/api/resources/assets/client/Client.js +48 -17
- package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +13 -1
- package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.d.ts +17 -0
- package/dist/api/resources/assets/client/requests/AssetsDeleteRequest.js +5 -0
- package/dist/api/resources/assets/client/requests/AssetsListRequest.d.ts +6 -1
- package/dist/api/resources/assets/client/requests/index.d.ts +1 -0
- package/dist/api/resources/assets/types/AssetsListResponse.d.ts +1 -1
- package/dist/api/resources/embed/client/Client.js +2 -2
- package/dist/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
- package/dist/api/resources/embed/resources/tasks/client/Client.js +9 -9
- package/dist/api/resources/embed/resources/v2/client/Client.js +2 -2
- package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +13 -3
- package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +19 -9
- package/dist/api/resources/entityCollections/client/Client.js +10 -10
- package/dist/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
- package/dist/api/resources/entityCollections/resources/entities/client/Client.js +108 -17
- package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.d.ts +25 -0
- package/dist/api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js +5 -0
- package/dist/api/resources/entityCollections/resources/entities/client/requests/index.d.ts +1 -0
- package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +9 -0
- package/dist/api/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +5 -0
- package/dist/api/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
- package/dist/api/resources/entityCollections/resources/entities/types/index.js +1 -0
- package/dist/api/resources/indexes/client/Client.js +10 -10
- package/dist/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
- package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +131 -20
- package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsCreateRequest.d.ts +1 -1
- package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.d.ts +25 -0
- package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListByAssetRequest.js +5 -0
- package/dist/api/resources/indexes/resources/indexedAssets/client/requests/IndexedAssetsListRequest.d.ts +15 -15
- package/dist/api/resources/indexes/resources/indexedAssets/client/requests/index.d.ts +1 -0
- package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +2 -0
- package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +9 -0
- package/dist/api/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +5 -0
- package/dist/api/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
- package/dist/api/resources/indexes/resources/indexedAssets/types/index.js +1 -0
- package/dist/api/resources/indexes/resources/videos/client/Client.d.ts +0 -5
- package/dist/api/resources/indexes/resources/videos/client/Client.js +39 -19
- package/dist/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
- package/dist/api/resources/multipartUpload/client/Client.d.ts +3 -3
- package/dist/api/resources/multipartUpload/client/Client.js +13 -13
- package/dist/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
- package/dist/api/resources/search/client/Client.js +4 -4
- package/dist/api/resources/tasks/client/Client.js +8 -8
- package/dist/api/resources/tasks/resources/transfers/client/Client.js +6 -6
- package/dist/api/types/AnalyzePromptV2.d.ts +13 -0
- package/dist/api/types/AnalyzePromptV2.js +5 -0
- package/dist/api/types/AnalyzeRequestModelName.d.ts +15 -0
- package/dist/api/types/AnalyzeRequestModelName.js +10 -0
- package/dist/api/types/AnalyzeStreamRequestModelName.d.ts +15 -0
- package/dist/api/types/AnalyzeStreamRequestModelName.js +10 -0
- package/dist/api/types/AnalyzeTaskResponse.d.ts +6 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParams.d.ts +39 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParams.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +11 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +10 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +16 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +11 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +24 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +12 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +11 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +6 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +9 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +8 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +10 -0
- package/dist/api/types/AnalyzeTaskResponseVideoSource.d.ts +21 -0
- package/dist/api/types/AnalyzeTaskResponseVideoSource.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +10 -0
- package/dist/api/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseVideoSourceType.d.ts +13 -0
- package/dist/api/types/AnalyzeTaskResponseVideoSourceType.js +12 -0
- package/dist/api/types/AnalyzeTaskResult.d.ts +10 -1
- package/dist/api/types/AnalyzeTaskResultUsage.d.ts +1 -1
- package/dist/api/types/AnalyzeTimeRange.d.ts +12 -0
- package/dist/api/types/AnalyzeTimeRange.js +5 -0
- package/dist/api/types/Asset.d.ts +5 -0
- package/dist/api/types/AssetDetail.d.ts +11 -0
- package/dist/api/types/AssetDetail.js +5 -0
- package/dist/api/types/AssetHls.d.ts +21 -0
- package/dist/api/types/AssetHls.js +5 -0
- package/dist/api/types/AssetHlsStatus.d.ts +19 -0
- package/dist/api/types/AssetHlsStatus.js +12 -0
- package/dist/api/types/AssetMethod.d.ts +3 -1
- package/dist/api/types/AssetMethod.js +1 -0
- package/dist/api/types/AssetThumbnail.d.ts +21 -0
- package/dist/api/types/AssetThumbnail.js +5 -0
- package/dist/api/types/AssetThumbnailStatus.d.ts +19 -0
- package/dist/api/types/AssetThumbnailStatus.js +12 -0
- package/dist/api/types/AsyncResponseFormat.d.ts +117 -0
- package/dist/api/types/AsyncResponseFormat.js +5 -0
- package/dist/api/types/AsyncResponseFormatType.d.ts +13 -0
- package/dist/api/types/AsyncResponseFormatType.js +10 -0
- package/dist/api/types/ConflictErrorBody.d.ts +11 -0
- package/dist/api/types/ConflictErrorBody.js +5 -0
- package/dist/api/types/Entity.d.ts +2 -0
- package/dist/api/types/IndexedAsset.d.ts +2 -0
- package/dist/api/types/IndexedAssetSummary.d.ts +12 -0
- package/dist/api/types/IndexedAssetSummary.js +5 -0
- package/dist/api/types/IndexedAssetSummaryIndex.d.ts +12 -0
- package/dist/api/types/IndexedAssetSummaryIndex.js +5 -0
- package/dist/api/types/IndexedAssetsListRequestDuration.d.ts +7 -0
- package/dist/api/types/IndexedAssetsListRequestDuration.js +5 -0
- package/dist/api/types/IndexedAssetsListRequestFps.d.ts +7 -0
- package/dist/api/types/IndexedAssetsListRequestFps.js +5 -0
- package/dist/api/types/IndexedAssetsListRequestHeight.d.ts +7 -0
- package/dist/api/types/IndexedAssetsListRequestHeight.js +5 -0
- package/dist/api/types/IndexedAssetsListRequestSize.d.ts +7 -0
- package/dist/api/types/IndexedAssetsListRequestSize.js +5 -0
- package/dist/api/types/IndexedAssetsListRequestWidth.d.ts +7 -0
- package/dist/api/types/IndexedAssetsListRequestWidth.js +5 -0
- package/dist/api/types/InternalEntity.d.ts +23 -1
- package/dist/api/types/MediaSource.d.ts +1 -1
- package/dist/api/types/One.d.ts +1 -1
- package/dist/api/types/SegmentDefinition.d.ts +28 -0
- package/dist/api/types/SegmentDefinition.js +5 -0
- package/dist/api/types/SegmentField.d.ts +19 -0
- package/dist/api/types/SegmentField.js +5 -0
- package/dist/api/types/SegmentFieldItems.d.ts +10 -0
- package/dist/api/types/SegmentFieldItems.js +5 -0
- package/dist/api/types/SegmentFieldItemsType.d.ts +10 -0
- package/dist/api/types/SegmentFieldItemsType.js +12 -0
- package/dist/api/types/SegmentFieldType.d.ts +14 -0
- package/dist/api/types/SegmentFieldType.js +13 -0
- package/dist/api/types/SmeMediaSource.d.ts +19 -0
- package/dist/api/types/SmeMediaSource.js +5 -0
- package/dist/api/types/SmeMediaSourceMediaType.d.ts +10 -0
- package/dist/api/types/SmeMediaSourceMediaType.js +9 -0
- package/dist/api/types/{ResponseFormat.d.ts → SyncResponseFormat.d.ts} +27 -8
- package/dist/api/types/SyncResponseFormat.js +5 -0
- package/{api/types/ResponseFormatType.d.ts → dist/api/types/SyncResponseFormatType.d.ts} +2 -2
- package/{api/types/ResponseFormatType.js → dist/api/types/SyncResponseFormatType.js} +2 -2
- package/dist/api/types/TokenUsage.d.ts +3 -1
- package/dist/api/types/VideosListRequestDuration.d.ts +7 -0
- package/dist/api/types/VideosListRequestDuration.js +5 -0
- package/dist/api/types/VideosListRequestFps.d.ts +7 -0
- package/dist/api/types/VideosListRequestFps.js +5 -0
- package/dist/api/types/VideosListRequestHeight.d.ts +7 -0
- package/dist/api/types/VideosListRequestHeight.js +5 -0
- package/dist/api/types/VideosListRequestSize.d.ts +7 -0
- package/dist/api/types/VideosListRequestSize.js +5 -0
- package/dist/api/types/VideosListRequestWidth.d.ts +7 -0
- package/dist/api/types/VideosListRequestWidth.js +5 -0
- package/dist/api/types/index.d.ts +46 -2
- package/dist/api/types/index.js +46 -2
- package/dist/serialization/client/requests/AnalyzeRequest.d.ts +10 -5
- package/dist/serialization/client/requests/AnalyzeRequest.js +10 -5
- package/dist/serialization/client/requests/AnalyzeStreamRequest.d.ts +10 -5
- package/dist/serialization/client/requests/AnalyzeStreamRequest.js +10 -5
- package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +15 -6
- package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +15 -6
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
- package/dist/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
- package/dist/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
- package/dist/serialization/resources/assets/types/AssetsListResponse.js +2 -2
- package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
- package/dist/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
- package/dist/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
- package/dist/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
- package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
- package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
- package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
- package/dist/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
- package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
- package/dist/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
- package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
- package/dist/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
- package/dist/serialization/types/AnalyzePromptV2.d.ts +14 -0
- package/dist/serialization/types/AnalyzePromptV2.js +45 -0
- package/dist/serialization/types/AnalyzeRequestModelName.d.ts +10 -0
- package/dist/serialization/types/AnalyzeRequestModelName.js +41 -0
- package/dist/serialization/types/AnalyzeStreamRequestModelName.d.ts +10 -0
- package/dist/serialization/types/AnalyzeStreamRequestModelName.js +41 -0
- package/dist/serialization/types/AnalyzeTaskResponse.d.ts +5 -0
- package/dist/serialization/types/AnalyzeTaskResponse.js +5 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +24 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParams.js +55 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +14 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.js +45 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +15 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +46 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +16 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +47 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +19 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +54 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSource.js +50 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
- package/dist/serialization/types/AnalyzeTaskResult.d.ts +1 -2
- package/dist/serialization/types/AnalyzeTaskResult.js +1 -2
- package/dist/serialization/types/AnalyzeTimeRange.d.ts +13 -0
- package/dist/serialization/types/AnalyzeTimeRange.js +44 -0
- package/dist/serialization/types/Asset.d.ts +2 -0
- package/dist/serialization/types/Asset.js +2 -0
- package/dist/serialization/types/AssetDetail.d.ts +16 -0
- package/dist/serialization/types/AssetDetail.js +49 -0
- package/dist/serialization/types/AssetHls.d.ts +14 -0
- package/dist/serialization/types/AssetHls.js +45 -0
- package/dist/serialization/types/AssetHlsStatus.d.ts +10 -0
- package/dist/serialization/types/AssetHlsStatus.js +41 -0
- package/dist/serialization/types/AssetMethod.d.ts +1 -1
- package/dist/serialization/types/AssetMethod.js +1 -1
- package/dist/serialization/types/AssetThumbnail.d.ts +14 -0
- package/dist/serialization/types/AssetThumbnail.js +45 -0
- package/dist/serialization/types/AssetThumbnailStatus.d.ts +10 -0
- package/dist/serialization/types/AssetThumbnailStatus.js +41 -0
- package/dist/serialization/types/AsyncResponseFormat.d.ts +16 -0
- package/dist/serialization/types/AsyncResponseFormat.js +47 -0
- package/dist/serialization/types/AsyncResponseFormatType.d.ts +10 -0
- package/dist/serialization/types/AsyncResponseFormatType.js +41 -0
- package/dist/serialization/types/ConflictErrorBody.d.ts +14 -0
- package/dist/serialization/types/ConflictErrorBody.js +45 -0
- package/dist/serialization/types/Entity.d.ts +1 -0
- package/dist/serialization/types/Entity.js +1 -0
- package/dist/serialization/types/IndexedAsset.d.ts +1 -0
- package/dist/serialization/types/IndexedAsset.js +1 -0
- package/dist/serialization/types/IndexedAssetSummary.d.ts +14 -0
- package/dist/serialization/types/IndexedAssetSummary.js +45 -0
- package/dist/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
- package/dist/serialization/types/IndexedAssetSummaryIndex.js +44 -0
- package/dist/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
- package/dist/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
- package/dist/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
- package/dist/serialization/types/IndexedAssetsListRequestFps.js +44 -0
- package/dist/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
- package/dist/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
- package/dist/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
- package/dist/serialization/types/IndexedAssetsListRequestSize.js +44 -0
- package/dist/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
- package/dist/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
- package/dist/serialization/types/InternalEntity.d.ts +10 -2
- package/dist/serialization/types/InternalEntity.js +11 -5
- package/dist/serialization/types/SegmentDefinition.d.ts +19 -0
- package/dist/serialization/types/SegmentDefinition.js +50 -0
- package/dist/serialization/types/SegmentField.d.ts +18 -0
- package/dist/serialization/types/SegmentField.js +49 -0
- package/dist/serialization/types/SegmentFieldItems.d.ts +13 -0
- package/dist/serialization/types/SegmentFieldItems.js +44 -0
- package/dist/serialization/types/SegmentFieldItemsType.d.ts +10 -0
- package/dist/serialization/types/SegmentFieldItemsType.js +41 -0
- package/dist/serialization/types/SegmentFieldType.d.ts +10 -0
- package/dist/serialization/types/SegmentFieldType.js +41 -0
- package/dist/serialization/types/SmeMediaSource.d.ts +17 -0
- package/dist/serialization/types/SmeMediaSource.js +48 -0
- package/dist/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
- package/dist/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
- package/dist/serialization/types/SyncResponseFormat.d.ts +14 -0
- package/{serialization/types/ResponseFormat.js → dist/serialization/types/SyncResponseFormat.js} +4 -4
- package/dist/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
- package/dist/serialization/types/SyncResponseFormatType.js +41 -0
- package/dist/serialization/types/TokenUsage.d.ts +2 -1
- package/dist/serialization/types/TokenUsage.js +2 -1
- package/dist/serialization/types/VideosListRequestDuration.d.ts +13 -0
- package/dist/serialization/types/VideosListRequestDuration.js +44 -0
- package/dist/serialization/types/VideosListRequestFps.d.ts +13 -0
- package/dist/serialization/types/VideosListRequestFps.js +44 -0
- package/dist/serialization/types/VideosListRequestHeight.d.ts +13 -0
- package/dist/serialization/types/VideosListRequestHeight.js +44 -0
- package/dist/serialization/types/VideosListRequestSize.d.ts +13 -0
- package/dist/serialization/types/VideosListRequestSize.js +44 -0
- package/dist/serialization/types/VideosListRequestWidth.d.ts +13 -0
- package/dist/serialization/types/VideosListRequestWidth.js +44 -0
- package/dist/serialization/types/index.d.ts +46 -2
- package/dist/serialization/types/index.js +46 -2
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/resources/IndexesVideosWrapper.js +29 -14
- package/package.json +1 -1
- package/reference.md +233 -68
- package/serialization/client/requests/AnalyzeRequest.d.ts +10 -5
- package/serialization/client/requests/AnalyzeRequest.js +10 -5
- package/serialization/client/requests/AnalyzeStreamRequest.d.ts +10 -5
- package/serialization/client/requests/AnalyzeStreamRequest.js +10 -5
- package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +15 -6
- package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +15 -6
- package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +41 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +10 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +41 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +10 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +41 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/index.d.ts +3 -0
- package/serialization/resources/analyzeAsync/resources/tasks/types/index.js +3 -0
- package/serialization/resources/assets/types/AssetsListResponse.d.ts +2 -2
- package/serialization/resources/assets/types/AssetsListResponse.js +2 -2
- package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.d.ts +15 -0
- package/serialization/resources/entityCollections/resources/entities/types/EntitiesListByAssetResponse.js +46 -0
- package/serialization/resources/entityCollections/resources/entities/types/index.d.ts +1 -0
- package/serialization/resources/entityCollections/resources/entities/types/index.js +1 -0
- package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.d.ts +1 -0
- package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsCreateResponse.js +1 -0
- package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.d.ts +15 -0
- package/serialization/resources/indexes/resources/indexedAssets/types/IndexedAssetsListByAssetResponse.js +46 -0
- package/serialization/resources/indexes/resources/indexedAssets/types/index.d.ts +1 -0
- package/serialization/resources/indexes/resources/indexedAssets/types/index.js +1 -0
- package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +2 -0
- package/serialization/resources/multipartUpload/client/requests/CreateAssetUploadRequest.js +2 -0
- package/serialization/types/AnalyzePromptV2.d.ts +14 -0
- package/serialization/types/AnalyzePromptV2.js +45 -0
- package/serialization/types/AnalyzeRequestModelName.d.ts +10 -0
- package/serialization/types/AnalyzeRequestModelName.js +41 -0
- package/serialization/types/AnalyzeStreamRequestModelName.d.ts +10 -0
- package/serialization/types/AnalyzeStreamRequestModelName.js +41 -0
- package/serialization/types/AnalyzeTaskResponse.d.ts +5 -0
- package/serialization/types/AnalyzeTaskResponse.js +5 -0
- package/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +24 -0
- package/serialization/types/AnalyzeTaskResponseRequestParams.js +55 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.d.ts +14 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2.js +45 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.d.ts +15 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsPromptV2MediaSourcesItem.js +46 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +16 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +47 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +19 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +54 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.d.ts +17 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItem.js +48 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.d.ts +12 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemFieldsItemItems.js +43 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.d.ts +15 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItemMediaSourcesItem.js +46 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.d.ts +10 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatType.js +41 -0
- package/serialization/types/AnalyzeTaskResponseVideoSource.d.ts +19 -0
- package/serialization/types/AnalyzeTaskResponseVideoSource.js +50 -0
- package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.d.ts +12 -0
- package/serialization/types/AnalyzeTaskResponseVideoSourceSystemMetadata.js +43 -0
- package/serialization/types/AnalyzeTaskResponseVideoSourceType.d.ts +10 -0
- package/serialization/types/AnalyzeTaskResponseVideoSourceType.js +41 -0
- package/serialization/types/AnalyzeTaskResult.d.ts +1 -2
- package/serialization/types/AnalyzeTaskResult.js +1 -2
- package/serialization/types/AnalyzeTimeRange.d.ts +13 -0
- package/serialization/types/AnalyzeTimeRange.js +44 -0
- package/serialization/types/Asset.d.ts +2 -0
- package/serialization/types/Asset.js +2 -0
- package/serialization/types/AssetDetail.d.ts +16 -0
- package/serialization/types/AssetDetail.js +49 -0
- package/serialization/types/AssetHls.d.ts +14 -0
- package/serialization/types/AssetHls.js +45 -0
- package/serialization/types/AssetHlsStatus.d.ts +10 -0
- package/serialization/types/AssetHlsStatus.js +41 -0
- package/serialization/types/AssetMethod.d.ts +1 -1
- package/serialization/types/AssetMethod.js +1 -1
- package/serialization/types/AssetThumbnail.d.ts +14 -0
- package/serialization/types/AssetThumbnail.js +45 -0
- package/serialization/types/AssetThumbnailStatus.d.ts +10 -0
- package/serialization/types/AssetThumbnailStatus.js +41 -0
- package/serialization/types/AsyncResponseFormat.d.ts +16 -0
- package/serialization/types/AsyncResponseFormat.js +47 -0
- package/serialization/types/AsyncResponseFormatType.d.ts +10 -0
- package/serialization/types/AsyncResponseFormatType.js +41 -0
- package/serialization/types/ConflictErrorBody.d.ts +14 -0
- package/serialization/types/ConflictErrorBody.js +45 -0
- package/serialization/types/Entity.d.ts +1 -0
- package/serialization/types/Entity.js +1 -0
- package/serialization/types/IndexedAsset.d.ts +1 -0
- package/serialization/types/IndexedAsset.js +1 -0
- package/serialization/types/IndexedAssetSummary.d.ts +14 -0
- package/serialization/types/IndexedAssetSummary.js +45 -0
- package/serialization/types/IndexedAssetSummaryIndex.d.ts +13 -0
- package/serialization/types/IndexedAssetSummaryIndex.js +44 -0
- package/serialization/types/IndexedAssetsListRequestDuration.d.ts +13 -0
- package/serialization/types/IndexedAssetsListRequestDuration.js +44 -0
- package/serialization/types/IndexedAssetsListRequestFps.d.ts +13 -0
- package/serialization/types/IndexedAssetsListRequestFps.js +44 -0
- package/serialization/types/IndexedAssetsListRequestHeight.d.ts +13 -0
- package/serialization/types/IndexedAssetsListRequestHeight.js +44 -0
- package/serialization/types/IndexedAssetsListRequestSize.d.ts +13 -0
- package/serialization/types/IndexedAssetsListRequestSize.js +44 -0
- package/serialization/types/IndexedAssetsListRequestWidth.d.ts +13 -0
- package/serialization/types/IndexedAssetsListRequestWidth.js +44 -0
- package/serialization/types/InternalEntity.d.ts +10 -2
- package/serialization/types/InternalEntity.js +11 -5
- package/serialization/types/SegmentDefinition.d.ts +19 -0
- package/serialization/types/SegmentDefinition.js +50 -0
- package/serialization/types/SegmentField.d.ts +18 -0
- package/serialization/types/SegmentField.js +49 -0
- package/serialization/types/SegmentFieldItems.d.ts +13 -0
- package/serialization/types/SegmentFieldItems.js +44 -0
- package/serialization/types/SegmentFieldItemsType.d.ts +10 -0
- package/serialization/types/SegmentFieldItemsType.js +41 -0
- package/serialization/types/SegmentFieldType.d.ts +10 -0
- package/serialization/types/SegmentFieldType.js +41 -0
- package/serialization/types/SmeMediaSource.d.ts +17 -0
- package/serialization/types/SmeMediaSource.js +48 -0
- package/serialization/types/SmeMediaSourceMediaType.d.ts +10 -0
- package/serialization/types/{ResponseFormatType.js → SmeMediaSourceMediaType.js} +2 -2
- package/serialization/types/SyncResponseFormat.d.ts +14 -0
- package/{dist/serialization/types/ResponseFormat.js → serialization/types/SyncResponseFormat.js} +4 -4
- package/serialization/types/{ResponseFormatType.d.ts → SyncResponseFormatType.d.ts} +2 -2
- package/serialization/types/SyncResponseFormatType.js +41 -0
- package/serialization/types/TokenUsage.d.ts +2 -1
- package/serialization/types/TokenUsage.js +2 -1
- package/serialization/types/VideosListRequestDuration.d.ts +13 -0
- package/serialization/types/VideosListRequestDuration.js +44 -0
- package/serialization/types/VideosListRequestFps.d.ts +13 -0
- package/serialization/types/VideosListRequestFps.js +44 -0
- package/serialization/types/VideosListRequestHeight.d.ts +13 -0
- package/serialization/types/VideosListRequestHeight.js +44 -0
- package/serialization/types/VideosListRequestSize.d.ts +13 -0
- package/serialization/types/VideosListRequestSize.js +44 -0
- package/serialization/types/VideosListRequestWidth.d.ts +13 -0
- package/serialization/types/VideosListRequestWidth.js +44 -0
- package/serialization/types/index.d.ts +46 -2
- package/serialization/types/index.js +46 -2
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/resources/IndexesVideosWrapper.js +29 -14
- package/dist/serialization/types/ResponseFormat.d.ts +0 -14
- package/serialization/types/ResponseFormat.d.ts +0 -14
- /package/api/{types/ResponseFormat.js → resources/assets/client/requests/AssetsDeleteRequest.js} +0 -0
- /package/{dist/api/types/ResponseFormat.js → api/resources/entityCollections/resources/entities/client/requests/EntitiesListByAssetRequest.js} +0 -0
package/dist/Client.js
CHANGED
|
@@ -100,7 +100,7 @@ class TwelvelabsApiClient {
|
|
|
100
100
|
return ((_a = this._analyzeAsync) !== null && _a !== void 0 ? _a : (this._analyzeAsync = new Client_8.AnalyzeAsync(this._options)));
|
|
101
101
|
}
|
|
102
102
|
/**
|
|
103
|
-
* This method
|
|
103
|
+
* This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
|
|
104
104
|
*
|
|
105
105
|
* <Accordion title="Input requirements">
|
|
106
106
|
* - Minimum duration: 4 seconds
|
|
@@ -112,14 +112,15 @@ class TwelvelabsApiClient {
|
|
|
112
112
|
*
|
|
113
113
|
* **When to use this method**:
|
|
114
114
|
* - Analyze videos up to 1 hour
|
|
115
|
-
* - Retrieve immediate results without
|
|
116
|
-
* - Stream text fragments in real
|
|
115
|
+
* - Retrieve immediate results without polling for task completion
|
|
116
|
+
* - Stream text fragments in real time for immediate processing and feedback
|
|
117
117
|
*
|
|
118
118
|
* **Do not use this method for**:
|
|
119
119
|
* - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
|
|
120
|
+
* - Video segmentation with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter set to `pegasus1.5` instead.
|
|
120
121
|
*
|
|
121
|
-
* <Note title="
|
|
122
|
-
*
|
|
122
|
+
* <Note title="Note">
|
|
123
|
+
* This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
|
|
123
124
|
* </Note>
|
|
124
125
|
*/
|
|
125
126
|
analyzeStream(request, requestOptions) {
|
|
@@ -131,12 +132,12 @@ class TwelvelabsApiClient {
|
|
|
131
132
|
const _response = yield core.fetcher({
|
|
132
133
|
url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
|
|
133
134
|
method: "POST",
|
|
134
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
135
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
135
136
|
contentType: "application/json",
|
|
136
137
|
requestType: "json",
|
|
137
138
|
body: Object.assign(Object.assign({}, serializers.AnalyzeStreamRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: true }),
|
|
138
139
|
responseType: "sse",
|
|
139
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 :
|
|
140
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
|
|
140
141
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
141
142
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
142
143
|
});
|
|
@@ -165,6 +166,8 @@ class TwelvelabsApiClient {
|
|
|
165
166
|
switch (_response.error.statusCode) {
|
|
166
167
|
case 400:
|
|
167
168
|
throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
|
|
169
|
+
case 404:
|
|
170
|
+
throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
168
171
|
case 429:
|
|
169
172
|
throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
170
173
|
default:
|
|
@@ -193,7 +196,7 @@ class TwelvelabsApiClient {
|
|
|
193
196
|
});
|
|
194
197
|
}
|
|
195
198
|
/**
|
|
196
|
-
* This method
|
|
199
|
+
* This method analyzes your videos and returns the results directly in the response. It generates text based on your prompts and supports both Pegasus 1.2 and Pegasus 1.5 for general analysis (prompt-based text generation).
|
|
197
200
|
*
|
|
198
201
|
* <Accordion title="Input requirements">
|
|
199
202
|
* - Minimum duration: 4 seconds
|
|
@@ -205,49 +208,26 @@ class TwelvelabsApiClient {
|
|
|
205
208
|
*
|
|
206
209
|
* **When to use this method**:
|
|
207
210
|
* - Analyze videos up to 1 hour
|
|
208
|
-
* - Retrieve immediate results without
|
|
209
|
-
* - Stream text fragments in real
|
|
211
|
+
* - Retrieve immediate results without polling for task completion
|
|
212
|
+
* - Stream text fragments in real time for immediate processing and feedback
|
|
210
213
|
*
|
|
211
214
|
* **Do not use this method for**:
|
|
212
215
|
* - Videos longer than 1 hour. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
|
|
216
|
+
* - Video segmentation with custom segment definitions. Use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint with the `model_name` parameter set to `pegasus1.5` instead.
|
|
213
217
|
*
|
|
214
|
-
* <Note title="
|
|
215
|
-
*
|
|
218
|
+
* <Note title="Note">
|
|
219
|
+
* This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
|
|
216
220
|
* </Note>
|
|
217
221
|
*
|
|
218
222
|
* @param {TwelvelabsApi.AnalyzeRequest} request
|
|
219
223
|
* @param {TwelvelabsApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
220
224
|
*
|
|
221
225
|
* @throws {@link TwelvelabsApi.BadRequestError}
|
|
226
|
+
* @throws {@link TwelvelabsApi.NotFoundError}
|
|
222
227
|
* @throws {@link TwelvelabsApi.TooManyRequestsError}
|
|
223
228
|
*
|
|
224
229
|
* @example
|
|
225
|
-
* await client.analyze({
|
|
226
|
-
* videoId: "6298d673f1090f1100476d4c",
|
|
227
|
-
* prompt: "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.",
|
|
228
|
-
* temperature: 0.2,
|
|
229
|
-
* responseFormat: {
|
|
230
|
-
* type: "json_schema",
|
|
231
|
-
* jsonSchema: {
|
|
232
|
-
* "type": "object",
|
|
233
|
-
* "properties": {
|
|
234
|
-
* "title": {
|
|
235
|
-
* "type": "string"
|
|
236
|
-
* },
|
|
237
|
-
* "summary": {
|
|
238
|
-
* "type": "string"
|
|
239
|
-
* },
|
|
240
|
-
* "keywords": {
|
|
241
|
-
* "type": "array",
|
|
242
|
-
* "items": {
|
|
243
|
-
* "type": "string"
|
|
244
|
-
* }
|
|
245
|
-
* }
|
|
246
|
-
* }
|
|
247
|
-
* }
|
|
248
|
-
* },
|
|
249
|
-
* maxTokens: 2000
|
|
250
|
-
* })
|
|
230
|
+
* await client.analyze({})
|
|
251
231
|
*/
|
|
252
232
|
analyze(request, requestOptions) {
|
|
253
233
|
return core.HttpResponsePromise.fromPromise(this.__analyze(request, requestOptions));
|
|
@@ -258,11 +238,11 @@ class TwelvelabsApiClient {
|
|
|
258
238
|
const _response = yield core.fetcher({
|
|
259
239
|
url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze"),
|
|
260
240
|
method: "POST",
|
|
261
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
241
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.4", "User-Agent": "twelvelabs-js/1.2.4", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
262
242
|
contentType: "application/json",
|
|
263
243
|
requestType: "json",
|
|
264
244
|
body: Object.assign(Object.assign({}, serializers.AnalyzeRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" })), { stream: false }),
|
|
265
|
-
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 :
|
|
245
|
+
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 600000,
|
|
266
246
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
267
247
|
abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
|
|
268
248
|
});
|
|
@@ -281,6 +261,8 @@ class TwelvelabsApiClient {
|
|
|
281
261
|
switch (_response.error.statusCode) {
|
|
282
262
|
case 400:
|
|
283
263
|
throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
|
|
264
|
+
case 404:
|
|
265
|
+
throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
284
266
|
case 429:
|
|
285
267
|
throw new TwelvelabsApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
286
268
|
default:
|
|
@@ -4,43 +4,56 @@
|
|
|
4
4
|
import * as TwelvelabsApi from "../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
8
|
-
* videoId: "6298d673f1090f1100476d4c",
|
|
9
|
-
* prompt: "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.",
|
|
10
|
-
* temperature: 0.2,
|
|
11
|
-
* responseFormat: {
|
|
12
|
-
* type: "json_schema",
|
|
13
|
-
* jsonSchema: {
|
|
14
|
-
* "type": "object",
|
|
15
|
-
* "properties": {
|
|
16
|
-
* "title": {
|
|
17
|
-
* "type": "string"
|
|
18
|
-
* },
|
|
19
|
-
* "summary": {
|
|
20
|
-
* "type": "string"
|
|
21
|
-
* },
|
|
22
|
-
* "keywords": {
|
|
23
|
-
* "type": "array",
|
|
24
|
-
* "items": {
|
|
25
|
-
* "type": "string"
|
|
26
|
-
* }
|
|
27
|
-
* }
|
|
28
|
-
* }
|
|
29
|
-
* }
|
|
30
|
-
* },
|
|
31
|
-
* maxTokens: 2000
|
|
32
|
-
* }
|
|
7
|
+
* {}
|
|
33
8
|
*/
|
|
34
9
|
export interface AnalyzeRequest {
|
|
35
10
|
/**
|
|
36
|
-
* The
|
|
11
|
+
* The video understanding model to use for analysis.
|
|
12
|
+
* - `pegasus1.2`: General analysis (prompt-based text generation).
|
|
13
|
+
* - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation (async only). Does not support `analysis_mode=time_based_metadata` or `response_format.type=segment_definitions` — use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
|
|
14
|
+
*
|
|
15
|
+
* **Default:** `pegasus1.2`
|
|
16
|
+
*/
|
|
17
|
+
modelName?: TwelvelabsApi.AnalyzeRequestModelName;
|
|
18
|
+
/**
|
|
19
|
+
* The unique identifier of the video to analyze. Use this parameter when the `model_name` parameter is `pegasus1.2`. Not supported with `pegasus1.5`.
|
|
37
20
|
*
|
|
38
21
|
* <Info> This parameter will be deprecated and removed in a future version. Use the [`video`](/v1.3/api-reference/analyze-videos/sync-analysis#request.body.video) parameter instead.</Info>
|
|
39
22
|
*/
|
|
40
23
|
videoId?: string;
|
|
41
24
|
video?: TwelvelabsApi.VideoContext;
|
|
42
|
-
prompt
|
|
25
|
+
/** A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter. */
|
|
26
|
+
prompt?: TwelvelabsApi.AnalyzeTextPrompt;
|
|
27
|
+
/** A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter. */
|
|
28
|
+
promptV2?: TwelvelabsApi.AnalyzePromptV2;
|
|
43
29
|
temperature?: TwelvelabsApi.AnalyzeTemperature;
|
|
44
|
-
|
|
45
|
-
|
|
30
|
+
/** Specifies the format of the response. When you omit this parameter, the platform returns unstructured text. Only the `json_schema` type is supported for synchronous analysis. */
|
|
31
|
+
responseFormat?: TwelvelabsApi.SyncResponseFormat;
|
|
32
|
+
/**
|
|
33
|
+
* The maximum number of tokens to generate. The allowed range depends on the model:
|
|
34
|
+
*
|
|
35
|
+
* | Model | Min | Max | Default |
|
|
36
|
+
* |-------|-----|-----|---------|
|
|
37
|
+
* | Pegasus 1.2 | 1 | 4,096 | 4,096 |
|
|
38
|
+
* | Pegasus 1.5 | 512 | 65,536 | 4,096 |
|
|
39
|
+
*/
|
|
40
|
+
maxTokens?: number;
|
|
41
|
+
/**
|
|
42
|
+
* 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`.
|
|
43
|
+
*
|
|
44
|
+
* <Note title="Notes">
|
|
45
|
+
* - If omitted, defaults to `0`.
|
|
46
|
+
* - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
|
|
47
|
+
* </Note>
|
|
48
|
+
*/
|
|
49
|
+
startTime?: number;
|
|
50
|
+
/**
|
|
51
|
+
* 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`.
|
|
52
|
+
*
|
|
53
|
+
* <Note title="Notes">
|
|
54
|
+
* - If omitted, defaults to the video duration.
|
|
55
|
+
* - 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.
|
|
56
|
+
* </Note>
|
|
57
|
+
*/
|
|
58
|
+
endTime?: number;
|
|
46
59
|
}
|
|
@@ -4,43 +4,56 @@
|
|
|
4
4
|
import * as TwelvelabsApi from "../../index";
|
|
5
5
|
/**
|
|
6
6
|
* @example
|
|
7
|
-
* {
|
|
8
|
-
* videoId: "6298d673f1090f1100476d4c",
|
|
9
|
-
* prompt: "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.",
|
|
10
|
-
* temperature: 0.2,
|
|
11
|
-
* responseFormat: {
|
|
12
|
-
* type: "json_schema",
|
|
13
|
-
* jsonSchema: {
|
|
14
|
-
* "type": "object",
|
|
15
|
-
* "properties": {
|
|
16
|
-
* "title": {
|
|
17
|
-
* "type": "string"
|
|
18
|
-
* },
|
|
19
|
-
* "summary": {
|
|
20
|
-
* "type": "string"
|
|
21
|
-
* },
|
|
22
|
-
* "keywords": {
|
|
23
|
-
* "type": "array",
|
|
24
|
-
* "items": {
|
|
25
|
-
* "type": "string"
|
|
26
|
-
* }
|
|
27
|
-
* }
|
|
28
|
-
* }
|
|
29
|
-
* }
|
|
30
|
-
* },
|
|
31
|
-
* maxTokens: 2000
|
|
32
|
-
* }
|
|
7
|
+
* {}
|
|
33
8
|
*/
|
|
34
9
|
export interface AnalyzeStreamRequest {
|
|
35
10
|
/**
|
|
36
|
-
* The
|
|
11
|
+
* The video understanding model to use for analysis.
|
|
12
|
+
* - `pegasus1.2`: General analysis (prompt-based text generation).
|
|
13
|
+
* - `pegasus1.5`: General analysis (prompt-based text generation) with video clipping, structured prompts with reference images, extended token limits, and video segmentation (async only). Does not support `analysis_mode=time_based_metadata` or `response_format.type=segment_definitions` — use the [`POST`](/v1.3/api-reference/analyze-videos/create-async-analysis-task) method of the `/analyze/tasks` endpoint instead.
|
|
14
|
+
*
|
|
15
|
+
* **Default:** `pegasus1.2`
|
|
16
|
+
*/
|
|
17
|
+
modelName?: TwelvelabsApi.AnalyzeStreamRequestModelName;
|
|
18
|
+
/**
|
|
19
|
+
* The unique identifier of the video to analyze. Use this parameter when the `model_name` parameter is `pegasus1.2`. Not supported with `pegasus1.5`.
|
|
37
20
|
*
|
|
38
21
|
* <Info> This parameter will be deprecated and removed in a future version. Use the [`video`](/v1.3/api-reference/analyze-videos/sync-analysis#request.body.video) parameter instead.</Info>
|
|
39
22
|
*/
|
|
40
23
|
videoId?: string;
|
|
41
24
|
video?: TwelvelabsApi.VideoContext;
|
|
42
|
-
prompt
|
|
25
|
+
/** A text prompt that guides the model on the desired format or content. Works with both Pegasus 1.2 and Pegasus 1.5. To include reference images in your prompt, use the `prompt_v2` parameter instead (Pegasus 1.5 only). Mutually exclusive with the `prompt_v2` parameter. */
|
|
26
|
+
prompt?: TwelvelabsApi.AnalyzeTextPrompt;
|
|
27
|
+
/** A structured prompt with `<@name>` placeholders for referencing images. Requires the `model_name` parameter set to `pegasus1.5`. Mutually exclusive with the `prompt` parameter. */
|
|
28
|
+
promptV2?: TwelvelabsApi.AnalyzePromptV2;
|
|
43
29
|
temperature?: TwelvelabsApi.AnalyzeTemperature;
|
|
44
|
-
|
|
45
|
-
|
|
30
|
+
/** Specifies the format of the response. When you omit this parameter, the platform returns unstructured text. Only the `json_schema` type is supported for synchronous analysis. */
|
|
31
|
+
responseFormat?: TwelvelabsApi.SyncResponseFormat;
|
|
32
|
+
/**
|
|
33
|
+
* The maximum number of tokens to generate. The allowed range depends on the model:
|
|
34
|
+
*
|
|
35
|
+
* | Model | Min | Max | Default |
|
|
36
|
+
* |-------|-----|-----|---------|
|
|
37
|
+
* | Pegasus 1.2 | 1 | 4,096 | 4,096 |
|
|
38
|
+
* | Pegasus 1.5 | 512 | 65,536 | 4,096 |
|
|
39
|
+
*/
|
|
40
|
+
maxTokens?: number;
|
|
41
|
+
/**
|
|
42
|
+
* 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`.
|
|
43
|
+
*
|
|
44
|
+
* <Note title="Notes">
|
|
45
|
+
* - If omitted, defaults to `0`.
|
|
46
|
+
* - Must be less than `end_time` and less than the video duration. The clip (`end_time - start_time`) must be at least `4` seconds.
|
|
47
|
+
* </Note>
|
|
48
|
+
*/
|
|
49
|
+
startTime?: number;
|
|
50
|
+
/**
|
|
51
|
+
* 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`.
|
|
52
|
+
*
|
|
53
|
+
* <Note title="Notes">
|
|
54
|
+
* - If omitted, defaults to the video duration.
|
|
55
|
+
* - 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.
|
|
56
|
+
* </Note>
|
|
57
|
+
*/
|
|
58
|
+
endTime?: number;
|
|
46
59
|
}
|
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
* This file was auto-generated by Fern from our API Definition.
|
|
3
3
|
*/
|
|
4
4
|
import * as errors from "../../errors/index";
|
|
5
|
-
import * as TwelvelabsApi from "../index";
|
|
6
5
|
import * as core from "../../core";
|
|
7
6
|
export declare class ConflictError extends errors.TwelvelabsApiError {
|
|
8
|
-
constructor(body
|
|
7
|
+
constructor(body?: unknown, rawResponse?: core.RawResponse);
|
|
9
8
|
}
|
package/dist/api/errors/index.js
CHANGED
|
@@ -17,6 +17,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
17
17
|
__exportStar(require("./BadRequestError"), exports);
|
|
18
18
|
__exportStar(require("./NotFoundError"), exports);
|
|
19
19
|
__exportStar(require("./InternalServerError"), exports);
|
|
20
|
+
__exportStar(require("./ConflictError"), exports);
|
|
20
21
|
__exportStar(require("./ForbiddenError"), exports);
|
|
21
22
|
__exportStar(require("./TooManyRequestsError"), exports);
|
|
22
|
-
__exportStar(require("./ConflictError"), exports);
|
|
@@ -37,13 +37,17 @@ export declare class Tasks {
|
|
|
37
37
|
* await client.analyzeAsync.tasks.list({
|
|
38
38
|
* page: 1,
|
|
39
39
|
* pageLimit: 10,
|
|
40
|
-
* status: "queued"
|
|
40
|
+
* status: "queued",
|
|
41
|
+
* videoUrl: "https://example.com/video.mp4",
|
|
42
|
+
* assetId: "69abc123def456789012abcd",
|
|
43
|
+
* videoId: "6298d673f1090f1100476d4c",
|
|
44
|
+
* analysisMode: "general"
|
|
41
45
|
* })
|
|
42
46
|
*/
|
|
43
47
|
list(request?: TwelvelabsApi.analyzeAsync.TasksListRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.analyzeAsync.TasksListResponse>;
|
|
44
48
|
private __list;
|
|
45
49
|
/**
|
|
46
|
-
* This method asynchronously analyzes your videos
|
|
50
|
+
* 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.
|
|
47
51
|
*
|
|
48
52
|
* <Accordion title="Input requirements">
|
|
49
53
|
* - Minimum duration: 4 seconds
|
|
@@ -54,6 +58,8 @@ export declare class Tasks {
|
|
|
54
58
|
* </Accordion>
|
|
55
59
|
*
|
|
56
60
|
* **When to use this method**:
|
|
61
|
+
* - Generate custom text from your video using a prompt (general analysis)
|
|
62
|
+
* - Extract timestamped metadata with custom segment definitions from your video (Pegasus 1.5 only)
|
|
57
63
|
* - Analyze videos longer than 1 hour
|
|
58
64
|
* - Process videos asynchronously without blocking your application
|
|
59
65
|
*
|
|
@@ -78,6 +84,7 @@ export declare class Tasks {
|
|
|
78
84
|
*
|
|
79
85
|
* @example
|
|
80
86
|
* await client.analyzeAsync.tasks.create({
|
|
87
|
+
* customId: "prod-segment-analysis-42",
|
|
81
88
|
* video: {
|
|
82
89
|
* type: "url",
|
|
83
90
|
* url: "https://example.com/video.mp4"
|
|
@@ -86,6 +93,93 @@ export declare class Tasks {
|
|
|
86
93
|
* temperature: 0.2,
|
|
87
94
|
* maxTokens: 1000
|
|
88
95
|
* })
|
|
96
|
+
*
|
|
97
|
+
* @example
|
|
98
|
+
* await client.analyzeAsync.tasks.create({
|
|
99
|
+
* modelName: "pegasus1.5",
|
|
100
|
+
* video: {
|
|
101
|
+
* type: "url",
|
|
102
|
+
* url: "https://example.com/video.mp4"
|
|
103
|
+
* },
|
|
104
|
+
* analysisMode: "time_based_metadata",
|
|
105
|
+
* responseFormat: {
|
|
106
|
+
* type: "segment_definitions",
|
|
107
|
+
* segmentDefinitions: [{
|
|
108
|
+
* id: "scene",
|
|
109
|
+
* description: "A distinct scene or setting change in the video",
|
|
110
|
+
* fields: [{
|
|
111
|
+
* name: "sentiment",
|
|
112
|
+
* type: "string",
|
|
113
|
+
* description: "The emotional tone of this segment",
|
|
114
|
+
* enum: ["positive", "negative", "neutral"]
|
|
115
|
+
* }, {
|
|
116
|
+
* name: "key_objects",
|
|
117
|
+
* type: "array",
|
|
118
|
+
* description: "Notable objects visible in this segment",
|
|
119
|
+
* items: {
|
|
120
|
+
* type: "string"
|
|
121
|
+
* }
|
|
122
|
+
* }]
|
|
123
|
+
* }]
|
|
124
|
+
* },
|
|
125
|
+
* minSegmentDuration: 5,
|
|
126
|
+
* maxSegmentDuration: 30
|
|
127
|
+
* })
|
|
128
|
+
*
|
|
129
|
+
* @example
|
|
130
|
+
* await client.analyzeAsync.tasks.create({
|
|
131
|
+
* modelName: "pegasus1.5",
|
|
132
|
+
* video: {
|
|
133
|
+
* type: "url",
|
|
134
|
+
* url: "https://example.com/video.mp4"
|
|
135
|
+
* },
|
|
136
|
+
* prompt: "Summarize the key events in this clip.",
|
|
137
|
+
* maxTokens: 4096,
|
|
138
|
+
* startTime: 10,
|
|
139
|
+
* endTime: 60
|
|
140
|
+
* })
|
|
141
|
+
*
|
|
142
|
+
* @example
|
|
143
|
+
* await client.analyzeAsync.tasks.create({
|
|
144
|
+
* modelName: "pegasus1.5",
|
|
145
|
+
* video: {
|
|
146
|
+
* type: "url",
|
|
147
|
+
* url: "https://example.com/video.mp4"
|
|
148
|
+
* },
|
|
149
|
+
* analysisMode: "time_based_metadata",
|
|
150
|
+
* responseFormat: {
|
|
151
|
+
* type: "segment_definitions",
|
|
152
|
+
* segmentDefinitions: [{
|
|
153
|
+
* id: "scenes",
|
|
154
|
+
* description: "Scene changes.",
|
|
155
|
+
* timeRanges: [{
|
|
156
|
+
* startTime: 0,
|
|
157
|
+
* endTime: 4
|
|
158
|
+
* }, {
|
|
159
|
+
* startTime: 10,
|
|
160
|
+
* endTime: 14
|
|
161
|
+
* }]
|
|
162
|
+
* }]
|
|
163
|
+
* }
|
|
164
|
+
* })
|
|
165
|
+
*
|
|
166
|
+
* @example
|
|
167
|
+
* await client.analyzeAsync.tasks.create({
|
|
168
|
+
* modelName: "pegasus1.5",
|
|
169
|
+
* video: {
|
|
170
|
+
* type: "url",
|
|
171
|
+
* url: "https://example.com/video.mp4"
|
|
172
|
+
* },
|
|
173
|
+
* promptV2: {
|
|
174
|
+
* inputText: "Is there a <@tiger-1> in the video?",
|
|
175
|
+
* mediaSources: [{
|
|
176
|
+
* name: "tiger-1",
|
|
177
|
+
* mediaType: "image",
|
|
178
|
+
* url: "https://example.com/tiger.jpg"
|
|
179
|
+
* }]
|
|
180
|
+
* },
|
|
181
|
+
* maxTokens: 4096
|
|
182
|
+
* })
|
|
89
183
|
*/
|
|
90
184
|
create(request: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequest, requestOptions?: Tasks.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.CreateAnalyzeTaskResponse>;
|
|
91
185
|
private __create;
|