@credal/sdk 0.0.29 → 0.1.0

package/dist/cjs/Client.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { Copilots } from "./api/resources/copilots/client/Client.js";
+import { DocumentCatalog } from "./api/resources/documentCatalog/client/Client.js";
+import { DocumentCollections } from "./api/resources/documentCollections/client/Client.js";
+import { PermissionsService } from "./api/resources/permissionsService/client/Client.js";
+import { Search } from "./api/resources/search/client/Client.js";
+import { Users } from "./api/resources/users/client/Client.js";
+export declare namespace CredalClient {
+    interface Options {
+        environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    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 CredalClient {
+    protected readonly _options: CredalClient.Options;
+    protected _copilots: Copilots | undefined;
+    protected _documentCatalog: DocumentCatalog | undefined;
+    protected _documentCollections: DocumentCollections | undefined;
+    protected _permissionsService: PermissionsService | undefined;
+    protected _search: Search | undefined;
+    protected _users: Users | undefined;
+    constructor(_options?: CredalClient.Options);
+    get copilots(): Copilots;
+    get documentCatalog(): DocumentCatalog;
+    get documentCollections(): DocumentCollections;
+    get permissionsService(): PermissionsService;
+    get search(): Search;
+    get users(): Users;
+}

package/dist/cjs/Client.js

@@ -0,0 +1,84 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredalClient = void 0;
+const core = __importStar(require("./core/index.js"));
+const headers_js_1 = require("./core/headers.js");
+const Client_js_1 = require("./api/resources/copilots/client/Client.js");
+const Client_js_2 = require("./api/resources/documentCatalog/client/Client.js");
+const Client_js_3 = require("./api/resources/documentCollections/client/Client.js");
+const Client_js_4 = require("./api/resources/permissionsService/client/Client.js");
+const Client_js_5 = require("./api/resources/search/client/Client.js");
+const Client_js_6 = require("./api/resources/users/client/Client.js");
+class CredalClient {
+    constructor(_options = {}) {
+        this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
+                "X-Fern-Language": "JavaScript",
+                "X-Fern-SDK-Name": "@credal/sdk",
+                "X-Fern-SDK-Version": "0.1.0",
+                "User-Agent": "@credal/sdk/0.1.0",
+                "X-Fern-Runtime": core.RUNTIME.type,
+                "X-Fern-Runtime-Version": core.RUNTIME.version,
+            }, _options === null || _options === void 0 ? void 0 : _options.headers) });
+    }
+    get copilots() {
+        var _a;
+        return ((_a = this._copilots) !== null && _a !== void 0 ? _a : (this._copilots = new Client_js_1.Copilots(this._options)));
+    }
+    get documentCatalog() {
+        var _a;
+        return ((_a = this._documentCatalog) !== null && _a !== void 0 ? _a : (this._documentCatalog = new Client_js_2.DocumentCatalog(this._options)));
+    }
+    get documentCollections() {
+        var _a;
+        return ((_a = this._documentCollections) !== null && _a !== void 0 ? _a : (this._documentCollections = new Client_js_3.DocumentCollections(this._options)));
+    }
+    get permissionsService() {
+        var _a;
+        return ((_a = this._permissionsService) !== null && _a !== void 0 ? _a : (this._permissionsService = new Client_js_4.PermissionsService(this._options)));
+    }
+    get search() {
+        var _a;
+        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_js_5.Search(this._options)));
+    }
+    get users() {
+        var _a;
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_js_6.Users(this._options)));
+    }
+}
+exports.CredalClient = CredalClient;

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

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

package/dist/cjs/api/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("./resources/index.js"), exports);

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

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

package/dist/cjs/api/resources/common/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("./types/index.js"), exports);

package/dist/cjs/api/resources/common/types/Collaborator.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.js";
+export interface Collaborator {
+    email: string;
+    role: Credal.Role;
+}

package/dist/cjs/api/resources/common/types/ExternalResourceId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.js";
+export interface ExternalResourceId {
+    externalResourceId: string;
+    resourceType: Credal.ResourceType;
+}

package/dist/cjs/api/resources/common/types/ResourceIdentifier.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.js";
+export type ResourceIdentifier = Credal.ResourceIdentifier.ExternalResourceId | Credal.ResourceIdentifier.Url;
+export declare namespace ResourceIdentifier {
+    interface ExternalResourceId extends Credal.ExternalResourceId {
+        type: "external-resource-id";
+    }
+    interface Url extends Credal.Url {
+        type: "url";
+    }
+}

package/dist/cjs/api/resources/common/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./ResourceIdentifier.js";
+export * from "./ExternalResourceId.js";
+export * from "./Url.js";
+export * from "./ResourceType.js";
+export * from "./Collaborator.js";
+export * from "./Role.js";
+export * from "./Operator.js";

package/dist/cjs/api/resources/common/types/index.js

