@usecortex_ai/node 0.1.2 → 0.2.0

package/dist/Client.d.ts

@@ -8,6 +8,7 @@ import { Sources } from "./api/resources/sources/client/Client.js";
 import { UserMemory } from "./api/resources/userMemory/client/Client.js";
 import { Fetch } from "./api/resources/fetch/client/Client.js";
 import { Upload } from "./api/resources/upload/client/Client.js";
+import { Document } from "./api/resources/document/client/Client.js";
 import { Embeddings } from "./api/resources/embeddings/client/Client.js";
 import { User } from "./api/resources/user/client/Client.js";
 import { Tenant } from "./api/resources/tenant/client/Client.js";
@@ -16,7 +17,7 @@ export declare namespace CortexAIClient {
         environment?: core.Supplier<environments.CortexAIEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -40,25 +41,18 @@ export declare class CortexAIClient {
     protected _userMemory: UserMemory | undefined;
     protected _fetch: Fetch | undefined;
     protected _upload: Upload | undefined;
+    protected _document: Document | undefined;
     protected _embeddings: Embeddings | undefined;
     protected _user: User | undefined;
     protected _tenant: Tenant | undefined;
-    constructor(_options?: CortexAIClient.Options);
+    constructor(_options: CortexAIClient.Options);
     get search(): Search;
     get sources(): Sources;
     get userMemory(): UserMemory;
     get fetch(): Fetch;
     get upload(): Upload;
+    get document(): Document;
     get embeddings(): Embeddings;
     get user(): User;
     get tenant(): Tenant;
-    /**
-     * @param {CortexAIClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.rootGet()
-     */
-    rootGet(requestOptions?: CortexAIClient.RequestOptions): core.HttpResponsePromise<unknown>;
-    private __rootGet;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/Client.js

@@ -27,20 +27,19 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CortexAIClient = void 0;
-const environments = __importStar(require("./environments.js"));
 const core = __importStar(require("./core/index.js"));
 const headers_js_1 = require("./core/headers.js");
-const errors = __importStar(require("./errors/index.js"));
 const Client_js_1 = require("./api/resources/search/client/Client.js");
 const Client_js_2 = require("./api/resources/sources/client/Client.js");
 const Client_js_3 = require("./api/resources/userMemory/client/Client.js");
 const Client_js_4 = require("./api/resources/fetch/client/Client.js");
 const Client_js_5 = require("./api/resources/upload/client/Client.js");
-const Client_js_6 = require("./api/resources/embeddings/client/Client.js");
-const Client_js_7 = require("./api/resources/user/client/Client.js");
-const Client_js_8 = require("./api/resources/tenant/client/Client.js");
+const Client_js_6 = require("./api/resources/document/client/Client.js");
+const Client_js_7 = require("./api/resources/embeddings/client/Client.js");
+const Client_js_8 = require("./api/resources/user/client/Client.js");
+const Client_js_9 = require("./api/resources/tenant/client/Client.js");
 class CortexAIClient {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-Runtime": core.RUNTIME.type,
@@ -67,71 +66,21 @@ class CortexAIClient {
         var _a;
         return ((_a = this._upload) !== null && _a !== void 0 ? _a : (this._upload = new Client_js_5.Upload(this._options)));
     }
+    get document() {
+        var _a;
+        return ((_a = this._document) !== null && _a !== void 0 ? _a : (this._document = new Client_js_6.Document(this._options)));
+    }
     get embeddings() {
         var _a;
-        return ((_a = this._embeddings) !== null && _a !== void 0 ? _a : (this._embeddings = new Client_js_6.Embeddings(this._options)));
+        return ((_a = this._embeddings) !== null && _a !== void 0 ? _a : (this._embeddings = new Client_js_7.Embeddings(this._options)));
     }
     get user() {
         var _a;
-        return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new Client_js_7.User(this._options)));
+        return ((_a = this._user) !== null && _a !== void 0 ? _a : (this._user = new Client_js_8.User(this._options)));
     }
     get tenant() {
         var _a;
-        return ((_a = this._tenant) !== null && _a !== void 0 ? _a : (this._tenant = new Client_js_8.Tenant(this._options)));
-    }
-    /**
-     * @param {CortexAIClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.rootGet()
-     */
-    rootGet(requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__rootGet(requestOptions));
-    }
-    async __rootGet(requestOptions) {
-        var _a, _b, _c;
-        let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
-        const _response = await core.fetcher({
-            url: (_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd,
-            method: "GET",
-            headers: _headers,
-            queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-            timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-            maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
-            abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-        });
-        if (_response.ok) {
-            return { data: _response.body, rawResponse: _response.rawResponse };
-        }
-        if (_response.error.reason === "status-code") {
-            throw new errors.CortexAIError({
-                statusCode: _response.error.statusCode,
-                body: _response.error.body,
-                rawResponse: _response.rawResponse,
-            });
-        }
-        switch (_response.error.reason) {
-            case "non-json":
-                throw new errors.CortexAIError({
-                    statusCode: _response.error.statusCode,
-                    body: _response.error.rawBody,
-                    rawResponse: _response.rawResponse,
-                });
-            case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling GET /.");
-            case "unknown":
-                throw new errors.CortexAIError({
-                    message: _response.error.errorMessage,
-                    rawResponse: _response.rawResponse,
-                });
-        }
-    }
-    async _getAuthorizationHeader() {
-        const bearer = await core.Supplier.get(this._options.token);
-        if (bearer != null) {
-            return `Bearer ${bearer}`;
-        }
-        return undefined;
+        return ((_a = this._tenant) !== null && _a !== void 0 ? _a : (this._tenant = new Client_js_9.Tenant(this._options)));
     }
 }
 exports.CortexAIClient = CortexAIClient;

