You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -226,7 +226,7 @@ This endpoint generates open-ended texts based on your videos, including but not
226
226
227
227
<Notetitle="Notes">
228
228
- This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
229
-
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Streaming response](/v1.3/docs/guides/generate-text-from-video/open-ended-text#streaming-responses) guide.
229
+
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses) guide.
230
230
</Note>
231
231
</dd>
232
232
</dl>
@@ -351,7 +351,7 @@ This endpoint analyzes your videos and creates fully customizable text based on
351
351
352
352
<Notetitle="Notes">
353
353
- This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
354
-
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Streaming response](/v1.3/docs/guides/generate-text-from-video/open-ended-text#streaming-responses) guide.
354
+
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses) guide.
355
355
</Note>
356
356
</dd>
357
357
</dl>
@@ -465,7 +465,7 @@ This endpoint analyzes your videos and creates fully customizable text based on
465
465
466
466
<Notetitle="Notes">
467
467
- This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
468
-
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Streaming response](/v1.3/docs/guides/generate-text-from-video/open-ended-text#streaming-responses) guide.
468
+
- This endpoint supports streaming responses. For details on integrating this feature into your application, refer to the [Open-ended analysis](/v1.3/docs/guides/analyze-videos/open-ended-analysis#streaming-responses) guide.
469
469
</Note>
470
470
</dd>
471
471
</dl>
@@ -800,7 +800,7 @@ Upload options:
800
800
-**Duration**: For Marengo, it must be between 4 seconds and 2 hours (7,200s). For Pegasus, it must be between 4 seconds and 60 minutes (3600s). In a future release, the maximum duration for Pegasus will be 2 hours (7,200 seconds).
801
801
-**File size**: Must not exceed 2 GB.
802
802
If you require different options, contact us at support@twelvelabs.io.
803
-
803
+
804
804
If both Marengo and Pegasus are enabled for your index, the most restrictive prerequisites will apply.
- The "Marengo-retrieval-2.7" video understanding model generates embeddings for all modalities in the same latent space. This shared space enables any-to-any searches across different types of content.
1575
+
- The Marengo video understanding model generates embeddings for all modalities in the same latent space. This shared space enables any-to-any searches across different types of content.
1670
1576
- You can create multiple types of embeddings in a single API call.
1671
1577
- Audio embeddings combine generic sound and human speech in a single embedding. For videos with transcriptions, you can retrieve transcriptions and then [create text embeddings](/v1.3/api-reference/text-image-audio-embeddings/create-text-image-audio-embeddings) from these transcriptions.
1672
1578
</Note>
@@ -1768,7 +1674,7 @@ typing.Optional[core.File]` — See core.File for more documentation
1768
1674
<dl>
1769
1675
<dd>
1770
1676
1771
-
**audio_url:**`typing.Optional[str]` — The publicly accessible URL of the audio file for which you wish to creae an embedding. This parameter is required for audio embeddings if `audio_file` is not provided.
1677
+
**audio_url:**`typing.Optional[str]` — The publicly accessible URL of the audio file for which you wish to create an embedding. This parameter is required for audio embeddings if `audio_file` is not provided.
1772
1678
1773
1679
</dd>
1774
1680
</dl>
@@ -2010,9 +1916,6 @@ When you perform a search specifying multiple [sources of information](/v1.3/doc
2010
1916
2011
1917
-`and`
2012
1918
2013
-
For details and examples, see the [Using multiple sources of information](/v1.3/docs/guides/search/queries/text-queries#visual-and-audio) section.
2014
-
2015
-
2016
1919
**Default**: `or`.
2017
1920
2018
1921
</dd>
@@ -2039,11 +1942,11 @@ Specifies a stringified JSON object to filter your search results. Supports both
2039
1942
2040
1943
**Syntax for filtering**
2041
1944
2042
-
The following table describes the supported data types, operators, and filter syntax:
1945
+
The following table describes the supported data types, operators, and filter syntax:
2043
1946
2044
1947
| Data type | Operator | Description | Syntax |
2045
1948
|:----------|:---------|:------------|:-------|
2046
-
| String | `=` | Matches results equal to the specified value. | `{"field": "value"}`
1949
+
| String | `=` | Matches results equal to the specified value. | `{"field": "value"}`
2047
1950
| Array of strings |`=`| Matches results with any value in the specified array. Supported only for `id`. |`{"id": ["value1", "value2"]}`|
2048
1951
| Numeric (integer, float) |`=`, `lte`, `gte`| Matches results equal to or within a range of the specified value. |`{"field": number}` or `{"field": { "gte": number, "lte": number }}`|
2049
1952
| Boolean |`=`| Matches results equal to the specified boolean value. |`{"field": true}` or `{"field": false}`. |
@@ -2059,8 +1962,8 @@ The table below describes the system-generated metadata available for filtering
2059
1962
|`duration`| Filters based on the duration of the video containing the segment that matches your query. | Number or object with `gte` and `lte`|`{"duration": 600}` or `{"duration": { "gte": 600, "lte": 800 }}`|
2060
1963
|`width`| Filters by video width (in pixels). | Number or object with `gte` and `lte`|`{"width": 1920}` or `{"width": { "gte": 1280, "lte": 1920}}`|
2061
1964
|`height`| Filters by video height (in pixels). | Number or object with `gte` and `lte`. |`{"height": 1080}` or `{"height": { "gte": 720, "lte": 1080 }}`. |
2062
-
|`size`| Filters by video size (in bytes) | Number or object with `gte` and `lte`. |`{"size": 1048576}` or `{"size": { "gte": 1048576, "lte": 5242880}}`|
2063
-
|`filename`| Filters by the exact file name. | String |`{"filename": "Animal Encounters part 1"}`|
1965
+
|`size`| Filters by video size (in bytes) | Number or object with `gte` and `lte`. |`{"size": 1048576}` or `{"size": { "gte": 1048576, "lte": 5242880}}`|
1966
+
|`filename`| Filters by the exact file name. | String |`{"filename": "Animal Encounters part 1"}`|
2064
1967
2065
1968
<br/>
2066
1969
**User-defined metadata**
@@ -2337,7 +2240,7 @@ Specify at least one option. If both are provided, `video_url` takes precedence.
2337
2240
</Accordion>
2338
2241
2339
2242
<Notetitle="Notes">
2340
-
- The "Marengo-retrieval-2.7" video understanding model generates embeddings for all modalities in the same latent space. This shared space enables any-to-any searches across different types of content.
2243
+
- The Marengo video understanding model generates embeddings for all modalities in the same latent space. This shared space enables any-to-any searches across different types of content.
2341
2244
- Video embeddings are stored for seven days.
2342
2245
- The platform supports uploading video files that can play without additional user interaction or custom video players. Ensure your URL points to the raw video file, not a web page containing the video. Links to third-party hosting sites, cloud storage services, or videos requiring extra steps to play are not supported.
2343
2246
</Note>
@@ -2950,7 +2853,7 @@ To retrieve embeddings for a video, it must be indexed using the Marengo video u
2950
2853
2951
2854
The platform does not return embeddings if you don't provide this parameter.
2952
2855
2953
-
The values you specify in `embedding_option` must be included in the `model_options` defined when the index was created. For example, if `model_options` is set to `visual,` you cannot set `embedding_option` to `audio` or both `visual-text` and `audio`.
2856
+
The values you specify in `embedding_option` must be included in the `model_options` defined when the index was created. For example, if `model_options` is set to `visual` only, then you cannot set `embedding_option` to `audio` or both `visual-text` and `audio`.
2954
2857
2955
2858
</dd>
2956
2859
</dl>
@@ -2978,7 +2881,7 @@ The values you specify in `embedding_option` must be included in the `model_opti
0 commit comments