@wildix/wilma-agents-client 1.0.1 → 1.0.2
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 +12 -20
- package/dist-cjs/commands/{DeleteGuardrailCommand.js → CreateAgentDeploymentCommand.js} +6 -6
- package/dist-cjs/commands/{ExecuteAgentCommand.js → DeleteAgentDeploymentCommand.js} +6 -6
- package/dist-cjs/commands/{CreateGuardrailCommand.js → GetAgentDeploymentCommand.js} +6 -6
- package/dist-cjs/commands/{DeleteAgentAliasCommand.js → ListAgentDeploymentsCommand.js} +6 -6
- package/dist-cjs/commands/RestoreAgentVersionToDraftCommand.js +20 -0
- package/dist-cjs/commands/UpdateAgentDeploymentCommand.js +20 -0
- package/dist-cjs/commands/index.js +6 -10
- package/dist-cjs/models/enums.js +36 -81
- package/dist-cjs/models/errors.js +51 -36
- package/dist-cjs/schemas/schemas_0.js +358 -539
- package/dist-es/WilmaAgents.js +12 -20
- package/dist-es/commands/{DeleteAgentAliasCommand.js → CreateAgentDeploymentCommand.js} +5 -5
- package/dist-es/commands/{ExecuteAgentCommand.js → DeleteAgentDeploymentCommand.js} +5 -5
- package/dist-es/commands/{CreateGuardrailCommand.js → GetAgentDeploymentCommand.js} +5 -5
- package/dist-es/commands/{DeleteGuardrailCommand.js → ListAgentDeploymentsCommand.js} +5 -5
- package/dist-es/commands/RestoreAgentVersionToDraftCommand.js +16 -0
- package/dist-es/commands/UpdateAgentDeploymentCommand.js +16 -0
- package/dist-es/commands/index.js +6 -10
- package/dist-es/models/enums.js +35 -80
- package/dist-es/models/errors.js +42 -28
- package/dist-es/schemas/schemas_0.js +356 -536
- package/dist-types/WilmaAgents.d.ts +42 -71
- package/dist-types/WilmaAgentsClient.d.ts +16 -19
- package/dist-types/commands/CompareAgentVersionsCommand.d.ts +5 -5
- package/dist-types/commands/CreateAgentApiKeyCommand.d.ts +1 -3
- package/dist-types/commands/CreateAgentCommand.d.ts +451 -324
- package/dist-types/commands/CreateAgentDeploymentCommand.d.ts +116 -0
- package/dist-types/commands/DeleteAgentApiKeyCommand.d.ts +1 -3
- package/dist-types/commands/DeleteAgentCommand.d.ts +5 -4
- package/dist-types/commands/DeleteAgentDeploymentCommand.d.ts +83 -0
- package/dist-types/commands/GetAgentCommand.d.ts +237 -170
- package/dist-types/commands/GetAgentDeploymentCommand.d.ts +106 -0
- package/dist-types/commands/GetAgentVersionCommand.d.ts +219 -158
- package/dist-types/commands/ListAgentApiKeysCommand.d.ts +1 -3
- package/dist-types/commands/ListAgentDeploymentsCommand.d.ts +105 -0
- package/dist-types/commands/ListAgentVersionsCommand.d.ts +8 -7
- package/dist-types/commands/ListAgentsCommand.d.ts +241 -174
- package/dist-types/commands/ListAgentsNamesCommand.d.ts +6 -8
- package/dist-types/commands/PublishAgentVersionCommand.d.ts +221 -159
- package/dist-types/commands/RestoreAgentVersionToDraftCommand.d.ts +460 -0
- package/dist-types/commands/UpdateAgentCommand.d.ts +451 -324
- package/dist-types/commands/UpdateAgentDeploymentCommand.d.ts +120 -0
- package/dist-types/commands/index.d.ts +6 -10
- package/dist-types/index.d.ts +8 -7
- package/dist-types/models/enums.d.ts +126 -161
- package/dist-types/models/errors.d.ts +35 -22
- package/dist-types/models/models_0.d.ts +695 -741
- package/dist-types/schemas/schemas_0.d.ts +41 -61
- package/package.json +2 -2
- package/dist-cjs/commands/GetGuardrailCommand.js +0 -20
- package/dist-cjs/commands/ListAgentAliasesCommand.js +0 -20
- package/dist-cjs/commands/ListAuditRecordsCommand.js +0 -20
- package/dist-cjs/commands/ListGuardrailsCommand.js +0 -20
- package/dist-cjs/commands/PutAgentAliasCommand.js +0 -20
- package/dist-cjs/commands/UpdateGuardrailCommand.js +0 -20
- package/dist-es/commands/GetGuardrailCommand.js +0 -16
- package/dist-es/commands/ListAgentAliasesCommand.js +0 -16
- package/dist-es/commands/ListAuditRecordsCommand.js +0 -16
- package/dist-es/commands/ListGuardrailsCommand.js +0 -16
- package/dist-es/commands/PutAgentAliasCommand.js +0 -16
- package/dist-es/commands/UpdateGuardrailCommand.js +0 -16
- package/dist-types/commands/CreateGuardrailCommand.d.ts +0 -172
- package/dist-types/commands/DeleteAgentAliasCommand.d.ts +0 -82
- package/dist-types/commands/DeleteGuardrailCommand.d.ts +0 -80
- package/dist-types/commands/ExecuteAgentCommand.d.ts +0 -112
- package/dist-types/commands/GetGuardrailCommand.d.ts +0 -135
- package/dist-types/commands/ListAgentAliasesCommand.d.ts +0 -99
- package/dist-types/commands/ListAuditRecordsCommand.d.ts +0 -109
- package/dist-types/commands/ListGuardrailsCommand.d.ts +0 -137
- package/dist-types/commands/PutAgentAliasCommand.d.ts +0 -107
- package/dist-types/commands/UpdateGuardrailCommand.d.ts +0 -175
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DeleteAgentAliasInput, DeleteAgentAliasOutput } 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 DeleteAgentAliasCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface DeleteAgentAliasCommandInput extends DeleteAgentAliasInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link DeleteAgentAliasCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface DeleteAgentAliasCommandOutput extends DeleteAgentAliasOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const DeleteAgentAliasCommand_base: {
|
|
25
|
-
new (input: DeleteAgentAliasCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentAliasCommandInput, DeleteAgentAliasCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (input: DeleteAgentAliasCommandInput): import("@smithy/core/client").CommandImpl<DeleteAgentAliasCommandInput, DeleteAgentAliasCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): {
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Deletes an alias. The 'production' alias cannot be deleted while any channel is enabled.
|
|
33
|
-
* @example
|
|
34
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
-
* ```javascript
|
|
36
|
-
* import { WilmaAgentsClient, DeleteAgentAliasCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
-
* // const { WilmaAgentsClient, DeleteAgentAliasCommand } = 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 = { // DeleteAgentAliasInput
|
|
42
|
-
* company: "STRING_VALUE",
|
|
43
|
-
* agentId: "STRING_VALUE", // required
|
|
44
|
-
* aliasName: "STRING_VALUE", // required
|
|
45
|
-
* };
|
|
46
|
-
* const command = new DeleteAgentAliasCommand(input);
|
|
47
|
-
* const response = await client.send(command);
|
|
48
|
-
* // {};
|
|
49
|
-
*
|
|
50
|
-
* ```
|
|
51
|
-
*
|
|
52
|
-
* @param DeleteAgentAliasCommandInput - {@link DeleteAgentAliasCommandInput}
|
|
53
|
-
* @returns {@link DeleteAgentAliasCommandOutput}
|
|
54
|
-
* @see {@link DeleteAgentAliasCommandInput} for command's `input` shape.
|
|
55
|
-
* @see {@link DeleteAgentAliasCommandOutput} for command's `response` shape.
|
|
56
|
-
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
57
|
-
*
|
|
58
|
-
* @throws {@link AgentNotFoundException} (client fault)
|
|
59
|
-
*
|
|
60
|
-
* @throws {@link AgentAliasNotFoundException} (client fault)
|
|
61
|
-
*
|
|
62
|
-
* @throws {@link ValidationException} (client fault)
|
|
63
|
-
*
|
|
64
|
-
* @throws {@link WilmaAgentsServiceException}
|
|
65
|
-
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
* @public
|
|
69
|
-
*/
|
|
70
|
-
export declare class DeleteAgentAliasCommand extends DeleteAgentAliasCommand_base {
|
|
71
|
-
/** @internal type navigation helper, not in runtime. */
|
|
72
|
-
protected static __types: {
|
|
73
|
-
api: {
|
|
74
|
-
input: DeleteAgentAliasInput;
|
|
75
|
-
output: {};
|
|
76
|
-
};
|
|
77
|
-
sdk: {
|
|
78
|
-
input: DeleteAgentAliasCommandInput;
|
|
79
|
-
output: DeleteAgentAliasCommandOutput;
|
|
80
|
-
};
|
|
81
|
-
};
|
|
82
|
-
}
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { DeleteGuardrailInput, DeleteGuardrailOutput } 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 DeleteGuardrailCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface DeleteGuardrailCommandInput extends DeleteGuardrailInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link DeleteGuardrailCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface DeleteGuardrailCommandOutput extends DeleteGuardrailOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const DeleteGuardrailCommand_base: {
|
|
25
|
-
new (input: DeleteGuardrailCommandInput): import("@smithy/core/client").CommandImpl<DeleteGuardrailCommandInput, DeleteGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (input: DeleteGuardrailCommandInput): import("@smithy/core/client").CommandImpl<DeleteGuardrailCommandInput, DeleteGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): {
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Deletes a guardrail. Fails while any agent still references it.
|
|
33
|
-
* @example
|
|
34
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
-
* ```javascript
|
|
36
|
-
* import { WilmaAgentsClient, DeleteGuardrailCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
-
* // const { WilmaAgentsClient, DeleteGuardrailCommand } = 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 = { // DeleteGuardrailInput
|
|
42
|
-
* company: "STRING_VALUE",
|
|
43
|
-
* guardrailId: "STRING_VALUE", // required
|
|
44
|
-
* };
|
|
45
|
-
* const command = new DeleteGuardrailCommand(input);
|
|
46
|
-
* const response = await client.send(command);
|
|
47
|
-
* // {};
|
|
48
|
-
*
|
|
49
|
-
* ```
|
|
50
|
-
*
|
|
51
|
-
* @param DeleteGuardrailCommandInput - {@link DeleteGuardrailCommandInput}
|
|
52
|
-
* @returns {@link DeleteGuardrailCommandOutput}
|
|
53
|
-
* @see {@link DeleteGuardrailCommandInput} for command's `input` shape.
|
|
54
|
-
* @see {@link DeleteGuardrailCommandOutput} for command's `response` shape.
|
|
55
|
-
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
56
|
-
*
|
|
57
|
-
* @throws {@link GuardrailInUseException} (client fault)
|
|
58
|
-
* The guardrail is referenced by at least one agent and cannot be deleted.
|
|
59
|
-
*
|
|
60
|
-
* @throws {@link ValidationException} (client fault)
|
|
61
|
-
*
|
|
62
|
-
* @throws {@link WilmaAgentsServiceException}
|
|
63
|
-
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* @public
|
|
67
|
-
*/
|
|
68
|
-
export declare class DeleteGuardrailCommand extends DeleteGuardrailCommand_base {
|
|
69
|
-
/** @internal type navigation helper, not in runtime. */
|
|
70
|
-
protected static __types: {
|
|
71
|
-
api: {
|
|
72
|
-
input: DeleteGuardrailInput;
|
|
73
|
-
output: {};
|
|
74
|
-
};
|
|
75
|
-
sdk: {
|
|
76
|
-
input: DeleteGuardrailCommandInput;
|
|
77
|
-
output: DeleteGuardrailCommandOutput;
|
|
78
|
-
};
|
|
79
|
-
};
|
|
80
|
-
}
|
|
@@ -1,112 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { ExecuteAgentInput, ExecuteAgentOutput } 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 ExecuteAgentCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface ExecuteAgentCommandInput extends ExecuteAgentInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link ExecuteAgentCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface ExecuteAgentCommandOutput extends ExecuteAgentOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const ExecuteAgentCommand_base: {
|
|
25
|
-
new (input: ExecuteAgentCommandInput): import("@smithy/core/client").CommandImpl<ExecuteAgentCommandInput, ExecuteAgentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (input: ExecuteAgentCommandInput): import("@smithy/core/client").CommandImpl<ExecuteAgentCommandInput, ExecuteAgentCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): {
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Executes an agent over the API channel and returns the result. By default the 'production' alias is resolved; pass alias or version to execute another alias, a specific version, or the draft (for testing).
|
|
33
|
-
* @example
|
|
34
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
-
* ```javascript
|
|
36
|
-
* import { WilmaAgentsClient, ExecuteAgentCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
-
* // const { WilmaAgentsClient, ExecuteAgentCommand } = 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 = { // ExecuteAgentInput
|
|
42
|
-
* company: "STRING_VALUE",
|
|
43
|
-
* agentId: "STRING_VALUE", // required
|
|
44
|
-
* input: "STRING_VALUE", // required
|
|
45
|
-
* variables: "DOCUMENT_VALUE",
|
|
46
|
-
* alias: "STRING_VALUE",
|
|
47
|
-
* version: Number("int"),
|
|
48
|
-
* user: "STRING_VALUE",
|
|
49
|
-
* parentAgentId: "STRING_VALUE",
|
|
50
|
-
* parentTraceId: "STRING_VALUE",
|
|
51
|
-
* files: [ // FileIdList
|
|
52
|
-
* "STRING_VALUE",
|
|
53
|
-
* ],
|
|
54
|
-
* };
|
|
55
|
-
* const command = new ExecuteAgentCommand(input);
|
|
56
|
-
* const response = await client.send(command);
|
|
57
|
-
* // { // ExecuteAgentOutput
|
|
58
|
-
* // result: { // AgentExecutionResult
|
|
59
|
-
* // output: "DOCUMENT_VALUE",
|
|
60
|
-
* // error: { // AgentExecutionError
|
|
61
|
-
* // message: "STRING_VALUE", // required
|
|
62
|
-
* // code: "STRING_VALUE",
|
|
63
|
-
* // },
|
|
64
|
-
* // files: [ // AgentFileList
|
|
65
|
-
* // { // AgentFile
|
|
66
|
-
* // id: "STRING_VALUE", // required
|
|
67
|
-
* // name: "STRING_VALUE", // required
|
|
68
|
-
* // contentType: "STRING_VALUE",
|
|
69
|
-
* // size: Number("long"),
|
|
70
|
-
* // scope: "user" || "agent",
|
|
71
|
-
* // agentId: "STRING_VALUE",
|
|
72
|
-
* // sessionId: "STRING_VALUE",
|
|
73
|
-
* // createdAt: "STRING_VALUE", // required
|
|
74
|
-
* // },
|
|
75
|
-
* // ],
|
|
76
|
-
* // traceId: "STRING_VALUE",
|
|
77
|
-
* // },
|
|
78
|
-
* // };
|
|
79
|
-
*
|
|
80
|
-
* ```
|
|
81
|
-
*
|
|
82
|
-
* @param ExecuteAgentCommandInput - {@link ExecuteAgentCommandInput}
|
|
83
|
-
* @returns {@link ExecuteAgentCommandOutput}
|
|
84
|
-
* @see {@link ExecuteAgentCommandInput} for command's `input` shape.
|
|
85
|
-
* @see {@link ExecuteAgentCommandOutput} for command's `response` shape.
|
|
86
|
-
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
87
|
-
*
|
|
88
|
-
* @throws {@link AgentNotFoundException} (client fault)
|
|
89
|
-
*
|
|
90
|
-
* @throws {@link AgentVersionNotFoundException} (client fault)
|
|
91
|
-
*
|
|
92
|
-
* @throws {@link ValidationException} (client fault)
|
|
93
|
-
*
|
|
94
|
-
* @throws {@link WilmaAgentsServiceException}
|
|
95
|
-
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
* @public
|
|
99
|
-
*/
|
|
100
|
-
export declare class ExecuteAgentCommand extends ExecuteAgentCommand_base {
|
|
101
|
-
/** @internal type navigation helper, not in runtime. */
|
|
102
|
-
protected static __types: {
|
|
103
|
-
api: {
|
|
104
|
-
input: ExecuteAgentInput;
|
|
105
|
-
output: ExecuteAgentOutput;
|
|
106
|
-
};
|
|
107
|
-
sdk: {
|
|
108
|
-
input: ExecuteAgentCommandInput;
|
|
109
|
-
output: ExecuteAgentCommandOutput;
|
|
110
|
-
};
|
|
111
|
-
};
|
|
112
|
-
}
|
|
@@ -1,135 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { GetGuardrailInput, GetGuardrailOutput } 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 GetGuardrailCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface GetGuardrailCommandInput extends GetGuardrailInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link GetGuardrailCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface GetGuardrailCommandOutput extends GetGuardrailOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const GetGuardrailCommand_base: {
|
|
25
|
-
new (input: GetGuardrailCommandInput): import("@smithy/core/client").CommandImpl<GetGuardrailCommandInput, GetGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (input: GetGuardrailCommandInput): import("@smithy/core/client").CommandImpl<GetGuardrailCommandInput, GetGuardrailCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): {
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Retrieves a guardrail.
|
|
33
|
-
* @example
|
|
34
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
-
* ```javascript
|
|
36
|
-
* import { WilmaAgentsClient, GetGuardrailCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
-
* // const { WilmaAgentsClient, GetGuardrailCommand } = 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 = { // GetGuardrailInput
|
|
42
|
-
* company: "STRING_VALUE",
|
|
43
|
-
* guardrailId: "STRING_VALUE", // required
|
|
44
|
-
* };
|
|
45
|
-
* const command = new GetGuardrailCommand(input);
|
|
46
|
-
* const response = await client.send(command);
|
|
47
|
-
* // { // GetGuardrailOutput
|
|
48
|
-
* // guardrail: { // Guardrail
|
|
49
|
-
* // name: "STRING_VALUE", // required
|
|
50
|
-
* // description: "STRING_VALUE",
|
|
51
|
-
* // topicPolicy: { // GuardrailTopicPolicy
|
|
52
|
-
* // topics: [ // GuardrailTopicsList // required
|
|
53
|
-
* // { // GuardrailTopic
|
|
54
|
-
* // name: "STRING_VALUE", // required
|
|
55
|
-
* // definition: "STRING_VALUE", // required
|
|
56
|
-
* // examples: [ // GuardrailPhrasesList
|
|
57
|
-
* // "STRING_VALUE",
|
|
58
|
-
* // ],
|
|
59
|
-
* // action: "block" || "detect", // required
|
|
60
|
-
* // },
|
|
61
|
-
* // ],
|
|
62
|
-
* // },
|
|
63
|
-
* // contentPolicy: { // GuardrailContentPolicy
|
|
64
|
-
* // filters: [ // GuardrailContentFiltersList // required
|
|
65
|
-
* // { // GuardrailContentFilter
|
|
66
|
-
* // category: "hate" || "insults" || "sexual" || "violence" || "misconduct" || "prompt_attack", // required
|
|
67
|
-
* // inputStrength: "none" || "low" || "medium" || "high",
|
|
68
|
-
* // outputStrength: "none" || "low" || "medium" || "high",
|
|
69
|
-
* // },
|
|
70
|
-
* // ],
|
|
71
|
-
* // },
|
|
72
|
-
* // wordPolicy: { // GuardrailWordPolicy
|
|
73
|
-
* // blockedWords: [
|
|
74
|
-
* // "STRING_VALUE",
|
|
75
|
-
* // ],
|
|
76
|
-
* // profanity: true || false,
|
|
77
|
-
* // },
|
|
78
|
-
* // piiPolicy: { // GuardrailPiiPolicy
|
|
79
|
-
* // entities: [ // GuardrailPiiEntitiesList // required
|
|
80
|
-
* // { // GuardrailPiiEntity
|
|
81
|
-
* // entityType: "email" || "phone_number" || "name" || "address" || "credit_card" || "iban" || "national_id" || "password" || "custom", // required
|
|
82
|
-
* // pattern: "STRING_VALUE",
|
|
83
|
-
* // action: "block" || "anonymize", // required
|
|
84
|
-
* // },
|
|
85
|
-
* // ],
|
|
86
|
-
* // },
|
|
87
|
-
* // blockedInputMessage: "STRING_VALUE",
|
|
88
|
-
* // blockedOutputMessage: "STRING_VALUE",
|
|
89
|
-
* // createdAt: "STRING_VALUE", // required
|
|
90
|
-
* // createdBy: { // Actor
|
|
91
|
-
* // type: "user" || "api_key" || "service", // required
|
|
92
|
-
* // id: "STRING_VALUE", // required
|
|
93
|
-
* // name: "STRING_VALUE",
|
|
94
|
-
* // },
|
|
95
|
-
* // updatedAt: "STRING_VALUE",
|
|
96
|
-
* // updatedBy: {
|
|
97
|
-
* // type: "user" || "api_key" || "service", // required
|
|
98
|
-
* // id: "STRING_VALUE", // required
|
|
99
|
-
* // name: "STRING_VALUE",
|
|
100
|
-
* // },
|
|
101
|
-
* // id: "STRING_VALUE", // required
|
|
102
|
-
* // },
|
|
103
|
-
* // };
|
|
104
|
-
*
|
|
105
|
-
* ```
|
|
106
|
-
*
|
|
107
|
-
* @param GetGuardrailCommandInput - {@link GetGuardrailCommandInput}
|
|
108
|
-
* @returns {@link GetGuardrailCommandOutput}
|
|
109
|
-
* @see {@link GetGuardrailCommandInput} for command's `input` shape.
|
|
110
|
-
* @see {@link GetGuardrailCommandOutput} for command's `response` shape.
|
|
111
|
-
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
112
|
-
*
|
|
113
|
-
* @throws {@link GuardrailNotFoundException} (client fault)
|
|
114
|
-
*
|
|
115
|
-
* @throws {@link ValidationException} (client fault)
|
|
116
|
-
*
|
|
117
|
-
* @throws {@link WilmaAgentsServiceException}
|
|
118
|
-
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
* @public
|
|
122
|
-
*/
|
|
123
|
-
export declare class GetGuardrailCommand extends GetGuardrailCommand_base {
|
|
124
|
-
/** @internal type navigation helper, not in runtime. */
|
|
125
|
-
protected static __types: {
|
|
126
|
-
api: {
|
|
127
|
-
input: GetGuardrailInput;
|
|
128
|
-
output: GetGuardrailOutput;
|
|
129
|
-
};
|
|
130
|
-
sdk: {
|
|
131
|
-
input: GetGuardrailCommandInput;
|
|
132
|
-
output: GetGuardrailCommandOutput;
|
|
133
|
-
};
|
|
134
|
-
};
|
|
135
|
-
}
|
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
import { Command as $Command } from "@smithy/core/client";
|
|
2
|
-
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
-
import type { ListAgentAliasesInput, ListAgentAliasesOutput } 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 ListAgentAliasesCommand}.
|
|
14
|
-
*/
|
|
15
|
-
export interface ListAgentAliasesCommandInput extends ListAgentAliasesInput {
|
|
16
|
-
}
|
|
17
|
-
/**
|
|
18
|
-
* @public
|
|
19
|
-
*
|
|
20
|
-
* The output of {@link ListAgentAliasesCommand}.
|
|
21
|
-
*/
|
|
22
|
-
export interface ListAgentAliasesCommandOutput extends ListAgentAliasesOutput, __MetadataBearer {
|
|
23
|
-
}
|
|
24
|
-
declare const ListAgentAliasesCommand_base: {
|
|
25
|
-
new (input: ListAgentAliasesCommandInput): import("@smithy/core/client").CommandImpl<ListAgentAliasesCommandInput, ListAgentAliasesCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
-
new (input: ListAgentAliasesCommandInput): import("@smithy/core/client").CommandImpl<ListAgentAliasesCommandInput, ListAgentAliasesCommandOutput, WilmaAgentsClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
-
getEndpointParameterInstructions(): {
|
|
28
|
-
[x: string]: unknown;
|
|
29
|
-
};
|
|
30
|
-
};
|
|
31
|
-
/**
|
|
32
|
-
* Lists the aliases of an agent with their version routing.
|
|
33
|
-
* @example
|
|
34
|
-
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
-
* ```javascript
|
|
36
|
-
* import { WilmaAgentsClient, ListAgentAliasesCommand } from "@wildix/wilma-agents-client"; // ES Modules import
|
|
37
|
-
* // const { WilmaAgentsClient, ListAgentAliasesCommand } = 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 = { // ListAgentAliasesInput
|
|
42
|
-
* company: "STRING_VALUE",
|
|
43
|
-
* agentId: "STRING_VALUE", // required
|
|
44
|
-
* };
|
|
45
|
-
* const command = new ListAgentAliasesCommand(input);
|
|
46
|
-
* const response = await client.send(command);
|
|
47
|
-
* // { // ListAgentAliasesOutput
|
|
48
|
-
* // aliases: [ // AgentAliasesList // required
|
|
49
|
-
* // { // AgentAlias
|
|
50
|
-
* // name: "STRING_VALUE", // required
|
|
51
|
-
* // agentId: "STRING_VALUE", // required
|
|
52
|
-
* // description: "STRING_VALUE",
|
|
53
|
-
* // routing: [ // AgentAliasRoutesList // required
|
|
54
|
-
* // { // AgentAliasRoute
|
|
55
|
-
* // version: Number("int"), // required
|
|
56
|
-
* // weight: Number("int"), // required
|
|
57
|
-
* // },
|
|
58
|
-
* // ],
|
|
59
|
-
* // updatedAt: "STRING_VALUE", // required
|
|
60
|
-
* // updatedBy: { // Actor
|
|
61
|
-
* // type: "user" || "api_key" || "service", // required
|
|
62
|
-
* // id: "STRING_VALUE", // required
|
|
63
|
-
* // name: "STRING_VALUE",
|
|
64
|
-
* // },
|
|
65
|
-
* // },
|
|
66
|
-
* // ],
|
|
67
|
-
* // };
|
|
68
|
-
*
|
|
69
|
-
* ```
|
|
70
|
-
*
|
|
71
|
-
* @param ListAgentAliasesCommandInput - {@link ListAgentAliasesCommandInput}
|
|
72
|
-
* @returns {@link ListAgentAliasesCommandOutput}
|
|
73
|
-
* @see {@link ListAgentAliasesCommandInput} for command's `input` shape.
|
|
74
|
-
* @see {@link ListAgentAliasesCommandOutput} for command's `response` shape.
|
|
75
|
-
* @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
|
|
76
|
-
*
|
|
77
|
-
* @throws {@link AgentNotFoundException} (client fault)
|
|
78
|
-
*
|
|
79
|
-
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
*
|
|
81
|
-
* @throws {@link WilmaAgentsServiceException}
|
|
82
|
-
* <p>Base exception class for all service exceptions from WilmaAgents service.</p>
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
* @public
|
|
86
|
-
*/
|
|
87
|
-
export declare class ListAgentAliasesCommand extends ListAgentAliasesCommand_base {
|
|
88
|
-
/** @internal type navigation helper, not in runtime. */
|
|
89
|
-
protected static __types: {
|
|
90
|
-
api: {
|
|
91
|
-
input: ListAgentAliasesInput;
|
|
92
|
-
output: ListAgentAliasesOutput;
|
|
93
|
-
};
|
|
94
|
-
sdk: {
|
|
95
|
-
input: ListAgentAliasesCommandInput;
|
|
96
|
-
output: ListAgentAliasesCommandOutput;
|
|
97
|
-
};
|
|
98
|
-
};
|
|
99
|
-
}
|
|
@@ -1,109 +0,0 @@
|
|
|
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
|
-
}
|