@usecortex_ai/node 0.3.6 → 0.5.0

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

@@ -37,9 +37,25 @@ class Search {
         this._options = _options;
     }
     /**
-     * Ask a question to your uploaded knowledge base and let Cortex AI answer it.
+     * Search for relevant content within your indexed sources or user memories.
      *
-     * @param {CortexAI.QnARequest} request
+     *     Results are ranked by relevance and can be customized with parameters like
+     *     result limits, alpha weighting, and recency preferences.
+     *
+     *     Use `search_mode` to specify what to search:
+     *     - "sources" (default): Search over indexed documents
+     *     - "memories": Search over user memories (uses inferred content)
+     *
+     *     Use `mode` to control retrieval quality:
+     *     - "fast" (default): Single query, faster response
+     *     - "accurate": Multi-query generation with reranking, higher quality
+     *
+     *     Use `filters` to narrow results by metadata:
+     *     - Provide key-value pairs matching fields defined in your tenant_metadata_schema
+     *     - Example: `{"category": "engineering", "priority": "high"}`
+     *     - Filters are validated against your tenant schema for type safety
+     *
+     * @param {CortexAI.HybridSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -47,24 +63,24 @@ class Search {
      * @throws {@link CortexAI.ForbiddenError}
      * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.TooManyRequestsError}
      * @throws {@link CortexAI.InternalServerError}
      * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
-     *     await client.search.qna({
-     *         question: "What is Cortex AI",
-     *         session_id: "chat_session_1234",
-     *         tenant_id: "tenant_1234"
+     *     await client.search.retrieve({
+     *         tenant_id: "tenant_id",
+     *         query: "query"
      *     })
      */
-    qna(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__qna(request, requestOptions));
+    retrieve(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__retrieve(request, requestOptions));
     }