@@ -0,0 +1,23 @@
+"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("./ResourceIdentifier.js"), exports);
+__exportStar(require("./ExternalResourceId.js"), exports);
+__exportStar(require("./Url.js"), exports);
+__exportStar(require("./ResourceType.js"), exports);
+__exportStar(require("./Collaborator.js"), exports);
+__exportStar(require("./Role.js"), exports);
+__exportStar(require("./Operator.js"), exports);

package/dist/cjs/api/resources/copilots/client/Client.d.ts

@@ -0,0 +1,170 @@
+/**
+ * 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 Credal from "../../../index.js";
+export declare namespace Copilots {
+    interface Options {
+        environment?: core.Supplier<environments.CredalEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    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 Copilots {
+    protected readonly _options: Copilots.Options;
+    constructor(_options?: Copilots.Options);
+    /**
+     * Create a new agent. The API key used will be added to the agent for future Requests
+     *
+     * @param {Credal.CreateCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.createCopilot({
+     *         name: "Customer Agent",
+     *         description: "This agent is used to answer customer requests based on internal documentation.",
+     *         collaborators: [{
+     *                 email: "test@gmail.com",
+     *                 role: "editor"
+     *             }]
+     *     })
+     */
+    createCopilot(request: Credal.CreateCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.CreateCopilotResponse>;
+    private __createCopilot;
+    /**
+     * OPTIONAL. Create a new conversation with the Agent. The conversation ID can be used in the `sendMessage` endpoint. The `sendMessage` endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
+     *
+     * @param {Credal.CreateConversationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.createConversation({
+     *         agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         userEmail: "ravin@credal.ai"
+     *     })
+     */
+    createConversation(request: Credal.CreateConversationRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.CreateConversationResponse>;
+    private __createConversation;
+    /**
+     * @param {Credal.ProvideMessageFeedbackRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.provideMessageFeedback({
+     *         userEmail: "ravin@credal.ai",
+     *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+     *         agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         messageFeedback: {
+     *             feedback: "NEGATIVE",
+     *             suggestedAnswer: "Yes, Credal is SOC 2 compliant.",
+     *             descriptiveFeedback: "The response should be extremely clear and concise."
+     *         }
+     *     })
+     */
+    provideMessageFeedback(request: Credal.ProvideMessageFeedbackRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
+    private __provideMessageFeedback;
+    /**
+     * @param {Credal.SendMessageRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.sendMessage({
+     *         agentId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         message: "Is Credal SOC 2 compliant?",
+     *         userEmail: "ravin@credal.ai",
+     *         inputVariables: [{
+     *                 name: "input1",
+     *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
+     *             }, {
+     *                 name: "input2",
+     *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
+     *             }]
+     *     })
+     */
+    sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.SendAgentMessageResponse>;
+    private __sendMessage;
+    /**
+     * This endpoint allows you to send a message to a specific agent and get the response back as a streamed set of Server-Sent Events.
+     */
+    streamMessage(request: Credal.StreamMessageRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<core.Stream<Credal.StreamingChunk>>;
+    private __streamMessage;
+    /**
+     * Link a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
+     *
+     * @param {Credal.AddCollectionToCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.addCollectionToCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    addCollectionToCopilot(request: Credal.AddCollectionToCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
+    private __addCollectionToCopilot;
+    /**
+     * Unlink a collection with a agent. The API Key used must be added to both the collection and the agent beforehand.
+     *
+     * @param {Credal.RemoveCollectionFromCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.removeCollectionFromCopilot({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         collectionId: "def1055f-83c5-43d6-b558-f7a38e7b299e"
+     *     })
+     */
+    removeCollectionFromCopilot(request: Credal.RemoveCollectionFromCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
+    private __removeCollectionFromCopilot;
+    /**
+     * Update the configuration for a agent
+     *
+     * @param {Credal.UpdateConfigurationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.updateConfiguration({
+     *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+     *         configuration: {
+     *             name: "Customer Agent",
+     *             description: "This agent is used to answer customer requests based on internal documentation.",
+     *             prompt: "You are a polite, helpful assistant used to answer customer requests.",
+     *             aiEndpointConfiguration: {
+     *                 baseUrl: "https://api.openai.com/v1/",
+     *                 apiKey: "<YOUR_API_KEY_HERE>"
+     *             }
+     *         }
+     *     })
+     */
+    updateConfiguration(request: Credal.UpdateConfigurationRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<void>;
+    private __updateConfiguration;
+    /**
+     * @param {Credal.DeleteCopilotRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.copilots.deleteCopilot({
+     *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
+     *     })
+     */
+    deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: Copilots.RequestOptions): core.HttpResponsePromise<Credal.DeleteCopilotResponse>;
+    private __deleteCopilot;
+    protected _getAuthorizationHeader(): Promise<string>;
+}