twelvelabs-js 0.1.0

package/LICENSE

@@ -0,0 +1,183 @@
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+

package/README.md

@@ -0,0 +1,278 @@
+# TwelveLabs JavaScript SDK
+
+This SDK provides a convenient way to interact with the Twelve Labs Video Understanding Platform from an application written in JavaScript or TypeScript language. The SDK equips you with a set of intuitive methods that streamline the process of interacting with the platform, minimizing the need for boilerplate code.
+
+
+# Prerequisites
+
+Ensure that the following prerequisites are met before using the SDK:
+
+-  [Node.js](https://nodejs.org/) 14 or newer must be installed on your machine.
+-  You have an API key. If you don't have an account, please [sign up](https://api.twelvelabs.io/) for a free account. Then, to retrieve your API key, go to the [Dashboard](https://api.twelvelabs.io/dashboard) page, and select the **Copy** icon to the right of the key to copy it to your clipboard.
+
+# Install the SDK
+
+Install the `twelvelabs-js` package:
+
+```sh
+yarn add twelvelabs-js # or npm i twelvelabs-js
+```
+
+# Initialize the SDK
+
+1. Import the required packages into your application:
+
+  ```js
+  import { TwelveLabs, SearchData, Task } from 'twelvelabs-js';
+  import { promises as fsPromises } from 'fs';
+  import * as path from 'path';
+  ```
+
+2. Instantiate the SDK client with your API key. This example code assumes that your API key is stored in an environment variable named `TL_API_KEY`:
+
+  ```js
+  const client = new TwelveLabs({ apiKey: '<YOUR_API_KEY>' });
+  ```
+
+# Use the SDK
+
+To get started with the SDK, follow these basic steps:
+
+1. Create an index.
+2. Upload videos.
+3. Perform downstream tasks, such as searching or generating text from video.
+
+## Create an index
+
+To create an index, use the example code below, replacing '<YOUR_INDEX_NAME>' with the desired name for your index:
+
+```js
+let index = await client.index.create({
+  name: '<YOUR_INDEX_NAME>',
+  engines: [
+    {
+      name: 'marengo2.6',
+      options: ['visual', 'conversation', 'text_in_video'],
+    },
+    {
+      name: 'pegasus1',
+      options: ['visual', 'conversation'],
+    },
+  ],
+});
+
+console.log(`Created index: id=${index.id} name=${index.name} engines=${JSON.stringify(index.engines)}`);
+```
+
+Note the following about this example:
+- The platform provides two distinct engine types - embedding and generative, each serving unique purposes in multimodal video understanding.
+  - **Embedding engines (Marengo)**: These engines are proficient at performing tasks such as search and classification, enabling enhanced video understanding.
+  - **Generative engines (Pegasus)**: These engines generate text based on your videos.
+  For your index, both Marengo and Pegasus are enabled.
+- The `engines.options` fields specify the types of information each video understanding engine will process. For details, see the [Engine options](https://docs.twelvelabs.io/v1.2/docs/engine-options) page.
+- The engines and the engine options specified when you create an index apply to all the videos you upload to that index and cannot be changed. For details, see the [Engine options](https://docs.twelvelabs.io/v1.2/docs/engine-options) page.
+
+The output should look similar to the following:
+
+```
+Created index: id=65e71802bb29f13bdd6f38d8 name=2024-03-05T13:02:57.938Z engines=[{"name":"pegasus1","options":["visual","conversation"]},{"name":"marengo2.6","options":["visual","conversation","text_in_video"]}]
+```
+
+Note that the API returns, among other information, a field named `id`, representing the unique identifier of your new index.
+
+For a description of each field in the request and response, see the [Create an index](https://docs.twelvelabs.io/v1.2/reference/create-index) page.
+
+
+## Upload videos
+
+Before you upload a video to the platform, ensure that it meets the following requirements:
+
+- **Video resolution**: Must be greater or equal than 360p and less or equal than 4K. For consistent search results, Twelve Labs recommends you upload 360p videos.
+- **Duration**: For Marengo, it must be between 4 seconds and 2 hours (7,200s). For Pegasus, it must be between 4 seconds and 20 minutes (1200s).
+- **File size**: Must not exceed 2 GB. If you require different options, send us an email at support@twelvelabs.io.
+- **Audio track**: If the `conversation` [engine option](https://docs.twelvelabs.io/v1.2/docs/engine-options) is selected, the video you're uploading must contain an audio track.
+
+To upload videos, use the example code below, replacing the following:
+
+- **`<YOUR_VIDEO_PATH>`**: with a string representing the path to the directory containing the video files you wish to upload.
+- **`<YOUR_INDEX_ID>`**: with a string representing the unique identifier of the index to which you want to upload your video.
+
+
+```js
+const files = await fsPromises.readdir('YOUR_VIDEO_PATH');
+for (const file of files) {
+  const filePath = path.join(__dirname, file);
+  console.log(`Uploading ${filePath}`);
+  const task = await client.task.create({
+    indexId: '<YOUR_INDEX_ID>'
+    file: filePath,
+  });
+  console.log(`Created task: id=${task.id}`);
+  await task.waitForDone(50, (task: Task) => {
+    console.log(`  Status=${task.status}`);
+  });
+  if (task.status !== 'ready') {
+    throw new Error(`Indexing failed with status ${task.status}`);
+  }
+  console.log(`Uploaded ${videoPath}. The unique identifer of your video is ${task.videoId}`);
+}
+```
+
+Note that once a video has been successfully uploaded and indexed, the response will contain a field named `videoId`, representing the unique identifier of your video.
+
+For a description of each field in the request and response, see the [Create a video indexing task](https://docs.twelvelabs.io/reference/create-video-indexing-task) page.
+
+## Perform downstream tasks
+
+The sections below show how you can perform the most common downstream tasks. See [our documentation](https://docs.twelvelabs.io/docs) for a complete list of all the features the Twelve Labs Understanding Platform provides.
+
+### Search
+
+To perform a search request, use the example code below, replacing the following:
+
+- **`<YOUR_INDEX_ID>`**: with a string representing the unique identifier of your index.
+- **`<YOUR_QUERY>`**: with a string representing your search query. Note that the API supports full natural language-based search. The following examples are valid queries: "birds flying near a castle," "sun shining on water," and "an officer holding a child's hand."
+- **`[<YOUR_SEARCH_OPTIONS>]`**: with an array of strings that specifies the sources of information the platform uses when performing a search. For example, to search based on visual and conversation cues, use `["visual", "conversation"]`. Note that the search options you specify must be a subset of the engine options used when you created the index. For more details, see the [Search options](https://docs.twelvelabs.io/docs/search-options) page.
+
+```js
+let searchResults = await client.search.query({
+  indexId: '<YOUR_INDEX_ID>'
+  query: '<YOUR_QUERY>',
+  options: ['<YOUR_SEARCH_OPTIONS>'],
+});
+printPage(searchResults.data);
+while (true) {
+  const page = await searchResults.next();
+  if (page === null) break;
+  else printPage(page);
+}
+
+// Utility function to print a specific page
+function printPage(searchData) {
+  (searchData as SearchData[]).forEach((clip) => {
+    console.log(
+      `video_id= ${clip.videoId} score=${clip.score} start=${clip.start} end=${clip.end} confidence=${clip.confidence}`,
+    );
+  });
+}
+```
+
+The results are returned one page at a time, with a default limit of 10 results on each page. The `next ` method returns the next page of results. When you've reached the end of the dataset, the response is `null`.
+
+```
+ video_id=65ca2bce48db9fa780cb3fa4 score=84.9 start=104.9375 end=111.90625 confidence=high
+ video_id=65ca2bce48db9fa780cb3fa4 score=84.82 start=160.46875 end=172.75 confidence=high
+ video_id=65ca2bce48db9fa780cb3fa4 score=84.77 start=55.375 end=72.46875 confidence=high
+```
+
+
+Note that the response contains, among other information, the following fields:
+- `videoId`: The unique identifier of the video that matched your search terms.
+- `score`: A quantitative value determined by the AI engine representing the level of confidence that the results match your search terms.
+- `start`: The start time of the matching video clip, expressed in seconds.
+- `end`: The end time of the matching video clip, expressed in seconds.
+- `confidence`: A qualitative indicator based on the value of the score field. This field can take one of the following values:
+  - `high`
+  - `medium`
+  - `low`
+  - `extremely low`
+
+
+For a description of each field in the request and response, see the [Make a search request](https://docs.twelvelabs.io/v1.2/reference/make-search-request) page.
+
+### Generate text from video
+
+The Twelve Labs Video Understanding Platform offers three distinct endpoints tailored to meet various requirements. Each endpoint has been designed with specific levels of flexibility and customization to accommodate different needs.
+
+Note the following about using these endpoints:
+- The Pegasus video understanding engine must be enabled for the index to which your video has been uploaded.
+- Your prompts must be instructive or descriptive, and you should not phrase them as questions.
+- The maximum length of a prompt is 300 characters.
+
+#### Topics, titles, and hashtags
+
+To generate topics, titles, and hashtags, use the example code below, replacing the following:
+
+- **`<YOUR_VIDEO_ID>`**: with a string representing the unique identifier of your video.
+- **`[<TYPES>]`**: with an array of strings representing the type of text the platform should generate. Example: `["title", "topic", "hashtag"]`.
+
+```py
+const gist = await client.generate.gist('<YOUR_VIDEO_ID>', ['<TYPES>']);
+console.log(`Title: ${gist.title}\nTopics=${gist.topics}\nHashtags=${gist.hashtags}`);
+```
+
+For a description of each field in the request and response, see the [Titles, topics, or hashtags](https://docs.twelvelabs.io/v1.2/reference/generate-gist) page.
+
+#### Summaries, chapters, and highlights
+
+To generate summaries, chapters, and highlights, use the example code below, replacing the following:
+
+- **`<YOUR_VIDEO_ID>`**: with a string representing the unique identifier of your video.
+- **`<TYPE>`**: with a string representing the type of text the platform should generate. This parameter can take one of the following values: "summary", "chapter", or "highlight".
+- _(Optional)_ **`<YOUR_PROMPT>`**: with a string that provides context for the summarization task, such as the target audience, style, tone of voice, and purpose. Example:  "Generate a summary in no more than 5 bullet points."
+
+
+```js
+const summary = await client.generate.summarize('<YOUR_VIDEO_ID>', '<TYPE>');
+console.log(`Summary: ${summary.summary}`);
+```
+
+For a description of each field in the request and response, see the [Summaries, chapters, or highlights](https://docs.twelvelabs.io/v1.2/docs/generate-summaries-chapters-highlights) page.
+
+#### Open-ended texts
+
+To generate open-ended texts, use the example code below, replacing the following:
+- **`<YOUR_VIDEO_ID>`**: with a string representing the unique identifier of your video.
+- **`<YOUR_PROMPT>`**: with a string that guides the model on the desired format or content. The maximum length of the prompt is 500 tokens or roughly 350 words. Example:  "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."
+
+```py
+const text = await client.generate.text('<YOUR_VIDEO_ID>', '<YOUR_PROMPT>');
+console.log(`Open-ended Text: ${text.data}`);
+```
+
+## Error Handling
+
+The SDK includes a set of exceptions that are mapped to specific HTTP status codes, as shown in the table below:
+
+| Exception | HTTP Status Code |
+|----------|----------|
+| BadRequestError| 400 |
+| AuthenticationError | 401 |
+| PermissionDeniedError  | 403 |
+| NotFoundError | 404 |
+| ConflictError | 409 |
+| UnprocessableEntityError | 422 |
+| RateLimitError | 429 |
+| InternalServerError | 5xx |
+
+The following example shows how you can handle specific HTTP errors in your application:
+
+```js
+try {
+  let index = await client.index.create({
+    name: '<YOUR_INDEX_NAME>',
+    engines: [
+      {
+        name: 'marengo2.6',
+        options: ['visual', 'conversation'],
+      },
+    ],
+  });
+  console.log(`Created index: id=${index.id} name=${index.name} engines=${JSON.stringify(index.engines)}`);
+} catch (e) {
+  console.log(e);
+}
+```
+
+# License
+
+We use the Developer Certificate of Origin (DCO) in lieu of a Contributor License Agreement for all contributions to Twelve Labs' open-source projects. We request that contributors agree to the terms of the DCO and indicate that agreement by signing all commits made to Twelve Labs' projects by adding a line with your name and email address to every Git commit message contributed, as shown in the example below:
+
+```
+Signed-off-by: Jane Doe <jane.doe@example.com>
+```
+
+You can sign your commit automatically with Git by using `git commit -s` if you have your `user.name` and `user.email` set as part of your Git configuration.
+We ask that you use your real name (please, no anonymous contributions or pseudonyms). By signing your commitment, you are certifying that you have the right have the right to submit it under the open-source license used by that particular project. You must use your real name (no pseudonyms or anonymous contributions are allowed.)
+We use the Probot DCO GitHub app to check for DCO signoffs of every commit.
+If you forget to sign your commits, the DCO bot will remind you and give you detailed instructions for how to amend your commits to add a signature.