-    async __qna(request, requestOptions) {
+    async __retrieve(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, "search/qna"),
+            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, "search/hybrid-search"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -90,6 +106,8 @@ class Search {
                     throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new CortexAI.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 case 500:
                     throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
                 case 503:
@@ -110,7 +128,7 @@ class Search {
                     rawResponse: _response.rawResponse,
                 });
             case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /search/qna.");
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /search/hybrid-search.");
             case "unknown":
                 throw new errors.CortexAIError({
                     message: _response.error.errorMessage,
@@ -119,12 +137,15 @@ class Search {
         }
     }
     /**
-     * Search for relevant content within your indexed sources.
+     * Perform full text search for exact matches within your indexed sources or memories.
+     *     Choose between 'OR' and 'AND' operators to control how search terms are combined
+     *     for precise text matching.
      *
-     * 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.
+     *     Use `search_mode` to specify what to search:
+     *     - "sources" (default): Search over indexed documents
+     *     - "memories": Search over user memories
      *
-     * @param {CortexAI.SearchRequest} request
+     * @param {CortexAI.FullTextSearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -132,23 +153,24 @@ class Search {
      * @throws {@link CortexAI.ForbiddenError}
      * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.TooManyRequestsError}
      * @throws {@link CortexAI.InternalServerError}
      * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
-     *     await client.search.retrieve({
-     *         query: "Which mode does user prefer",
-     *         tenant_id: "tenant_1234"
+     *     await client.search.fullTextSearch({
+     *         tenant_id: "tenant_id",
+     *         query: "query"
      *     })
      */
-    retrieve(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__retrieve(request, requestOptions));
+    fullTextSearch(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__fullTextSearch(request, requestOptions));
     }
-    async __retrieve(request, requestOptions) {
+    async __fullTextSearch(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, "search/retrieve"),
+            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, "search/full-text-search"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -174,6 +196,8 @@ class Search {
                     throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new CortexAI.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 case 500:
                     throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
                 case 503:
@@ -194,7 +218,7 @@ class Search {
                     rawResponse: _response.rawResponse,
                 });
             case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /search/retrieve.");
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /search/full-text-search.");
             case "unknown":
                 throw new errors.CortexAIError({
                     message: _response.error.errorMessage,
@@ -203,12 +227,20 @@ class Search {
         }
     }
     /**
-     * Perform full text search for exact matches within your indexed sources.
+     * Ask a question and get an AI-generated answer based on your indexed sources or memories.
      *
-     * 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.
+     *     The response includes both the AI answer and the source chunks used to generate it,
+     *     enabling full transparency and citation capabilities.
      *
-     * @param {CortexAI.FullTextSearchRequest} request
+     *     Use `search_mode` to specify what to search:
+     *     - "sources" (default): Search over indexed documents
+     *     - "memories": Search over user memories
+     *
+     *     Use `mode` to control retrieval quality:
+     *     - "fast" (default): Single query, faster response
+     *     - "accurate": Multi-query generation with reranking, higher quality
+     *
+     * @param {CortexAI.QnASearchRequest} request
      * @param {Search.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -216,23 +248,24 @@ class Search {
      * @throws {@link CortexAI.ForbiddenError}
      * @throws {@link CortexAI.NotFoundError}
      * @throws {@link CortexAI.UnprocessableEntityError}
+     * @throws {@link CortexAI.TooManyRequestsError}
      * @throws {@link CortexAI.InternalServerError}
      * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
-     *     await client.search.fullTextSearch({
-     *         query: "John Smith Jake",
-     *         tenant_id: "tenant_1234"
+     *     await client.search.qna({
+     *         tenant_id: "tenant_id",
+     *         question: "question"
      *     })
      */
-    fullTextSearch(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__fullTextSearch(request, requestOptions));
+    qna(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__qna(request, requestOptions));
     }
-    async __fullTextSearch(request, requestOptions) {
+    async __qna(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, "search/full-text-search"),
+            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, "search/qna"),
             method: "POST",
             headers: _headers,
             contentType: "application/json",
@@ -258,6 +291,8 @@ class Search {
                     throw new CortexAI.NotFoundError(_response.error.body, _response.rawResponse);
                 case 422:
                     throw new CortexAI.UnprocessableEntityError(_response.error.body, _response.rawResponse);
+                case 429:
+                    throw new CortexAI.TooManyRequestsError(_response.error.body, _response.rawResponse);
                 case 500:
                     throw new CortexAI.InternalServerError(_response.error.body, _response.rawResponse);
                 case 503:
@@ -278,7 +313,7 @@ class Search {
                     rawResponse: _response.rawResponse,
                 });
             case "timeout":
-                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /search/full-text-search.");
+                throw new errors.CortexAITimeoutError("Timeout exceeded when calling POST /search/qna.");
             case "unknown":
                 throw new errors.CortexAIError({
                     message: _response.error.errorMessage,

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

@@ -5,19 +5,21 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         query: "John Smith Jake",
- *         tenant_id: "tenant_1234"
+ *         tenant_id: "tenant_id",
+ *         query: "query"
  *     }
  */
 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 used to organize data within a tenant. If omitted, the default sub-tenant created during tenant setup will be used. */
     sub_tenant_id?: string;
+    /** Search terms to find in your content */
+    query: string;
     /** How to combine search terms (OR or AND) */
     operator?: CortexAI.Bm25OperatorType;
     /** Maximum number of results to return */
     max_chunks?: number;
+    /** What to search: 'sources' for documents or 'memories' for user memories */
+    search_mode?: CortexAI.SearchMode;
 }

package/dist/api/resources/search/client/requests/{SearchRequest.d.ts → HybridSearchRequest.d.ts}

@@ -5,35 +5,41 @@ import * as CortexAI from "../../../../index.js";
 /**
  * @example
  *     {
- *         query: "Which mode does user prefer",
- *         tenant_id: "tenant_1234"
+ *         tenant_id: "tenant_id",
+ *         query: "query"
  *     }
  */
-export interface SearchRequest {
-    /** Search terms to find relevant content */
-    query: string;
+export interface HybridSearchRequest {
     /** Unique identifier for the tenant/organization */
     tenant_id: 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;
+    /** Search terms to find relevant content */
+    query: string;
     /** Maximum number of results to return */
     max_chunks?: number;
     /** Retrieval mode to use ('fast' or 'accurate') */
     mode?: CortexAI.RetrieveMode;
     /** 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) */
+    alpha?: HybridSearchRequest.Alpha;
+    /** Preference for newer content (0.0 = no bias, 1.0 =             strong recency preference) */
     recency_bias?: number;
+    /** Number of related content chunks to include */
+    num_related_chunks?: number;
     /** Enable personalized search results based on user preferences */
     personalise_search?: boolean;
     /** Enable graph context for search results */
     graph_context?: boolean;
     /** Additional context provided by the user to guide retrieval */
     extra_context?: string;
+    /** What to search: 'sources' for documents or 'memories' for user memories */
+    search_mode?: CortexAI.SearchMode;
+    /** Optional key-value pairs to filter search results by tenant metadata fields. Keys must match fields defined in tenant_metadata_schema during tenant creation. Supports exact match filtering on indexed metadata fields. Example: {'category': 'engineering', 'priority': 'high'} */
+    filters?: Record<string, unknown>;
 }
-export declare namespace SearchRequest {
+export declare namespace HybridSearchRequest {
     /**
      * Search ranking algorithm parameter (0.0-1.0 or 'auto')
      */
-    type Alpha = number | string;
+    type Alpha = string | number;
 }

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

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CortexAI from "../../../../index.js";
+/**
+ * @example
+ *     {
+ *         tenant_id: "tenant_id",
+ *         question: "question"
+ *     }
+ */
+export interface QnASearchRequest {
+    /** Unique identifier for the tenant/organization */
+    tenant_id: 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;
+    /** The question to answer based on indexed sources */
+    question: string;
+    /** Maximum number of context chunks to retrieve */
+    max_chunks?: number;
+    /** Retrieval mode: 'fast' for single query, 'accurate' for multi-query with reranking */
+    mode?: CortexAI.RetrieveMode;
+    /** Hybrid search alpha (0.0 = sparse/keyword, 1.0 = dense/semantic) */
+    alpha?: number;
+    /** What to search: 'sources' for documents or 'memories' for user memories */
+    search_mode?: CortexAI.SearchMode;
+    /** Whether to include knowledge graph context for enhanced answers */
+    include_graph_context?: boolean;
+    /** Additional context to guide retrieval and answer generation */
+    extra_context?: string;
+    /** LLM provider for answer generation */
+    llm_provider?: CortexAI.SupportedLlmProviders;
+    /** Specific model to use (defaults to provider's default model) */
+    model?: string;
+    /** LLM temperature for answer generation (lower = more focused) */
+    temperature?: number;
+    /** Maximum tokens for the generated answer */
+    max_tokens?: number;
+}

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

@@ -1,3 +1,3 @@
-export { type QnARequest } from "./QnARequest.js";
-export { type SearchRequest } from "./SearchRequest.js";
+export { type HybridSearchRequest } from "./HybridSearchRequest.js";
 export { type FullTextSearchRequest } from "./FullTextSearchRequest.js";
+export { type QnASearchRequest } from "./QnASearchRequest.js";

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

@@ -30,13 +30,14 @@ export declare class Sources {
     protected readonly _options: Sources.Options;
     constructor(_options?: Sources.Options);
     /**
-     * Retrieve all sources for a specific tenant.
+     * Remove documents and content from your knowledge base.
      *
-     * 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.
+     * This endpoint permanently deletes the specified sources from your knowledge base.
+     *  Once deleted, the content will no longer be available for search or retrieval.
      *
-     * You can optionally specify a sub-tenant to narrow down the results to sources within that specific sub-tenant scope.
+     * Use this carefully as the action cannot be undone. The system will confirm successful deletion of each source ID you specify.
      *
-     * @param {CortexAI.SourcesGetAllRequest} request
+     * @param {CortexAI.SourceDeleteRequest} request
      * @param {Sources.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link CortexAI.BadRequestError}
@@ -48,64 +49,13 @@ export declare class Sources {
      * @throws {@link CortexAI.ServiceUnavailableError}
      *
      * @example
-     *     await client.sources.getAll({
-     *         tenant_id: "tenant_1234",
-     *         sub_tenant_id: "sub_tenant_4567"
+     *     await client.sources.delete({
+     *         tenant_id: "tenant_id",
+     *         sub_tenant_id: "sub_tenant_id",
+     *         source_ids: ["source_ids"]
      *     })
      */
-    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.
-     *
-     * @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.getByIds({
-     *         tenant_id: "tenant_1234",
-     *         source_ids: ["CortexDoc1234", "CortexDoc4567"]
-     *     })
-     */
-    getByIds(request: CortexAI.SourceBodyParams, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.ListSourcesResponse>;
-    private __getByIds;
-    /**
-     * Retrieve relations for a specific source.
-     *
-     * Use this endpoint to fetch all relations associated with a specific source. This is useful when you need to understand the relationships between entities within a source.
-     *
-     * Provide the source ID in the request body along with your tenant information to get the relations for that source.
-     *
-     * @param {CortexAI.SourcesGetGraphRelationsByIdRequest} 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.getGraphRelationsById({
-     *         source_id: "CortexDoc1234",
-     *         tenant_id: "tenant_1234"
-     *     })
-     */
-    getGraphRelationsById(request: CortexAI.SourcesGetGraphRelationsByIdRequest, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.GraphRelationsResponse>;
-    private __getGraphRelationsById;
+    delete(request: CortexAI.SourceDeleteRequest, requestOptions?: Sources.RequestOptions): core.HttpResponsePromise<CortexAI.SourceDeleteResponse>;
+    private __delete;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }