@credal/sdk 0.0.13 → 0.0.14

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

@@ -2,6 +2,7 @@ export { type CreateCopilotRequest } from "./CreateCopilotRequest";
 export { type CreateConversationRequest } from "./CreateConversationRequest";
 export { type ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest";
 export { type SendMessageRequest } from "./SendMessageRequest";
+export { type StreamMessageRequest } from "./StreamMessageRequest";
 export { type AddCollectionToCopilotRequest } from "./AddCollectionToCopilotRequest";
 export { type RemoveCollectionFromCopilotRequest } from "./RemoveCollectionFromCopilotRequest";
 export { type UpdateConfigurationRequest } from "./UpdateConfigurationRequest";

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface BlockedChunk {
+    conversationId: string;
+    warnings: string[];
+    blocks: string[];
+    policyTriggers: Credal.PolicyTrigger[];
+}

package/dist/api/resources/copilots/types/BlockedChunk.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/types/BooleanFieldSchema.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface BooleanFieldSchema {
+    field: string;
+    operator: "==";
+    value: boolean;
+}

package/dist/api/resources/copilots/types/BooleanFieldSchema.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/types/CollectionFilteredData.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface CollectionFilteredData {
+    collectionId: string;
+    filteredDataIds: string[];
+    filters: Credal.Filter[];
+}

package/dist/api/resources/copilots/types/CollectionFilteredData.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/types/DataChunk.d.ts

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

package/dist/api/resources/copilots/types/DataChunk.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/types/DataFilter.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface DataFilter {
+    semanticSearchTerms: string[];
+    webSearchResults: string[];
+    filteredDataSourcesPerCollection: Credal.CollectionFilteredData[];
+}

package/dist/api/resources/copilots/types/DataFilter.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/types/DatetimeFieldSchema.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface DatetimeFieldSchema {
+    field: string;
+    operator: Credal.Operator;
+    value: string;
+}

package/dist/api/resources/copilots/types/DatetimeFieldSchema.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/types/Filter.d.ts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type Filter = Credal.Filter.String | Credal.Filter.Number | Credal.Filter.Boolean | Credal.Filter.Datetime;
+export declare namespace Filter {
+    interface String extends Credal.StringFieldSchema {
+        fieldType: "string";
+    }
+    interface Number extends Credal.NumberFieldSchema {
+        fieldType: "number";
+    }
+    interface Boolean extends Credal.BooleanFieldSchema {
+        fieldType: "boolean";
+    }
+    interface Datetime extends Credal.DatetimeFieldSchema {
+        fieldType: "datetime";
+    }
+}

package/dist/api/resources/copilots/types/Filter.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/types/FinalChunk.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface FinalChunk {
+    referencedSources: Credal.ReferencedSource[];
+}

package/dist/api/resources/copilots/types/FinalChunk.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/types/InitialChunk.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface InitialChunk {
+    conversationId: string;
+    warnings: string[];
+    webSearchResults: Credal.WebSearchResult[];
+    dataFilters?: Credal.DataFilter;
+}

package/dist/api/resources/copilots/types/InitialChunk.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/types/InputVariable.d.ts

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

package/dist/api/resources/copilots/types/InputVariable.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/types/MessageReply.d.ts

@@ -10,5 +10,6 @@ export interface MessageReply {
     insertedAuditLog: Credal.InsertedAuditLog;
     referencedSources: Credal.ReferencedSource[];
     sourcesInDataContext: Credal.ReferencedSource[];
+    webSearchResults: Credal.WebSearchResult[];
     messageId: string;
 }

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface NumberFieldSchema {
+    field: string;
+    operator: Credal.Operator;
+    value: number;
+}

package/dist/api/resources/copilots/types/NumberFieldSchema.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/types/StreamingChunk.d.ts

@@ -0,0 +1,5 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type StreamingChunk = Credal.InitialChunk | Credal.DataChunk | Credal.FinalChunk | Credal.BlockedChunk;

package/dist/api/resources/copilots/types/StreamingChunk.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/types/StringFieldSchema.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface StringFieldSchema {
+    field: string;
+    operator: Credal.Operator;
+    value: string;
+}

package/dist/api/resources/copilots/types/StringFieldSchema.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/types/WebSearchResult.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WebSearchResult {
+    title: string;
+    url: string;
+    content: string;
+}

package/dist/api/resources/copilots/types/WebSearchResult.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/types/index.d.ts

@@ -1,8 +1,10 @@
 export * from "./CreateConversationResponse";
 export * from "./SendAgentMessageResponse";
 export * from "./SendMessageResponse";
+export * from "./InputVariable";
 export * from "./MessageReply";
 export * from "./ReferencedSource";
+export * from "./WebSearchResult";
 export * from "./ResponseChunk";
 export * from "./InsertedAuditLog";
 export * from "./MessageBlocked";
@@ -13,3 +15,15 @@ export * from "./Configuration";
 export * from "./AiEndpointConfiguration";
 export * from "./CreateCopilotResponse";
 export * from "./DeleteCopilotResponse";
+export * from "./StringFieldSchema";
+export * from "./NumberFieldSchema";
+export * from "./BooleanFieldSchema";
+export * from "./DatetimeFieldSchema";
+export * from "./Filter";
+export * from "./CollectionFilteredData";
+export * from "./DataFilter";
+export * from "./InitialChunk";
+export * from "./DataChunk";
+export * from "./FinalChunk";
+export * from "./BlockedChunk";
+export * from "./StreamingChunk";

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

@@ -17,8 +17,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./CreateConversationResponse"), exports);
 __exportStar(require("./SendAgentMessageResponse"), exports);
 __exportStar(require("./SendMessageResponse"), exports);
+__exportStar(require("./InputVariable"), exports);
 __exportStar(require("./MessageReply"), exports);
 __exportStar(require("./ReferencedSource"), exports);
+__exportStar(require("./WebSearchResult"), exports);
 __exportStar(require("./ResponseChunk"), exports);
 __exportStar(require("./InsertedAuditLog"), exports);
 __exportStar(require("./MessageBlocked"), exports);
@@ -29,3 +31,15 @@ __exportStar(require("./Configuration"), exports);
 __exportStar(require("./AiEndpointConfiguration"), exports);
 __exportStar(require("./CreateCopilotResponse"), exports);
 __exportStar(require("./DeleteCopilotResponse"), exports);
+__exportStar(require("./StringFieldSchema"), exports);
+__exportStar(require("./NumberFieldSchema"), exports);
+__exportStar(require("./BooleanFieldSchema"), exports);
+__exportStar(require("./DatetimeFieldSchema"), exports);
+__exportStar(require("./Filter"), exports);
+__exportStar(require("./CollectionFilteredData"), exports);
+__exportStar(require("./DataFilter"), exports);
+__exportStar(require("./InitialChunk"), exports);
+__exportStar(require("./DataChunk"), exports);
+__exportStar(require("./FinalChunk"), exports);
+__exportStar(require("./BlockedChunk"), exports);
+__exportStar(require("./StreamingChunk"), exports);

package/dist/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.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "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.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/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.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -144,7 +144,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -206,7 +206,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -266,7 +266,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -342,7 +342,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -420,7 +420,7 @@ class DocumentCollections {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/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.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -144,7 +144,7 @@ class PermissionsService {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },
@@ -206,7 +206,7 @@ class PermissionsService {
                     Authorization: yield this._getAuthorizationHeader(),
                     "X-Fern-Language": "JavaScript",
                     "X-Fern-SDK-Name": "@credal/sdk",
-                    "X-Fern-SDK-Version": "0.0.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/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.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/api/resources/search/types/index.d.ts

@@ -2,5 +2,4 @@ export * from "./DocumentCollectionSearchOptions";
 export * from "./SearchDocumentCollectionResponse";
 export * from "./DocumentCollectionSearchResult";
 export * from "./SearchResultChunk";
-export * from "./Operator";
 export * from "./SingleFieldFilter";

package/dist/api/resources/search/types/index.js

@@ -18,5 +18,4 @@ __exportStar(require("./DocumentCollectionSearchOptions"), exports);
 __exportStar(require("./SearchDocumentCollectionResponse"), exports);
 __exportStar(require("./DocumentCollectionSearchResult"), exports);
 __exportStar(require("./SearchResultChunk"), exports);
-__exportStar(require("./Operator"), exports);
 __exportStar(require("./SingleFieldFilter"), exports);

package/dist/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.13",
+                    "X-Fern-SDK-Version": "0.0.14",
                     "X-Fern-Runtime": core.RUNTIME.type,
                     "X-Fern-Runtime-Version": core.RUNTIME.version,
                 },

package/dist/core/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./fetcher";
 export * from "./auth";
 export * from "./runtime";
+export * from "./streaming-fetcher";
 export * as serialization from "./schemas";

package/dist/core/index.js

@@ -30,4 +30,5 @@ exports.serialization = void 0;
 __exportStar(require("./fetcher"), exports);
 __exportStar(require("./auth"), exports);
 __exportStar(require("./runtime"), exports);
+__exportStar(require("./streaming-fetcher"), exports);
 exports.serialization = __importStar(require("./schemas"));

package/dist/core/streaming-fetcher/Stream.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+import { Readable } from "stream";
+export declare namespace Stream {
+    interface Args {
+        /**
+         * The HTTP response stream to read from.
+         */
+        stream: Readable | ReadableStream;
+        /**
+         * The event shape to use for parsing the stream data.
+         */
+        eventShape: JsonEvent | SseEvent;
+        /**
+         * An abort signal to stop the stream.
+         */
+        signal?: AbortSignal;
+    }
+    interface JsonEvent {
+        type: "json";
+        messageTerminator: string;
+    }
+    interface SseEvent {
+        type: "sse";
+        streamTerminator?: string;
+    }
+}
+export declare class Stream<T> implements AsyncIterable<T> {
+    private stream;
+    private parse;
+    /**
+     * The prefix to use for each message. For example,
+     * for SSE, the prefix is "data: ".
+     */
+    private prefix;
+    private messageTerminator;
+    private streamTerminator;
+    private controller;
+    constructor({ stream, parse, eventShape, signal }: Stream.Args & {
+        parse: (val: unknown) => Promise<T>;
+    });
+    private iterMessages;
+    [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
+    private decodeChunk;
+}
+/**
+ * Browser polyfill for ReadableStream
+ */
+export declare function readableStreamAsyncIterable<T>(stream: any): AsyncIterableIterator<T>;