retell-sdk 4.7.0 → 4.9.0

package/resources/knowledge-base.d.ts

@@ -0,0 +1,144 @@
+import { APIResource } from "../resource.js";
+import * as Core from "../core.js";
+export declare class KnowledgeBase extends APIResource {
+    /**
+     * Create a new knowledge base
+     */
+    create(body: KnowledgeBaseCreateParams, options?: Core.RequestOptions): Core.APIPromise<KnowledgeBaseResponse>;
+    /**
+     * Retrieve details of a specific knowledge base
+     */
+    retrieve(knowledgeBaseId: string, options?: Core.RequestOptions): Core.APIPromise<KnowledgeBaseResponse>;
+    /**
+     * List all knowledge bases
+     */
+    list(options?: Core.RequestOptions): Core.APIPromise<KnowledgeBaseListResponse>;
+    /**
+     * Delete an existing knowledge base
+     */
+    delete(knowledgeBaseId: string, options?: Core.RequestOptions): Core.APIPromise<void>;
+}
+export interface KnowledgeBaseResponse {
+    /**
+     * Unique id of the knowledge base.
+     */
+    knowledge_base_id: string;
+    /**
+     * Name of the knowledge base. Must be less than 40 characters.
+     */
+    knowledge_base_name: string;
+    /**
+     * Status of the knowledge base. When it's created and being processed, it's
+     * "in_progress". When the processing is done, it's "complete". When there's an
+     * error in processing, it's "error".
+     */
+    status: 'in_progress' | 'complete' | 'error';
+    /**
+     * Whether to enable auto refresh for the knowledge base urls. If set to true, will
+     * retrieve the data from the specified url every 12 hours.
+     */
+    enable_auto_refresh?: boolean;
+    /**
+     * Sources of the knowledge base. Will be populated after the processing is done
+     * (when status is "complete").
+     */
+    knowledge_base_sources?: Array<KnowledgeBaseResponse.KnowledgeBaseSourceDocument | KnowledgeBaseResponse.KnowledgeBaseSourceText | KnowledgeBaseResponse.KnowledgeBaseSourceURL>;
+    /**
+     * Last refreshed timestamp (milliseconds since epoch). Only applicable when
+     * enable_auto_refresh is true.
+     */
+    last_refreshed_timestamp?: number;
+}
+export declare namespace KnowledgeBaseResponse {
+    interface KnowledgeBaseSourceDocument {
+        /**
+         * URL of the document stored.
+         */
+        file_url: string;
+        /**
+         * Filename of the document.
+         */
+        filename: string;
+        /**
+         * Unique id of the knowledge base source.
+         */
+        source_id: string;
+        /**
+         * Type of the knowledge base source.
+         */
+        type: 'document';
+    }
+    interface KnowledgeBaseSourceText {
+        /**
+         * URL of the text content stored.
+         */
+        content_url: string;
+        /**
+         * Unique id of the knowledge base source.
+         */
+        source_id: string;
+        /**
+         * Title of the text.
+         */
+        title: string;
+        /**
+         * Type of the knowledge base source.
+         */
+        type: 'text';
+    }
+    interface KnowledgeBaseSourceURL {
+        /**
+         * Unique id of the knowledge base source.
+         */
+        source_id: string;
+        /**
+         * Type of the knowledge base source.
+         */
+        type: 'url';
+        /**
+         * URL used to be scraped and added to the knowledge base.
+         */
+        url: string;
+    }
+}
+export type KnowledgeBaseListResponse = Array<KnowledgeBaseResponse>;
+export interface KnowledgeBaseCreateParams {
+    /**
+     * Name of the knowledge base. Must be less than 40 characters.
+     */
+    knowledge_base_name: string;
+    /**
+     * Whether to enable auto refresh for the knowledge base urls. If set to true, will
+     * retrieve the data from the specified url every 12 hours.
+     */
+    enable_auto_refresh?: boolean;
+    /**
+     * Files to add to the knowledge base. Limit to 25 files, where each file is
+     * limited to 50MB.
+     */
+    knowledge_base_files?: Array<Core.Uploadable>;
+    /**
+     * Texts to add to the knowledge base.
+     */
+    knowledge_base_texts?: Array<KnowledgeBaseCreateParams.KnowledgeBaseText>;
+    /**
+     * URLs to be scraped and added to the knowledge base. Must be valid urls.
+     */
+    knowledge_base_urls?: Array<string>;
+}
+export declare namespace KnowledgeBaseCreateParams {
+    interface KnowledgeBaseText {
+        /**
+         * Text to add to the knowledge base.
+         */
+        text: string;
+        /**
+         * Title of the text.
+         */
+        title: string;
+    }
+}
+export declare namespace KnowledgeBase {
+    export { type KnowledgeBaseResponse as KnowledgeBaseResponse, type KnowledgeBaseListResponse as KnowledgeBaseListResponse, type KnowledgeBaseCreateParams as KnowledgeBaseCreateParams, };
+}
+//# sourceMappingURL=knowledge-base.d.ts.map

