@wildix/wilma-agents-client 1.0.1

package/dist-types/commands/UpdateGuardrailCommand.d.ts

@@ -0,0 +1,175 @@
+import { Command as $Command } from "@smithy/core/client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { UpdateGuardrailInput, UpdateGuardrailOutput } from "../models/models_0";
+import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateGuardrailCommand}.
+ */
+export interface UpdateGuardrailCommandInput extends UpdateGuardrailInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateGuardrailCommand}.
+ */
+export interface UpdateGuardrailCommandOutput extends UpdateGuardrailOutput, __MetadataBearer {
+}
+declare const UpdateGuardrailCommand_base: {
+    new (input: UpdateGuardrailCommandInput): import("@smithy/core/client").CommandImpl<UpdateGuardrailCommandInput, UpdateGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: UpdateGuardrailCommandInput): import("@smithy/core/client").CommandImpl<UpdateGuardrailCommandInput, UpdateGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): {
+        [x: string]: unknown;
+    };
+};
+/**
+ * Updates a guardrail. The change applies to every agent referencing it.
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { WilmaAgentsClient, UpdateGuardrailCommand } from "@wildix/wilma-agents-client"; // ES Modules import
+ * // const { WilmaAgentsClient, UpdateGuardrailCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
+ * // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
+ * const config = {}; // type is WilmaAgentsClientConfig
+ * const client = new WilmaAgentsClient(config);
+ * const input = { // UpdateGuardrailInput
+ *   name: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   topicPolicy: { // GuardrailTopicPolicy
+ *     topics: [ // GuardrailTopicsList // required
+ *       { // GuardrailTopic
+ *         name: "STRING_VALUE", // required
+ *         definition: "STRING_VALUE", // required
+ *         examples: [ // GuardrailPhrasesList
+ *           "STRING_VALUE",
+ *         ],
+ *         action: "block" || "detect", // required
+ *       },
+ *     ],
+ *   },
+ *   contentPolicy: { // GuardrailContentPolicy
+ *     filters: [ // GuardrailContentFiltersList // required
+ *       { // GuardrailContentFilter
+ *         category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
+ *         inputStrength: "none" || "low" || "medium" || "high",
+ *         outputStrength: "none" || "low" || "medium" || "high",
+ *       },
+ *     ],
+ *   },
+ *   wordPolicy: { // GuardrailWordPolicy
+ *     blockedWords: [
+ *       "STRING_VALUE",
+ *     ],
+ *     profanity: true || false,
+ *   },
+ *   piiPolicy: { // GuardrailPiiPolicy
+ *     entities: [ // GuardrailPiiEntitiesList // required
+ *       { // GuardrailPiiEntity
+ *         entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
+ *         pattern: "STRING_VALUE",
+ *         action: "block" || "anonymize", // required
+ *       },
+ *     ],
+ *   },
+ *   blockedInputMessage: "STRING_VALUE",
+ *   blockedOutputMessage: "STRING_VALUE",
+ *   company: "STRING_VALUE",
+ *   guardrailId: "STRING_VALUE", // required
+ * };
+ * const command = new UpdateGuardrailCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateGuardrailOutput
+ * //   guardrail: { // Guardrail
+ * //     name: "STRING_VALUE", // required
+ * //     description: "STRING_VALUE",
+ * //     topicPolicy: { // GuardrailTopicPolicy
+ * //       topics: [ // GuardrailTopicsList // required
+ * //         { // GuardrailTopic
+ * //           name: "STRING_VALUE", // required
+ * //           definition: "STRING_VALUE", // required
+ * //           examples: [ // GuardrailPhrasesList
+ * //             "STRING_VALUE",
+ * //           ],
+ * //           action: "block" || "detect", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     contentPolicy: { // GuardrailContentPolicy
+ * //       filters: [ // GuardrailContentFiltersList // required
+ * //         { // GuardrailContentFilter
+ * //           category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
+ * //           inputStrength: "none" || "low" || "medium" || "high",
+ * //           outputStrength: "none" || "low" || "medium" || "high",
+ * //         },
+ * //       ],
+ * //     },
+ * //     wordPolicy: { // GuardrailWordPolicy
+ * //       blockedWords: [
+ * //         "STRING_VALUE",
+ * //       ],
+ * //       profanity: true || false,
+ * //     },
+ * //     piiPolicy: { // GuardrailPiiPolicy
+ * //       entities: [ // GuardrailPiiEntitiesList // required
+ * //         { // GuardrailPiiEntity
+ * //           entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
+ * //           pattern: "STRING_VALUE",
+ * //           action: "block" || "anonymize", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     blockedInputMessage: "STRING_VALUE",
+ * //     blockedOutputMessage: "STRING_VALUE",
+ * //     createdAt: "STRING_VALUE", // required
+ * //     createdBy: { // Actor
+ * //       type: "user" || "api_key" || "service", // required
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //     },
+ * //     updatedAt: "STRING_VALUE",
+ * //     updatedBy: {
+ * //       type: "user" || "api_key" || "service", // required
+ * //       id: "STRING_VALUE", // required
+ * //       name: "STRING_VALUE",
+ * //     },
+ * //     id: "STRING_VALUE", // required
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateGuardrailCommandInput - {@link UpdateGuardrailCommandInput}
+ * @returns {@link UpdateGuardrailCommandOutput}
+ * @see {@link UpdateGuardrailCommandInput} for command's `input` shape.
+ * @see {@link UpdateGuardrailCommandOutput} for command's `response` shape.
+ * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
+ *
+ * @throws {@link GuardrailNotFoundException} (client fault)
+ *
+ * @throws {@link ValidationException} (client fault)
+ *
+ * @throws {@link WilmaAgentsServiceException}
+ * <p>Base exception class for all service exceptions from WilmaAgents service.</p>
+ *
+ *
+ * @public
+ */
+export declare class UpdateGuardrailCommand extends UpdateGuardrailCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: UpdateGuardrailInput;
+            output: UpdateGuardrailOutput;
+        };
+        sdk: {
+            input: UpdateGuardrailCommandInput;
+            output: UpdateGuardrailCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -0,0 +1,23 @@
+export * from "./CompareAgentVersionsCommand";
+export * from "./CreateAgentApiKeyCommand";
+export * from "./CreateAgentCommand";
+export * from "./CreateGuardrailCommand";
+export * from "./DeleteAgentAliasCommand";
+export * from "./DeleteAgentApiKeyCommand";
+export * from "./DeleteAgentCommand";
+export * from "./DeleteGuardrailCommand";
+export * from "./ExecuteAgentCommand";
+export * from "./GetAgentCommand";
+export * from "./GetAgentVersionCommand";
+export * from "./GetGuardrailCommand";
+export * from "./ListAgentAliasesCommand";
+export * from "./ListAgentApiKeysCommand";
+export * from "./ListAgentVersionsCommand";
+export * from "./ListAgentsCommand";
+export * from "./ListAgentsNamesCommand";
+export * from "./ListAuditRecordsCommand";
+export * from "./ListGuardrailsCommand";
+export * from "./PublishAgentVersionCommand";
+export * from "./PutAgentAliasCommand";
+export * from "./UpdateAgentCommand";
+export * from "./UpdateGuardrailCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -0,0 +1,41 @@
+import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
+/**
+ * @public
+ */
+export interface ClientInputEndpointParameters {
+    clientContextParams?: {
+        env?: string | undefined | Provider<string | undefined>;
+    };
+    env?: string | undefined | Provider<string | undefined>;
+    endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
+}
+/**
+ * @public
+ */
+export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
+    defaultSigningName: string;
+};
+/**
+ * @internal
+ */
+export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
+/**
+ * @internal
+ */
+export declare const commonParams: {
+    readonly env: {
+        readonly type: "clientContextParams";
+        readonly name: "env";
+    };
+    readonly endpoint: {
+        readonly type: "builtInParams";
+        readonly name: "endpoint";
+    };
+};
+/**
+ * @internal
+ */
+export interface EndpointParameters extends __EndpointParameters {
+    env?: string | undefined;
+    endpoint?: string | undefined;
+}

