@aws-sdk/client-bedrock-agentcore 3.939.0 → 3.943.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/README.md +8 -0
- package/dist-cjs/index.js +132 -14
- package/dist-es/BedrockAgentCore.js +2 -0
- package/dist-es/commands/EvaluateCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/errors.js +12 -0
- package/dist-es/schemas/schemas_0.js +108 -15
- package/dist-types/BedrockAgentCore.d.ts +7 -0
- package/dist-types/BedrockAgentCoreClient.d.ts +3 -2
- package/dist-types/commands/EvaluateCommand.d.ts +137 -0
- package/dist-types/commands/GetBrowserSessionCommand.d.ts +1 -1
- package/dist-types/commands/GetCodeInterpreterSessionCommand.d.ts +1 -1
- package/dist-types/commands/GetMemoryRecordCommand.d.ts +5 -0
- package/dist-types/commands/InvokeCodeInterpreterCommand.d.ts +1 -1
- package/dist-types/commands/ListBrowserSessionsCommand.d.ts +1 -1
- package/dist-types/commands/ListCodeInterpreterSessionsCommand.d.ts +1 -1
- package/dist-types/commands/ListMemoryRecordsCommand.d.ts +5 -0
- package/dist-types/commands/RetrieveMemoryRecordsCommand.d.ts +18 -0
- package/dist-types/commands/StartBrowserSessionCommand.d.ts +1 -1
- package/dist-types/commands/StartCodeInterpreterSessionCommand.d.ts +1 -1
- package/dist-types/commands/StopBrowserSessionCommand.d.ts +1 -1
- package/dist-types/commands/StopCodeInterpreterSessionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/errors.d.ts +12 -0
- package/dist-types/models/models_0.d.ts +275 -0
- package/dist-types/schemas/schemas_0.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentCore.d.ts +17 -0
- package/dist-types/ts3.4/BedrockAgentCoreClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/EvaluateCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/errors.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +96 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +17 -0
- package/package.json +5 -5
|
@@ -43,6 +43,19 @@ declare const RetrieveMemoryRecordsCommand_base: {
|
|
|
43
43
|
* searchQuery: "STRING_VALUE", // required
|
|
44
44
|
* memoryStrategyId: "STRING_VALUE",
|
|
45
45
|
* topK: Number("int"),
|
|
46
|
+
* metadataFilters: [ // MemoryMetadataFilterList
|
|
47
|
+
* { // MemoryMetadataFilterExpression
|
|
48
|
+
* left: { // LeftExpression Union: only one key present
|
|
49
|
+
* metadataKey: "STRING_VALUE",
|
|
50
|
+
* },
|
|
51
|
+
* operator: "EQUALS_TO" || "EXISTS" || "NOT_EXISTS", // required
|
|
52
|
+
* right: { // RightExpression Union: only one key present
|
|
53
|
+
* metadataValue: { // MetadataValue Union: only one key present
|
|
54
|
+
* stringValue: "STRING_VALUE",
|
|
55
|
+
* },
|
|
56
|
+
* },
|
|
57
|
+
* },
|
|
58
|
+
* ],
|
|
46
59
|
* },
|
|
47
60
|
* nextToken: "STRING_VALUE",
|
|
48
61
|
* maxResults: Number("int"),
|
|
@@ -62,6 +75,11 @@ declare const RetrieveMemoryRecordsCommand_base: {
|
|
|
62
75
|
* // ],
|
|
63
76
|
* // createdAt: new Date("TIMESTAMP"), // required
|
|
64
77
|
* // score: Number("double"),
|
|
78
|
+
* // metadata: { // MetadataMap
|
|
79
|
+
* // "<keys>": { // MetadataValue Union: only one key present
|
|
80
|
+
* // stringValue: "STRING_VALUE",
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
65
83
|
* // },
|
|
66
84
|
* // ],
|
|
67
85
|
* // nextToken: "STRING_VALUE",
|
|
@@ -27,7 +27,7 @@ declare const StartBrowserSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates and initializes a browser session in Amazon Bedrock. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.</p> <p>To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the <code>StopBrowserSession</code> operation.</p> <p>The following operations are related to <code>StartBrowserSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/API_GetBrowserSession.html">GetBrowserSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_UpdateBrowserStream.html">UpdateBrowserStream</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_StopBrowserSession.html">StopBrowserSession</a> </p> </li> </ul>
|
|
30
|
+
* <p>Creates and initializes a browser session in Amazon Bedrock. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.</p> <p>To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the <code>StopBrowserSession</code> operation.</p> <p>The following operations are related to <code>StartBrowserSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_GetBrowserSession.html">GetBrowserSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_UpdateBrowserStream.html">UpdateBrowserStream</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_StopBrowserSession.html">StopBrowserSession</a> </p> </li> </ul>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const StartCodeInterpreterSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates and initializes a code interpreter session in Amazon Bedrock. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.</p> <p>To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the <code>StopCodeInterpreterSession</code> operation.</p> <p>The following operations are related to <code>StartCodeInterpreterSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/API_InvokeCodeInterpreter.html">InvokeCodeInterpreter</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_GetCodeInterpreterSession.html">GetCodeInterpreterSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_StopCodeInterpreterSession.html">StopCodeInterpreterSession</a> </p> </li> </ul>
|
|
30
|
+
* <p>Creates and initializes a code interpreter session in Amazon Bedrock. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.</p> <p>To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the <code>StopCodeInterpreterSession</code> operation.</p> <p>The following operations are related to <code>StartCodeInterpreterSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_InvokeCodeInterpreter.html">InvokeCodeInterpreter</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_GetCodeInterpreterSession.html">GetCodeInterpreterSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_StopCodeInterpreterSession.html">StopCodeInterpreterSession</a> </p> </li> </ul>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const StopBrowserSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Terminates an active browser session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.</p> <p>To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using <code>StartBrowserSession</code>.</p> <p>The following operations are related to <code>StopBrowserSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/API_StartBrowserSession.html">StartBrowserSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_GetBrowserSession.html">GetBrowserSession</a> </p> </li> </ul>
|
|
30
|
+
* <p>Terminates an active browser session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.</p> <p>To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using <code>StartBrowserSession</code>.</p> <p>The following operations are related to <code>StopBrowserSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_StartBrowserSession.html">StartBrowserSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_GetBrowserSession.html">GetBrowserSession</a> </p> </li> </ul>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const StopCodeInterpreterSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Terminates an active code interpreter session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.</p> <p>To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using <code>StartCodeInterpreterSession</code>.</p> <p>The following operations are related to <code>StopCodeInterpreterSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/API_StartCodeInterpreterSession.html">StartCodeInterpreterSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/API_GetCodeInterpreterSession.html">GetCodeInterpreterSession</a> </p> </li> </ul>
|
|
30
|
+
* <p>Terminates an active code interpreter session in Amazon Bedrock. This operation stops the session, releases associated resources, and makes the session unavailable for further use.</p> <p>To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using <code>StartCodeInterpreterSession</code>.</p> <p>The following operations are related to <code>StopCodeInterpreterSession</code>:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_StartCodeInterpreterSession.html">StartCodeInterpreterSession</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/bedrock-agentcore/latest/APIReference/API_GetCodeInterpreterSession.html">GetCodeInterpreterSession</a> </p> </li> </ul>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -5,6 +5,7 @@ export * from "./CompleteResourceTokenAuthCommand";
|
|
|
5
5
|
export * from "./CreateEventCommand";
|
|
6
6
|
export * from "./DeleteEventCommand";
|
|
7
7
|
export * from "./DeleteMemoryRecordCommand";
|
|
8
|
+
export * from "./EvaluateCommand";
|
|
8
9
|
export * from "./GetAgentCardCommand";
|
|
9
10
|
export * from "./GetBrowserSessionCommand";
|
|
10
11
|
export * from "./GetCodeInterpreterSessionCommand";
|
|
@@ -112,6 +112,18 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
112
112
|
*/
|
|
113
113
|
constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
|
|
114
114
|
}
|
|
115
|
+
/**
|
|
116
|
+
* <p> An exception thrown when attempting to create a resource with an identifier that already exists.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export declare class DuplicateIdException extends __BaseException {
|
|
120
|
+
readonly name: "DuplicateIdException";
|
|
121
|
+
readonly $fault: "client";
|
|
122
|
+
/**
|
|
123
|
+
* @internal
|
|
124
|
+
*/
|
|
125
|
+
constructor(opts: __ExceptionOptionType<DuplicateIdException, __BaseException>);
|
|
126
|
+
}
|
|
115
127
|
/**
|
|
116
128
|
* <p>The service encountered an internal error. Try your request again later.</p>
|
|
117
129
|
* @public
|
|
@@ -948,6 +948,245 @@ export interface CompleteResourceTokenAuthRequest {
|
|
|
948
948
|
*/
|
|
949
949
|
export interface CompleteResourceTokenAuthResponse {
|
|
950
950
|
}
|
|
951
|
+
/**
|
|
952
|
+
* <p> The input data structure containing agent session spans in OpenTelemetry format. Supports traces from frameworks like Strands (AgentCore Runtime) and LangGraph with OpenInference instrumentation for comprehensive evaluation. </p>
|
|
953
|
+
* @public
|
|
954
|
+
*/
|
|
955
|
+
export type EvaluationInput = EvaluationInput.SessionSpansMember | EvaluationInput.$UnknownMember;
|
|
956
|
+
/**
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
export declare namespace EvaluationInput {
|
|
960
|
+
/**
|
|
961
|
+
* <p> The collection of spans representing agent execution traces within a session. Each span contains detailed information about tool calls, model interactions, and other agent activities that can be evaluated for quality and performance. </p>
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
interface SessionSpansMember {
|
|
965
|
+
sessionSpans: __DocumentType[];
|
|
966
|
+
$unknown?: never;
|
|
967
|
+
}
|
|
968
|
+
/**
|
|
969
|
+
* @public
|
|
970
|
+
*/
|
|
971
|
+
interface $UnknownMember {
|
|
972
|
+
sessionSpans?: never;
|
|
973
|
+
$unknown: [string, any];
|
|
974
|
+
}
|
|
975
|
+
/**
|
|
976
|
+
* @deprecated unused in schema-serde mode.
|
|
977
|
+
*
|
|
978
|
+
*/
|
|
979
|
+
interface Visitor<T> {
|
|
980
|
+
sessionSpans: (value: __DocumentType[]) => T;
|
|
981
|
+
_: (name: string, value: any) => T;
|
|
982
|
+
}
|
|
983
|
+
}
|
|
984
|
+
/**
|
|
985
|
+
* <p> The specification of which trace or span IDs to evaluate within the provided input data. Allows precise targeting of evaluation at different levels: tool calls, traces, or sessions. </p>
|
|
986
|
+
* @public
|
|
987
|
+
*/
|
|
988
|
+
export type EvaluationTarget = EvaluationTarget.SpanIdsMember | EvaluationTarget.TraceIdsMember | EvaluationTarget.$UnknownMember;
|
|
989
|
+
/**
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
export declare namespace EvaluationTarget {
|
|
993
|
+
/**
|
|
994
|
+
* <p> The list of specific span IDs to evaluate within the provided traces. Used to target evaluation at individual tool calls or specific operations within the agent's execution flow. </p>
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
interface SpanIdsMember {
|
|
998
|
+
spanIds: string[];
|
|
999
|
+
traceIds?: never;
|
|
1000
|
+
$unknown?: never;
|
|
1001
|
+
}
|
|
1002
|
+
/**
|
|
1003
|
+
* <p> The list of trace IDs to evaluate, representing complete request-response interactions. Used to evaluate entire conversation turns or specific agent interactions within a session. </p>
|
|
1004
|
+
* @public
|
|
1005
|
+
*/
|
|
1006
|
+
interface TraceIdsMember {
|
|
1007
|
+
spanIds?: never;
|
|
1008
|
+
traceIds: string[];
|
|
1009
|
+
$unknown?: never;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
* @public
|
|
1013
|
+
*/
|
|
1014
|
+
interface $UnknownMember {
|
|
1015
|
+
spanIds?: never;
|
|
1016
|
+
traceIds?: never;
|
|
1017
|
+
$unknown: [string, any];
|
|
1018
|
+
}
|
|
1019
|
+
/**
|
|
1020
|
+
* @deprecated unused in schema-serde mode.
|
|
1021
|
+
*
|
|
1022
|
+
*/
|
|
1023
|
+
interface Visitor<T> {
|
|
1024
|
+
spanIds: (value: string[]) => T;
|
|
1025
|
+
traceIds: (value: string[]) => T;
|
|
1026
|
+
_: (name: string, value: any) => T;
|
|
1027
|
+
}
|
|
1028
|
+
}
|
|
1029
|
+
/**
|
|
1030
|
+
* @public
|
|
1031
|
+
*/
|
|
1032
|
+
export interface EvaluateRequest {
|
|
1033
|
+
/**
|
|
1034
|
+
* <p> The unique identifier of the evaluator to use for scoring. Can be a built-in evaluator (e.g., <code>Builtin.Helpfulness</code>, <code>Builtin.Correctness</code>) or a custom evaluator ARN created through the control plane API. </p>
|
|
1035
|
+
* @public
|
|
1036
|
+
*/
|
|
1037
|
+
evaluatorId: string | undefined;
|
|
1038
|
+
/**
|
|
1039
|
+
* <p> The input data containing agent session spans to be evaluated. Includes a list of spans in OpenTelemetry format from supported frameworks like Strands (AgentCore Runtime) or LangGraph with OpenInference instrumentation. </p>
|
|
1040
|
+
* @public
|
|
1041
|
+
*/
|
|
1042
|
+
evaluationInput: EvaluationInput | undefined;
|
|
1043
|
+
/**
|
|
1044
|
+
* <p> The specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions. </p>
|
|
1045
|
+
* @public
|
|
1046
|
+
*/
|
|
1047
|
+
evaluationTarget?: EvaluationTarget | undefined;
|
|
1048
|
+
}
|
|
1049
|
+
/**
|
|
1050
|
+
* <p> The contextual information that uniquely identifies a span within the distributed tracing system. Contains session, trace, and span identifiers used to correlate evaluation results with specific agent execution points. </p>
|
|
1051
|
+
* @public
|
|
1052
|
+
*/
|
|
1053
|
+
export interface SpanContext {
|
|
1054
|
+
/**
|
|
1055
|
+
* <p> The unique identifier of the session containing this span. Sessions represent complete conversation flows and are detected using configurable <code>SessionTimeoutMinutes</code> (default 15 minutes). </p>
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
sessionId: string | undefined;
|
|
1059
|
+
/**
|
|
1060
|
+
* <p> The unique identifier of the trace containing this span. Traces represent individual request-response interactions within a session and group related spans together. </p>
|
|
1061
|
+
* @public
|
|
1062
|
+
*/
|
|
1063
|
+
traceId?: string | undefined;
|
|
1064
|
+
/**
|
|
1065
|
+
* <p> The unique identifier of the specific span being referenced. Spans represent individual operations like tool calls, model invocations, or other discrete actions within the agent's execution. </p>
|
|
1066
|
+
* @public
|
|
1067
|
+
*/
|
|
1068
|
+
spanId?: string | undefined;
|
|
1069
|
+
}
|
|
1070
|
+
/**
|
|
1071
|
+
* <p> The contextual information associated with an evaluation, including span context details that identify the specific traces and sessions being evaluated within the agent's execution flow. </p>
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
export type Context = Context.SpanContextMember | Context.$UnknownMember;
|
|
1075
|
+
/**
|
|
1076
|
+
* @public
|
|
1077
|
+
*/
|
|
1078
|
+
export declare namespace Context {
|
|
1079
|
+
/**
|
|
1080
|
+
* <p> The span context information that uniquely identifies the trace and span being evaluated, including session ID, trace ID, and span ID for precise targeting within the agent's execution flow. </p>
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
interface SpanContextMember {
|
|
1084
|
+
spanContext: SpanContext;
|
|
1085
|
+
$unknown?: never;
|
|
1086
|
+
}
|
|
1087
|
+
/**
|
|
1088
|
+
* @public
|
|
1089
|
+
*/
|
|
1090
|
+
interface $UnknownMember {
|
|
1091
|
+
spanContext?: never;
|
|
1092
|
+
$unknown: [string, any];
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* @deprecated unused in schema-serde mode.
|
|
1096
|
+
*
|
|
1097
|
+
*/
|
|
1098
|
+
interface Visitor<T> {
|
|
1099
|
+
spanContext: (value: SpanContext) => T;
|
|
1100
|
+
_: (name: string, value: any) => T;
|
|
1101
|
+
}
|
|
1102
|
+
}
|
|
1103
|
+
/**
|
|
1104
|
+
* <p> The token consumption statistics for language model operations during evaluation. Provides detailed breakdown of input, output, and total tokens used for cost tracking and performance monitoring. </p>
|
|
1105
|
+
* @public
|
|
1106
|
+
*/
|
|
1107
|
+
export interface TokenUsage {
|
|
1108
|
+
/**
|
|
1109
|
+
* <p> The number of tokens consumed for input processing during the evaluation. Includes tokens from the evaluation prompt, agent traces, and any additional context provided to the evaluator model. </p>
|
|
1110
|
+
* @public
|
|
1111
|
+
*/
|
|
1112
|
+
inputTokens?: number | undefined;
|
|
1113
|
+
/**
|
|
1114
|
+
* <p> The number of tokens generated by the evaluator model in its response. Includes tokens for the score, explanation, and any additional output produced during the evaluation process. </p>
|
|
1115
|
+
* @public
|
|
1116
|
+
*/
|
|
1117
|
+
outputTokens?: number | undefined;
|
|
1118
|
+
/**
|
|
1119
|
+
* <p> The total number of tokens consumed during the evaluation, calculated as the sum of input and output tokens. Used for cost calculation and rate limiting within the service limits. </p>
|
|
1120
|
+
* @public
|
|
1121
|
+
*/
|
|
1122
|
+
totalTokens?: number | undefined;
|
|
1123
|
+
}
|
|
1124
|
+
/**
|
|
1125
|
+
* <p> The comprehensive result of an evaluation containing the score, explanation, evaluator metadata, and execution details. Provides both quantitative ratings and qualitative insights about agent performance. </p>
|
|
1126
|
+
* @public
|
|
1127
|
+
*/
|
|
1128
|
+
export interface EvaluationResultContent {
|
|
1129
|
+
/**
|
|
1130
|
+
* <p> The Amazon Resource Name (ARN) of the evaluator used to generate this result. For custom evaluators, this is the full ARN; for built-in evaluators, this follows the pattern <code>Builtin.\{EvaluatorName\}</code>. </p>
|
|
1131
|
+
* @public
|
|
1132
|
+
*/
|
|
1133
|
+
evaluatorArn: string | undefined;
|
|
1134
|
+
/**
|
|
1135
|
+
* <p> The unique identifier of the evaluator that produced this result. This matches the <code>evaluatorId</code> provided in the evaluation request and can be used to identify which evaluator generated specific results. </p>
|
|
1136
|
+
* @public
|
|
1137
|
+
*/
|
|
1138
|
+
evaluatorId: string | undefined;
|
|
1139
|
+
/**
|
|
1140
|
+
* <p> The human-readable name of the evaluator used for this evaluation. For built-in evaluators, this is the descriptive name (e.g., "Helpfulness", "Correctness"); for custom evaluators, this is the user-defined name. </p>
|
|
1141
|
+
* @public
|
|
1142
|
+
*/
|
|
1143
|
+
evaluatorName: string | undefined;
|
|
1144
|
+
/**
|
|
1145
|
+
* <p> The detailed explanation provided by the evaluator describing the reasoning behind the assigned score. This qualitative feedback helps understand why specific ratings were given and provides actionable insights for improvement. </p>
|
|
1146
|
+
* @public
|
|
1147
|
+
*/
|
|
1148
|
+
explanation?: string | undefined;
|
|
1149
|
+
/**
|
|
1150
|
+
* <p> The contextual information associated with this evaluation result, including span context details that identify the specific traces and sessions that were evaluated. </p>
|
|
1151
|
+
* @public
|
|
1152
|
+
*/
|
|
1153
|
+
context: Context | undefined;
|
|
1154
|
+
/**
|
|
1155
|
+
* <p> The numerical score assigned by the evaluator according to its configured rating scale. For numerical scales, this is a decimal value within the defined range. This field is not allowed for categorical scales. </p>
|
|
1156
|
+
* @public
|
|
1157
|
+
*/
|
|
1158
|
+
value?: number | undefined;
|
|
1159
|
+
/**
|
|
1160
|
+
* <p> The categorical label assigned by the evaluator when using a categorical rating scale. This provides a human-readable description of the evaluation result (e.g., "Excellent", "Good", "Poor") corresponding to the numerical value. For numerical scales, this field is optional and provides a natural language explanation of what the value means (e.g., value 0.5 = "Somewhat Helpful"). </p>
|
|
1161
|
+
* @public
|
|
1162
|
+
*/
|
|
1163
|
+
label?: string | undefined;
|
|
1164
|
+
/**
|
|
1165
|
+
* <p> The token consumption statistics for this evaluation, including input tokens, output tokens, and total tokens used by the underlying language model during the evaluation process. </p>
|
|
1166
|
+
* @public
|
|
1167
|
+
*/
|
|
1168
|
+
tokenUsage?: TokenUsage | undefined;
|
|
1169
|
+
/**
|
|
1170
|
+
* <p> The error message describing what went wrong if the evaluation failed. Provides detailed information about evaluation failures to help diagnose and resolve issues with evaluator configuration or input data. </p>
|
|
1171
|
+
* @public
|
|
1172
|
+
*/
|
|
1173
|
+
errorMessage?: string | undefined;
|
|
1174
|
+
/**
|
|
1175
|
+
* <p> The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors. </p>
|
|
1176
|
+
* @public
|
|
1177
|
+
*/
|
|
1178
|
+
errorCode?: string | undefined;
|
|
1179
|
+
}
|
|
1180
|
+
/**
|
|
1181
|
+
* @public
|
|
1182
|
+
*/
|
|
1183
|
+
export interface EvaluateResponse {
|
|
1184
|
+
/**
|
|
1185
|
+
* <p> The detailed evaluation results containing scores, explanations, and metadata. Includes the evaluator information, numerical or categorical ratings based on the evaluator's rating scale, and token usage statistics for the evaluation process. </p>
|
|
1186
|
+
* @public
|
|
1187
|
+
*/
|
|
1188
|
+
evaluationResults: EvaluationResultContent[] | undefined;
|
|
1189
|
+
}
|
|
951
1190
|
/**
|
|
952
1191
|
* @public
|
|
953
1192
|
*/
|
|
@@ -2154,6 +2393,11 @@ export interface MemoryRecord {
|
|
|
2154
2393
|
* @public
|
|
2155
2394
|
*/
|
|
2156
2395
|
createdAt: Date | undefined;
|
|
2396
|
+
/**
|
|
2397
|
+
* <p>A map of metadata key-value pairs associated with a memory record.</p>
|
|
2398
|
+
* @public
|
|
2399
|
+
*/
|
|
2400
|
+
metadata?: Record<string, MetadataValue> | undefined;
|
|
2157
2401
|
}
|
|
2158
2402
|
/**
|
|
2159
2403
|
* @public
|
|
@@ -2595,6 +2839,11 @@ export interface MemoryRecordSummary {
|
|
|
2595
2839
|
* @public
|
|
2596
2840
|
*/
|
|
2597
2841
|
score?: number | undefined;
|
|
2842
|
+
/**
|
|
2843
|
+
* <p>A map of metadata key-value pairs associated with a memory record.</p>
|
|
2844
|
+
* @public
|
|
2845
|
+
*/
|
|
2846
|
+
metadata?: Record<string, MetadataValue> | undefined;
|
|
2598
2847
|
}
|
|
2599
2848
|
/**
|
|
2600
2849
|
* @public
|
|
@@ -2672,6 +2921,27 @@ export interface ListSessionsOutput {
|
|
|
2672
2921
|
*/
|
|
2673
2922
|
nextToken?: string | undefined;
|
|
2674
2923
|
}
|
|
2924
|
+
/**
|
|
2925
|
+
* <p>Filters to apply to metadata associated with a memory. Specify the metadata key and value in the <code>left</code> and <code>right</code> fields and use the <code>operator</code> field to define the relationship to match.</p>
|
|
2926
|
+
* @public
|
|
2927
|
+
*/
|
|
2928
|
+
export interface MemoryMetadataFilterExpression {
|
|
2929
|
+
/**
|
|
2930
|
+
* <p>Left expression of the event metadata filter.</p>
|
|
2931
|
+
* @public
|
|
2932
|
+
*/
|
|
2933
|
+
left: LeftExpression | undefined;
|
|
2934
|
+
/**
|
|
2935
|
+
* <p>The relationship between the metadata key and value to match when applying the metadata filter.</p>
|
|
2936
|
+
* @public
|
|
2937
|
+
*/
|
|
2938
|
+
operator: OperatorType | undefined;
|
|
2939
|
+
/**
|
|
2940
|
+
* <p>Right expression of the <code>eventMetadata</code>filter.</p>
|
|
2941
|
+
* @public
|
|
2942
|
+
*/
|
|
2943
|
+
right?: RightExpression | undefined;
|
|
2944
|
+
}
|
|
2675
2945
|
/**
|
|
2676
2946
|
* <p>Contains search criteria for retrieving memory records.</p>
|
|
2677
2947
|
* @public
|
|
@@ -2692,6 +2962,11 @@ export interface SearchCriteria {
|
|
|
2692
2962
|
* @public
|
|
2693
2963
|
*/
|
|
2694
2964
|
topK?: number | undefined;
|
|
2965
|
+
/**
|
|
2966
|
+
* <p>Filters to apply to metadata associated with a memory.</p>
|
|
2967
|
+
* @public
|
|
2968
|
+
*/
|
|
2969
|
+
metadataFilters?: MemoryMetadataFilterExpression[] | undefined;
|
|
2695
2970
|
}
|
|
2696
2971
|
/**
|
|
2697
2972
|
* @public
|
|
@@ -5,6 +5,7 @@ export declare var AuthorizationUrlType: StaticSimpleSchema;
|
|
|
5
5
|
export declare var Body: StaticSimpleSchema;
|
|
6
6
|
export declare var CustomRequestValueType: StaticSimpleSchema;
|
|
7
7
|
export declare var Document: StaticSimpleSchema;
|
|
8
|
+
export declare var EvaluationExplanation: StaticSimpleSchema;
|
|
8
9
|
export declare var ResponseStream: StaticSimpleSchema;
|
|
9
10
|
export declare var SensitiveString: StaticSimpleSchema;
|
|
10
11
|
export declare var State: StaticSimpleSchema;
|
|
@@ -37,6 +38,10 @@ export declare var DeleteEventInput: StaticStructureSchema;
|
|
|
37
38
|
export declare var DeleteEventOutput: StaticStructureSchema;
|
|
38
39
|
export declare var DeleteMemoryRecordInput: StaticStructureSchema;
|
|
39
40
|
export declare var DeleteMemoryRecordOutput: StaticStructureSchema;
|
|
41
|
+
export declare var DuplicateIdException: StaticErrorSchema;
|
|
42
|
+
export declare var EvaluateRequest: StaticStructureSchema;
|
|
43
|
+
export declare var EvaluateResponse: StaticStructureSchema;
|
|
44
|
+
export declare var EvaluationResultContent: StaticStructureSchema;
|
|
40
45
|
export declare var Event: StaticStructureSchema;
|
|
41
46
|
export declare var EventMetadataFilterExpression: StaticStructureSchema;
|
|
42
47
|
export declare var ExtractionJob: StaticStructureSchema;
|
|
@@ -85,6 +90,7 @@ export declare var ListMemoryRecordsOutput: StaticStructureSchema;
|
|
|
85
90
|
export declare var ListSessionsInput: StaticStructureSchema;
|
|
86
91
|
export declare var ListSessionsOutput: StaticStructureSchema;
|
|
87
92
|
export declare var LiveViewStream: StaticStructureSchema;
|
|
93
|
+
export declare var MemoryMetadataFilterExpression: StaticStructureSchema;
|
|
88
94
|
export declare var MemoryRecord: StaticStructureSchema;
|
|
89
95
|
export declare var MemoryRecordCreateInput: StaticStructureSchema;
|
|
90
96
|
export declare var MemoryRecordDeleteInput: StaticStructureSchema;
|
|
@@ -101,6 +107,7 @@ export declare var SearchCriteria: StaticStructureSchema;
|
|
|
101
107
|
export declare var ServiceException: StaticErrorSchema;
|
|
102
108
|
export declare var ServiceQuotaExceededException: StaticErrorSchema;
|
|
103
109
|
export declare var SessionSummary: StaticStructureSchema;
|
|
110
|
+
export declare var SpanContext: StaticStructureSchema;
|
|
104
111
|
export declare var StartBrowserSessionRequest: StaticStructureSchema;
|
|
105
112
|
export declare var StartBrowserSessionResponse: StaticStructureSchema;
|
|
106
113
|
export declare var StartCodeInterpreterSessionRequest: StaticStructureSchema;
|
|
@@ -115,6 +122,7 @@ export declare var StopRuntimeSessionRequest: StaticStructureSchema;
|
|
|
115
122
|
export declare var StopRuntimeSessionResponse: StaticStructureSchema;
|
|
116
123
|
export declare var ThrottledException: StaticErrorSchema;
|
|
117
124
|
export declare var ThrottlingException: StaticErrorSchema;
|
|
125
|
+
export declare var TokenUsage: StaticStructureSchema;
|
|
118
126
|
export declare var ToolArguments: StaticStructureSchema;
|
|
119
127
|
export declare var ToolResultStructuredContent: StaticStructureSchema;
|
|
120
128
|
export declare var UnauthorizedException: StaticErrorSchema;
|
|
@@ -129,10 +137,12 @@ export declare var ActorSummaryList: StaticListSchema;
|
|
|
129
137
|
export declare var BrowserSessionSummaries: StaticListSchema;
|
|
130
138
|
export declare var CodeInterpreterSessionSummaries: StaticListSchema;
|
|
131
139
|
export declare var ContentBlockList: StaticListSchema;
|
|
140
|
+
export declare var EvaluationResults: StaticListSchema;
|
|
132
141
|
export declare var EventList: StaticListSchema;
|
|
133
142
|
export declare var EventMetadataFilterList: StaticListSchema;
|
|
134
143
|
export declare var ExtractionJobMetadataList: StaticListSchema;
|
|
135
144
|
export declare var InputContentBlockList: StaticListSchema;
|
|
145
|
+
export declare var MemoryMetadataFilterList: StaticListSchema;
|
|
136
146
|
export declare var MemoryRecordsCreateInputList: StaticListSchema;
|
|
137
147
|
export declare var MemoryRecordsDeleteInputList: StaticListSchema;
|
|
138
148
|
export declare var MemoryRecordsOutputList: StaticListSchema;
|
|
@@ -143,12 +153,18 @@ export declare var NamespacesList: number;
|
|
|
143
153
|
export declare var PayloadTypeList: StaticListSchema;
|
|
144
154
|
export declare var ScopesListType: number;
|
|
145
155
|
export declare var SessionSummaryList: StaticListSchema;
|
|
156
|
+
export declare var SpanIds: number;
|
|
157
|
+
export declare var Spans: StaticListSchema;
|
|
146
158
|
export declare var StringList: number;
|
|
159
|
+
export declare var TraceIds: number;
|
|
147
160
|
export declare var ValidationExceptionFieldList: StaticListSchema;
|
|
148
161
|
export declare var CustomRequestParametersType: StaticMapSchema;
|
|
149
162
|
export declare var MetadataMap: StaticMapSchema;
|
|
150
163
|
export declare var CodeInterpreterStreamOutput: StaticStructureSchema;
|
|
151
164
|
export declare var Content: StaticStructureSchema;
|
|
165
|
+
export declare var Context: StaticStructureSchema;
|
|
166
|
+
export declare var EvaluationInput: StaticStructureSchema;
|
|
167
|
+
export declare var EvaluationTarget: StaticStructureSchema;
|
|
152
168
|
export declare var ExtractionJobMessages: StaticStructureSchema;
|
|
153
169
|
export declare var LeftExpression: StaticStructureSchema;
|
|
154
170
|
export declare var MemoryContent: StaticStructureSchema;
|
|
@@ -164,6 +180,7 @@ export declare var CompleteResourceTokenAuth: StaticOperationSchema;
|
|
|
164
180
|
export declare var CreateEvent: StaticOperationSchema;
|
|
165
181
|
export declare var DeleteEvent: StaticOperationSchema;
|
|
166
182
|
export declare var DeleteMemoryRecord: StaticOperationSchema;
|
|
183
|
+
export declare var Evaluate: StaticOperationSchema;
|
|
167
184
|
export declare var GetAgentCard: StaticOperationSchema;
|
|
168
185
|
export declare var GetBrowserSession: StaticOperationSchema;
|
|
169
186
|
export declare var GetCodeInterpreterSession: StaticOperationSchema;
|
|
@@ -28,6 +28,10 @@ import {
|
|
|
28
28
|
DeleteMemoryRecordCommandInput,
|
|
29
29
|
DeleteMemoryRecordCommandOutput,
|
|
30
30
|
} from "./commands/DeleteMemoryRecordCommand";
|
|
31
|
+
import {
|
|
32
|
+
EvaluateCommandInput,
|
|
33
|
+
EvaluateCommandOutput,
|
|
34
|
+
} from "./commands/EvaluateCommand";
|
|
31
35
|
import {
|
|
32
36
|
GetAgentCardCommandInput,
|
|
33
37
|
GetAgentCardCommandOutput,
|
|
@@ -228,6 +232,19 @@ export interface BedrockAgentCore {
|
|
|
228
232
|
options: __HttpHandlerOptions,
|
|
229
233
|
cb: (err: any, data?: DeleteMemoryRecordCommandOutput) => void
|
|
230
234
|
): void;
|
|
235
|
+
evaluate(
|
|
236
|
+
args: EvaluateCommandInput,
|
|
237
|
+
options?: __HttpHandlerOptions
|
|
238
|
+
): Promise<EvaluateCommandOutput>;
|
|
239
|
+
evaluate(
|
|
240
|
+
args: EvaluateCommandInput,
|
|
241
|
+
cb: (err: any, data?: EvaluateCommandOutput) => void
|
|
242
|
+
): void;
|
|
243
|
+
evaluate(
|
|
244
|
+
args: EvaluateCommandInput,
|
|
245
|
+
options: __HttpHandlerOptions,
|
|
246
|
+
cb: (err: any, data?: EvaluateCommandOutput) => void
|
|
247
|
+
): void;
|
|
231
248
|
getAgentCard(
|
|
232
249
|
args: GetAgentCardCommandInput,
|
|
233
250
|
options?: __HttpHandlerOptions
|
|
@@ -82,6 +82,10 @@ import {
|
|
|
82
82
|
DeleteMemoryRecordCommandInput,
|
|
83
83
|
DeleteMemoryRecordCommandOutput,
|
|
84
84
|
} from "./commands/DeleteMemoryRecordCommand";
|
|
85
|
+
import {
|
|
86
|
+
EvaluateCommandInput,
|
|
87
|
+
EvaluateCommandOutput,
|
|
88
|
+
} from "./commands/EvaluateCommand";
|
|
85
89
|
import {
|
|
86
90
|
GetAgentCardCommandInput,
|
|
87
91
|
GetAgentCardCommandOutput,
|
|
@@ -205,6 +209,7 @@ export type ServiceInputTypes =
|
|
|
205
209
|
| CreateEventCommandInput
|
|
206
210
|
| DeleteEventCommandInput
|
|
207
211
|
| DeleteMemoryRecordCommandInput
|
|
212
|
+
| EvaluateCommandInput
|
|
208
213
|
| GetAgentCardCommandInput
|
|
209
214
|
| GetBrowserSessionCommandInput
|
|
210
215
|
| GetCodeInterpreterSessionCommandInput
|
|
@@ -240,6 +245,7 @@ export type ServiceOutputTypes =
|
|
|
240
245
|
| CreateEventCommandOutput
|
|
241
246
|
| DeleteEventCommandOutput
|
|
242
247
|
| DeleteMemoryRecordCommandOutput
|
|
248
|
+
| EvaluateCommandOutput
|
|
243
249
|
| GetAgentCardCommandOutput
|
|
244
250
|
| GetBrowserSessionCommandOutput
|
|
245
251
|
| GetCodeInterpreterSessionCommandOutput
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import {
|
|
4
|
+
BedrockAgentCoreClientResolvedConfig,
|
|
5
|
+
ServiceInputTypes,
|
|
6
|
+
ServiceOutputTypes,
|
|
7
|
+
} from "../BedrockAgentCoreClient";
|
|
8
|
+
import { EvaluateRequest, EvaluateResponse } from "../models/models_0";
|
|
9
|
+
export { __MetadataBearer };
|
|
10
|
+
export { $Command };
|
|
11
|
+
export interface EvaluateCommandInput extends EvaluateRequest {}
|
|
12
|
+
export interface EvaluateCommandOutput
|
|
13
|
+
extends EvaluateResponse,
|
|
14
|
+
__MetadataBearer {}
|
|
15
|
+
declare const EvaluateCommand_base: {
|
|
16
|
+
new (
|
|
17
|
+
input: EvaluateCommandInput
|
|
18
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
19
|
+
EvaluateCommandInput,
|
|
20
|
+
EvaluateCommandOutput,
|
|
21
|
+
BedrockAgentCoreClientResolvedConfig,
|
|
22
|
+
ServiceInputTypes,
|
|
23
|
+
ServiceOutputTypes
|
|
24
|
+
>;
|
|
25
|
+
new (
|
|
26
|
+
input: EvaluateCommandInput
|
|
27
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
28
|
+
EvaluateCommandInput,
|
|
29
|
+
EvaluateCommandOutput,
|
|
30
|
+
BedrockAgentCoreClientResolvedConfig,
|
|
31
|
+
ServiceInputTypes,
|
|
32
|
+
ServiceOutputTypes
|
|
33
|
+
>;
|
|
34
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
35
|
+
};
|
|
36
|
+
export declare class EvaluateCommand extends EvaluateCommand_base {
|
|
37
|
+
protected static __types: {
|
|
38
|
+
api: {
|
|
39
|
+
input: EvaluateRequest;
|
|
40
|
+
output: EvaluateResponse;
|
|
41
|
+
};
|
|
42
|
+
sdk: {
|
|
43
|
+
input: EvaluateCommandInput;
|
|
44
|
+
output: EvaluateCommandOutput;
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
}
|
|
@@ -5,6 +5,7 @@ export * from "./CompleteResourceTokenAuthCommand";
|
|
|
5
5
|
export * from "./CreateEventCommand";
|
|
6
6
|
export * from "./DeleteEventCommand";
|
|
7
7
|
export * from "./DeleteMemoryRecordCommand";
|
|
8
|
+
export * from "./EvaluateCommand";
|
|
8
9
|
export * from "./GetAgentCardCommand";
|
|
9
10
|
export * from "./GetBrowserSessionCommand";
|
|
10
11
|
export * from "./GetCodeInterpreterSessionCommand";
|
|
@@ -63,6 +63,13 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
63
63
|
opts: __ExceptionOptionType<UnauthorizedException, __BaseException>
|
|
64
64
|
);
|
|
65
65
|
}
|
|
66
|
+
export declare class DuplicateIdException extends __BaseException {
|
|
67
|
+
readonly name: "DuplicateIdException";
|
|
68
|
+
readonly $fault: "client";
|
|
69
|
+
constructor(
|
|
70
|
+
opts: __ExceptionOptionType<DuplicateIdException, __BaseException>
|
|
71
|
+
);
|
|
72
|
+
}
|
|
66
73
|
export declare class ServiceException extends __BaseException {
|
|
67
74
|
readonly name: "ServiceException";
|
|
68
75
|
readonly $fault: "server";
|