@usecortex_ai/node 0.1.1 → 0.2.0

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;

package/dist/api/resources/fetch/client/requests/FetchContentRequest.d.ts

@@ -10,9 +10,14 @@
  *     }
  */
 export interface FetchContentRequest {
+    /** Unique identifier for the file to fetch */
     file_id: string;
+    /** Type of file (e.g., 'app', 'file', or other) */
     file_type: string;
+    /** Tenant identifier for multi-tenancy */
     tenant_id: string;
+    /** Whether to return the file content along with the URL */
     return_content?: boolean;
+    /** Sub-tenant identifier, defaults to tenant_id if not provided */
     sub_tenant_id?: string;
 }

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

@@ -3,6 +3,7 @@ export * as sources from "./sources/index.js";
 export * as userMemory from "./userMemory/index.js";
 export * as fetch from "./fetch/index.js";
 export * as upload from "./upload/index.js";
+export * as document from "./document/index.js";
 export * as embeddings from "./embeddings/index.js";
 export * as user from "./user/index.js";
 export * as tenant from "./tenant/index.js";

package/dist/api/resources/index.js

@@ -26,12 +26,13 @@ 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 });
-exports.tenant = exports.user = exports.embeddings = exports.upload = exports.fetch = exports.userMemory = exports.sources = exports.search = void 0;
+exports.tenant = exports.user = exports.embeddings = exports.document = exports.upload = exports.fetch = exports.userMemory = exports.sources = exports.search = void 0;
 exports.search = __importStar(require("./search/index.js"));
 exports.sources = __importStar(require("./sources/index.js"));
 exports.userMemory = __importStar(require("./userMemory/index.js"));
 exports.fetch = __importStar(require("./fetch/index.js"));
 exports.upload = __importStar(require("./upload/index.js"));
