twelvelabs-js 1.2.9 → 1.3.0

package/api/resources/knowledgeStores/client/Client.d.ts

@@ -0,0 +1,169 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as TwelvelabsApi from "../../../index";
+export declare namespace KnowledgeStores {
+    interface Options {
+        environment?: core.Supplier<environments.TwelvelabsApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class KnowledgeStores {
+    protected readonly _options: KnowledgeStores.Options;
+    constructor(_options: KnowledgeStores.Options);
+    /**
+     * This method returns a list of the knowledge stores in your account.
+     *
+     * @param {TwelvelabsApi.KnowledgeStoresListRequest} request
+     * @param {KnowledgeStores.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStores.list({
+     *         page: 1,
+     *         pageLimit: 10,
+     *         sortBy: "created_at",
+     *         sortOption: "desc"
+     *     })
+     */
+    list(request?: TwelvelabsApi.KnowledgeStoresListRequest, requestOptions?: KnowledgeStores.RequestOptions): Promise<core.Page<TwelvelabsApi.KnowledgeStore>>;
+    /**
+     * This method creates a knowledge store.
+     *
+     * Provide a name. Optionally include a description, a metadata map, and an `ingestion_config` object that controls how content added to the store is processed. The `ingestion_config` object is immutable after creation.
+     *
+     * @param {TwelvelabsApi.KnowledgeStoresCreateRequest} request
+     * @param {KnowledgeStores.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStores.create({
+     *         name: "Product Demo Analysis"
+     *     })
+     */
+    create(request: TwelvelabsApi.KnowledgeStoresCreateRequest, requestOptions?: KnowledgeStores.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStore>;
+    private __create;
+    /**
+     * This method retrieves the details of a specific knowledge store.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {KnowledgeStores.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStores.retrieve("ks_069e9869-1ea3-7481-8000-dae72bf6be6e")
+     */
+    retrieve(knowledgeStoreId: string, requestOptions?: KnowledgeStores.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStore>;
+    private __retrieve;
+    /**
+     * This method deletes the specified knowledge store and all its items.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {KnowledgeStores.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStores.delete("ks_069e9869-1ea3-7481-8000-dae72bf6be6e")
+     */
+    delete(knowledgeStoreId: string, requestOptions?: KnowledgeStores.RequestOptions): core.HttpResponsePromise<void>;
+    private __delete;
+    /**
+     * This method updates the specified knowledge store. Only the `name`, `description`, and `metadata` fields can be updated.
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {TwelvelabsApi.KnowledgeStoresUpdateRequest} request
+     * @param {KnowledgeStores.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     *
+     * @example
+     *     await client.knowledgeStores.update("ks_069e9869-1ea3-7481-8000-dae72bf6be6e")
+     */
+    update(knowledgeStoreId: string, request?: TwelvelabsApi.KnowledgeStoresUpdateRequest, requestOptions?: KnowledgeStores.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.KnowledgeStore>;
+    private __update;
+    /**
+     * This method searches a knowledge store using natural language and returns matching video clips and images ranked by relevance.
+     *
+     * Provide your natural-language query in the `query.text` field. Use the `filter` parameter to choose which items to search: by type of item (the `asset_type` field) or by specific items (the `item_id` field). Use the optional `search_options` parameter to control how videos are matched (by visual content, audio, or both). If you omit it, videos are matched on their visual content. Images are always matched on their visual content.
+     *
+     * By default, each result is an individual match: a video clip or an image. Set the `group_by` parameter to `item` to group clips under their parent item.
+     *
+     * <Note title="Note">
+     * This endpoint is rate-limited. For details, see the [Rate limits](/v1.3/docs/get-started/rate-limits) page.
+     * </Note>
+     *
+     * @param {string} knowledgeStoreId - The unique identifier of the knowledge store.
+     * @param {TwelvelabsApi.SearchKnowledgeStoreRequest} request
+     * @param {KnowledgeStores.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link TwelvelabsApi.BadRequestError}
+     * @throws {@link TwelvelabsApi.NotFoundError}
+     * @throws {@link TwelvelabsApi.GoneError}
+     * @throws {@link TwelvelabsApi.TooManyRequestsError}
+     *
+     * @example
+     *     await client.knowledgeStores.search("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", {
+     *         query: {
+     *             text: "A person cooking pasta"
+     *         },
+     *         searchOptions: {
+     *             video: {
+     *                 modalities: ["visual", "audio"]
+     *             }
+     *         },
+     *         groupBy: "none",
+     *         pageSize: 10
+     *     })
+     *
+     * @example
+     *     await client.knowledgeStores.search("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", {
+     *         query: {
+     *             text: "A person cooking pasta"
+     *         },
+     *         filter: {
+     *             assetType: {
+     *                 in: ["video"]
+     *             }
+     *         },
+     *         searchOptions: {
+     *             video: {
+     *                 modalities: ["visual", "audio"]
+     *             }
+     *         },
+     *         groupBy: "none",
+     *         pageSize: 10
+     *     })
+     *
+     * @example
+     *     await client.knowledgeStores.search("ks_069e9869-1ea3-7481-8000-dae72bf6be6e", {
+     *         query: {
+     *             text: "A person cooking pasta"
+     *         },
+     *         groupBy: "none",
+     *         pageSize: 10
+     *     })
+     */
+    search(knowledgeStoreId: string, request: TwelvelabsApi.SearchKnowledgeStoreRequest, requestOptions?: KnowledgeStores.RequestOptions): core.HttpResponsePromise<TwelvelabsApi.SearchKnowledgeStoreResponse>;
+    private __search;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        "x-api-key": string;
+    }>;
+}