🌿 Fern Regeneration -- April 2, 2025

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@credal/sdk",
-    "version": "0.0.24",
+    "version": "0.0.25",
     "private": false,
     "repository": "https://github.com/credal-ai/credal-typescript-sdk",
     "main": "./index.js",

src/api/resources/copilots/client/Client.ts

@@ -60,8 +60,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -129,8 +129,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -202,8 +202,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -272,8 +272,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -332,8 +332,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -412,8 +412,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -476,8 +476,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -550,8 +550,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },
@@ -611,8 +611,8 @@ export class Copilots {
                 Authorization: await this._getAuthorizationHeader(),
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@credal/sdk",
-                "X-Fern-SDK-Version": "0.0.24",
-                "User-Agent": "@credal/sdk/0.0.24",
+                "X-Fern-SDK-Version": "0.0.25",
+                "User-Agent": "@credal/sdk/0.0.25",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             },

src/api/resources/copilots/client/requests/AddCollectionToCopilotRequest.ts

@@ -10,14 +10,8 @@
  *     }
  */
 export interface AddCollectionToCopilotRequest {
-    /**
-     * Credal-generated copilot ID to add the collection to.
-     *
-     */
+    /** Credal-generated copilot ID to add the collection to. */
     copilotId: string;
-    /**
-     * Credal-generated collection ID to add.
-     *
-     */
+    /** Credal-generated collection ID to add. */
     collectionId: string;
 }

src/api/resources/copilots/client/requests/CreateConversationRequest.ts

@@ -10,14 +10,8 @@
  *     }
  */
 export interface CreateConversationRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * End-user for the conversation.
-     *
-     */
+    /** End-user for the conversation. */
     userEmail: string;
 }

src/api/resources/copilots/client/requests/CreateCopilotRequest.ts

@@ -16,19 +16,10 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface CreateCopilotRequest {
-    /**
-     * A descriptive name for the copilot.
-     *
-     */
+    /** A descriptive name for the copilot. */
     name: string;
-    /**
-     * An in depth name for the copilot's function. Useful for routing requests to the right copilot.
-     *
-     */
+    /** An in depth name for the copilot's function. Useful for routing requests to the right copilot. */
     description: string;
-    /**
-     * A list of collaborator emails and roles that will have access to the copilot.
-     *
-     */
+    /** A list of collaborator emails and roles that will have access to the copilot. */
     collaborators: Credal.Collaborator[];
 }

src/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.ts

@@ -18,24 +18,12 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface ProvideMessageFeedbackRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * The user profile you want to use when providing feedback.
-     *
-     */
+    /** The user profile you want to use when providing feedback. */
     userEmail: string;
-    /**
-     * The message ID for which feedback is being provided.
-     *
-     */
+    /** The message ID for which feedback is being provided. */
     messageId: string;
-    /**
-     * The feedback provided by the user.
-     *
-     */
+    /** The feedback provided by the user. */
     messageFeedback: Credal.MessageFeedback;
 }

src/api/resources/copilots/client/requests/RemoveCollectionFromCopilotRequest.ts

@@ -10,14 +10,8 @@
  *     }
  */
 export interface RemoveCollectionFromCopilotRequest {
-    /**
-     * Credal-generated copilot ID to add the collection to.
-     *
-     */
+    /** Credal-generated copilot ID to add the collection to. */
     copilotId: string;
-    /**
-     * Credal-generated collection ID to add.
-     *
-     */
+    /** Credal-generated collection ID to add. */
     collectionId: string;
 }

src/api/resources/copilots/client/requests/SendMessageRequest.ts

@@ -20,29 +20,14 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface SendMessageRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     agentId: string;
-    /**
-     * The message you want to send to your copilot.
-     *
-     */
+    /** The message you want to send to your copilot. */
     message: string;
-    /**
-     * The user profile you want to use when sending the message.
-     *
-     */
+    /** The user profile you want to use when sending the message. */
     userEmail: string;
-    /**
-     * Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
-     *
-     */
+    /** Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations. */
     conversationId?: string;