package/dist/api/resources/document/client/Client.d.ts

@@ -0,0 +1,59 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.js";
+import * as core from "../../../../core/index.js";
+import * as CortexAI from "../../../index.js";
+export declare namespace Document {
+    interface Options {
+        environment?: core.Supplier<environments.CortexAIEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token: core.Supplier<core.BearerToken>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+    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 query string parameters to include in the request. */
+        queryParams?: Record<string, unknown>;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Document {
+    protected readonly _options: Document.Options;
+    constructor(_options: Document.Options);
+    /**
+     * Remove documents and content from your knowledge base.
+     *
+     * This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
+     *
+     * Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
+     *
+     * @param {CortexAI.DeleteMemoryRequest} request
+     * @param {Document.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.document.delete({
+     *         tenant_id: "tenant_id",
+     *         source_ids: ["source_ids"]
+     *     })
+     */
+    delete(request: CortexAI.DeleteMemoryRequest, requestOptions?: Document.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteSources>;
+    private __delete;
+    protected _getAuthorizationHeader(): Promise<string>;
+}

package/dist/api/resources/document/client/Client.js

@@ -0,0 +1,128 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Document = void 0;
+const environments = __importStar(require("../../../../environments.js"));
+const core = __importStar(require("../../../../core/index.js"));
+const CortexAI = __importStar(require("../../../index.js"));
+const headers_js_1 = require("../../../../core/headers.js");
+const errors = __importStar(require("../../../../errors/index.js"));
+class Document {
+    constructor(_options) {
+        this._options = _options;
+    }
+    /**
+     * Remove documents and content from your knowledge base.
+     *
+     * This endpoint permanently deletes the specified sources from your knowledge base. Once deleted, the content will no longer be available for search or retrieval.
+     *
+     * Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
+     *
+     * @param {CortexAI.DeleteMemoryRequest} request
+     * @param {Document.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link CortexAI.BadRequestError}
+     * @throws {@link CortexAI.UnauthorizedError}
+     * @throws {@link CortexAI.ForbiddenError}
+     * @throws {@link CortexAI.NotFoundError}
+     * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.InternalServerError}
+     * @throws {@link CortexAI.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.document.delete({
+     *         tenant_id: "tenant_id",
+     *         source_ids: ["source_ids"]
+     *     })
+     */
+    delete(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__delete(request, requestOptions));
+    }
+    async __delete(request, requestOptions) {
+        var _a, _b, _c;
+        let _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: await this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+        const _response = await core.fetcher({
+            url: core.url.join((_c = (_b = (await core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (await core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CortexAIEnvironment.CortexProd, "document/delete"),
+            method: "DELETE",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+            requestType: "json",
+            body: request,
+            timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+            maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+            abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new CortexAI.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new CortexAI.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 403:
+                    throw new CortexAI.ForbiddenError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
+                case 422:
+                    throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 500:
+                    throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
+                case 503:
+                    throw new CortexAI.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.CortexAIError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        switch (_response.error.reason) {
+            case "non-json":
+                throw new errors.CortexAIError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.rawBody,
+                    rawResponse: _response.rawResponse,
+                });
+            case "timeout":
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling DELETE /document/delete.");
+            case "unknown":
+                throw new errors.CortexAIError({
+                    message: _response.error.errorMessage,
+                    rawResponse: _response.rawResponse,
+                });
+        }
+    }
+    async _getAuthorizationHeader() {
+        return `Bearer ${await core.Supplier.get(this._options.token)}`;
+    }
+}
+exports.Document = Document;

package/dist/api/resources/document/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/resources/document/client/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/resources/document/index.d.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";

package/dist/api/resources/document/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./client/index.js"), exports);

package/dist/api/resources/embeddings/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Embeddings {
         environment?: core.Supplier<environments.CortexAIEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,22 +28,11 @@ export declare namespace Embeddings {
 }
 export declare class Embeddings {
     protected readonly _options: Embeddings.Options;
-    constructor(_options?: Embeddings.Options);
+    constructor(_options: Embeddings.Options);
     /**
-     * Delete specific embedding chunks from indexed sources.
+     * Delete embedding chunks by chunk ID.
      *
-     * This endpoint deletes specified embedding chunks from the Findr backend by sending
-     * chunk IDs to the backend delete service.
-     *
-     * Args:
-     *     request (EmbeddingsDeleteRequest): The delete request containing:
-     *         - chunk_ids (List[str]): List of chunk IDs to delete
-     *         - tenant_id (str): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *     api_details (dict): Authentication details obtained from API key validation
-     *
-     * Returns:
-     *     EmbeddingsDeleteData: Success response with deletion details
+     * Use this to remove specific chunks from your embeddings index when they are no longer valid or should not appear in results.
      *
      * @param {CortexAI.EmbeddingsDeleteRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -65,21 +54,13 @@ export declare class Embeddings {
     delete(request: CortexAI.EmbeddingsDeleteRequest, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.EmbeddingsDeleteData>;
     private __delete;
     /**
-     * Search for similar embedding chunks using vector similarity.
+     * Find similar chunks using an embedding vector.
      *
-     * This endpoint performs semantic search by sending an embedding vector to the Findr backend
-     * and returns a list of the most similar chunk IDs based on vector similarity.
+     * Use this to retrieve the most similar chunk IDs to a single query embedding.
      *
-     * Args:
-     *     request (EmbeddingsSearchRequest): The search request containing:
-     *         - embeddings (List[float]): Single embedding vector for similarity search
-     *         - tenant_id (str): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *         - max_chunks (int, optional): Maximum number of chunk IDs to return (default: 10)
-     *     api_details (dict): Authentication details obtained from API key validation
      *
-     * Returns:
-     *     EmbeddingsSearchData: List of chunk IDs with similarity scores
+     * Expected outcome
+     * - You receive the closest chunk IDs with optional similarity scores.
      *
      * @param {CortexAI.EmbeddingsSearchRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -100,12 +81,9 @@ export declare class Embeddings {
     search(request: CortexAI.EmbeddingsSearchRequest, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.EmbeddingsSearchData>;
     private __search;
     /**
-     * Get embeddings based on chunk IDs.
+     * Retrieve embeddings for specific chunk IDs.
      *
-     * This endpoint returns embeddings for a list of chunk IDs.
-     *
-     * Returns:
-     *     EmbeddingsGetData: Embeddings data for the requested chunk IDs
+     * Use this when you already know the chunk IDs and need their corresponding embeddings.
      *
      * @param {CortexAI.GetEmbeddingsBasedOnChunkIdsRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -127,12 +105,9 @@ export declare class Embeddings {
     getByChunkIds(request: CortexAI.GetEmbeddingsBasedOnChunkIdsRequest, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.EmbeddingsGetData>;
     private __getByChunkIds;
     /**
-     * Create an embeddings collection for the given tenant in Findr.
-     *
-     * sub_tenant_id is set to be the same as tenant_id as per requirements.
+     * Create an embeddings collection for a tenant.
      *
-     * Returns:
-     *     EmbeddingsCreateCollectionData: Success response with collection details
+     * Use this to initialize storage so you can index and query embeddings for the tenant.
      *
      * @param {CortexAI.EmbeddingsCreateCollectionRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -152,5 +127,5 @@ export declare class Embeddings {
      */
     createCollection(request: CortexAI.EmbeddingsCreateCollectionRequest, requestOptions?: Embeddings.RequestOptions): core.HttpResponsePromise<CortexAI.EmbeddingsCreateCollectionData>;
     private __createCollection;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/api/resources/embeddings/client/Client.js

@@ -33,24 +33,13 @@ const CortexAI = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class Embeddings {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
-     * Delete specific embedding chunks from indexed sources.
+     * Delete embedding chunks by chunk ID.
      *
-     * This endpoint deletes specified embedding chunks from the Findr backend by sending
-     * chunk IDs to the backend delete service.
-     *
-     * Args:
-     *     request (EmbeddingsDeleteRequest): The delete request containing:
-     *         - chunk_ids (List[str]): List of chunk IDs to delete
-     *         - tenant_id (str): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *     api_details (dict): Authentication details obtained from API key validation
-     *
-     * Returns:
-     *     EmbeddingsDeleteData: Success response with deletion details
+     * Use this to remove specific chunks from your embeddings index when they are no longer valid or should not appear in results.
      *
      * @param {CortexAI.EmbeddingsDeleteRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -131,21 +120,13 @@ class Embeddings {
         }
     }
     /**
-     * Search for similar embedding chunks using vector similarity.
+     * Find similar chunks using an embedding vector.
      *
-     * This endpoint performs semantic search by sending an embedding vector to the Findr backend
-     * and returns a list of the most similar chunk IDs based on vector similarity.
+     * Use this to retrieve the most similar chunk IDs to a single query embedding.
      *
-     * Args:
-     *     request (EmbeddingsSearchRequest): The search request containing:
-     *         - embeddings (List[float]): Single embedding vector for similarity search
-     *         - tenant_id (str): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *         - max_chunks (int, optional): Maximum number of chunk IDs to return (default: 10)
-     *     api_details (dict): Authentication details obtained from API key validation
      *
-     * Returns:
-     *     EmbeddingsSearchData: List of chunk IDs with similarity scores
+     * Expected outcome
+     * - You receive the closest chunk IDs with optional similarity scores.
      *
      * @param {CortexAI.EmbeddingsSearchRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -225,12 +206,9 @@ class Embeddings {
         }
     }
     /**
-     * Get embeddings based on chunk IDs.
-     *
-     * This endpoint returns embeddings for a list of chunk IDs.
+     * Retrieve embeddings for specific chunk IDs.
      *
-     * Returns:
-     *     EmbeddingsGetData: Embeddings data for the requested chunk IDs
+     * Use this when you already know the chunk IDs and need their corresponding embeddings.
      *
      * @param {CortexAI.GetEmbeddingsBasedOnChunkIdsRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -311,12 +289,9 @@ class Embeddings {
         }
     }
     /**
-     * Create an embeddings collection for the given tenant in Findr.
+     * Create an embeddings collection for a tenant.
      *
-     * sub_tenant_id is set to be the same as tenant_id as per requirements.
-     *
-     * Returns:
-     *     EmbeddingsCreateCollectionData: Success response with collection details
+     * Use this to initialize storage so you can index and query embeddings for the tenant.
      *
      * @param {CortexAI.EmbeddingsCreateCollectionRequest} request
      * @param {Embeddings.RequestOptions} requestOptions - Request-specific configuration.
@@ -399,11 +374,7 @@ class Embeddings {
         }
     }
     async _getAuthorizationHeader() {
-        const bearer = await core.Supplier.get(this._options.token);
-        if (bearer != null) {
-            return `Bearer ${bearer}`;
-        }
-        return undefined;
+        return `Bearer ${await core.Supplier.get(this._options.token)}`;
     }
 }
 exports.Embeddings = Embeddings;

package/dist/api/resources/embeddings/client/requests/EmbeddingsCreateCollectionRequest.d.ts

@@ -8,5 +8,6 @@
  *     }
  */
 export interface EmbeddingsCreateCollectionRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
 }

package/dist/api/resources/embeddings/client/requests/EmbeddingsDeleteRequest.d.ts

@@ -9,7 +9,10 @@
  *     }
  */
 export interface EmbeddingsDeleteRequest {
+    /** The chunk IDs of the source you want to delete */
     chunk_ids: string[];
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
     sub_tenant_id?: string;
 }

package/dist/api/resources/embeddings/client/requests/EmbeddingsSearchRequest.d.ts

@@ -8,8 +8,11 @@
  *     }
  */
 export interface EmbeddingsSearchRequest {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** The embedding vector for search */
     embeddings?: number[];
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
     sub_tenant_id?: string;
     max_chunks?: number;
 }

package/dist/api/resources/embeddings/client/requests/GetEmbeddingsBasedOnChunkIdsRequest.d.ts

@@ -9,7 +9,10 @@
  *     }
  */
 export interface GetEmbeddingsBasedOnChunkIdsRequest {
+    /** The chunk IDs of the source you want to get embeddings for */
     chunk_ids: string[];
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** Optional sub-tenant identifier for organizing data within a tenant. If not provided, defaults to tenant_id */
     sub_tenant_id?: string;
 }

package/dist/api/resources/fetch/client/Client.d.ts

@@ -9,7 +9,7 @@ export declare namespace Fetch {
         environment?: core.Supplier<environments.CortexAIEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Fetch {
 }
 export declare class Fetch {
     protected readonly _options: Fetch.Options;
-    constructor(_options?: Fetch.Options);
+    constructor(_options: Fetch.Options);
     /**
      * @param {CortexAI.FetchContentRequest} request
      * @param {Fetch.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,5 +50,5 @@ export declare class Fetch {
      */
     fetchContent(request: CortexAI.FetchContentRequest, requestOptions?: Fetch.RequestOptions): core.HttpResponsePromise<CortexAI.FetchContentData>;
     private __fetchContent;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

package/dist/api/resources/fetch/client/Client.js

@@ -33,7 +33,7 @@ const CortexAI = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class Fetch {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
@@ -117,11 +117,7 @@ class Fetch {
         }
     }
     async _getAuthorizationHeader() {
-        const bearer = await core.Supplier.get(this._options.token);
-        if (bearer != null) {
-            return `Bearer ${bearer}`;
-        }
-        return undefined;
+        return `Bearer ${await core.Supplier.get(this._options.token)}`;
     }
 }
 exports.Fetch = Fetch;