+exports.document = __importStar(require("./document/index.js"));
 exports.embeddings = __importStar(require("./embeddings/index.js"));
 exports.user = __importStar(require("./user/index.js"));
 exports.tenant = __importStar(require("./tenant/index.js"));

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 | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,8 +28,10 @@ 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.
+     *
      * @param {CortexAI.QnARequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -51,25 +53,10 @@ export declare class Search {
     qna(request: CortexAI.QnARequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<unknown>;
     private __qna;
     /**
-     * Search for content within indexed sources using semantic and keyword search capabilities.
-     *
-     * This endpoint performs a search query against the Findr backend, allowing users to retrieve
-     * relevant content chunks from their indexed documents and sources. The search can be customized
-     * with various parameters to control the number of results and search behavior.
-     *
-     * Args:
-     *     request (SearchRequest): The search request containing:
-     *         - query (str): Search query string to find relevant content
-     *         - tenant_id (str, optional): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *         - max_chunks (int, optional): Maximum number of content chunks to return
-     *         - alpha (Union[float, str], optional): Search algorithm parameter for result ranking (default: 0.8). Can be float-type (0.0-1.0) or 'auto' for dynamic selection
-     *         - recency_bias (float, optional): Bias towards more recent content (default: 0.5)
-     *         - num_related_chunks (int, optional): Number of related chunks to return (default: 0)
-     *     api_details (dict): Authentication details obtained from API key validation
+     * Search for relevant content within your indexed sources.
      *
-     * Returns:
-     *     SearchData: Success response with search results
+     * This API returns the chunks related to the query you make. We use neural (embedding) search to give you the most relevant chunks.
+     * Results are ranked by relevance and can be customized with parameters like result limits and recency preferences.
      *
      * @param {CortexAI.SearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
@@ -91,24 +78,10 @@ export declare class Search {
     retrieve(request: CortexAI.SearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<CortexAI.SearchChunk[]>;
     private __retrieve;
     /**
-     * Full text search endpoint for Cortex customers.
-     * Performs full text search with configurable operators for precise text matching against the Findr backend.
-     *
-     * This endpoint performs a full text search query against the Findr backend, allowing users to retrieve
-     * relevant content chunks from their indexed documents and sources using BM25-based text matching.
-     * The search can be customized with various operators to control the matching behavior.
-     *
-     * Args:
-     *     request (FullTextSearchRequest): The full text search request containing:
-     *         - query (str): Search query string to find relevant content
-     *         - tenant_id (str): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *         - operator (BM25OperatorType, optional): Full text search operator type (OR or AND). Defaults to OR
-     *         - max_chunks (int, optional): Maximum number of content chunks to return (1-1001, defaults to 25)
-     *     api_details (dict): Authentication details obtained from API key validation
+     * Perform full text search for exact matches within your indexed sources.
      *
-     * Returns:
-     *     FullTextSearchData: Success response with full text search results
+     * 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.
      *
      * @param {CortexAI.FullTextSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
@@ -129,5 +102,5 @@ export declare class Search {
      */
     fullTextSearch(request: CortexAI.FullTextSearchRequest, requestOptions?: Search.RequestOptions): core.HttpResponsePromise<CortexAI.SearchChunk[]>;
     private __fullTextSearch;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

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

@@ -33,10 +33,12 @@ 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;
     }
     /**
+     * Ask a question to your uploaded knowledge base and let Cortex AI answer it.
+     *
      * @param {CortexAI.QnARequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -117,25 +119,10 @@ class Search {
         }
     }
     /**
-     * Search for content within indexed sources using semantic and keyword search capabilities.
-     *
-     * This endpoint performs a search query against the Findr backend, allowing users to retrieve
-     * relevant content chunks from their indexed documents and sources. The search can be customized
-     * with various parameters to control the number of results and search behavior.
-     *
-     * Args:
-     *     request (SearchRequest): The search request containing:
-     *         - query (str): Search query string to find relevant content
-     *         - tenant_id (str, optional): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *         - max_chunks (int, optional): Maximum number of content chunks to return
-     *         - alpha (Union[float, str], optional): Search algorithm parameter for result ranking (default: 0.8). Can be float-type (0.0-1.0) or 'auto' for dynamic selection
-     *         - recency_bias (float, optional): Bias towards more recent content (default: 0.5)
-     *         - num_related_chunks (int, optional): Number of related chunks to return (default: 0)
-     *     api_details (dict): Authentication details obtained from API key validation
+     * Search for relevant content within your indexed sources.
      *
-     * Returns:
-     *     SearchData: Success response with search results
+     * This API returns the chunks related to the query you make. We use neural (embedding) search to give you the most relevant chunks.
+     * Results are ranked by relevance and can be customized with parameters like result limits and recency preferences.
      *
      * @param {CortexAI.SearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
@@ -216,24 +203,10 @@ class Search {
         }
     }
     /**
-     * Full text search endpoint for Cortex customers.
-     * Performs full text search with configurable operators for precise text matching against the Findr backend.
+     * Perform full text search for exact matches within your indexed sources.
      *
-     * This endpoint performs a full text search query against the Findr backend, allowing users to retrieve
-     * relevant content chunks from their indexed documents and sources using BM25-based text matching.
-     * The search can be customized with various operators to control the matching behavior.
-     *
-     * Args:
-     *     request (FullTextSearchRequest): The full text search request containing:
-     *         - query (str): Search query string to find relevant content
-     *         - tenant_id (str): Tenant identifier for multi-tenancy
-     *         - sub_tenant_id (str, optional): Sub-tenant identifier, defaults to tenant_id
-     *         - operator (BM25OperatorType, optional): Full text search operator type (OR or AND). Defaults to OR
-     *         - max_chunks (int, optional): Maximum number of content chunks to return (1-1001, defaults to 25)
-     *     api_details (dict): Authentication details obtained from API key validation
-     *
-     * Returns:
-     *     FullTextSearchData: Success response with full text search results
+     * 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.
      *
      * @param {CortexAI.FullTextSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
@@ -314,11 +287,7 @@ class Search {
         }
     }
     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.Search = Search;

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

@@ -10,9 +10,14 @@ import * as CortexAI from "../../../../index.js";
  *     }
  */
 export interface FullTextSearchRequest {
+    /** Search terms to find in your content */
     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 */
     sub_tenant_id?: string;
+    /** How to combine search terms (OR or AND) */
     operator?: CortexAI.Bm25OperatorType;
+    /** Maximum number of results to return */
     max_chunks?: number;
 }

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

@@ -10,21 +10,38 @@
  *     }
  */
 export interface QnARequest {
+    /** The question to be answered */
     question: string;
+    /** Unique identifier for the conversation session. Keep it same when the current question refers to a previous answer or question */
     session_id: string;
+    /** Identifier for the tenant/organization */
     tenant_id: string;
+    /** List of context strings to provide additional information */
     context_list?: string[];
+    /** List of search modes to use for finding relevant information */
     search_modes?: string[];
+    /** Identifier for sub-tenant within the tenant */
     sub_tenant_id?: string;
+    /** Whether to return text chunks in the response along with final LLM generated answer */
     highlight_chunks?: boolean;
+    /** Whether to stream the response */
     stream?: boolean;
+    /** Closer to 0.0 means a exact keyword search will be performed, closer to 1.0 means semantics of the search will be considered. In most cases, you wont have to toggle it yourself. */
     search_alpha?: number;
+    /** Bias towards more recent information (0.0 to 1.0) */
     recency_bias?: number;
+    /** Whether to use AI for generating responses */
     ai_generation?: boolean;
+    /** Number of top results to return */
     top_n?: number;
+    /** Name of the user making the request. This helps LLM to know the user's name if semantics around the username are involved in query. Its generally a good practice to include it possible. */
     user_name?: string;
+    /** Custom instructions for the AI response to add to our proprietary prompt. This can be used to provide additional context or instructions for the LLM to follow so that the answers are tailored towards your application style */
     user_instructions?: string;
+    /** Enable advanced multi-step reasoning for complex queries. When enabled, the AI will automatically break down complex questions into multiple research steps to provide more comprehensive and accurate answers. */
     multi_step_reasoning?: boolean;
+    /** Enable intelligent agent routing to automatically select the most suitable AI agent for your specific query type. Different agents are optimized for various use cases like social media, code, conversations, general knowledge, etc. */
     auto_agent_routing?: boolean;
+    /** Additional metadata for the request */
     metadata?: Record<string, unknown>;
 }

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

@@ -9,14 +9,22 @@
  *     }
  */
 export interface SearchRequest {
+    /** Search terms to find relevant content */
     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 */
     sub_tenant_id?: string;
+    /** Maximum number of results to return */
     max_chunks?: number;
+    /** Search ranking algorithm parameter (0.0-1.0 or 'auto') */
     alpha?: SearchRequest.Alpha;
+    /** Preference for newer content (0.0 = no bias, 1.0 = strong recency preference) */
     recency_bias?: number;
-    num_related_chunks?: number;
 }
 export declare namespace SearchRequest {
+    /**
+     * Search ranking algorithm parameter (0.0-1.0 or 'auto')
+     */
     type Alpha = number | string;
 }

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 | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,8 +28,14 @@ export declare namespace Sources {
 }
 export declare class Sources {
     protected readonly _options: Sources.Options;
-    constructor(_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.
      *
@@ -49,6 +55,12 @@ export declare class Sources {
     getAll(request: CortexAI.SourcesGetAllRequest, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.ListSourcesResponse>;
     private __getAll;
     /**
+     * Retrieve specific sources by their IDs.
+     *
+     * Use this endpoint to fetch one or more sources by providing their unique identifiers. This is useful when you need detailed information about specific documents or content you've previously uploaded.
+     *
+     * Provide the source IDs in the request body along with your tenant information to get the exact sources you need.
+     *
      * @param {CortexAI.SourceBodyParams} request
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -68,5 +80,5 @@ export declare class Sources {
      */
     getByIds(request: CortexAI.SourceBodyParams, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.ListSourcesResponse>;
     private __getByIds;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    protected _getAuthorizationHeader(): Promise<string>;
 }

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

@@ -33,10 +33,16 @@ 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.
      *
@@ -118,6 +124,12 @@ class Sources {
         }
     }
     /**
+     * Retrieve specific sources by their IDs.
+     *
+     * Use this endpoint to fetch one or more sources by providing their unique identifiers. This is useful when you need detailed information about specific documents or content you've previously uploaded.
+     *
+     * Provide the source IDs in the request body along with your tenant information to get the exact sources you need.
+     *
      * @param {CortexAI.SourceBodyParams} request
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -197,11 +209,7 @@ class Sources {
         }
     }
     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.Sources = Sources;

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

@@ -8,6 +8,8 @@
  *     }
  */
 export interface SourcesGetAllRequest {
+    /** 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/sources/client/requests/SourcesGetSubTenantIdsRequest.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id"
+ *     }
+ */
+export interface SourcesGetSubTenantIdsRequest {
+    tenant_id: string;
+}

package/dist/api/resources/sources/client/requests/SourcesGetSubTenantIdsRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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 | undefined>;
+        token: core.Supplier<core.BearerToken>;
         /** Additional headers to include in requests. */
         headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
     }
@@ -28,11 +28,15 @@ export declare namespace Tenant {
 }
 export declare class Tenant {
     protected readonly _options: Tenant.Options;
-    constructor(_options?: Tenant.Options);
+    constructor(_options: Tenant.Options);
     /**
-     * Get tenant stats.
+     * Retrieve usage stats for your tenant.
      *
-     * This endpoint returns stats for tenant.
+     * Use this endpoint to check whether a tenant exists and view core metrics like total indexed objects and vector dimension. This helps you validate setup and monitor ingestion.
+     *
+     * Expected outcome
+     * - You receive the current object count and vector dimension for the tenant.
+     * - If the tenant does not exist, you get a not-found error.
      *
      * @param {CortexAI.TenantStatsRequest} request
      * @param {Tenant.RequestOptions} requestOptions - Request-specific configuration.
@@ -52,5 +56,51 @@ export declare class Tenant {
      */
     stats(request: CortexAI.TenantStatsRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.TenantStats>;
     private __stats;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
+    /**
+     * Retrieve all sub-tenant IDs contained within a specific tenant. Fetches the sub-tenant IDs directly from the underlying data store.
+     *
+     * @param {CortexAI.TenantGetSubTenantIdsRequest} request
+     * @param {Tenant.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.tenant.getSubTenantIds({
+     *         tenant_id: "tenant_id"
+     *     })
+     */
+    getSubTenantIds(request: CortexAI.TenantGetSubTenantIdsRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.SubTenantIdsData>;
+    private __getSubTenantIds;
+    /**
+     * Delete a sub-tenant from a given tenant.
+     *
+     * This endpoint deletes a specific sub-tenant from the specified tenant.
+     * It validates that the sub-tenant is not the primary/default sub-tenant before deletion.
+     *
+     * @param {CortexAI.TenantDeleteSubTenantRequest} request
+     * @param {Tenant.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.tenant.deleteSubTenant({
+     *         tenant_id: "tenant_id",
+     *         sub_tenant_id: "sub_tenant_id"
+     *     })
+     */
+    deleteSubTenant(request: CortexAI.TenantDeleteSubTenantRequest, requestOptions?: Tenant.RequestOptions): core.HttpResponsePromise<CortexAI.DeleteSubTenantData>;
+    private __deleteSubTenant;
+    protected _getAuthorizationHeader(): Promise<string>;
 }