package/resources/knowledge-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge-base.d.ts","sourceRoot":"","sources":["../src/resources/knowledge-base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,yBAAyB,EAC/B,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAC5B,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAOzC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;IAIxG;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;IAI/E;;OAEG;IACH,MAAM,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;CAMtF;AAED,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;;OAIG;IACH,MAAM,EAAE,aAAa,GAAG,UAAU,GAAG,OAAO,CAAC;IAE7C;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAC1B,qBAAqB,CAAC,2BAA2B,GACjD,qBAAqB,CAAC,uBAAuB,GAC7C,qBAAqB,CAAC,sBAAsB,CAC/C,CAAC;IAEF;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,yBAAiB,qBAAqB,CAAC;IACrC,UAAiB,2BAA2B;QAC1C;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,UAAU,CAAC;KAClB;IAED,UAAiB,uBAAuB;QACtC;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,sBAAsB;QACrC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,IAAI,EAAE,KAAK,CAAC;QAEZ;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;KACb;CACF;AAED,MAAM,MAAM,yBAAyB,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;AAErE,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;OAGG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAE9C;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,iBAAiB,CAAC,CAAC;IAE1E;;OAEG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrC;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,OAAO,EACL,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;CACH"}

package/resources/knowledge-base.js

@@ -0,0 +1,60 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+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.KnowledgeBase = void 0;
+const resource_1 = require("../resource.js");
+const Core = __importStar(require("../core.js"));
+class KnowledgeBase extends resource_1.APIResource {
+    /**
+     * Create a new knowledge base
+     */
+    create(body, options) {
+        return this._client.post('/create-knowledge-base', Core.multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Retrieve details of a specific knowledge base
+     */
+    retrieve(knowledgeBaseId, options) {
+        return this._client.get(`/get-knowledge-base/${knowledgeBaseId}`, options);
+    }
+    /**
+     * List all knowledge bases
+     */
+    list(options) {
+        return this._client.get('/list-knowledge-bases', options);
+    }
+    /**
+     * Delete an existing knowledge base
+     */
+    delete(knowledgeBaseId, options) {
+        return this._client.delete(`/delete-knowledge-base/${knowledgeBaseId}`, {
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+}
+exports.KnowledgeBase = KnowledgeBase;
+//# sourceMappingURL=knowledge-base.js.map

package/resources/knowledge-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge-base.js","sourceRoot":"","sources":["../src/resources/knowledge-base.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;;;;;;;;;;;;;;;;;;;;;;;AAEtF,6CAA0C;AAC1C,iDAAgC;AAEhC,MAAa,aAAc,SAAQ,sBAAW;IAC5C;;OAEG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,wBAAwB,EACxB,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CACvD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,eAAuB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,0BAA0B,eAAe,EAAE,EAAE;YACtE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF;AArCD,sCAqCC"}

package/resources/knowledge-base.mjs

@@ -0,0 +1,33 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../resource.mjs";
+import * as Core from "../core.mjs";
+export class KnowledgeBase extends APIResource {
+    /**
+     * Create a new knowledge base
+     */
+    create(body, options) {
+        return this._client.post('/create-knowledge-base', Core.multipartFormRequestOptions({ body, ...options }));
+    }
+    /**
+     * Retrieve details of a specific knowledge base
+     */
+    retrieve(knowledgeBaseId, options) {
+        return this._client.get(`/get-knowledge-base/${knowledgeBaseId}`, options);
+    }
+    /**
+     * List all knowledge bases
+     */
+    list(options) {
+        return this._client.get('/list-knowledge-bases', options);
+    }
+    /**
+     * Delete an existing knowledge base
+     */
+    delete(knowledgeBaseId, options) {
+        return this._client.delete(`/delete-knowledge-base/${knowledgeBaseId}`, {
+            ...options,
+            headers: { Accept: '*/*', ...options?.headers },
+        });
+    }
+}
+//# sourceMappingURL=knowledge-base.mjs.map

package/resources/knowledge-base.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"knowledge-base.mjs","sourceRoot":"","sources":["../src/resources/knowledge-base.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,IAAI;AAEhB,MAAM,OAAO,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACH,MAAM,CACJ,IAA+B,EAC/B,OAA6B;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,wBAAwB,EACxB,IAAI,CAAC,2BAA2B,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CACvD,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,eAAuB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,eAAe,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7E,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAA6B;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,eAAuB,EAAE,OAA6B;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,0BAA0B,eAAe,EAAE,EAAE;YACtE,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAChD,CAAC,CAAC;IACL,CAAC;CACF"}