@credal/sdk 0.0.30 → 0.1.0

package/dist/esm/api/resources/copilots/client/requests/SendMessageRequest.d.mts

@@ -0,0 +1,31 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         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"]
+ *             }]
+ *     }
+ */
+export interface SendMessageRequest {
+    /** Credal-generated Agent ID to specify which agent to route the request to. */
+    agentId: string;
+    /** The message you want to send to your agent. */
+    message: string;
+    /** 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. */
+    conversationId?: string;
+    /** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
+    inputVariables?: Credal.InputVariable[];
+}

package/dist/esm/api/resources/copilots/client/requests/SendMessageRequest.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/client/requests/StreamMessageRequest.d.mts

@@ -0,0 +1,59 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+ *         message: "Is Credal SOC 2 compliant?",
+ *         email: "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"]
+ *             }]
+ *     }
+ *
+ * @example
+ *     {
+ *         copilotId: "82e4b12a-6990-45d4-8ebd-85c00e030c24",
+ *         message: "Is this user eligible for benefits based on their date of birth?",
+ *         email: "ravin@credal.ai",
+ *         inputVariables: [{
+ *                 name: "input1",
+ *                 ids: ["82e4b12a-6990-45d4-8ebd-85c00e030c26"]
+ *             }, {
+ *                 name: "input2",
+ *                 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: "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"]
+ *             }]
+ *     }
+ */
+export interface StreamMessageRequest {
+    /** Credal-generated Agent ID to specify which agent to route the request to. */
+    copilotId: string;
+    /** The message you want to send to your agent. */
+    message: string;
+    /** 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. */
+    conversationId?: string;
+    /** Optional input variables to be used in the message. Map the name of the variable to a list of urls. */
+    inputVariables?: Credal.InputVariable[];
+}

package/dist/esm/api/resources/copilots/client/requests/StreamMessageRequest.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/client/requests/UpdateConfigurationRequest.d.mts

@@ -0,0 +1,24 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         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>"
+ *             }
+ *         }
+ *     }
+ */
+export interface UpdateConfigurationRequest {
+    /** Credal-generated agent ID to add the collection to. */
+    copilotId: string;
+    configuration: Credal.Configuration;
+}

package/dist/esm/api/resources/copilots/client/requests/UpdateConfigurationRequest.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/client/requests/index.d.mts

@@ -0,0 +1,9 @@
+export { type CreateCopilotRequest } from "./CreateCopilotRequest.mjs";
+export { type CreateConversationRequest } from "./CreateConversationRequest.mjs";
+export { type ProvideMessageFeedbackRequest } from "./ProvideMessageFeedbackRequest.mjs";
+export { type SendMessageRequest } from "./SendMessageRequest.mjs";
+export { type StreamMessageRequest } from "./StreamMessageRequest.mjs";
+export { type AddCollectionToCopilotRequest } from "./AddCollectionToCopilotRequest.mjs";
+export { type RemoveCollectionFromCopilotRequest } from "./RemoveCollectionFromCopilotRequest.mjs";
+export { type UpdateConfigurationRequest } from "./UpdateConfigurationRequest.mjs";
+export { type DeleteCopilotRequest } from "./DeleteCopilotRequest.mjs";

package/dist/esm/api/resources/copilots/index.d.mts

@@ -0,0 +1,2 @@
+export * from "./types/index.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/copilots/index.mjs

@@ -0,0 +1,2 @@
+export * from "./types/index.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/copilots/types/AiEndpointConfiguration.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/BlockedChunk.d.mts

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

package/dist/esm/api/resources/copilots/types/BlockedChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/BooleanFieldSchema.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/CollectionFilteredData.d.mts

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

package/dist/esm/api/resources/copilots/types/CollectionFilteredData.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/Configuration.d.mts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export interface Configuration {
+    aiEndpointConfiguration?: Credal.AiEndpointConfiguration;
+    name?: string;
+    description?: string;
+    prompt?: string;
+}

package/dist/esm/api/resources/copilots/types/Configuration.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/CreateConversationResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/CreateCopilotResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/DataChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/DataFilter.d.mts

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

package/dist/esm/api/resources/copilots/types/DataFilter.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/DatetimeFieldSchema.d.mts

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

package/dist/esm/api/resources/copilots/types/DatetimeFieldSchema.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/DeleteCopilotResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/EndOfMessageChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/ErrorChunk.d.mts

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

package/dist/esm/api/resources/copilots/types/ErrorChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/ErrorChunkData.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/FeedbackEnum.mjs

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

package/dist/esm/api/resources/copilots/types/Filter.d.mts

@@ -0,0 +1,19 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export 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/esm/api/resources/copilots/types/Filter.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/FinalChunk.d.mts

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

package/dist/esm/api/resources/copilots/types/FinalChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/InitialChunk.d.mts

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

