@wildix/wilma-agents-client 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/WilmaAgents.js +57 -0
- package/dist-cjs/WilmaAgentsClient.js +49 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +43 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +58 -0
- package/dist-cjs/commands/CompareAgentVersionsCommand.js +20 -0
- package/dist-cjs/commands/CreateAgentApiKeyCommand.js +20 -0
- package/dist-cjs/commands/CreateAgentCommand.js +20 -0
- package/dist-cjs/commands/CreateGuardrailCommand.js +20 -0
- package/dist-cjs/commands/DeleteAgentAliasCommand.js +20 -0
- package/dist-cjs/commands/DeleteAgentApiKeyCommand.js +20 -0
- package/dist-cjs/commands/DeleteAgentCommand.js +20 -0
- package/dist-cjs/commands/DeleteGuardrailCommand.js +20 -0
- package/dist-cjs/commands/ExecuteAgentCommand.js +20 -0
- package/dist-cjs/commands/GetAgentCommand.js +20 -0
- package/dist-cjs/commands/GetAgentVersionCommand.js +20 -0
- package/dist-cjs/commands/GetGuardrailCommand.js +20 -0
- package/dist-cjs/commands/ListAgentAliasesCommand.js +20 -0
- package/dist-cjs/commands/ListAgentApiKeysCommand.js +20 -0
- package/dist-cjs/commands/ListAgentVersionsCommand.js +20 -0
- package/dist-cjs/commands/ListAgentsCommand.js +20 -0
- package/dist-cjs/commands/ListAgentsNamesCommand.js +20 -0
- package/dist-cjs/commands/ListAuditRecordsCommand.js +20 -0
- package/dist-cjs/commands/ListGuardrailsCommand.js +20 -0
- package/dist-cjs/commands/PublishAgentVersionCommand.js +20 -0
- package/dist-cjs/commands/PutAgentAliasCommand.js +20 -0
- package/dist-cjs/commands/UpdateAgentCommand.js +20 -0
- package/dist-cjs/commands/UpdateGuardrailCommand.js +20 -0
- package/dist-cjs/commands/index.js +26 -0
- package/dist-cjs/endpoint/EndpointParameters.js +16 -0
- package/dist-cjs/endpoint/bdd.js +28 -0
- package/dist-cjs/endpoint/endpointResolver.js +16 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/index.js +13 -0
- package/dist-cjs/models/WilmaAgentsServiceException.js +12 -0
- package/dist-cjs/models/enums.js +118 -0
- package/dist-cjs/models/errors.js +154 -0
- package/dist-cjs/models/models_0.js +2 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +41 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +41 -0
- package/dist-cjs/runtimeExtensions.js +12 -0
- package/dist-cjs/schemas/schemas_0.js +1168 -0
- package/dist-es/WilmaAgents.js +53 -0
- package/dist-es/WilmaAgentsClient.js +45 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +52 -0
- package/dist-es/commands/CompareAgentVersionsCommand.js +16 -0
- package/dist-es/commands/CreateAgentApiKeyCommand.js +16 -0
- package/dist-es/commands/CreateAgentCommand.js +16 -0
- package/dist-es/commands/CreateGuardrailCommand.js +16 -0
- package/dist-es/commands/DeleteAgentAliasCommand.js +16 -0
- package/dist-es/commands/DeleteAgentApiKeyCommand.js +16 -0
- package/dist-es/commands/DeleteAgentCommand.js +16 -0
- package/dist-es/commands/DeleteGuardrailCommand.js +16 -0
- package/dist-es/commands/ExecuteAgentCommand.js +16 -0
- package/dist-es/commands/GetAgentCommand.js +16 -0
- package/dist-es/commands/GetAgentVersionCommand.js +16 -0
- package/dist-es/commands/GetGuardrailCommand.js +16 -0
- package/dist-es/commands/ListAgentAliasesCommand.js +16 -0
- package/dist-es/commands/ListAgentApiKeysCommand.js +16 -0
- package/dist-es/commands/ListAgentVersionsCommand.js +16 -0
- package/dist-es/commands/ListAgentsCommand.js +16 -0
- package/dist-es/commands/ListAgentsNamesCommand.js +16 -0
- package/dist-es/commands/ListAuditRecordsCommand.js +16 -0
- package/dist-es/commands/ListGuardrailsCommand.js +16 -0
- package/dist-es/commands/PublishAgentVersionCommand.js +16 -0
- package/dist-es/commands/PutAgentAliasCommand.js +16 -0
- package/dist-es/commands/UpdateAgentCommand.js +16 -0
- package/dist-es/commands/UpdateGuardrailCommand.js +16 -0
- package/dist-es/commands/index.js +23 -0
- package/dist-es/endpoint/EndpointParameters.js +12 -0
- package/dist-es/endpoint/bdd.js +25 -0
- package/dist-es/endpoint/endpointResolver.js +12 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/index.js +8 -0
- package/dist-es/models/WilmaAgentsServiceException.js +8 -0
- package/dist-es/models/enums.js +115 -0
- package/dist-es/models/errors.js +141 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +36 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +37 -0
- package/dist-es/runtimeExtensions.js +8 -0
- package/dist-es/schemas/schemas_0.js +1162 -0
- package/dist-types/WilmaAgents.d.ts +182 -0
- package/dist-types/WilmaAgentsClient.d.ts +192 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +81 -0
- package/dist-types/commands/CompareAgentVersionsCommand.d.ts +91 -0
- package/dist-types/commands/CreateAgentApiKeyCommand.d.ts +96 -0
- package/dist-types/commands/CreateAgentCommand.d.ts +654 -0
- package/dist-types/commands/CreateGuardrailCommand.d.ts +172 -0
- package/dist-types/commands/DeleteAgentAliasCommand.d.ts +82 -0
- package/dist-types/commands/DeleteAgentApiKeyCommand.d.ts +82 -0
- package/dist-types/commands/DeleteAgentCommand.d.ts +77 -0
- package/dist-types/commands/DeleteGuardrailCommand.d.ts +80 -0
- package/dist-types/commands/ExecuteAgentCommand.d.ts +112 -0
- package/dist-types/commands/GetAgentCommand.d.ts +386 -0
- package/dist-types/commands/GetAgentVersionCommand.d.ts +365 -0
- package/dist-types/commands/GetGuardrailCommand.d.ts +135 -0
- package/dist-types/commands/ListAgentAliasesCommand.d.ts +99 -0
- package/dist-types/commands/ListAgentApiKeysCommand.d.ts +95 -0
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +99 -0
- package/dist-types/commands/ListAgentsCommand.d.ts +391 -0
- package/dist-types/commands/ListAgentsNamesCommand.d.ts +90 -0
- package/dist-types/commands/ListAuditRecordsCommand.d.ts +109 -0
- package/dist-types/commands/ListGuardrailsCommand.d.ts +137 -0
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +370 -0
- package/dist-types/commands/PutAgentAliasCommand.d.ts +107 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +661 -0
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +175 -0
- package/dist-types/commands/index.d.ts +23 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +41 -0
- package/dist-types/endpoint/bdd.d.ts +2 -0
- package/dist-types/endpoint/endpointResolver.d.ts +8 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/index.d.ts +23 -0
- package/dist-types/models/WilmaAgentsServiceException.d.ts +14 -0
- package/dist-types/models/enums.d.ts +301 -0
- package/dist-types/models/errors.d.ts +129 -0
- package/dist-types/models/models_0.d.ts +2186 -0
- package/dist-types/runtimeConfig.browser.d.ts +55 -0
- package/dist-types/runtimeConfig.d.ts +55 -0
- package/dist-types/runtimeConfig.native.d.ts +54 -0
- package/dist-types/runtimeConfig.shared.d.ts +32 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/dist-types/schemas/schemas_0.d.ts +160 -0
- package/package.json +57 -0
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListAuditRecordsInput, ListAuditRecordsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListAuditRecordsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListAuditRecordsCommandInput extends ListAuditRecordsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListAuditRecordsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListAuditRecordsCommandOutput extends ListAuditRecordsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListAuditRecordsCommand_base: {
|
|
25
|
+
new (input: ListAuditRecordsCommandInput): import("@smithy/core/client").CommandImpl<ListAuditRecordsCommandInput, ListAuditRecordsCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListAuditRecordsCommandInput]): import("@smithy/core/client").CommandImpl<ListAuditRecordsCommandInput, ListAuditRecordsCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Lists immutable audit records of configuration changes (who changed what and when, with field-level before/after values), newest first.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WilmaAgentsClient, ListAuditRecordsCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
+
* // const { WilmaAgentsClient, ListAuditRecordsCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
|
|
38
|
+
* // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
|
|
39
|
+
* const config = {}; // type is WilmaAgentsClientConfig
|
|
40
|
+
* const client = new WilmaAgentsClient(config);
|
|
41
|
+
* const input = { // ListAuditRecordsInput
|
|
42
|
+
* company: "STRING_VALUE",
|
|
43
|
+
* agentId: "STRING_VALUE",
|
|
44
|
+
* resourceType: "agent" || "agent_version" || "agent_alias" || "agent_api_key" || "guardrail" || "skill" || "dataset" || "test_case" || "evaluator" || "evaluation",
|
|
45
|
+
* action: "created" || "updated" || "deleted" || "published" || "alias_updated" || "alias_deleted" || "archived" || "api_key_created" || "api_key_deleted" || "evaluation_started" || "evaluation_cancelled",
|
|
46
|
+
* actorId: "STRING_VALUE",
|
|
47
|
+
* from: "STRING_VALUE",
|
|
48
|
+
* to: "STRING_VALUE",
|
|
49
|
+
* limit: Number("int"),
|
|
50
|
+
* nextToken: "STRING_VALUE",
|
|
51
|
+
* };
|
|
52
|
+
* const command = new ListAuditRecordsCommand(input);
|
|
53
|
+
* const response = await client.send(command);
|
|
54
|
+
* // { // ListAuditRecordsOutput
|
|
55
|
+
* // records: [ // AuditRecordsList // required
|
|
56
|
+
* // { // AuditRecord
|
|
57
|
+
* // id: "STRING_VALUE", // required
|
|
58
|
+
* // timestamp: "STRING_VALUE", // required
|
|
59
|
+
* // actor: { // Actor
|
|
60
|
+
* // type: "user" || "api_key" || "service", // required
|
|
61
|
+
* // id: "STRING_VALUE", // required
|
|
62
|
+
* // name: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // action: "created" || "updated" || "deleted" || "published" || "alias_updated" || "alias_deleted" || "archived" || "api_key_created" || "api_key_deleted" || "evaluation_started" || "evaluation_cancelled", // required
|
|
65
|
+
* // resourceType: "agent" || "agent_version" || "agent_alias" || "agent_api_key" || "guardrail" || "skill" || "dataset" || "test_case" || "evaluator" || "evaluation", // required
|
|
66
|
+
* // resourceId: "STRING_VALUE", // required
|
|
67
|
+
* // agentId: "STRING_VALUE",
|
|
68
|
+
* // changes: [ // AgentVersionChangesList
|
|
69
|
+
* // { // AgentVersionChange
|
|
70
|
+
* // path: "STRING_VALUE", // required
|
|
71
|
+
* // before: "DOCUMENT_VALUE",
|
|
72
|
+
* // after: "DOCUMENT_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // requestId: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // nextToken: "STRING_VALUE",
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @param ListAuditRecordsCommandInput - {@link ListAuditRecordsCommandInput}
|
|
84
|
+
* @returns {@link ListAuditRecordsCommandOutput}
|
|
85
|
+
* @see {@link ListAuditRecordsCommandInput} for command's `input` shape.
|
|
86
|
+
* @see {@link ListAuditRecordsCommandOutput} for command's `response` shape.
|
|
87
|
+
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link ValidationException} (client fault)
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link WilmaAgentsServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
93
|
+
*
|
|
94
|
+
*
|
|
95
|
+
* @public
|
|
96
|
+
*/
|
|
97
|
+
export declare class ListAuditRecordsCommand extends ListAuditRecordsCommand_base {
|
|
98
|
+
/** @internal type navigation helper, not in runtime. */
|
|
99
|
+
protected static __types: {
|
|
100
|
+
api: {
|
|
101
|
+
input: ListAuditRecordsInput;
|
|
102
|
+
output: ListAuditRecordsOutput;
|
|
103
|
+
};
|
|
104
|
+
sdk: {
|
|
105
|
+
input: ListAuditRecordsCommandInput;
|
|
106
|
+
output: ListAuditRecordsCommandOutput;
|
|
107
|
+
};
|
|
108
|
+
};
|
|
109
|
+
}
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { ListGuardrailsInput, ListGuardrailsOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListGuardrailsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListGuardrailsCommandInput extends ListGuardrailsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListGuardrailsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListGuardrailsCommandOutput extends ListGuardrailsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListGuardrailsCommand_base: {
|
|
25
|
+
new (input: ListGuardrailsCommandInput): import("@smithy/core/client").CommandImpl<ListGuardrailsCommandInput, ListGuardrailsCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListGuardrailsCommandInput]): import("@smithy/core/client").CommandImpl<ListGuardrailsCommandInput, ListGuardrailsCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Lists guardrails for the specified company.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WilmaAgentsClient, ListGuardrailsCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
+
* // const { WilmaAgentsClient, ListGuardrailsCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
|
|
38
|
+
* // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
|
|
39
|
+
* const config = {}; // type is WilmaAgentsClientConfig
|
|
40
|
+
* const client = new WilmaAgentsClient(config);
|
|
41
|
+
* const input = { // ListGuardrailsInput
|
|
42
|
+
* company: "STRING_VALUE",
|
|
43
|
+
* limit: Number("int"),
|
|
44
|
+
* nextToken: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListGuardrailsCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListGuardrailsOutput
|
|
49
|
+
* // guardrails: [ // GuardrailsList // required
|
|
50
|
+
* // { // Guardrail
|
|
51
|
+
* // name: "STRING_VALUE", // required
|
|
52
|
+
* // description: "STRING_VALUE",
|
|
53
|
+
* // topicPolicy: { // GuardrailTopicPolicy
|
|
54
|
+
* // topics: [ // GuardrailTopicsList // required
|
|
55
|
+
* // { // GuardrailTopic
|
|
56
|
+
* // name: "STRING_VALUE", // required
|
|
57
|
+
* // definition: "STRING_VALUE", // required
|
|
58
|
+
* // examples: [ // GuardrailPhrasesList
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // action: "block" || "detect", // required
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // },
|
|
65
|
+
* // contentPolicy: { // GuardrailContentPolicy
|
|
66
|
+
* // filters: [ // GuardrailContentFiltersList // required
|
|
67
|
+
* // { // GuardrailContentFilter
|
|
68
|
+
* // category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
|
|
69
|
+
* // inputStrength: "none" || "low" || "medium" || "high",
|
|
70
|
+
* // outputStrength: "none" || "low" || "medium" || "high",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // },
|
|
74
|
+
* // wordPolicy: { // GuardrailWordPolicy
|
|
75
|
+
* // blockedWords: [
|
|
76
|
+
* // "STRING_VALUE",
|
|
77
|
+
* // ],
|
|
78
|
+
* // profanity: true || false,
|
|
79
|
+
* // },
|
|
80
|
+
* // piiPolicy: { // GuardrailPiiPolicy
|
|
81
|
+
* // entities: [ // GuardrailPiiEntitiesList // required
|
|
82
|
+
* // { // GuardrailPiiEntity
|
|
83
|
+
* // entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
|
|
84
|
+
* // pattern: "STRING_VALUE",
|
|
85
|
+
* // action: "block" || "anonymize", // required
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // },
|
|
89
|
+
* // blockedInputMessage: "STRING_VALUE",
|
|
90
|
+
* // blockedOutputMessage: "STRING_VALUE",
|
|
91
|
+
* // createdAt: "STRING_VALUE", // required
|
|
92
|
+
* // createdBy: { // Actor
|
|
93
|
+
* // type: "user" || "api_key" || "service", // required
|
|
94
|
+
* // id: "STRING_VALUE", // required
|
|
95
|
+
* // name: "STRING_VALUE",
|
|
96
|
+
* // },
|
|
97
|
+
* // updatedAt: "STRING_VALUE",
|
|
98
|
+
* // updatedBy: {
|
|
99
|
+
* // type: "user" || "api_key" || "service", // required
|
|
100
|
+
* // id: "STRING_VALUE", // required
|
|
101
|
+
* // name: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // id: "STRING_VALUE", // required
|
|
104
|
+
* // },
|
|
105
|
+
* // ],
|
|
106
|
+
* // nextToken: "STRING_VALUE",
|
|
107
|
+
* // };
|
|
108
|
+
*
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
* @param ListGuardrailsCommandInput - {@link ListGuardrailsCommandInput}
|
|
112
|
+
* @returns {@link ListGuardrailsCommandOutput}
|
|
113
|
+
* @see {@link ListGuardrailsCommandInput} for command's `input` shape.
|
|
114
|
+
* @see {@link ListGuardrailsCommandOutput} for command's `response` shape.
|
|
115
|
+
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link ValidationException} (client fault)
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link WilmaAgentsServiceException}
|
|
120
|
+
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
121
|
+
*
|
|
122
|
+
*
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export declare class ListGuardrailsCommand extends ListGuardrailsCommand_base {
|
|
126
|
+
/** @internal type navigation helper, not in runtime. */
|
|
127
|
+
protected static __types: {
|
|
128
|
+
api: {
|
|
129
|
+
input: ListGuardrailsInput;
|
|
130
|
+
output: ListGuardrailsOutput;
|
|
131
|
+
};
|
|
132
|
+
sdk: {
|
|
133
|
+
input: ListGuardrailsCommandInput;
|
|
134
|
+
output: ListGuardrailsCommandOutput;
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
}
|
|
@@ -0,0 +1,370 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
+
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import type { PublishAgentVersionInput, PublishAgentVersionOutput } from "../models/models_0";
|
|
4
|
+
import type { ServiceInputTypes, ServiceOutputTypes, WilmaAgentsClientResolvedConfig } from "../WilmaAgentsClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link PublishAgentVersionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface PublishAgentVersionCommandInput extends PublishAgentVersionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link PublishAgentVersionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface PublishAgentVersionCommandOutput extends PublishAgentVersionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const PublishAgentVersionCommand_base: {
|
|
25
|
+
new (input: PublishAgentVersionCommandInput): import("@smithy/core/client").CommandImpl<PublishAgentVersionCommandInput, PublishAgentVersionCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: PublishAgentVersionCommandInput): import("@smithy/core/client").CommandImpl<PublishAgentVersionCommandInput, PublishAgentVersionCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): {
|
|
28
|
+
[x: string]: unknown;
|
|
29
|
+
};
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* Publishes the current draft as a new immutable version. Publishing never changes what is served: point an alias at the new version (PutAgentAlias) to release it.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { WilmaAgentsClient, PublishAgentVersionCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
+
* // const { WilmaAgentsClient, PublishAgentVersionCommand } = require("@wildix/wilma-agents-client"); // CommonJS import
|
|
38
|
+
* // import type { WilmaAgentsClientConfig } from "@wildix/wilma-agents-client";
|
|
39
|
+
* const config = {}; // type is WilmaAgentsClientConfig
|
|
40
|
+
* const client = new WilmaAgentsClient(config);
|
|
41
|
+
* const input = { // PublishAgentVersionInput
|
|
42
|
+
* company: "STRING_VALUE",
|
|
43
|
+
* agentId: "STRING_VALUE", // required
|
|
44
|
+
* changelog: "STRING_VALUE",
|
|
45
|
+
* revision: Number("int"),
|
|
46
|
+
* };
|
|
47
|
+
* const command = new PublishAgentVersionCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // PublishAgentVersionOutput
|
|
50
|
+
* // version: { // AgentVersion
|
|
51
|
+
* // agentId: "STRING_VALUE", // required
|
|
52
|
+
* // version: Number("int"), // required
|
|
53
|
+
* // changelog: "STRING_VALUE",
|
|
54
|
+
* // definition: { // AgentDefinitionSnapshot
|
|
55
|
+
* // name: "STRING_VALUE", // required
|
|
56
|
+
* // description: "STRING_VALUE",
|
|
57
|
+
* // category: "STRING_VALUE",
|
|
58
|
+
* // picture: "STRING_VALUE",
|
|
59
|
+
* // engine: { // AgentEngine Union: only one key present
|
|
60
|
+
* // llm: { // AgentLlmEngine
|
|
61
|
+
* // instructions: "STRING_VALUE", // required
|
|
62
|
+
* // model: "STRING_VALUE",
|
|
63
|
+
* // skills: [ // AgentSkillsList
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // capabilities: [ // AgentCapabilitiesList
|
|
67
|
+
* // { // AgentCapability Union: only one key present
|
|
68
|
+
* // tool: { // AgentTool
|
|
69
|
+
* // id: "STRING_VALUE", // required
|
|
70
|
+
* // variables: [ // AgentToolVariablesList
|
|
71
|
+
* // { // AgentToolVariable
|
|
72
|
+
* // name: "STRING_VALUE", // required
|
|
73
|
+
* // handler: { // AgentToolVariableHandler Union: only one key present
|
|
74
|
+
* // auto: {},
|
|
75
|
+
* // guided: { // AgentToolVariableGuidedHandler
|
|
76
|
+
* // description: "STRING_VALUE", // required
|
|
77
|
+
* // },
|
|
78
|
+
* // predefined: { // AgentToolVariablePredefinedHandler
|
|
79
|
+
* // description: "STRING_VALUE", // required
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // function: { // AgentFunctionTool
|
|
86
|
+
* // name: "STRING_VALUE", // required
|
|
87
|
+
* // description: "STRING_VALUE",
|
|
88
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
89
|
+
* // integration: { // FunctionIntegration Union: only one key present
|
|
90
|
+
* // webhook: { // FunctionWebhookIntegration
|
|
91
|
+
* // url: "STRING_VALUE", // required
|
|
92
|
+
* // method: "get" || "post" || "put" || "delete" || "patch",
|
|
93
|
+
* // async: true || false,
|
|
94
|
+
* // authorization: { // WebhookAuthorization Union: only one key present
|
|
95
|
+
* // bearer: { // WebhookAuthorizationBearer
|
|
96
|
+
* // token: "STRING_VALUE", // required
|
|
97
|
+
* // },
|
|
98
|
+
* // basic: { // WebhookAuthorizationBasic
|
|
99
|
+
* // username: "STRING_VALUE", // required
|
|
100
|
+
* // password: "STRING_VALUE", // required
|
|
101
|
+
* // },
|
|
102
|
+
* // oauth: { // WebhookAuthorizationOAuth
|
|
103
|
+
* // clientId: "STRING_VALUE", // required
|
|
104
|
+
* // clientSecret: "STRING_VALUE", // required
|
|
105
|
+
* // endpointUrl: "STRING_VALUE", // required
|
|
106
|
+
* // scope: "STRING_VALUE",
|
|
107
|
+
* // },
|
|
108
|
+
* // },
|
|
109
|
+
* // headers: [ // WebhookHeadersList
|
|
110
|
+
* // { // WebhookHeader
|
|
111
|
+
* // name: "STRING_VALUE", // required
|
|
112
|
+
* // value: "STRING_VALUE", // required
|
|
113
|
+
* // },
|
|
114
|
+
* // ],
|
|
115
|
+
* // timeout: Number("int"),
|
|
116
|
+
* // parameters: "DOCUMENT_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // },
|
|
119
|
+
* // },
|
|
120
|
+
* // kb: { // AgentKnowledgeBase
|
|
121
|
+
* // knowledgeBaseId: "STRING_VALUE",
|
|
122
|
+
* // instructions: "STRING_VALUE",
|
|
123
|
+
* // },
|
|
124
|
+
* // sandbox: { // AgentSandboxCapability Union: only one key present
|
|
125
|
+
* // vercel: { // AgentVercelSandboxOptions
|
|
126
|
+
* // vcpus: Number("int"),
|
|
127
|
+
* // network: "allow-all" || "deny-all" || "allowlist",
|
|
128
|
+
* // allowedDomains: [ // DomainNameList
|
|
129
|
+
* // "STRING_VALUE",
|
|
130
|
+
* // ],
|
|
131
|
+
* // },
|
|
132
|
+
* // snapshot: { // AgentSnapshotSandboxOptions
|
|
133
|
+
* // snapshotId: "STRING_VALUE", // required
|
|
134
|
+
* // network: "allow-all" || "deny-all" || "allowlist",
|
|
135
|
+
* // allowedDomains: [
|
|
136
|
+
* // "STRING_VALUE",
|
|
137
|
+
* // ],
|
|
138
|
+
* // vcpus: Number("int"),
|
|
139
|
+
* // },
|
|
140
|
+
* // },
|
|
141
|
+
* // webSearch: { // AgentWebSearchCapability
|
|
142
|
+
* // contextSize: "low" || "medium" || "high",
|
|
143
|
+
* // allowedDomains: [
|
|
144
|
+
* // "STRING_VALUE",
|
|
145
|
+
* // ],
|
|
146
|
+
* // userLocation: { // WebSearchUserLocation
|
|
147
|
+
* // country: "STRING_VALUE",
|
|
148
|
+
* // region: "STRING_VALUE",
|
|
149
|
+
* // city: "STRING_VALUE",
|
|
150
|
+
* // timezone: "STRING_VALUE",
|
|
151
|
+
* // },
|
|
152
|
+
* // },
|
|
153
|
+
* // webFetch: { // AgentWebFetchCapability
|
|
154
|
+
* // allowedDomains: [
|
|
155
|
+
* // "STRING_VALUE",
|
|
156
|
+
* // ],
|
|
157
|
+
* // },
|
|
158
|
+
* // agent: { // AgentCallCapability
|
|
159
|
+
* // agentId: "STRING_VALUE", // required
|
|
160
|
+
* // variables: [
|
|
161
|
+
* // {
|
|
162
|
+
* // name: "STRING_VALUE", // required
|
|
163
|
+
* // handler: {// Union: only one key present
|
|
164
|
+
* // auto: {},
|
|
165
|
+
* // guided: {
|
|
166
|
+
* // description: "STRING_VALUE", // required
|
|
167
|
+
* // },
|
|
168
|
+
* // predefined: {
|
|
169
|
+
* // description: "STRING_VALUE", // required
|
|
170
|
+
* // },
|
|
171
|
+
* // },
|
|
172
|
+
* // },
|
|
173
|
+
* // ],
|
|
174
|
+
* // },
|
|
175
|
+
* // mcp: { // AgentMcpServerCapability
|
|
176
|
+
* // url: "STRING_VALUE", // required
|
|
177
|
+
* // authorization: {// Union: only one key present
|
|
178
|
+
* // bearer: {
|
|
179
|
+
* // token: "STRING_VALUE", // required
|
|
180
|
+
* // },
|
|
181
|
+
* // basic: {
|
|
182
|
+
* // username: "STRING_VALUE", // required
|
|
183
|
+
* // password: "STRING_VALUE", // required
|
|
184
|
+
* // },
|
|
185
|
+
* // oauth: {
|
|
186
|
+
* // clientId: "STRING_VALUE", // required
|
|
187
|
+
* // clientSecret: "STRING_VALUE", // required
|
|
188
|
+
* // endpointUrl: "STRING_VALUE", // required
|
|
189
|
+
* // scope: "STRING_VALUE",
|
|
190
|
+
* // },
|
|
191
|
+
* // },
|
|
192
|
+
* // allowedTools: [ // FunctionNameList
|
|
193
|
+
* // "STRING_VALUE",
|
|
194
|
+
* // ],
|
|
195
|
+
* // },
|
|
196
|
+
* // handover: { // AgentHandoverCapability
|
|
197
|
+
* // instructions: "STRING_VALUE",
|
|
198
|
+
* // message: "STRING_VALUE",
|
|
199
|
+
* // },
|
|
200
|
+
* // delegation: { // AgentDelegationCapability
|
|
201
|
+
* // agents: [ // AgentIdList
|
|
202
|
+
* // "STRING_VALUE",
|
|
203
|
+
* // ],
|
|
204
|
+
* // instructions: "STRING_VALUE",
|
|
205
|
+
* // },
|
|
206
|
+
* // transfer: { // AgentTransferCapability
|
|
207
|
+
* // targets: [ // VoiceTransferTargetsList // required
|
|
208
|
+
* // { // VoiceTransferTarget
|
|
209
|
+
* // name: "STRING_VALUE", // required
|
|
210
|
+
* // description: "STRING_VALUE",
|
|
211
|
+
* // context: "STRING_VALUE", // required
|
|
212
|
+
* // extension: "STRING_VALUE", // required
|
|
213
|
+
* // },
|
|
214
|
+
* // ],
|
|
215
|
+
* // instructions: "STRING_VALUE",
|
|
216
|
+
* // },
|
|
217
|
+
* // suggestions: {},
|
|
218
|
+
* // },
|
|
219
|
+
* // ],
|
|
220
|
+
* // variables: [ // AgentVariablesList
|
|
221
|
+
* // { // AgentVariable
|
|
222
|
+
* // name: "STRING_VALUE", // required
|
|
223
|
+
* // type: "string" || "number" || "boolean" || "string_array" || "number_array", // required
|
|
224
|
+
* // optional: true || false, // required
|
|
225
|
+
* // description: "STRING_VALUE",
|
|
226
|
+
* // },
|
|
227
|
+
* // ],
|
|
228
|
+
* // },
|
|
229
|
+
* // webhook: { // AgentWebhookEngine
|
|
230
|
+
* // url: "STRING_VALUE", // required
|
|
231
|
+
* // secret: "STRING_VALUE", // required
|
|
232
|
+
* // timeout: Number("int"),
|
|
233
|
+
* // },
|
|
234
|
+
* // sqs: { // AgentSqsEngine
|
|
235
|
+
* // url: "STRING_VALUE", // required
|
|
236
|
+
* // key: "STRING_VALUE", // required
|
|
237
|
+
* // secret: "STRING_VALUE", // required
|
|
238
|
+
* // },
|
|
239
|
+
* // },
|
|
240
|
+
* // channels: { // AgentChannels
|
|
241
|
+
* // assistant: { // AssistantChannelSettings
|
|
242
|
+
* // enabled: true || false, // required
|
|
243
|
+
* // default: true || false,
|
|
244
|
+
* // },
|
|
245
|
+
* // chat: { // ChatChannelSettings
|
|
246
|
+
* // enabled: true || false, // required
|
|
247
|
+
* // discoverable: true || false,
|
|
248
|
+
* // pbxGroupId: "STRING_VALUE",
|
|
249
|
+
* // welcomeMessage: "STRING_VALUE",
|
|
250
|
+
* // },
|
|
251
|
+
* // voice: { // VoiceChannelSettings
|
|
252
|
+
* // enabled: true || false, // required
|
|
253
|
+
* // language: "STRING_VALUE", // required
|
|
254
|
+
* // synthesis: { // VoiceSynthesisSettings
|
|
255
|
+
* // provider: "elevenlabs" || "google", // required
|
|
256
|
+
* // voiceId: "STRING_VALUE", // required
|
|
257
|
+
* // speed: Number("float"),
|
|
258
|
+
* // },
|
|
259
|
+
* // greeting: "STRING_VALUE",
|
|
260
|
+
* // interruptions: { // VoiceInterruptionSettings
|
|
261
|
+
* // enabled: true || false, // required
|
|
262
|
+
* // minWords: Number("int"),
|
|
263
|
+
* // },
|
|
264
|
+
* // silenceTimeout: { // VoiceSilenceTimeoutSettings
|
|
265
|
+
* // seconds: Number("int"), // required
|
|
266
|
+
* // action: { // VoiceTerminateAction Union: only one key present
|
|
267
|
+
* // hangup: { // VoiceTerminateHangupAction
|
|
268
|
+
* // message: "STRING_VALUE",
|
|
269
|
+
* // },
|
|
270
|
+
* // transfer: {
|
|
271
|
+
* // name: "STRING_VALUE", // required
|
|
272
|
+
* // description: "STRING_VALUE",
|
|
273
|
+
* // context: "STRING_VALUE", // required
|
|
274
|
+
* // extension: "STRING_VALUE", // required
|
|
275
|
+
* // },
|
|
276
|
+
* // },
|
|
277
|
+
* // },
|
|
278
|
+
* // maxDuration: { // VoiceMaxDurationSettings
|
|
279
|
+
* // seconds: Number("int"), // required
|
|
280
|
+
* // action: {// Union: only one key present
|
|
281
|
+
* // hangup: {
|
|
282
|
+
* // message: "STRING_VALUE",
|
|
283
|
+
* // },
|
|
284
|
+
* // transfer: {
|
|
285
|
+
* // name: "STRING_VALUE", // required
|
|
286
|
+
* // description: "STRING_VALUE",
|
|
287
|
+
* // context: "STRING_VALUE", // required
|
|
288
|
+
* // extension: "STRING_VALUE", // required
|
|
289
|
+
* // },
|
|
290
|
+
* // },
|
|
291
|
+
* // },
|
|
292
|
+
* // endCall: { // VoiceEndCallSettings
|
|
293
|
+
* // enabled: true || false, // required
|
|
294
|
+
* // phrases: "STRING_VALUE",
|
|
295
|
+
* // },
|
|
296
|
+
* // callerMetadata: { // VoiceCallerMetadataSettings
|
|
297
|
+
* // callerName: true || false,
|
|
298
|
+
* // callerNumber: true || false,
|
|
299
|
+
* // callerEmail: true || false,
|
|
300
|
+
* // callerCompany: true || false,
|
|
301
|
+
* // time: true || false,
|
|
302
|
+
* // timeZone: "STRING_VALUE",
|
|
303
|
+
* // },
|
|
304
|
+
* // },
|
|
305
|
+
* // api: { // ApiChannelSettings
|
|
306
|
+
* // enabled: true || false, // required
|
|
307
|
+
* // },
|
|
308
|
+
* // },
|
|
309
|
+
* // guardrails: [ // GuardrailIdList
|
|
310
|
+
* // "STRING_VALUE",
|
|
311
|
+
* // ],
|
|
312
|
+
* // access: { // AgentAccess
|
|
313
|
+
* // visibility: "explicit" || "organization",
|
|
314
|
+
* // grants: [ // AgentGrantList
|
|
315
|
+
* // { // AgentGrant
|
|
316
|
+
* // permission: "view" || "edit" || "use", // required
|
|
317
|
+
* // principal: { // AgentGrantPrincipal Union: only one key present
|
|
318
|
+
* // userId: "STRING_VALUE",
|
|
319
|
+
* // groupId: "STRING_VALUE",
|
|
320
|
+
* // },
|
|
321
|
+
* // },
|
|
322
|
+
* // ],
|
|
323
|
+
* // },
|
|
324
|
+
* // },
|
|
325
|
+
* // publishedAt: "STRING_VALUE", // required
|
|
326
|
+
* // publishedBy: { // Actor
|
|
327
|
+
* // type: "user" || "api_key" || "service", // required
|
|
328
|
+
* // id: "STRING_VALUE", // required
|
|
329
|
+
* // name: "STRING_VALUE",
|
|
330
|
+
* // },
|
|
331
|
+
* // },
|
|
332
|
+
* // };
|
|
333
|
+
*
|
|
334
|
+
* ```
|
|
335
|
+
*
|
|
336
|
+
* @param PublishAgentVersionCommandInput - {@link PublishAgentVersionCommandInput}
|
|
337
|
+
* @returns {@link PublishAgentVersionCommandOutput}
|
|
338
|
+
* @see {@link PublishAgentVersionCommandInput} for command's `input` shape.
|
|
339
|
+
* @see {@link PublishAgentVersionCommandOutput} for command's `response` shape.
|
|
340
|
+
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
341
|
+
*
|
|
342
|
+
* @throws {@link AgentNotFoundException} (client fault)
|
|
343
|
+
*
|
|
344
|
+
* @throws {@link NothingToPublishException} (client fault)
|
|
345
|
+
* The draft has not changed since the last published version; there is nothing to publish.
|
|
346
|
+
*
|
|
347
|
+
* @throws {@link RevisionConflictException} (client fault)
|
|
348
|
+
* The resource was modified concurrently; re-read it and retry with the latest revision.
|
|
349
|
+
*
|
|
350
|
+
* @throws {@link ValidationException} (client fault)
|
|
351
|
+
*
|
|
352
|
+
* @throws {@link WilmaAgentsServiceException}
|
|
353
|
+
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
354
|
+
*
|
|
355
|
+
*
|
|
356
|
+
* @public
|
|
357
|
+
*/
|
|
358
|
+
export declare class PublishAgentVersionCommand extends PublishAgentVersionCommand_base {
|
|
359
|
+
/** @internal type navigation helper, not in runtime. */
|
|
360
|
+
protected static __types: {
|
|
361
|
+
api: {
|
|
362
|
+
input: PublishAgentVersionInput;
|
|
363
|
+
output: PublishAgentVersionOutput;
|
|
364
|
+
};
|
|
365
|
+
sdk: {
|
|
366
|
+
input: PublishAgentVersionCommandInput;
|
|
367
|
+
output: PublishAgentVersionCommandOutput;
|
|
368
|
+
};
|
|
369
|
+
};
|
|
370
|
+
}
|