@credal/sdk 0.0.3 → 0.0.5

package/README.md

@@ -0,0 +1,168 @@
+<div align="center">  
+  <img src="./credal-dark-logo.svg" width="400" />
+  <h1>Credal Typescript SDK</h1>
+
+  <p>
+    <strong>The Credal Typescript Library provides convenient access to the Credal API from applications written in Typescript.</strong>
+  </p>
+
+  <br>
+  <div>
+    <a href="https://buildwithfern.com/"><img src="https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen">     
+  </div>
+  <br>
+</div>
+
+# Documentation
+
+Docs for the API endpoints available through the SDK can be found [here](https://docs.credal.ai/getting-started/overview).
+
+## Reference
+
+A full reference of the SDK is available [here](./reference.md).
+
+# Installation
+
+```sh
+npm install @credal/sdk
+```
+
+# Usage
+
+```typescript
+import { CredalClient } from "@credal/sdk";
+
+const credal = new CredalClient({
+  apiKey: process.env.CREDAL_API_KEY,
+});
+
+await credal.copilots.sendMessage({
+    message: "Is Credal SOC 2 compliant?",
+    userEmail: "ravin@credal.ai"
+});
+```
+
+Docs for the API endpoints available through the SDK can be found [here](https://docs.credal.ai/getting-started/overview). 
+
+## Self Hosted
+
+If you're on a self-hosted Credal instance, then you can customize the base url of the SDK. 
+
+```typescript
+const credal = new CredalClient({
+    apiKey: process.env.CREDAL_API_KEY,
+    environment: "https://<custom-domain>/api",
+  });
+```
+
+## Request and Response Types
+
+The SDK exports all request and response types as TypeScript interfaces. Simply 
+import them under the `Credal` namespace: 
+
+```ts
+import { Credal } from "@credal/sdk"; 
+
+const metadata: Credal.DocumentMetadataPatch = {
+  resourceIdentifier: "..."
+};
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), 
+a subclass of [CredalError](./src/errors/CredalError.ts) will be thrown:
+
+```ts
+import { CredalError } from "@credal/sdk";
+
+try {
+  await credal.copilots.sendMessage(...);
+} catch (err) {
+  if (err instanceof CredalError) {
+    console.log(err.statusCode); 
+    console.log(err.message);
+    console.log(err.body); 
+  }
+}
+```
+
+## Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be
+retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+than the configured retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+  
+Use the `maxRetries` request option to configure this behavior. 
+
+```ts
+const response = await credal.copilots.sendMessage(..., {
+  maxRetries: 0 // override maxRetries at the request level
+});
+```
+
+## Timeouts
+
+The SDK defaults to a 60 second timout. Use the `timeoutInSeconds` option to 
+configure this behavior. 
+
+```ts
+const response = await credal.copilots.sendMessage(..., {
+  timeoutInSeconds: 30 // override timeout to 30s
+});
+```
+
+## Aborting Requests
+
+The SDK allows users to abort requests at any point by passing 
+in an abort signal. 
+
+```ts
+const controller = new AbortController();
+const response = await credal.copilots.sendMessage(..., {
+  abortSignal: controller.signal,
+});
+controller.abort(); // aborts the request
+```
+
+## Runtime compatiblity
+
+The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK 
+works in the following runtimes: 
+
+The following runtimes are supported:
+
+- Node.js 18+ 
+- Vercel 
+- Cloudflare Workers
+- Deno v1.25+
+- Bun 1.0+
+- React Native
+
+### Customizing Fetch client
+
+The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're 
+running in an unsupported environment, this provides a way for you to break the glass and 
+ensure the SDK works. 
+
+```ts
+import { CredalClient } from "@credal/sdk";
+
+const credal = new CredalClient({
+  apiKey: "...",
+  fetcher: // provide your implementation here
+});
+```
+
+
+# Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.

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

@@ -31,6 +31,21 @@ export declare class Copilots {
      *     })
      */
     createConversation(request: Credal.CreateConversationRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.CreateConversationResponse>;
+    /**
+     * @param {Credal.ProvideMessageFeedbackRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.provideMessageFeedback({
+     *         userEmail: "ravin@credal.ai",
+     *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+     *         messageFeedback: {
+     *             feedback: Credal.FeedbackEnum.Negative,
+     *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
+     *         }
+     *     })
+     */
+    provideMessageFeedback(request: Credal.ProvideMessageFeedbackRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
     /**
      * @param {Credal.SendMessageRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.

package/api/resources/copilots/client/Client.js

@@ -69,7 +69,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -108,6 +108,66 @@ class Copilots {
             }
         });
     }
+    /**
+     * @param {Credal.ProvideMessageFeedbackRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.provideMessageFeedback({
+     *         userEmail: "ravin@credal.ai",
+     *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+     *         messageFeedback: {
+     *             feedback: Credal.FeedbackEnum.Negative,
+     *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
+     *         }
+     *     })
+     */
+    provideMessageFeedback(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/provideMessageFeedback"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.5",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.ProvideMessageFeedbackRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     /**
      * @param {Credal.SendMessageRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,7 +188,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         userEmail: "ravin@credal.ai",
+ *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+ *         messageFeedback: {
+ *             feedback: Credal.FeedbackEnum.Negative,
+ *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
+ *         }
+ *     }
+ */
+export interface ProvideMessageFeedbackRequest {
+    /**
+     * The user profile you want to use when providing feedback.
+     *
+     */
+    userEmail: string;
+    /**
+     * The message ID for which feedback is being provided.
+     *
+     */
+    messageId: string;
+    /**
+     * The feedback provided by the user.
+     *
+     */
+    messageFeedback: Credal.MessageFeedback;
+}

package/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/client/requests/index.d.ts

@@ -1,2 +1,3 @@
 export { type CreateConversationRequest } from "./CreateConversationRequest";
+export { type ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest";
 export { type SendMessageRequest } from "./SendMessageRequest";

package/api/resources/copilots/types/FeedbackEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type FeedbackEnum = "POSITIVE" | "NEGATIVE";
+export declare const FeedbackEnum: {
+    readonly Positive: "POSITIVE";
+    readonly Negative: "NEGATIVE";
+};

package/api/resources/copilots/types/FeedbackEnum.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeedbackEnum = void 0;
+exports.FeedbackEnum = {
+    Positive: "POSITIVE",
+    Negative: "NEGATIVE",
+};

package/api/resources/copilots/types/MessageFeedback.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface MessageFeedback {
+    feedback: Credal.FeedbackEnum;
+    suggestedAnswer?: string;
+}

package/api/resources/copilots/types/MessageFeedback.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/MessageReply.d.ts

@@ -9,4 +9,6 @@ export interface MessageReply {
     warnings: string[];
     activitySourceIdsForAudit: string[];
     insertedAuditLog: Credal.InsertedAuditLog;
+    referencedSources: Credal.ReferencedSource[];
+    messageId: string;
 }

package/api/resources/copilots/types/ReferencedSource.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface ReferencedSource {
+    id: string;
+    externalResourceId: Credal.ExternalResourceId;
+    name: string;
+    url?: string;
+}

package/api/resources/copilots/types/ReferencedSource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/copilots/types/index.d.ts

@@ -2,7 +2,10 @@ export * from "./CreateConversationResponse";
 export * from "./SendAgentMessageResponse";
 export * from "./SendMessageResponse";
 export * from "./MessageReply";
+export * from "./ReferencedSource";
 export * from "./ResponseChunk";
 export * from "./InsertedAuditLog";
 export * from "./MessageBlocked";
 export * from "./PolicyTrigger";
+export * from "./FeedbackEnum";
+export * from "./MessageFeedback";

package/api/resources/copilots/types/index.js

@@ -18,7 +18,10 @@ __exportStar(require("./CreateConversationResponse"), exports);
 __exportStar(require("./SendAgentMessageResponse"), exports);
 __exportStar(require("./SendMessageResponse"), exports);
 __exportStar(require("./MessageReply"), exports);
+__exportStar(require("./ReferencedSource"), exports);
 __exportStar(require("./ResponseChunk"), exports);
 __exportStar(require("./InsertedAuditLog"), exports);
 __exportStar(require("./MessageBlocked"), exports);
 __exportStar(require("./PolicyTrigger"), exports);
+__exportStar(require("./FeedbackEnum"), exports);
+__exportStar(require("./MessageFeedback"), exports);

package/api/resources/documentCatalog/client/Client.js

@@ -71,7 +71,7 @@ class DocumentCatalog {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -154,7 +154,7 @@ class DocumentCatalog {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/documentCollections/client/Client.js

@@ -78,7 +78,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/permissionsService/client/Client.js

@@ -74,7 +74,7 @@ class PermissionsService {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -145,7 +145,7 @@ class PermissionsService {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -207,7 +207,7 @@ class PermissionsService {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

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

@@ -84,7 +84,7 @@ class Search {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/api/resources/search/client/requests/SearchDocumentCollectionRequest.d.ts

@@ -35,7 +35,7 @@ export interface SearchDocumentCollectionRequest {
      * The structured query filters to apply to the search query.
      *
      */
-    structuredQueryFilters: Credal.SingleFieldFilter[];
+    structuredQueryFilters?: Credal.SingleFieldFilter[];
     searchOptions?: Credal.DocumentCollectionSearchOptions;
     /**
      * Legacy metadata filter expression to apply to the search query. Use structuredQueryFilters instead.

package/api/resources/users/client/Client.js

@@ -79,7 +79,7 @@ class Users {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

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

@@ -31,6 +31,21 @@ export declare class Copilots {
      *     })
      */
     createConversation(request: Credal.CreateConversationRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.CreateConversationResponse>;
+    /**
+     * @param {Credal.ProvideMessageFeedbackRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.provideMessageFeedback({
+     *         userEmail: "ravin@credal.ai",
+     *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+     *         messageFeedback: {
+     *             feedback: Credal.FeedbackEnum.Negative,
+     *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
+     *         }
+     *     })
+     */
+    provideMessageFeedback(request: Credal.ProvideMessageFeedbackRequest, requestOptions?: Copilots.RequestOptions): Promise<void>;
     /**
      * @param {Credal.SendMessageRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.

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

@@ -69,7 +69,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -108,6 +108,66 @@ class Copilots {
             }
         });
     }
+    /**
+     * @param {Credal.ProvideMessageFeedbackRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.provideMessageFeedback({
+     *         userEmail: "ravin@credal.ai",
+     *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+     *         messageFeedback: {
+     *             feedback: Credal.FeedbackEnum.Negative,
+     *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
+     *         }
+     *     })
+     */
+    provideMessageFeedback(request, requestOptions) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: (0, url_join_1.default)((_b = (yield core.Supplier.get(this._options.environment))) !== null && _b !== void 0 ? _b : environments.CredalEnvironment.Production, "/v0/copilots/provideMessageFeedback"),
+                method: "POST",
+                headers: {
+                    Authorization: yield this._getAuthorizationHeader(),
+                    "X-Fern-Language": "JavaScript",
+                    "X-Fern-SDK-Name": "@credal/sdk",
+                    "X-Fern-SDK-Version": "0.0.5",
+                    "X-Fern-Runtime": core.RUNTIME.type,
+                    "X-Fern-Runtime-Version": core.RUNTIME.version,
+                },
+                contentType: "application/json",
+                body: yield serializers.ProvideMessageFeedbackRequest.jsonOrThrow(request, {
+                    unrecognizedObjectKeys: "strip",
+                }),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return;
+            }
+            if (_response.error.reason === "status-code") {
+                throw new errors.CredalError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                });
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.CredalError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                    });
+                case "timeout":
+                    throw new errors.CredalTimeoutError();
+                case "unknown":
+                    throw new errors.CredalError({
+                        message: _response.error.errorMessage,
+                    });
+            }
+        });
+    }
     /**
      * @param {Credal.SendMessageRequest} request
      * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
@@ -128,7 +188,7 @@ class Copilots {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.3",
+                    "X-Fern-SDK-Version": "0.0.5",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index";
+/**
+ * @example
+ *     {
+ *         userEmail: "ravin@credal.ai",
+ *         messageId: "dd721cd8-4bf2-4b94-9869-258df3dab9dc",
+ *         messageFeedback: {
+ *             feedback: Credal.FeedbackEnum.Negative,
+ *             suggestedAnswer: "Yes, Credal is SOC 2 compliant."
+ *         }
+ *     }
+ */
+export interface ProvideMessageFeedbackRequest {
+    /**
+     * The user profile you want to use when providing feedback.
+     *
+     */
+    userEmail: string;
+    /**
+     * The message ID for which feedback is being provided.
+     *
+     */
+    messageId: string;
+    /**
+     * The feedback provided by the user.
+     *
+     */
+    messageFeedback: Credal.MessageFeedback;
+}

package/dist/api/resources/copilots/client/requests/ProvideMessageFeedbackRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,2 +1,3 @@
 export { type CreateConversationRequest } from "./CreateConversationRequest";
+export { type ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest";
 export { type SendMessageRequest } from "./SendMessageRequest";

package/dist/api/resources/copilots/types/FeedbackEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type FeedbackEnum = "POSITIVE" | "NEGATIVE";
+export declare const FeedbackEnum: {
+    readonly Positive: "POSITIVE";
+    readonly Negative: "NEGATIVE";
+};