@usecortex_ai/node 0.2.0 → 0.3.0

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

@@ -9,7 +9,7 @@ export declare namespace Search {
         environment?: core.Supplier<environments.CortexAIEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
+        token?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Search {
 }
 export declare class Search {
     protected readonly _options: Search.Options;
-    constructor(_options: Search.Options);
+    constructor(_options?: Search.Options);
     /**
      * Ask a question to your uploaded knowledge base and let Cortex AI answer it.
      *
@@ -45,9 +45,9 @@ export declare class Search {
      *
      * @example
      *     await client.search.qna({
-     *         question: "question",
-     *         session_id: "session_id",
-     *         tenant_id: "tenant_id"
+     *         question: "What is Cortex AI",
+     *         session_id: "chat_session_1234",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     qna(request: CortexAI.QnARequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<unknown>;
@@ -71,8 +71,8 @@ export declare class Search {
      *
      * @example
      *     await client.search.retrieve({
-     *         query: "query",
-     *         tenant_id: "tenant_id"
+     *         query: "Which mode does user prefer",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     retrieve(request: CortexAI.SearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<CortexAI.SearchChunk[]>;
@@ -81,7 +81,7 @@ export declare class Search {
      * Perform full text search for exact matches within your indexed sources.
      *
      * Use this endpoint to find content chunks using BM25-based text matching with configurable operators.
-     * Choose between OR and AND operators to control how search terms are combined for precise text matching.
+     * Choose between 'OR' and 'AND' operators to control how search terms are combined for precise text matching.
      *
      * @param {CortexAI.FullTextSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
@@ -96,11 +96,11 @@ export declare class Search {
      *
      * @example
      *     await client.search.fullTextSearch({
-     *         query: "query",
-     *         tenant_id: "tenant_id"
+     *         query: "John Smith Jake",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     fullTextSearch(request: CortexAI.FullTextSearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<CortexAI.SearchChunk[]>;
     private __fullTextSearch;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/api/resources/search/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 Search {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -52,9 +52,9 @@ class Search {
      *
      * @example
      *     await client.search.qna({
-     *         question: "question",
-     *         session_id: "session_id",
-     *         tenant_id: "tenant_id"
+     *         question: "What is Cortex AI",
+     *         session_id: "chat_session_1234",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     qna(request, requestOptions) {
@@ -137,8 +137,8 @@ class Search {
      *
      * @example
      *     await client.search.retrieve({
-     *         query: "query",
-     *         tenant_id: "tenant_id"
+     *         query: "Which mode does user prefer",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     retrieve(request, requestOptions) {
@@ -206,7 +206,7 @@ class Search {
      * Perform full text search for exact matches within your indexed sources.
      *
      * Use this endpoint to find content chunks using BM25-based text matching with configurable operators.
-     * Choose between OR and AND operators to control how search terms are combined for precise text matching.
+     * Choose between 'OR' and 'AND' operators to control how search terms are combined for precise text matching.
      *
      * @param {CortexAI.FullTextSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
@@ -221,8 +221,8 @@ class Search {
      *
      * @example
      *     await client.search.fullTextSearch({
-     *         query: "query",
-     *         tenant_id: "tenant_id"
+     *         query: "John Smith Jake",
+     *         tenant_id: "tenant_1234"
      *     })
      */
     fullTextSearch(request, requestOptions) {
@@ -287,7 +287,11 @@ class Search {
         }
     }
     async _getAuthorizationHeader() {
-        return `Bearer ${await core.Supplier.get(this._options.token)}`;
+        const bearer = await core.Supplier.get(this._options.token);
+        if (bearer != null) {
+            return `Bearer ${bearer}`;
+        }
+        return undefined;
     }
 }
 exports.Search = Search;

package/dist/api/resources/search/client/requests/FullTextSearchRequest.d.ts

@@ -5,8 +5,8 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         query: "query",
- *         tenant_id: "tenant_id"
+ *         query: "John Smith Jake",
+ *         tenant_id: "tenant_1234"
  *     }
  */
 export interface FullTextSearchRequest {
@@ -14,7 +14,7 @@ export interface FullTextSearchRequest {
     query: 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 */
+    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
     sub_tenant_id?: string;
     /** How to combine search terms (OR or AND) */
     operator?: CortexAI.Bm25OperatorType;

package/dist/api/resources/search/client/requests/QnARequest.d.ts

@@ -4,9 +4,9 @@
 /**
  * @example
  *     {
- *         question: "question",
- *         session_id: "session_id",
- *         tenant_id: "tenant_id"
+ *         question: "What is Cortex AI",
+ *         session_id: "chat_session_1234",
+ *         tenant_id: "tenant_1234"
  *     }
  */
 export interface QnARequest {

package/dist/api/resources/search/client/requests/SearchRequest.d.ts

@@ -4,8 +4,8 @@
 /**
  * @example
  *     {
- *         query: "query",
- *         tenant_id: "tenant_id"
+ *         query: "Which mode does user prefer",
+ *         tenant_id: "tenant_1234"
  *     }
  */
 export interface SearchRequest {
@@ -13,7 +13,7 @@ export interface SearchRequest {
     query: 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 */
+    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
     sub_tenant_id?: string;
     /** Maximum number of results to return */
     max_chunks?: number;
@@ -21,6 +21,8 @@ export interface SearchRequest {
     alpha?: SearchRequest.Alpha;
     /** Preference for newer content (0.0 = no bias, 1.0 = strong recency preference) */
     recency_bias?: number;
+    /** Enable personalized search results based on user preferences */
+    personalise_search?: boolean;
 }
 export declare namespace SearchRequest {
     /**

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

@@ -9,7 +9,7 @@ export declare namespace Sources {
         environment?: core.Supplier<environments.CortexAIEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
+        token?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,32 +28,7 @@ export declare namespace Sources {
 }
 export declare class Sources {
     protected readonly _options: Sources.Options;
-    constructor(_options: Sources.Options);
-    /**
-     * Retrieve all sources for a specific tenant.
-     *
-     * Use this endpoint to fetch a complete list of all sources associated with your tenant. This includes documents, files, and other content you've uploaded for processing.
-     *
-     * You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
-     *
-     * @param {CortexAI.SourcesGetAllRequest} request
-     * @param {Sources.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.sources.getAll({
-     *         tenant_id: "tenant_id"
-     *     })
-     */
-    getAll(request: CortexAI.SourcesGetAllRequest, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.ListSourcesResponse>;
-    private __getAll;
+    constructor(_options?: Sources.Options);
     /**
      * Retrieve specific sources by their IDs.
      *
@@ -73,12 +48,12 @@ export declare class Sources {
      * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
-     *     await client.sources.getByIds({
-     *         tenant_id: "tenant_id",
-     *         source_ids: ["source_ids"]
+     *     await client.sources.getAll({
+     *         tenant_id: "tenant_1234",
+     *         source_ids: ["CortexDoc1234", "CortexDoc4567"]
      *     })
      */
-    getByIds(request: CortexAI.SourceBodyParams, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.ListSourcesResponse>;
-    private __getByIds;
-    protected _getAuthorizationHeader(): Promise<string>;
+    getAll(request: CortexAI.SourceBodyParams, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.ListSourcesResponse>;
+    private __getAll;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -33,96 +33,9 @@ const CortexAI = __importStar(require("../../../index.js"));
 const headers_js_1 = require("../../../../core/headers.js");
 const errors = __importStar(require("../../../../errors/index.js"));
 class Sources {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
-    /**
-     * Retrieve all sources for a specific tenant.
-     *
-     * Use this endpoint to fetch a complete list of all sources associated with your tenant. This includes documents, files, and other content you've uploaded for processing.
-     *
-     * You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
-     *
-     * @param {CortexAI.SourcesGetAllRequest} request
-     * @param {Sources.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.sources.getAll({
-     *         tenant_id: "tenant_id"
-     *     })
-     */
-    getAll(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getAll(request, requestOptions));
-    }
-    async __getAll(request, requestOptions) {
-        var _a, _b, _c;
-        const { tenant_id: tenantId, sub_tenant_id: subTenantId } = request;
-        const _queryParams = {};
-        _queryParams["tenant_id"] = tenantId;
-        if (subTenantId != null) {
-            _queryParams["sub_tenant_id"] = subTenantId;
-        }
-        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, "list/sources"),
-            method: "GET",
-            headers: _headers,
-            queryParameters: Object.assign(Object.assign({}, _queryParams), 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") {
-            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 GET /list/sources.");
-            case "unknown":
-                throw new errors.CortexAIError({
-                    message: _response.error.errorMessage,
-                    rawResponse: _response.rawResponse,
-                });
-        }
-    }
     /**
      * Retrieve specific sources by their IDs.
      *
@@ -142,15 +55,15 @@ class Sources {
      * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
-     *     await client.sources.getByIds({
-     *         tenant_id: "tenant_id",
-     *         source_ids: ["source_ids"]
+     *     await client.sources.getAll({
+     *         tenant_id: "tenant_1234",
+     *         source_ids: ["CortexDoc1234", "CortexDoc4567"]
      *     })
      */
-    getByIds(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getByIds(request, requestOptions));
+    getAll(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getAll(request, requestOptions));
     }
-    async __getByIds(request, requestOptions) {
+    async __getAll(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({
@@ -209,7 +122,11 @@ class Sources {
         }
     }
     async _getAuthorizationHeader() {
-        return `Bearer ${await core.Supplier.get(this._options.token)}`;
+        const bearer = await core.Supplier.get(this._options.token);
+        if (bearer != null) {
+            return `Bearer ${bearer}`;
+        }
+        return undefined;
     }
 }
 exports.Sources = Sources;

package/dist/api/resources/sources/client/requests/SourceBodyParams.d.ts

@@ -4,11 +4,15 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         source_ids: ["source_ids"]
+ *         tenant_id: "tenant_1234",
+ *         source_ids: ["CortexDoc1234", "CortexDoc4567"]
  *     }
  */
 export interface SourceBodyParams {
+    /** Unique identifier for the tenant/organization */
     tenant_id: string;
+    /** List of source IDs to fetch */
     source_ids: string[];
+    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
+    sub_tenant_id?: string;
 }

package/dist/api/resources/sources/client/requests/index.d.ts

@@ -1,2 +1 @@
-export { type SourcesGetAllRequest } from "./SourcesGetAllRequest.js";
 export { type SourceBodyParams } from "./SourceBodyParams.js";

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

@@ -9,7 +9,7 @@ export declare namespace Tenant {
         environment?: core.Supplier<environments.CortexAIEnvironment | string>;
         /** Specify a custom URL to connect the client to. */
         baseUrl?: core.Supplier<string>;
-        token: core.Supplier<core.BearerToken>;
+        token?: core.Supplier<core.BearerToken | undefined>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,7 +28,7 @@ export declare namespace Tenant {
 }
 export declare class Tenant {
     protected readonly _options: Tenant.Options;
-    constructor(_options: Tenant.Options);
+    constructor(_options?: Tenant.Options);
     /**
      * Retrieve usage stats for your tenant.
      *
@@ -51,7 +51,8 @@ export declare class Tenant {
      *
      * @example
      *     await client.tenant.stats({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     stats(request: CortexAI.TenantStatsRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.TenantStats>;
@@ -72,7 +73,7 @@ export declare class Tenant {
      *
      * @example
      *     await client.tenant.getSubTenantIds({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     getSubTenantIds(request: CortexAI.TenantGetSubTenantIdsRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.SubTenantIdsData>;
@@ -96,11 +97,11 @@ export declare class Tenant {
      *
      * @example
      *     await client.tenant.deleteSubTenant({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     deleteSubTenant(request: CortexAI.TenantDeleteSubTenantRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteSubTenantData>;
     private __deleteSubTenant;
-    protected _getAuthorizationHeader(): Promise<string>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

package/dist/api/resources/tenant/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 Tenant {
-    constructor(_options) {
+    constructor(_options = {}) {
         this._options = _options;
     }
     /**
@@ -58,7 +58,8 @@ class Tenant {
      *
      * @example
      *     await client.tenant.stats({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     stats(request, requestOptions) {
@@ -141,7 +142,7 @@ class Tenant {
      *
      * @example
      *     await client.tenant.getSubTenantIds({
-     *         tenant_id: "tenant_id"
+     *         tenant_id: "tenant_1234"
      *     })
      */
     getSubTenantIds(request, requestOptions) {
@@ -224,8 +225,8 @@ class Tenant {
      *
      * @example
      *     await client.tenant.deleteSubTenant({
-     *         tenant_id: "tenant_id",
-     *         sub_tenant_id: "sub_tenant_id"
+     *         tenant_id: "tenant_1234",
+     *         sub_tenant_id: "sub_tenant_4567"
      *     })
      */
     deleteSubTenant(request, requestOptions) {
@@ -291,7 +292,11 @@ class Tenant {
         }
     }
     async _getAuthorizationHeader() {
-        return `Bearer ${await core.Supplier.get(this._options.token)}`;
+        const bearer = await core.Supplier.get(this._options.token);
+        if (bearer != null) {
+            return `Bearer ${bearer}`;
+        }
+        return undefined;
     }
 }
 exports.Tenant = Tenant;

package/dist/api/resources/tenant/client/requests/TenantDeleteSubTenantRequest.d.ts

@@ -4,8 +4,8 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id",
- *         sub_tenant_id: "sub_tenant_id"
+ *         tenant_id: "tenant_1234",
+ *         sub_tenant_id: "sub_tenant_4567"
  *     }
  */
 export interface TenantDeleteSubTenantRequest {

package/dist/api/resources/tenant/client/requests/TenantGetSubTenantIdsRequest.d.ts

@@ -4,7 +4,7 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id"
+ *         tenant_id: "tenant_1234"
  *     }
  */
 export interface TenantGetSubTenantIdsRequest {

package/dist/api/resources/tenant/client/requests/TenantStatsRequest.d.ts

@@ -4,12 +4,13 @@
 /**
  * @example
  *     {
- *         tenant_id: "tenant_id"
+ *         tenant_id: "tenant_1234",
+ *         sub_tenant_id: "sub_tenant_4567"
  *     }
  */
 export interface TenantStatsRequest {
     /** 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 */
+    /** Optional sub-tenant identifier used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
     sub_tenant_id?: string;
 }