twelvelabs-js 1.2.2 → 1.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Client.d.ts +2 -0
- package/Client.js +4 -2
- package/README.md +20 -1
- package/api/client/requests/AnalyzeRequest.d.ts +1 -1
- package/api/client/requests/AnalyzeStreamRequest.d.ts +1 -1
- 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 +39 -2
- package/api/resources/analyzeAsync/resources/tasks/client/Client.js +54 -13
- package/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +74 -3
- package/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +26 -1
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +9 -0
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +13 -0
- package/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
- package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +7 -0
- package/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +9 -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 +17 -6
- package/api/resources/assets/client/Client.js +41 -13
- 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 +1 -1
- package/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
- package/api/resources/embed/resources/tasks/client/Client.js +5 -5
- package/api/resources/embed/resources/v2/client/Client.js +1 -1
- package/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +12 -2
- package/api/resources/embed/resources/v2/resources/tasks/client/Client.js +15 -5
- package/api/resources/entityCollections/client/Client.js +5 -5
- package/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
- package/api/resources/entityCollections/resources/entities/client/Client.js +100 -9
- 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 +5 -5
- package/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
- package/api/resources/indexes/resources/indexedAssets/client/Client.js +126 -15
- 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 +35 -15
- package/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
- package/api/resources/multipartUpload/client/Client.d.ts +2 -2
- package/api/resources/multipartUpload/client/Client.js +7 -7
- package/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
- package/api/resources/search/client/Client.js +2 -2
- package/api/resources/tasks/client/Client.js +4 -4
- package/api/resources/tasks/resources/transfers/client/Client.js +3 -3
- package/api/types/AnalyzeTaskResponse.d.ts +4 -0
- package/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -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/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +11 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
- package/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +10 -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 +19 -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/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 +89 -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 +17 -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} +2 -2
- 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/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 +40 -2
- package/api/types/index.js +40 -2
- package/dist/Client.d.ts +2 -0
- package/dist/Client.js +4 -2
- package/dist/api/client/requests/AnalyzeRequest.d.ts +1 -1
- package/dist/api/client/requests/AnalyzeStreamRequest.d.ts +1 -1
- 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 +39 -2
- package/dist/api/resources/analyzeAsync/resources/tasks/client/Client.js +54 -13
- package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +74 -3
- package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts +26 -1
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.d.ts +10 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestAnalysisMode.js +9 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.d.ts +13 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js +10 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.d.ts +7 -0
- package/dist/api/resources/analyzeAsync/resources/tasks/types/TasksListRequestAnalysisMode.js +9 -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 +17 -6
- package/dist/api/resources/assets/client/Client.js +41 -13
- 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 +1 -1
- package/dist/api/resources/embed/resources/tasks/client/Client.d.ts +1 -1
- package/dist/api/resources/embed/resources/tasks/client/Client.js +5 -5
- package/dist/api/resources/embed/resources/v2/client/Client.js +1 -1
- package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.d.ts +12 -2
- package/dist/api/resources/embed/resources/v2/resources/tasks/client/Client.js +15 -5
- package/dist/api/resources/entityCollections/client/Client.js +5 -5
- package/dist/api/resources/entityCollections/resources/entities/client/Client.d.ts +16 -0
- package/dist/api/resources/entityCollections/resources/entities/client/Client.js +100 -9
- 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 +5 -5
- package/dist/api/resources/indexes/resources/indexedAssets/client/Client.d.ts +16 -5
- package/dist/api/resources/indexes/resources/indexedAssets/client/Client.js +126 -15
- 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 +35 -15
- package/dist/api/resources/indexes/resources/videos/client/requests/VideosListRequest.d.ts +15 -15
- package/dist/api/resources/multipartUpload/client/Client.d.ts +2 -2
- package/dist/api/resources/multipartUpload/client/Client.js +7 -7
- package/dist/api/resources/multipartUpload/client/requests/CreateAssetUploadRequest.d.ts +12 -0
- package/dist/api/resources/search/client/Client.js +2 -2
- package/dist/api/resources/tasks/client/Client.js +4 -4
- package/dist/api/resources/tasks/resources/transfers/client/Client.js +3 -3
- package/dist/api/types/AnalyzeTaskResponse.d.ts +4 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParams.d.ts +21 -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/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +11 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +5 -0
- package/dist/api/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +10 -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 +19 -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/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 +89 -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 +17 -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} +2 -2
- 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/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 +40 -2
- package/dist/api/types/index.js +40 -2
- package/dist/serialization/client/requests/AnalyzeRequest.d.ts +2 -2
- package/dist/serialization/client/requests/AnalyzeRequest.js +2 -2
- package/dist/serialization/client/requests/AnalyzeStreamRequest.d.ts +2 -2
- package/dist/serialization/client/requests/AnalyzeStreamRequest.js +2 -2
- package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +10 -6
- package/dist/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +10 -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/AnalyzeTaskResponse.d.ts +4 -0
- package/dist/serialization/types/AnalyzeTaskResponse.js +4 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +19 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParams.js +50 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +15 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +46 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +17 -0
- package/dist/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +52 -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 +18 -0
- package/dist/serialization/types/AnalyzeTaskResponseVideoSource.js +49 -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/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 +17 -0
- package/dist/serialization/types/SegmentDefinition.js +48 -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/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 +40 -2
- package/dist/serialization/types/index.js +40 -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 +219 -35
- package/serialization/client/requests/AnalyzeRequest.d.ts +2 -2
- package/serialization/client/requests/AnalyzeRequest.js +2 -2
- package/serialization/client/requests/AnalyzeStreamRequest.d.ts +2 -2
- package/serialization/client/requests/AnalyzeStreamRequest.js +2 -2
- package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.d.ts +10 -6
- package/serialization/resources/analyzeAsync/resources/tasks/client/requests/CreateAsyncAnalyzeRequest.js +10 -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/AnalyzeTaskResponse.d.ts +4 -0
- package/serialization/types/AnalyzeTaskResponse.js +4 -0
- package/serialization/types/AnalyzeTaskResponseRequestParams.d.ts +19 -0
- package/serialization/types/AnalyzeTaskResponseRequestParams.js +50 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.d.ts +10 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsAnalysisMode.js +41 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.d.ts +15 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormat.js +46 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.d.ts +17 -0
- package/serialization/types/AnalyzeTaskResponseRequestParamsResponseFormatSegmentDefinitionsItem.js +52 -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 +18 -0
- package/serialization/types/AnalyzeTaskResponseVideoSource.js +49 -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/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 +17 -0
- package/serialization/types/SegmentDefinition.js +48 -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/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 +40 -2
- package/serialization/types/index.js +40 -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
|
@@ -71,7 +71,10 @@ class Tasks {
|
|
|
71
71
|
* await client.analyzeAsync.tasks.list({
|
|
72
72
|
* page: 1,
|
|
73
73
|
* pageLimit: 10,
|
|
74
|
-
* status: "queued"
|
|
74
|
+
* status: "queued",
|
|
75
|
+
* videoUrl: "https://example.com/video.mp4",
|
|
76
|
+
* assetId: "69abc123def456789012abcd",
|
|
77
|
+
* analysisMode: "time_based_metadata"
|
|
75
78
|
* })
|
|
76
79
|
*/
|
|
77
80
|
list(request = {}, requestOptions) {
|
|
@@ -80,7 +83,7 @@ class Tasks {
|
|
|
80
83
|
__list() {
|
|
81
84
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
82
85
|
var _a, _b;
|
|
83
|
-
const { page, pageLimit, status } = request;
|
|
86
|
+
const { page, pageLimit, status, videoUrl, assetId, analysisMode } = request;
|
|
84
87
|
const _queryParams = {};
|
|
85
88
|
if (page != null) {
|
|
86
89
|
_queryParams["page"] = page.toString();
|
|
@@ -93,10 +96,19 @@ class Tasks {
|
|
|
93
96
|
unrecognizedObjectKeys: "strip",
|
|
94
97
|
});
|
|
95
98
|
}
|
|
99
|
+
if (videoUrl != null) {
|
|
100
|
+
_queryParams["video_url"] = videoUrl;
|
|
101
|
+
}
|
|
102
|
+
if (assetId != null) {
|
|
103
|
+
_queryParams["asset_id"] = assetId;
|
|
104
|
+
}
|
|
105
|
+
if (analysisMode != null) {
|
|
106
|
+
_queryParams["analysis_mode"] = serializers.analyzeAsync.TasksListRequestAnalysisMode.jsonOrThrow(analysisMode, { unrecognizedObjectKeys: "strip" });
|
|
107
|
+
}
|
|
96
108
|
const _response = yield core.fetcher({
|
|
97
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, "analyze/tasks"),
|
|
98
110
|
method: "GET",
|
|
99
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
111
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
100
112
|
contentType: "application/json",
|
|
101
113
|
queryParameters: _queryParams,
|
|
102
114
|
requestType: "json",
|
|
@@ -145,7 +157,7 @@ class Tasks {
|
|
|
145
157
|
});
|
|
146
158
|
}
|
|
147
159
|
/**
|
|
148
|
-
* This method asynchronously analyzes your videos
|
|
160
|
+
* This method asynchronously analyzes your videos. It supports two modes: general analysis (prompt-based text generation) with Pegasus 1.2 and video segmentation with Pegasus 1.5.
|
|
149
161
|
*
|
|
150
162
|
* <Accordion title="Input requirements">
|
|
151
163
|
* - Minimum duration: 4 seconds
|
|
@@ -156,6 +168,8 @@ class Tasks {
|
|
|
156
168
|
* </Accordion>
|
|
157
169
|
*
|
|
158
170
|
* **When to use this method**:
|
|
171
|
+
* - Generate custom text from your video using a prompt (Pegasus 1.2 only)
|
|
172
|
+
* - Extract timestamped metadata with custom fields from your video (Pegasus 1.5 only)
|
|
159
173
|
* - Analyze videos longer than 1 hour
|
|
160
174
|
* - Process videos asynchronously without blocking your application
|
|
161
175
|
*
|
|
@@ -188,6 +202,38 @@ class Tasks {
|
|
|
188
202
|
* temperature: 0.2,
|
|
189
203
|
* maxTokens: 1000
|
|
190
204
|
* })
|
|
205
|
+
*
|
|
206
|
+
* @example
|
|
207
|
+
* await client.analyzeAsync.tasks.create({
|
|
208
|
+
* modelName: "pegasus1.5",
|
|
209
|
+
* video: {
|
|
210
|
+
* type: "url",
|
|
211
|
+
* url: "https://example.com/video.mp4"
|
|
212
|
+
* },
|
|
213
|
+
* analysisMode: "time_based_metadata",
|
|
214
|
+
* responseFormat: {
|
|
215
|
+
* type: "segment_definitions",
|
|
216
|
+
* segmentDefinitions: [{
|
|
217
|
+
* id: "scene",
|
|
218
|
+
* description: "A distinct scene or setting change in the video",
|
|
219
|
+
* fields: [{
|
|
220
|
+
* name: "sentiment",
|
|
221
|
+
* type: "string",
|
|
222
|
+
* description: "The emotional tone of this segment",
|
|
223
|
+
* enum: ["positive", "negative", "neutral"]
|
|
224
|
+
* }, {
|
|
225
|
+
* name: "key_objects",
|
|
226
|
+
* type: "array",
|
|
227
|
+
* description: "Notable objects visible in this segment",
|
|
228
|
+
* items: {
|
|
229
|
+
* type: "string"
|
|
230
|
+
* }
|
|
231
|
+
* }]
|
|
232
|
+
* }]
|
|
233
|
+
* },
|
|
234
|
+
* minSegmentDuration: 5,
|
|
235
|
+
* maxSegmentDuration: 30
|
|
236
|
+
* })
|
|
191
237
|
*/
|
|
192
238
|
create(request, requestOptions) {
|
|
193
239
|
return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
|
|
@@ -198,7 +244,7 @@ class Tasks {
|
|
|
198
244
|
const _response = yield core.fetcher({
|
|
199
245
|
url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "analyze/tasks"),
|
|
200
246
|
method: "POST",
|
|
201
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
247
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
202
248
|
contentType: "application/json",
|
|
203
249
|
requestType: "json",
|
|
204
250
|
body: serializers.analyzeAsync.CreateAsyncAnalyzeRequest.jsonOrThrow(request, {
|
|
@@ -279,7 +325,7 @@ class Tasks {
|
|
|
279
325
|
const _response = yield core.fetcher({
|
|
280
326
|
url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `analyze/tasks/${encodeURIComponent(taskId)}`),
|
|
281
327
|
method: "GET",
|
|
282
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
328
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
283
329
|
contentType: "application/json",
|
|
284
330
|
requestType: "json",
|
|
285
331
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -347,7 +393,7 @@ class Tasks {
|
|
|
347
393
|
const _response = yield core.fetcher({
|
|
348
394
|
url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, `analyze/tasks/${encodeURIComponent(taskId)}`),
|
|
349
395
|
method: "DELETE",
|
|
350
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
396
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
351
397
|
contentType: "application/json",
|
|
352
398
|
requestType: "json",
|
|
353
399
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -362,12 +408,7 @@ class Tasks {
|
|
|
362
408
|
case 404:
|
|
363
409
|
throw new TwelvelabsApi.NotFoundError(_response.error.body, _response.rawResponse);
|
|
364
410
|
case 409:
|
|
365
|
-
throw new TwelvelabsApi.ConflictError(
|
|
366
|
-
unrecognizedObjectKeys: "passthrough",
|
|
367
|
-
allowUnrecognizedUnionMembers: true,
|
|
368
|
-
allowUnrecognizedEnumValues: true,
|
|
369
|
-
breadcrumbsPrefix: ["response"],
|
|
370
|
-
}), _response.rawResponse);
|
|
411
|
+
throw new TwelvelabsApi.ConflictError(_response.error.body, _response.rawResponse);
|
|
371
412
|
default:
|
|
372
413
|
throw new errors.TwelvelabsApiError({
|
|
373
414
|
statusCode: _response.error.statusCode,
|
|
@@ -13,11 +13,82 @@ import * as TwelvelabsApi from "../../../../../../index";
|
|
|
13
13
|
* temperature: 0.2,
|
|
14
14
|
* maxTokens: 1000
|
|
15
15
|
* }
|
|
16
|
+
*
|
|
17
|
+
* @example
|
|
18
|
+
* {
|
|
19
|
+
* modelName: "pegasus1.5",
|
|
20
|
+
* video: {
|
|
21
|
+
* type: "url",
|
|
22
|
+
* url: "https://example.com/video.mp4"
|
|
23
|
+
* },
|
|
24
|
+
* analysisMode: "time_based_metadata",
|
|
25
|
+
* responseFormat: {
|
|
26
|
+
* type: "segment_definitions",
|
|
27
|
+
* segmentDefinitions: [{
|
|
28
|
+
* id: "scene",
|
|
29
|
+
* description: "A distinct scene or setting change in the video",
|
|
30
|
+
* fields: [{
|
|
31
|
+
* name: "sentiment",
|
|
32
|
+
* type: "string",
|
|
33
|
+
* description: "The emotional tone of this segment",
|
|
34
|
+
* enum: ["positive", "negative", "neutral"]
|
|
35
|
+
* }, {
|
|
36
|
+
* name: "key_objects",
|
|
37
|
+
* type: "array",
|
|
38
|
+
* description: "Notable objects visible in this segment",
|
|
39
|
+
* items: {
|
|
40
|
+
* type: "string"
|
|
41
|
+
* }
|
|
42
|
+
* }]
|
|
43
|
+
* }]
|
|
44
|
+
* },
|
|
45
|
+
* minSegmentDuration: 5,
|
|
46
|
+
* maxSegmentDuration: 30
|
|
47
|
+
* }
|
|
16
48
|
*/
|
|
17
49
|
export interface CreateAsyncAnalyzeRequest {
|
|
50
|
+
/**
|
|
51
|
+
* The video understanding model to use for analysis.
|
|
52
|
+
* - `pegasus1.2` (default): Analyzes pre-indexed videos. Pass a `video_id` to reference your video.
|
|
53
|
+
* - `pegasus1.5`: Analyzes videos directly from a URL, asset, or base64 string. Supports video segmentation with custom segment definitions.
|
|
54
|
+
*/
|
|
55
|
+
modelName?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestModelName;
|
|
18
56
|
video: TwelvelabsApi.VideoContext;
|
|
19
|
-
|
|
57
|
+
/**
|
|
58
|
+
* A natural-language text that provides instructions for analyzing the video. Required for general-mode analysis. Not supported when `analysis_mode` is `time_based_metadata`.
|
|
59
|
+
*
|
|
60
|
+
* <Note title="Notes">
|
|
61
|
+
* - Even though the model behind this endpoint is trained to a high degree of accuracy, the preciseness of the generated text may vary based on the nature and quality of the video and the clarity of the prompt.
|
|
62
|
+
* - Your prompts can be instructive or descriptive, or you can also phrase them as questions.
|
|
63
|
+
* - The maximum length of a prompt is 2,000 tokens.
|
|
64
|
+
* </Note>
|
|
65
|
+
*
|
|
66
|
+
* **Examples**:
|
|
67
|
+
*
|
|
68
|
+
* - Based on this video, I want to generate five keywords for SEO (Search Engine Optimization).
|
|
69
|
+
* - I want to generate a description for my video with the following format: Title of the video, followed by a summary in 2-3 sentences, highlighting the main topic, key events, and concluding remarks.
|
|
70
|
+
*/
|
|
71
|
+
prompt?: string;
|
|
72
|
+
/** Sets the analysis mode to `time_based_metadata`, which segments your video into time-based intervals and extracts custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`. */
|
|
73
|
+
analysisMode?: TwelvelabsApi.analyzeAsync.CreateAsyncAnalyzeRequestAnalysisMode;
|
|
20
74
|
temperature?: TwelvelabsApi.AnalyzeTemperature;
|
|
21
|
-
|
|
22
|
-
|
|
75
|
+
/**
|
|
76
|
+
* The maximum number of tokens to generate. The allowed range depends on the model:
|
|
77
|
+
* - `pegasus1.2`: **Min:** 1, **Max:** 4,096
|
|
78
|
+
* - `pegasus1.5`: **Min:** 2,048, **Max:** 32,768, **Default:** 32,768
|
|
79
|
+
*/
|
|
80
|
+
maxTokens?: number;
|
|
81
|
+
responseFormat?: TwelvelabsApi.AsyncResponseFormat;
|
|
82
|
+
/**
|
|
83
|
+
* Minimum duration for each extracted segment, in seconds. Set this to prevent the model from creating very short segments. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
|
|
84
|
+
*
|
|
85
|
+
* **Min:** 2
|
|
86
|
+
*/
|
|
87
|
+
minSegmentDuration?: number;
|
|
88
|
+
/**
|
|
89
|
+
* Maximum duration for each extracted segment, in seconds. Set this to break long continuous sections into shorter segments. Must be greater than or equal to `min_segment_duration`. Requires `model_name` set to `pegasus1.5` and `analysis_mode` set to `time_based_metadata`.
|
|
90
|
+
*
|
|
91
|
+
* **Min:** 2
|
|
92
|
+
*/
|
|
93
|
+
maxSegmentDuration?: number;
|
|
23
94
|
}
|
package/dist/api/resources/analyzeAsync/resources/tasks/client/requests/TasksListRequest.d.ts
CHANGED
|
@@ -7,7 +7,20 @@ import * as TwelvelabsApi from "../../../../../../index";
|
|
|
7
7
|
* {
|
|
8
8
|
* page: 1,
|
|
9
9
|
* pageLimit: 10,
|
|
10
|
-
* status: "queued"
|
|
10
|
+
* status: "queued",
|
|
11
|
+
* videoUrl: "https://example.com/video.mp4",
|
|
12
|
+
* assetId: "69abc123def456789012abcd",
|
|
13
|
+
* analysisMode: "time_based_metadata"
|
|
14
|
+
* }
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* {
|
|
18
|
+
* page: 1,
|
|
19
|
+
* pageLimit: 10,
|
|
20
|
+
* status: "queued",
|
|
21
|
+
* videoUrl: "https://example.com/video.mp4",
|
|
22
|
+
* assetId: "69abc123def456789012abcd",
|
|
23
|
+
* analysisMode: "time_based_metadata"
|
|
11
24
|
* }
|
|
12
25
|
*/
|
|
13
26
|
export interface TasksListRequest {
|
|
@@ -29,4 +42,16 @@ export interface TasksListRequest {
|
|
|
29
42
|
* Possible values: `queued`, `pending`, `processing`, `ready`, `failed`.
|
|
30
43
|
*/
|
|
31
44
|
status?: TwelvelabsApi.AnalyzeTaskStatus;
|
|
45
|
+
/**
|
|
46
|
+
* Filter tasks by exact video source URL.
|
|
47
|
+
*/
|
|
48
|
+
videoUrl?: string;
|
|
49
|
+
/**
|
|
50
|
+
* Filter tasks by asset ID.
|
|
51
|
+
*/
|
|
52
|
+
assetId?: string;
|
|
53
|
+
/**
|
|
54
|
+
* Filter tasks by the analysis mode used when creating the task.
|
|
55
|
+
*/
|
|
56
|
+
analysisMode?: TwelvelabsApi.analyzeAsync.TasksListRequestAnalysisMode;
|
|
32
57
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* Sets the analysis mode to `time_based_metadata`, which segments your video into time-based intervals and extracts custom metadata for each segment. Requires `model_name` set to `pegasus1.5` and `response_format.type` set to `segment_definitions`.
|
|
6
|
+
*/
|
|
7
|
+
export type CreateAsyncAnalyzeRequestAnalysisMode = "time_based_metadata";
|
|
8
|
+
export declare const CreateAsyncAnalyzeRequestAnalysisMode: {
|
|
9
|
+
readonly TimeBasedMetadata: "time_based_metadata";
|
|
10
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.CreateAsyncAnalyzeRequestAnalysisMode = void 0;
|
|
7
|
+
exports.CreateAsyncAnalyzeRequestAnalysisMode = {
|
|
8
|
+
TimeBasedMetadata: "time_based_metadata",
|
|
9
|
+
};
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* The video understanding model to use for analysis.
|
|
6
|
+
* - `pegasus1.2` (default): Analyzes pre-indexed videos. Pass a `video_id` to reference your video.
|
|
7
|
+
* - `pegasus1.5`: Analyzes videos directly from a URL, asset, or base64 string. Supports video segmentation with custom segment definitions.
|
|
8
|
+
*/
|
|
9
|
+
export type CreateAsyncAnalyzeRequestModelName = "pegasus1.2" | "pegasus1.5";
|
|
10
|
+
export declare const CreateAsyncAnalyzeRequestModelName: {
|
|
11
|
+
readonly Pegasus12: "pegasus1.2";
|
|
12
|
+
readonly Pegasus15: "pegasus1.5";
|
|
13
|
+
};
|
package/dist/api/resources/analyzeAsync/resources/tasks/types/CreateAsyncAnalyzeRequestModelName.js
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.CreateAsyncAnalyzeRequestModelName = void 0;
|
|
7
|
+
exports.CreateAsyncAnalyzeRequestModelName = {
|
|
8
|
+
Pegasus12: "pegasus1.2",
|
|
9
|
+
Pegasus15: "pegasus1.5",
|
|
10
|
+
};
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
4
|
+
*/
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.TasksListRequestAnalysisMode = void 0;
|
|
7
|
+
exports.TasksListRequestAnalysisMode = {
|
|
8
|
+
TimeBasedMetadata: "time_based_metadata",
|
|
9
|
+
};
|
|
@@ -14,4 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
14
14
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
15
|
};
|
|
16
16
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./TasksListRequestAnalysisMode"), exports);
|
|
17
18
|
__exportStar(require("./TasksListResponse"), exports);
|
|
19
|
+
__exportStar(require("./CreateAsyncAnalyzeRequestModelName"), exports);
|
|
20
|
+
__exportStar(require("./CreateAsyncAnalyzeRequestAnalysisMode"), exports);
|
|
@@ -38,10 +38,11 @@ export declare class Assets {
|
|
|
38
38
|
* @example
|
|
39
39
|
* await client.assets.list({
|
|
40
40
|
* page: 1,
|
|
41
|
-
* pageLimit: 10
|
|
41
|
+
* pageLimit: 10,
|
|
42
|
+
* filename: "meeting"
|
|
42
43
|
* })
|
|
43
44
|
*/
|
|
44
|
-
list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.
|
|
45
|
+
list(request?: TwelvelabsApi.AssetsListRequest, requestOptions?: Assets.RequestOptions): Promise<core.Page<TwelvelabsApi.AssetDetail>>;
|
|
45
46
|
/**
|
|
46
47
|
* This method creates an asset by uploading a file to the platform. Assets are media files that you can use in downstream workflows, including indexing, analyzing video content, and creating entities.
|
|
47
48
|
*
|
|
@@ -51,7 +52,7 @@ export declare class Assets {
|
|
|
51
52
|
* - **Local file**: Set the `method` parameter to `direct` and use the `file` parameter to specify the file.
|
|
52
53
|
* - **Publicly accessible URL**: Set the `method` parameter to `url` and use the `url` parameter to specify the URL of your file.
|
|
53
54
|
*
|
|
54
|
-
* **File size**:
|
|
55
|
+
* **File size**: Up to 4 GB.
|
|
55
56
|
*
|
|
56
57
|
* **Additional requirements** depend on your workflow:
|
|
57
58
|
* - **Search**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements)
|
|
@@ -86,20 +87,30 @@ export declare class Assets {
|
|
|
86
87
|
* @example
|
|
87
88
|
* await client.assets.retrieve("6298d673f1090f1100476d4c")
|
|
88
89
|
*/
|
|
89
|
-
retrieve(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.
|
|
90
|
+
retrieve(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.AssetDetail>;
|
|
90
91
|
private __retrieve;
|
|
91
92
|
/**
|
|
92
93
|
* This method deletes the specified asset. This action cannot be undone.
|
|
93
94
|
*
|
|
95
|
+
* By default, the platform checks whether any indexed assets reference the asset. If references exist, the platform rejects the request with a `409 Conflict` error. To skip this check and delete the asset anyway, set the `force` query parameter to `true`. The platform unlinks any entity associations.
|
|
96
|
+
*
|
|
97
|
+
* Before deleting, you can inspect existing references:
|
|
98
|
+
* - [`GET`](/v1.3/api-reference/index-content/list-indexed-assets-by-asset) `/assets/{asset_id}/indexed-assets` returns a list of the indexed assets that will block deletion unless the `force` query parameter is set to `true`.
|
|
99
|
+
* - [`GET`](/v1.3/api-reference/entities/list-entities-by-asset) `/assets/{asset_id}/entities` returns a list of the entities whose associations the platform will unlink.
|
|
100
|
+
*
|
|
94
101
|
* @param {string} assetId - The unique identifier of the asset to delete.
|
|
102
|
+
* @param {TwelvelabsApi.AssetsDeleteRequest} request
|
|
95
103
|
* @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
|
|
96
104
|
*
|
|
97
105
|
* @throws {@link TwelvelabsApi.BadRequestError}
|
|
106
|
+
* @throws {@link TwelvelabsApi.ConflictError}
|
|
98
107
|
*
|
|
99
108
|
* @example
|
|
100
|
-
* await client.assets.delete("6298d673f1090f1100476d4c"
|
|
109
|
+
* await client.assets.delete("6298d673f1090f1100476d4c", {
|
|
110
|
+
* force: true
|
|
111
|
+
* })
|
|
101
112
|
*/
|
|
102
|
-
delete(assetId: string, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
|
|
113
|
+
delete(assetId: string, request?: TwelvelabsApi.AssetsDeleteRequest, requestOptions?: Assets.RequestOptions): core.HttpResponsePromise<void>;
|
|
103
114
|
private __delete;
|
|
104
115
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
105
116
|
"x-api-key": string;
|
|
@@ -72,14 +72,15 @@ class Assets {
|
|
|
72
72
|
* @example
|
|
73
73
|
* await client.assets.list({
|
|
74
74
|
* page: 1,
|
|
75
|
-
* pageLimit: 10
|
|
75
|
+
* pageLimit: 10,
|
|
76
|
+
* filename: "meeting"
|
|
76
77
|
* })
|
|
77
78
|
*/
|
|
78
79
|
list() {
|
|
79
80
|
return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
|
|
80
81
|
const list = core.HttpResponsePromise.interceptFunction((request) => __awaiter(this, void 0, void 0, function* () {
|
|
81
82
|
var _a, _b;
|
|
82
|
-
const { page, pageLimit, assetIds, assetTypes } = request;
|
|
83
|
+
const { page, pageLimit, assetIds, assetTypes, filename } = request;
|
|
83
84
|
const _queryParams = {};
|
|
84
85
|
if (page != null) {
|
|
85
86
|
_queryParams["page"] = page.toString();
|
|
@@ -105,10 +106,13 @@ class Assets {
|
|
|
105
106
|
_queryParams["asset_types"] = serializers.AssetsListRequestAssetTypesItem.jsonOrThrow(assetTypes, { unrecognizedObjectKeys: "strip" });
|
|
106
107
|
}
|
|
107
108
|
}
|
|
109
|
+
if (filename != null) {
|
|
110
|
+
_queryParams["filename"] = filename;
|
|
111
|
+
}
|
|
108
112
|
const _response = yield core.fetcher({
|
|
109
113
|
url: (0, url_join_1.default)((_b = (_a = (yield core.Supplier.get(this._options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.TwelvelabsApiEnvironment.Default, "assets"),
|
|
110
114
|
method: "GET",
|
|
111
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
115
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
112
116
|
contentType: "application/json",
|
|
113
117
|
queryParameters: _queryParams,
|
|
114
118
|
requestType: "json",
|
|
@@ -178,7 +182,7 @@ class Assets {
|
|
|
178
182
|
* - **Local file**: Set the `method` parameter to `direct` and use the `file` parameter to specify the file.
|
|
179
183
|
* - **Publicly accessible URL**: Set the `method` parameter to `url` and use the `url` parameter to specify the URL of your file.
|
|
180
184
|
*
|
|
181
|
-
* **File size**:
|
|
185
|
+
* **File size**: Up to 4 GB.
|
|
182
186
|
*
|
|
183
187
|
* **Additional requirements** depend on your workflow:
|
|
184
188
|
* - **Search**: [Marengo requirements](/v1.3/docs/concepts/models/marengo#video-file-requirements)
|
|
@@ -217,11 +221,17 @@ class Assets {
|
|
|
217
221
|
if (request.filename != null) {
|
|
218
222
|
_request.append("filename", request.filename);
|
|
219
223
|
}
|
|
224
|
+
if (request.enableHls != null) {
|
|
225
|
+
_request.append("enable_hls", request.enableHls.toString());
|
|
226
|
+
}
|
|
227
|
+
if (request.enableThumbnail != null) {
|
|
228
|
+
_request.append("enable_thumbnail", request.enableThumbnail.toString());
|
|
229
|
+
}
|
|
220
230
|
const _maybeEncodedRequest = yield _request.getRequest();
|
|
221
231
|
const _response = yield core.fetcher({
|
|
222
232
|
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
233
|
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.
|
|
234
|
+
headers: Object.assign(Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), _maybeEncodedRequest.headers), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
225
235
|
requestType: "file",
|
|
226
236
|
duplex: _maybeEncodedRequest.duplex,
|
|
227
237
|
body: _maybeEncodedRequest.body,
|
|
@@ -289,7 +299,7 @@ class Assets {
|
|
|
289
299
|
const _response = yield core.fetcher({
|
|
290
300
|
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
301
|
method: "GET",
|
|
292
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
302
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
293
303
|
contentType: "application/json",
|
|
294
304
|
requestType: "json",
|
|
295
305
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -298,7 +308,7 @@ class Assets {
|
|
|
298
308
|
});
|
|
299
309
|
if (_response.ok) {
|
|
300
310
|
return {
|
|
301
|
-
data: serializers.
|
|
311
|
+
data: serializers.AssetDetail.parseOrThrow(_response.body, {
|
|
302
312
|
unrecognizedObjectKeys: "passthrough",
|
|
303
313
|
allowUnrecognizedUnionMembers: true,
|
|
304
314
|
allowUnrecognizedEnumValues: true,
|
|
@@ -339,25 +349,41 @@ class Assets {
|
|
|
339
349
|
/**
|
|
340
350
|
* This method deletes the specified asset. This action cannot be undone.
|
|
341
351
|
*
|
|
352
|
+
* By default, the platform checks whether any indexed assets reference the asset. If references exist, the platform rejects the request with a `409 Conflict` error. To skip this check and delete the asset anyway, set the `force` query parameter to `true`. The platform unlinks any entity associations.
|
|
353
|
+
*
|
|
354
|
+
* Before deleting, you can inspect existing references:
|
|
355
|
+
* - [`GET`](/v1.3/api-reference/index-content/list-indexed-assets-by-asset) `/assets/{asset_id}/indexed-assets` returns a list of the indexed assets that will block deletion unless the `force` query parameter is set to `true`.
|
|
356
|
+
* - [`GET`](/v1.3/api-reference/entities/list-entities-by-asset) `/assets/{asset_id}/entities` returns a list of the entities whose associations the platform will unlink.
|
|
357
|
+
*
|
|
342
358
|
* @param {string} assetId - The unique identifier of the asset to delete.
|
|
359
|
+
* @param {TwelvelabsApi.AssetsDeleteRequest} request
|
|
343
360
|
* @param {Assets.RequestOptions} requestOptions - Request-specific configuration.
|
|
344
361
|
*
|
|
345
362
|
* @throws {@link TwelvelabsApi.BadRequestError}
|
|
363
|
+
* @throws {@link TwelvelabsApi.ConflictError}
|
|
346
364
|
*
|
|
347
365
|
* @example
|
|
348
|
-
* await client.assets.delete("6298d673f1090f1100476d4c"
|
|
366
|
+
* await client.assets.delete("6298d673f1090f1100476d4c", {
|
|
367
|
+
* force: true
|
|
368
|
+
* })
|
|
349
369
|
*/
|
|
350
|
-
delete(assetId, requestOptions) {
|
|
351
|
-
return core.HttpResponsePromise.fromPromise(this.__delete(assetId, requestOptions));
|
|
370
|
+
delete(assetId, request = {}, requestOptions) {
|
|
371
|
+
return core.HttpResponsePromise.fromPromise(this.__delete(assetId, request, requestOptions));
|
|
352
372
|
}
|
|
353
|
-
__delete(
|
|
354
|
-
return __awaiter(this,
|
|
373
|
+
__delete(assetId_1) {
|
|
374
|
+
return __awaiter(this, arguments, void 0, function* (assetId, request = {}, requestOptions) {
|
|
355
375
|
var _a, _b;
|
|
376
|
+
const { force } = request;
|
|
377
|
+
const _queryParams = {};
|
|
378
|
+
if (force != null) {
|
|
379
|
+
_queryParams["force"] = force.toString();
|
|
380
|
+
}
|
|
356
381
|
const _response = yield core.fetcher({
|
|
357
382
|
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
383
|
method: "DELETE",
|
|
359
|
-
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.
|
|
384
|
+
headers: Object.assign(Object.assign({ "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "twelvelabs-js", "X-Fern-SDK-Version": "1.2.3", "User-Agent": "twelvelabs-js/1.2.3", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, (yield this._getCustomAuthorizationHeaders())), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
360
385
|
contentType: "application/json",
|
|
386
|
+
queryParameters: _queryParams,
|
|
361
387
|
requestType: "json",
|
|
362
388
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
363
389
|
maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
|
|
@@ -370,6 +396,8 @@ class Assets {
|
|
|
370
396
|
switch (_response.error.statusCode) {
|
|
371
397
|
case 400:
|
|
372
398
|
throw new TwelvelabsApi.BadRequestError(_response.error.body, _response.rawResponse);
|
|
399
|
+
case 409:
|
|
400
|
+
throw new TwelvelabsApi.ConflictError(_response.error.body, _response.rawResponse);
|
|
373
401
|
default:
|
|
374
402
|
throw new errors.TwelvelabsApiError({
|
|
375
403
|
statusCode: _response.error.statusCode,
|
|
@@ -16,9 +16,21 @@ export interface AssetsCreateRequest {
|
|
|
16
16
|
/**
|
|
17
17
|
* Specify this parameter to upload a file from a publicly accessible URL. This parameter is required when `method` is set to `url`.
|
|
18
18
|
*
|
|
19
|
-
* URL uploads have a maximum limit of
|
|
19
|
+
* URL uploads have a maximum limit of 4 GB.
|
|
20
20
|
*/
|
|
21
21
|
url?: string;
|
|
22
22
|
/** The optional filename of the asset. If not provided, the platform will determine the filename from the file or URL. */
|
|
23
23
|
filename?: string;
|
|
24
|
+
/**
|
|
25
|
+
* When set to `true`, the platform generates an HLS playlist and segments for streaming. Applicable to video and audio assets only.
|
|
26
|
+
*
|
|
27
|
+
* **Default**: `false`.
|
|
28
|
+
*/
|
|
29
|
+
enableHls?: boolean;
|
|
30
|
+
/**
|
|
31
|
+
* When set to `true`, the platform generates thumbnail images from the uploaded content.
|
|
32
|
+
*
|
|
33
|
+
* **Default**: `false`.
|
|
34
|
+
*/
|
|
35
|
+
enableThumbnail?: boolean;
|
|
24
36
|
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
/**
|
|
5
|
+
* @example
|
|
6
|
+
* {
|
|
7
|
+
* force: true
|
|
8
|
+
* }
|
|
9
|
+
*/
|
|
10
|
+
export interface AssetsDeleteRequest {
|
|
11
|
+
/**
|
|
12
|
+
* When set to `true`, the platform deletes the asset even if indexed assets reference it. When set to `false` or omitted, the request fails with `409 Conflict` if references exist.
|
|
13
|
+
*
|
|
14
|
+
* **Default**: `false`.
|
|
15
|
+
*/
|
|
16
|
+
force?: boolean;
|
|
17
|
+
}
|
|
@@ -6,7 +6,8 @@ import * as TwelvelabsApi from "../../../../index";
|
|
|
6
6
|
* @example
|
|
7
7
|
* {
|
|
8
8
|
* page: 1,
|
|
9
|
-
* pageLimit: 10
|
|
9
|
+
* pageLimit: 10,
|
|
10
|
+
* filename: "meeting"
|
|
10
11
|
* }
|
|
11
12
|
*/
|
|
12
13
|
export interface AssetsListRequest {
|
|
@@ -31,4 +32,8 @@ export interface AssetsListRequest {
|
|
|
31
32
|
* Filters the response to include only assets of the specified types. Provide one or more asset types. When you specify multiple types, the platform returns all matching assets.
|
|
32
33
|
*/
|
|
33
34
|
assetTypes?: TwelvelabsApi.AssetsListRequestAssetTypesItem | TwelvelabsApi.AssetsListRequestAssetTypesItem[];
|
|
35
|
+
/**
|
|
36
|
+
* Filters the response to include only assets whose filename contains the specified string. The match is case-insensitive and supports partial matching.
|
|
37
|
+
*/
|
|
38
|
+
filename?: string;
|
|
34
39
|
}
|