package/dist-types/endpoint/bdd.d.ts

@@ -0,0 +1,2 @@
+import { BinaryDecisionDiagram } from "@smithy/core/endpoints";
+export declare const bdd: BinaryDecisionDiagram;

package/dist-types/endpoint/endpointResolver.d.ts

@@ -0,0 +1,8 @@
+import type { EndpointV2, Logger } from "@smithy/types";
+import type { EndpointParameters } from "./EndpointParameters";
+/**
+ * @internal
+ */
+export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
+    logger?: Logger;
+}) => EndpointV2;

package/dist-types/extensionConfiguration.d.ts

@@ -0,0 +1,8 @@
+import type { HttpHandlerExtensionConfiguration } from "@smithy/core/protocols";
+import type { DefaultExtensionConfiguration } from "@smithy/types";
+import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
+/**
+ * @internal
+ */
+export interface WilmaAgentsExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, HttpAuthExtensionConfiguration {
+}

package/dist-types/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Unified agent platform. A single agent configuration is deployed to multiple channels
+ *     (in-app assistant, chat conversations, voice calls, API) while keeping channel-specific
+ *     settings. Successor of the agent/bot configuration APIs of wim-wilma, xbees-users bots
+ *     and wim-voicebots. Covers the agent lifecycle: draft editing, immutable versions with
+ *     alias-based routing (rollback, canary), guardrail policies, API keys and a company-wide
+ *     audit trail. Durable runtime sessions live in the companion wilma-sessions service and
+ *     skills in wilma-skills. Evaluations live in wilma-evaluations; observability in
+ *     wilma-traces; analytics in wilma-analytics.
+ *
+ * @packageDocumentation
+ */
+export * from "./WilmaAgentsClient";
+export * from "./WilmaAgents";
+export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export type { RuntimeExtension } from "./runtimeExtensions";
+export type { WilmaAgentsExtensionConfiguration } from "./extensionConfiguration";
+export * from "./commands";
+export * from "./schemas/schemas_0";
+export * from "./models/enums";
+export * from "./models/errors";
+export * from "./models/models_0";
+export { WilmaAgentsServiceException } from "./models/WilmaAgentsServiceException";