-    /**
-     * Optional input variables to be used in the message. Map the name of the variable to a list of urls.
-     *
-     */
+    /** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
     inputVariables?: Credal.InputVariable[];
 }

src/api/resources/copilots/client/requests/StreamMessageRequest.ts

@@ -32,31 +32,30 @@ import * as Credal from "../../../../index";
  *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c24"]
  *             }]
  *     }
+ *
+ * @example
+ *     {
+ *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c25",
+ *         message: "Is Credal SOC 2 compliant?",
+ *         email: "[email protected]",
+ *         inputVariables: [{
+ *                 name: "input1",
+ *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c24"]
+ *             }, {
+ *                 name: "input2",
+ *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c25", "82e4b12a-6990-45d4-8ebd-85c00e030c26"]
+ *             }]
+ *     }
  */
 export interface StreamMessageRequest {
-    /**
-     * Credal-generated Copilot ID to specify which agent to route the request to.
-     *
-     */
+    /** Credal-generated Copilot ID to specify which agent to route the request to. */
     copilotId: string;
-    /**
-     * The message you want to send to your copilot.
-     *
-     */
+    /** The message you want to send to your copilot. */
     message: string;
-    /**
-     * The user profile you want to use when sending the message.
-     *
-     */
+    /** The user profile you want to use when sending the message. */
     email: string;
-    /**
-     * Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations.
-     *
-     */
+    /** Credal-generated conversation ID for sending follow up messages. Conversation ID is returned after initial message. Optional, to be left off for first messages on new conversations. */
     conversationId?: string;
-    /**
-     * Optional input variables to be used in the message. Map the name of the variable to a list of urls.
-     *
-     */
+    /** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
     inputVariables?: Credal.InputVariable[];
 }

src/api/resources/copilots/client/requests/UpdateConfigurationRequest.ts

@@ -20,10 +20,7 @@ import * as Credal from "../../../../index";
  *     }
  */
 export interface UpdateConfigurationRequest {
-    /**
-     * Credal-generated copilot ID to add the collection to.
-     *
-     */
+    /** Credal-generated copilot ID to add the collection to. */
     copilotId: string;
     configuration: Credal.Configuration;
 }

src/api/resources/copilots/types/ErrorChunk.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as Credal from "../../../index";
+
+export interface ErrorChunk {
+    error: Credal.ErrorChunkData;
+}

src/api/resources/copilots/types/ErrorChunkData.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface ErrorChunkData {
+    message: string;
+}

src/api/resources/copilots/types/SendMessageResponse.ts

@@ -7,13 +7,11 @@ import * as Credal from "../../../index";
 export type SendMessageResponse =
     /**
      * Returned when there is a reply
-     * fetched from the copilot.
-     *  */
+     * fetched from the copilot. */
     | Credal.SendMessageResponse.AiResponseResult
     /**
      * Returned when Credal detects possible
-     * infosec violations and blocks the message.
-     *  */
+     * infosec violations and blocks the message. */
     | Credal.SendMessageResponse.BlockedResult;
 
 export declare namespace SendMessageResponse {

src/api/resources/copilots/types/StreamingChunk.ts

@@ -9,7 +9,8 @@ export type StreamingChunk =
     | Credal.StreamingChunk.DataChunk
     | Credal.StreamingChunk.EndOfMessage
     | Credal.StreamingChunk.FinalChunk
-    | Credal.StreamingChunk.Blocked;
+    | Credal.StreamingChunk.Blocked
+    | Credal.StreamingChunk.ErrorChunk;
 
 export declare namespace StreamingChunk {
     interface Initial extends Credal.InitialChunk {
@@ -31,4 +32,8 @@ export declare namespace StreamingChunk {
     interface Blocked extends Credal.BlockedChunk {
         event: "blocked";
     }
+
+    interface ErrorChunk extends Credal.ErrorChunk {
+        event: "error_chunk";
+    }
 }

src/api/resources/copilots/types/index.ts

@@ -27,4 +27,6 @@ export * from "./DataChunk";
 export * from "./FinalChunk";
 export * from "./EndOfMessageChunk";
 export * from "./BlockedChunk";
+export * from "./ErrorChunkData";
+export * from "./ErrorChunk";
 export * from "./StreamingChunk";