@credal/sdk 0.1.17 → 1.0.0

package/dist/esm/api/resources/copilots/client/Client.d.mts

@@ -1,169 +0,0 @@
-import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
-import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
-import * as core from "../../../../core/index.mjs";
-import type * as Credal from "../../../index.mjs";
-export declare namespace CopilotsClient {
-    type Options = BaseClientOptions;
-    interface RequestOptions extends BaseRequestOptions {
-    }
-}
-export declare class CopilotsClient {
-    protected readonly _options: NormalizedClientOptionsWithAuth<CopilotsClient.Options>;
-    constructor(options?: CopilotsClient.Options);
-    /**
-     * Create a new agent. The API key used will be added to the agent for future Requests
-     *
-     * @param {Credal.CreateCopilotRequest} request
-     * @param {CopilotsClient.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?: CopilotsClient.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 {CopilotsClient.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?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.CreateConversationResponse>;
-    private __createConversation;
-    /**
-     * @param {Credal.ProvideMessageFeedbackRequest} request
-     * @param {CopilotsClient.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?: CopilotsClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __provideMessageFeedback;
-    /**
-     * @param {Credal.SendMessageRequest} request
-     * @param {CopilotsClient.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?: CopilotsClient.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?: CopilotsClient.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 {CopilotsClient.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?: CopilotsClient.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 {CopilotsClient.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?: CopilotsClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __removeCollectionFromCopilot;
-    /**
-     * Update the configuration for a agent
-     *
-     * @param {Credal.UpdateConfigurationRequest} request
-     * @param {CopilotsClient.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?: CopilotsClient.RequestOptions): core.HttpResponsePromise<void>;
-    private __updateConfiguration;
-    /**
-     * @param {Credal.DeleteCopilotRequest} request
-     * @param {CopilotsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.copilots.deleteCopilot({
-     *         id: "ac20e6ba-0bae-11ef-b25a-efca73df4c3a"
-     *     })
-     */
-    deleteCopilot(request: Credal.DeleteCopilotRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.DeleteCopilotResponse>;
-    private __deleteCopilot;
-    /**
-     * Export copilot configurations for backup or migration purposes.
-     *
-     * **IMPORTANT**: This endpoint requires:
-     * - Admin privileges
-     * - The 'ai-usage-analytics-log.export' scope on the API key
-     *
-     * Returns all deployed copilots with their full configuration including model settings, tools, and deployment details. Optional date filters can be applied to narrow down results.
-     *
-     * @param {Credal.ExportCopilotsRequest} request
-     * @param {CopilotsClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.copilots.export({
-     *         agentCreatedFrom: "2024-01-01T00:00:00Z",
-     *         agentCreatedTo: "2024-12-31T23:59:59Z"
-     *     })
-     */
-    export(request?: Credal.ExportCopilotsRequest, requestOptions?: CopilotsClient.RequestOptions): core.HttpResponsePromise<Credal.ExportCopilotsResponse>;
-    private __export;
-}