@uipath/agent-sdk 1.0.1 → 1.1.0
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/generated/src/apis/GovernanceDesignerApi.d.ts +31 -0
- package/dist/generated/src/apis/index.d.ts +1 -0
- package/dist/generated/src/models/AgentEnforcementsDto.d.ts +56 -0
- package/dist/generated/src/models/EvalRunSource.d.ts +1 -1
- package/dist/generated/src/models/LlmModel.d.ts +12 -0
- package/dist/generated/src/models/index.d.ts +1 -0
- package/dist/index.js +21384 -43836
- package/dist/src/governance.d.ts +56 -0
- package/dist/src/index.d.ts +1 -1
- package/dist/src/user-agent.d.ts +1 -0
- package/package.json +5 -12
package/dist/src/governance.d.ts
CHANGED
|
@@ -23,3 +23,59 @@ export declare function getAgentEnforcements(options?: CreateApiClientOptions):
|
|
|
23
23
|
* just the model name strings (the shape consumers need for validation).
|
|
24
24
|
*/
|
|
25
25
|
export declare function getAvailableModelNames(options?: CreateApiClientOptions): Promise<string[]>;
|
|
26
|
+
export interface GuardrailParameterDefinition {
|
|
27
|
+
type: "enum-list" | "map-enum" | "number";
|
|
28
|
+
id: string;
|
|
29
|
+
required: boolean;
|
|
30
|
+
defaultValue?: unknown;
|
|
31
|
+
options?: string[];
|
|
32
|
+
keySource?: string;
|
|
33
|
+
step?: number | null;
|
|
34
|
+
min?: number | null;
|
|
35
|
+
max?: number | null;
|
|
36
|
+
}
|
|
37
|
+
export interface GuardrailDefinition {
|
|
38
|
+
validator: string;
|
|
39
|
+
allowedScopes: string[];
|
|
40
|
+
guardrailStages: Record<string, string[]>;
|
|
41
|
+
parameters: GuardrailParameterDefinition[];
|
|
42
|
+
status: "Available" | "FeatureDisabled" | "Unauthorised";
|
|
43
|
+
}
|
|
44
|
+
/**
|
|
45
|
+
* Fetch out-of-the-box guardrail definitions for the authenticated tenant.
|
|
46
|
+
*
|
|
47
|
+
* Endpoint: `GET /api/execution/guardrails/definitions`
|
|
48
|
+
* Returns guardrails with status "Available" or "Unauthorised".
|
|
49
|
+
*/
|
|
50
|
+
export declare function getGuardrailDefinitions(options?: CreateApiClientOptions): Promise<GuardrailDefinition[]>;
|
|
51
|
+
export interface GuardrailCatalogEntry {
|
|
52
|
+
validator_id: string;
|
|
53
|
+
display_name: string;
|
|
54
|
+
type: "BuiltIn" | "Custom";
|
|
55
|
+
status: "Available" | "FeatureDisabled" | "Unauthorised";
|
|
56
|
+
description: string;
|
|
57
|
+
security_category: string;
|
|
58
|
+
detection_method: string;
|
|
59
|
+
security_risk_addressed: string;
|
|
60
|
+
use_cases: string[];
|
|
61
|
+
when_to_use: string;
|
|
62
|
+
when_not_to_use: string;
|
|
63
|
+
notes: string;
|
|
64
|
+
rule_types: unknown[] | null;
|
|
65
|
+
examples: unknown[];
|
|
66
|
+
}
|
|
67
|
+
export interface GuardrailsCatalogResponse {
|
|
68
|
+
schema_version: string;
|
|
69
|
+
guardrails: GuardrailCatalogEntry[];
|
|
70
|
+
}
|
|
71
|
+
export declare class GuardrailCatalogUnavailableError extends Error {
|
|
72
|
+
constructor();
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Fetch the guardrail catalog (authored metadata) for the authenticated tenant.
|
|
76
|
+
*
|
|
77
|
+
* Endpoint: `GET /api/execution/guardrails/catalog[?validator=<id>]`
|
|
78
|
+
* Returns authored metadata: descriptions, use cases, examples, when-to-use guidance.
|
|
79
|
+
* For technical specs (parameters, scopes, stages) use getGuardrailDefinitions().
|
|
80
|
+
*/
|
|
81
|
+
export declare function getGuardrailCatalog(validatorId?: string, options?: CreateApiClientOptions): Promise<GuardrailsCatalogResponse>;
|
package/dist/src/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export * from "../generated/src/index.js";
|
|
2
2
|
export { type CreateApiClientOptions, createAgentRuntimeConfig, createApiClient, } from "./client-factory.js";
|
|
3
|
-
export { type AgentEnforcements, getAgentEnforcements, getAvailableModelNames, } from "./governance.js";
|
|
3
|
+
export { type AgentEnforcements, type GuardrailCatalogEntry, GuardrailCatalogUnavailableError, type GuardrailDefinition, type GuardrailParameterDefinition, type GuardrailsCatalogResponse, getAgentEnforcements, getAvailableModelNames, getGuardrailCatalog, getGuardrailDefinitions, } from "./governance.js";
|
|
4
4
|
export { ProjectFilesSource } from "./types.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const SDK_USER_AGENT: string;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uipath/agent-sdk",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "SDK for the UiPath Agent Runtime API — evaluation execution and debug sessions.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -28,18 +28,11 @@
|
|
|
28
28
|
"files": [
|
|
29
29
|
"dist"
|
|
30
30
|
],
|
|
31
|
-
"scripts": {
|
|
32
|
-
"build": "bun build ./src/index.ts --outdir dist --format esm --target node && tsc -p tsconfig.build.json --noCheck",
|
|
33
|
-
"generate": "bun run src/scripts/generate-sdk.ts",
|
|
34
|
-
"test": "vitest run",
|
|
35
|
-
"test:coverage": "vitest run --coverage",
|
|
36
|
-
"lint": "biome check ."
|
|
37
|
-
},
|
|
38
31
|
"devDependencies": {
|
|
39
32
|
"@openapitools/openapi-generator-cli": "^2.31.1",
|
|
40
|
-
"@types/node": "^25.5.
|
|
41
|
-
"@uipath/auth": "
|
|
42
|
-
"typescript": "^
|
|
33
|
+
"@types/node": "^25.5.2",
|
|
34
|
+
"@uipath/auth": "1.1.0",
|
|
35
|
+
"typescript": "^6.0.2"
|
|
43
36
|
},
|
|
44
|
-
"gitHead": "
|
|
37
|
+
"gitHead": "06e8c8f566df4b87da4a008635483c62f64f33f0"
|
|
45
38
|
}
|