package/dist-types/models/WilmaAgentsServiceException.d.ts

@@ -0,0 +1,14 @@
+import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/core/client";
+export type { __ServiceExceptionOptions };
+export { __ServiceException };
+/**
+ * @public
+ *
+ * Base exception class for all service exceptions from WilmaAgents service.
+ */
+export declare class WilmaAgentsServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}

package/dist-types/models/enums.d.ts

@@ -0,0 +1,301 @@
+/**
+ * @public
+ * @enum
+ */
+export declare const ActorType: {
+    readonly API_KEY: "api_key";
+    readonly SERVICE: "service";
+    readonly USER: "user";
+};
+/**
+ * @public
+ */
+export type ActorType = (typeof ActorType)[keyof typeof ActorType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AgentGrantPermission: {
+    readonly EDIT: "edit";
+    readonly USE: "use";
+    readonly VIEW: "view";
+};
+/**
+ * @public
+ */
+export type AgentGrantPermission = (typeof AgentGrantPermission)[keyof typeof AgentGrantPermission];
+/**
+ * @public
+ * @enum
+ */
+export declare const AgentVisibility: {
+    readonly EXPLICIT: "explicit";
+    readonly ORGANIZATION: "organization";
+};
+/**
+ * @public
+ */
+export type AgentVisibility = (typeof AgentVisibility)[keyof typeof AgentVisibility];
+/**
+ * @public
+ * @enum
+ */
+export declare const SpeechProvider: {
+    readonly ELEVENLABS: "elevenlabs";
+    readonly GOOGLE: "google";
+};
+/**
+ * @public
+ */
+export type SpeechProvider = (typeof SpeechProvider)[keyof typeof SpeechProvider];
+/**
+ * @public
+ * @enum
+ */
+export declare const WebhookMethod: {
+    readonly DELETE: "delete";
+    readonly GET: "get";
+    readonly PATCH: "patch";
+    readonly POST: "post";
+    readonly PUT: "put";
+};
+/**
+ * @public
+ */
+export type WebhookMethod = (typeof WebhookMethod)[keyof typeof WebhookMethod];
+/**
+ * @public
+ * @enum
+ */
+export declare const SandboxNetworkAccess: {
+    readonly ALL: "allow-all";
+    readonly ALLOWLIST: "allowlist";
+    readonly NONE: "deny-all";
+};
+/**
+ * @public
+ */
+export type SandboxNetworkAccess = (typeof SandboxNetworkAccess)[keyof typeof SandboxNetworkAccess];
+/**
+ * @public
+ * @enum
+ */
+export declare const WebSearchContextSize: {
+    readonly HIGH: "high";
+    readonly LOW: "low";
+    readonly MEDIUM: "medium";
+};
+/**
+ * @public
+ */
+export type WebSearchContextSize = (typeof WebSearchContextSize)[keyof typeof WebSearchContextSize];
+/**
+ * @public
+ * @enum
+ */
+export declare const AgentVariableType: {
+    readonly BOOLEAN: "boolean";
+    readonly NUMBER: "number";
+    readonly NUMBER_ARRAY: "number_array";
+    readonly STRING: "string";
+    readonly STRING_ARRAY: "string_array";
+};
+/**
+ * @public
+ */
+export type AgentVariableType = (typeof AgentVariableType)[keyof typeof AgentVariableType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AgentStatus: {
+    /**
+     * Has at least one published version.
+     */
+    readonly ACTIVE: "active";
+    /**
+     * Kept for history; not serving any traffic.
+     */
+    readonly ARCHIVED: "archived";
+    /**
+     * Being edited; never published yet.
+     */
+    readonly DRAFT: "draft";
+};
+/**
+ * @public
+ */
+export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const AgentFileScope: {
+    /**
+     * Shared to other agents only (not surfaced to the end user).
+     */
+    readonly AGENT: "agent";
+    /**
+     * Visible and downloadable by the end user.
+     */
+    readonly USER: "user";
+};
+/**
+ * @public
+ */
+export type AgentFileScope = (typeof AgentFileScope)[keyof typeof AgentFileScope];
+/**
+ * @public
+ * @enum
+ */
+export declare const ChannelType: {
+    /**
+     * Programmatic execution over the API.
+     */
+    readonly API: "api";
+    /**
+     * In-app assistant (x-bees / x-hoppers / Collaboration).
+     */
+    readonly ASSISTANT: "assistant";
+    /**
+     * Bot member of chat conversations.
+     */
+    readonly CHAT: "chat";
+    /**
+     * Voice calls on the PBX.
+     */
+    readonly VOICE: "voice";
+};
+/**
+ * @public
+ */
+export type ChannelType = (typeof ChannelType)[keyof typeof ChannelType];
+/**
+ * @public
+ * @enum
+ */
+export declare const AuditAction: {
+    readonly ALIAS_DELETED: "alias_deleted";
+    readonly ALIAS_UPDATED: "alias_updated";
+    readonly API_KEY_CREATED: "api_key_created";
+    readonly API_KEY_DELETED: "api_key_deleted";
+    readonly ARCHIVED: "archived";
+    readonly CREATED: "created";
+    readonly DELETED: "deleted";
+    readonly EVALUATION_CANCELLED: "evaluation_cancelled";
+    readonly EVALUATION_STARTED: "evaluation_started";
+    readonly PUBLISHED: "published";
+    readonly UPDATED: "updated";
+};
+/**
+ * @public
+ */
+export type AuditAction = (typeof AuditAction)[keyof typeof AuditAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const AuditResourceType: {
+    readonly AGENT: "agent";
+    readonly AGENT_ALIAS: "agent_alias";
+    readonly AGENT_API_KEY: "agent_api_key";
+    readonly AGENT_VERSION: "agent_version";
+    readonly DATASET: "dataset";
+    readonly EVALUATION: "evaluation";
+    readonly EVALUATOR: "evaluator";
+    readonly GUARDRAIL: "guardrail";
+    readonly SKILL: "skill";
+    readonly TEST_CASE: "test_case";
+};
+/**
+ * @public
+ */
+export type AuditResourceType = (typeof AuditResourceType)[keyof typeof AuditResourceType];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailContentCategory: {
+    readonly HATE: "hate";
+    readonly INSULTS: "insults";
+    readonly MISCONDUCT: "misconduct";
+    readonly PROMPT_ATTACK: "prompt_attack";
+    readonly SEXUAL: "sexual";
+    readonly VIOLENCE: "violence";
+};
+/**
+ * @public
+ */
+export type GuardrailContentCategory = (typeof GuardrailContentCategory)[keyof typeof GuardrailContentCategory];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailFilterStrength: {
+    readonly HIGH: "high";
+    readonly LOW: "low";
+    readonly MEDIUM: "medium";
+    readonly NONE: "none";
+};
+/**
+ * @public
+ */
+export type GuardrailFilterStrength = (typeof GuardrailFilterStrength)[keyof typeof GuardrailFilterStrength];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailPiiAction: {
+    /**
+     * Replace the entity with a placeholder, e.g. {EMAIL}.
+     */
+    readonly ANONYMIZE: "anonymize";
+    /**
+     * Block the message entirely.
+     */
+    readonly BLOCK: "block";
+};
+/**
+ * @public
+ */
+export type GuardrailPiiAction = (typeof GuardrailPiiAction)[keyof typeof GuardrailPiiAction];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailPiiEntityType: {
+    readonly ADDRESS: "address";
+    readonly CREDIT_CARD: "credit_card";
+    /**
+     * Custom entity matched by the regex in `pattern`.
+     */
+    readonly CUSTOM: "custom";
+    readonly EMAIL: "email";
+    readonly IBAN: "iban";
+    readonly NAME: "name";
+    readonly NATIONAL_ID: "national_id";
+    readonly PASSWORD: "password";
+    readonly PHONE_NUMBER: "phone_number";
+};
+/**
+ * @public
+ */
+export type GuardrailPiiEntityType = (typeof GuardrailPiiEntityType)[keyof typeof GuardrailPiiEntityType];
+/**
+ * @public
+ * @enum
+ */
+export declare const GuardrailAction: {
+    /**
+     * Block the message and answer with the configured blocked message.
+     */
+    readonly BLOCK: "block";
+    /**
+     * Record the violation in the trace but let the message through.
+     */
+    readonly DETECT: "detect";
+};
+/**
+ * @public
+ */
+export type GuardrailAction = (typeof GuardrailAction)[keyof typeof GuardrailAction];