package/dist/esm/api/resources/copilots/types/InitialChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/InputVariable.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/InsertedAuditLog.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/MessageBlocked.d.mts

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

package/dist/esm/api/resources/copilots/types/MessageBlocked.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/MessageFeedback.d.mts

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

package/dist/esm/api/resources/copilots/types/MessageFeedback.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/MessageReply.d.mts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export interface MessageReply {
+    policy_triggers: Credal.PolicyTrigger[];
+    conversationId: string;
+    response: Credal.ResponseChunk;
+    warnings: string[];
+    inserted_audit_log: Credal.InsertedAuditLog;
+    referencedSources: Credal.ReferencedSource[];
+    sourcesInDataContext: Credal.ReferencedSource[];
+    webSearchResults: Credal.WebSearchResult[];
+    messageId: string;
+}

package/dist/esm/api/resources/copilots/types/MessageReply.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/NumberFieldSchema.d.mts

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

package/dist/esm/api/resources/copilots/types/NumberFieldSchema.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/PolicyTrigger.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/ReferencedSource.d.mts

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

package/dist/esm/api/resources/copilots/types/ReferencedSource.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/ResponseChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/SendAgentMessageResponse.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export interface SendAgentMessageResponse {
+    sendChatResult: Credal.SendMessageResponse;
+}

package/dist/esm/api/resources/copilots/types/SendAgentMessageResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/SendMessageResponse.d.mts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export type SendMessageResponse = 
+/**
+ * Returned when there is a reply
+ * fetched from the agent. */
+Credal.SendMessageResponse.AiResponseResult
+/**
+ * Returned when Credal detects possible
+ * infosec violations and blocks the message. */
+ | Credal.SendMessageResponse.BlockedResult;
+export declare namespace SendMessageResponse {
+    interface AiResponseResult extends Credal.MessageReply {
+        type: "ai_response_result";
+    }
+    interface BlockedResult extends Credal.MessageBlocked {
+        type: "blocked_result";
+    }
+}

package/dist/esm/api/resources/copilots/types/SendMessageResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/StreamingChunk.d.mts

@@ -0,0 +1,25 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index.mjs";
+export type StreamingChunk = Credal.StreamingChunk.Initial | Credal.StreamingChunk.DataChunk | Credal.StreamingChunk.EndOfMessage | Credal.StreamingChunk.FinalChunk | Credal.StreamingChunk.Blocked | Credal.StreamingChunk.ErrorChunk;
+export declare namespace StreamingChunk {
+    interface Initial extends Credal.InitialChunk {
+        event: "initial";
+    }
+    interface DataChunk extends Credal.DataChunk {
+        event: "data_chunk";
+    }
+    interface EndOfMessage extends Credal.EndOfMessageChunk {
+        event: "end_of_message";
+    }
+    interface FinalChunk extends Credal.FinalChunk {
+        event: "final_chunk";
+    }
+    interface Blocked extends Credal.BlockedChunk {
+        event: "blocked";
+    }
+    interface ErrorChunk extends Credal.ErrorChunk {
+        event: "error_chunk";
+    }
+}

package/dist/esm/api/resources/copilots/types/StreamingChunk.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/StringFieldSchema.d.mts

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

package/dist/esm/api/resources/copilots/types/StringFieldSchema.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/WebSearchResult.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/dist/esm/api/resources/copilots/types/index.d.mts

@@ -0,0 +1,32 @@
+export * from "./CreateConversationResponse.mjs";
+export * from "./SendAgentMessageResponse.mjs";
+export * from "./SendMessageResponse.mjs";
+export * from "./InputVariable.mjs";
+export * from "./MessageReply.mjs";
+export * from "./ReferencedSource.mjs";
+export * from "./WebSearchResult.mjs";
+export * from "./ResponseChunk.mjs";
+export * from "./InsertedAuditLog.mjs";
+export * from "./MessageBlocked.mjs";
+export * from "./PolicyTrigger.mjs";
+export * from "./FeedbackEnum.mjs";
+export * from "./MessageFeedback.mjs";
+export * from "./Configuration.mjs";
+export * from "./AiEndpointConfiguration.mjs";
+export * from "./CreateCopilotResponse.mjs";
+export * from "./DeleteCopilotResponse.mjs";
+export * from "./StringFieldSchema.mjs";
+export * from "./NumberFieldSchema.mjs";
+export * from "./BooleanFieldSchema.mjs";
+export * from "./DatetimeFieldSchema.mjs";
+export * from "./Filter.mjs";
+export * from "./CollectionFilteredData.mjs";
+export * from "./DataFilter.mjs";
+export * from "./InitialChunk.mjs";
+export * from "./DataChunk.mjs";
+export * from "./FinalChunk.mjs";
+export * from "./EndOfMessageChunk.mjs";
+export * from "./BlockedChunk.mjs";
+export * from "./ErrorChunkData.mjs";
+export * from "./ErrorChunk.mjs";
+export * from "./StreamingChunk.mjs";