@aws-sdk/client-bedrock-agent-runtime 3.751.0 → 3.758.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 +119 -7
- package/dist-cjs/index.js +1009 -55
- package/dist-es/BedrockAgentRuntime.js +28 -0
- package/dist-es/commands/CreateInvocationCommand.js +22 -0
- package/dist-es/commands/CreateSessionCommand.js +22 -0
- package/dist-es/commands/DeleteSessionCommand.js +22 -0
- package/dist-es/commands/EndSessionCommand.js +22 -0
- package/dist-es/commands/GetInvocationStepCommand.js +23 -0
- package/dist-es/commands/GetSessionCommand.js +22 -0
- package/dist-es/commands/InvokeAgentCommand.js +2 -1
- package/dist-es/commands/InvokeInlineAgentCommand.js +2 -1
- package/dist-es/commands/ListInvocationStepsCommand.js +22 -0
- package/dist-es/commands/ListInvocationsCommand.js +22 -0
- package/dist-es/commands/ListSessionsCommand.js +22 -0
- package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
- package/dist-es/commands/PutInvocationStepCommand.js +23 -0
- package/dist-es/commands/RetrieveAndGenerateCommand.js +2 -1
- package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +2 -1
- package/dist-es/commands/RetrieveCommand.js +2 -1
- package/dist-es/commands/TagResourceCommand.js +22 -0
- package/dist-es/commands/UntagResourceCommand.js +22 -0
- package/dist-es/commands/UpdateSessionCommand.js +22 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +78 -151
- package/dist-es/models/models_1.js +164 -0
- package/dist-es/pagination/ListInvocationStepsPaginator.js +4 -0
- package/dist-es/pagination/ListInvocationsPaginator.js +4 -0
- package/dist-es/pagination/ListSessionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +574 -11
- package/dist-types/BedrockAgentRuntime.d.ts +100 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +16 -2
- package/dist-types/commands/CreateInvocationCommand.d.ts +115 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +133 -0
- package/dist-types/commands/DeleteSessionCommand.d.ts +89 -0
- package/dist-types/commands/EndSessionCommand.d.ts +93 -0
- package/dist-types/commands/GetInvocationStepCommand.d.ts +109 -0
- package/dist-types/commands/GetSessionCommand.d.ts +94 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +23 -1
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +23 -1
- package/dist-types/commands/ListInvocationStepsCommand.d.ts +97 -0
- package/dist-types/commands/ListInvocationsCommand.d.ts +95 -0
- package/dist-types/commands/ListSessionsCommand.d.ts +93 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +88 -0
- package/dist-types/commands/PutInvocationStepCommand.d.ts +134 -0
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +2 -1
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -1
- package/dist-types/commands/RetrieveCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +90 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +96 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +582 -635
- package/dist-types/models/models_1.d.ts +919 -0
- package/dist-types/pagination/ListInvocationStepsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListInvocationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListSessionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +240 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +86 -2
- package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/InvokeInlineAgentCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +262 -365
- package/dist-types/ts3.4/models/models_1.d.ts +416 -0
- package/dist-types/ts3.4/pagination/ListInvocationStepsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListInvocationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListSessionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
- package/package.json +12 -12
|
@@ -3701,6 +3701,70 @@ export interface RawResponse {
|
|
|
3701
3701
|
*/
|
|
3702
3702
|
content?: string | undefined;
|
|
3703
3703
|
}
|
|
3704
|
+
/**
|
|
3705
|
+
* <p>Contains information about the reasoning that the model used to return the content in the content block.</p>
|
|
3706
|
+
* @public
|
|
3707
|
+
*/
|
|
3708
|
+
export interface ReasoningTextBlock {
|
|
3709
|
+
/**
|
|
3710
|
+
* <p>Text describing the reasoning that the model used to return the content in the content block.</p>
|
|
3711
|
+
* @public
|
|
3712
|
+
*/
|
|
3713
|
+
text: string | undefined;
|
|
3714
|
+
/**
|
|
3715
|
+
* <p>A hash of all the messages in the conversation to ensure that the content in the
|
|
3716
|
+
* reasoning text block isn't tampered with. You must submit the signature in subsequent
|
|
3717
|
+
* <code>Converse</code> requests, in addition to the previous messages. If the
|
|
3718
|
+
* previous messages are tampered with, the response throws an error.</p>
|
|
3719
|
+
* @public
|
|
3720
|
+
*/
|
|
3721
|
+
signature?: string | undefined;
|
|
3722
|
+
}
|
|
3723
|
+
/**
|
|
3724
|
+
* <p>Contains content regarding the reasoning that the foundation model made with respect
|
|
3725
|
+
* to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that
|
|
3726
|
+
* the model generates to enhance the accuracy of its final response.</p>
|
|
3727
|
+
* @public
|
|
3728
|
+
*/
|
|
3729
|
+
export type ReasoningContentBlock = ReasoningContentBlock.ReasoningTextMember | ReasoningContentBlock.RedactedContentMember | ReasoningContentBlock.$UnknownMember;
|
|
3730
|
+
/**
|
|
3731
|
+
* @public
|
|
3732
|
+
*/
|
|
3733
|
+
export declare namespace ReasoningContentBlock {
|
|
3734
|
+
/**
|
|
3735
|
+
* <p>Contains information about the reasoning that the model used to return the content in
|
|
3736
|
+
* the content block.</p>
|
|
3737
|
+
* @public
|
|
3738
|
+
*/
|
|
3739
|
+
interface ReasoningTextMember {
|
|
3740
|
+
reasoningText: ReasoningTextBlock;
|
|
3741
|
+
redactedContent?: never;
|
|
3742
|
+
$unknown?: never;
|
|
3743
|
+
}
|
|
3744
|
+
/**
|
|
3745
|
+
* <p>The content in the reasoning that was encrypted by the model provider for trust and safety reasons.</p>
|
|
3746
|
+
* @public
|
|
3747
|
+
*/
|
|
3748
|
+
interface RedactedContentMember {
|
|
3749
|
+
reasoningText?: never;
|
|
3750
|
+
redactedContent: Uint8Array;
|
|
3751
|
+
$unknown?: never;
|
|
3752
|
+
}
|
|
3753
|
+
/**
|
|
3754
|
+
* @public
|
|
3755
|
+
*/
|
|
3756
|
+
interface $UnknownMember {
|
|
3757
|
+
reasoningText?: never;
|
|
3758
|
+
redactedContent?: never;
|
|
3759
|
+
$unknown: [string, any];
|
|
3760
|
+
}
|
|
3761
|
+
interface Visitor<T> {
|
|
3762
|
+
reasoningText: (value: ReasoningTextBlock) => T;
|
|
3763
|
+
redactedContent: (value: Uint8Array) => T;
|
|
3764
|
+
_: (name: string, value: any) => T;
|
|
3765
|
+
}
|
|
3766
|
+
const visit: <T>(value: ReasoningContentBlock, visitor: Visitor<T>) => T;
|
|
3767
|
+
}
|
|
3704
3768
|
/**
|
|
3705
3769
|
* <p>The foundation model output from the orchestration step.</p>
|
|
3706
3770
|
* @public
|
|
@@ -3721,6 +3785,11 @@ export interface OrchestrationModelInvocationOutput {
|
|
|
3721
3785
|
* @public
|
|
3722
3786
|
*/
|
|
3723
3787
|
metadata?: Metadata | undefined;
|
|
3788
|
+
/**
|
|
3789
|
+
* <p>Contains content about the reasoning that the model made during the orchestration step. </p>
|
|
3790
|
+
* @public
|
|
3791
|
+
*/
|
|
3792
|
+
reasoningContent?: ReasoningContentBlock | undefined;
|
|
3724
3793
|
}
|
|
3725
3794
|
/**
|
|
3726
3795
|
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
@@ -4040,6 +4109,11 @@ export interface PostProcessingModelInvocationOutput {
|
|
|
4040
4109
|
* @public
|
|
4041
4110
|
*/
|
|
4042
4111
|
metadata?: Metadata | undefined;
|
|
4112
|
+
/**
|
|
4113
|
+
* <p>Contains content about the reasoning that the model made during the post-processing step.</p>
|
|
4114
|
+
* @public
|
|
4115
|
+
*/
|
|
4116
|
+
reasoningContent?: ReasoningContentBlock | undefined;
|
|
4043
4117
|
}
|
|
4044
4118
|
/**
|
|
4045
4119
|
* <p>Details about the post-processing step, in which the agent shapes the response.</p>
|
|
@@ -4139,6 +4213,11 @@ export interface PreProcessingModelInvocationOutput {
|
|
|
4139
4213
|
* @public
|
|
4140
4214
|
*/
|
|
4141
4215
|
metadata?: Metadata | undefined;
|
|
4216
|
+
/**
|
|
4217
|
+
* <p>Contains content about the reasoning that the model made during the pre-processing step. </p>
|
|
4218
|
+
* @public
|
|
4219
|
+
*/
|
|
4220
|
+
reasoningContent?: ReasoningContentBlock | undefined;
|
|
4142
4221
|
}
|
|
4143
4222
|
/**
|
|
4144
4223
|
* <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p>
|
|
@@ -4985,7 +5064,7 @@ export interface PromptConfiguration {
|
|
|
4985
5064
|
*/
|
|
4986
5065
|
inferenceConfiguration?: InferenceConfiguration | undefined;
|
|
4987
5066
|
/**
|
|
4988
|
-
* <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>. If you set the field as <code>
|
|
5067
|
+
* <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>. If you set the field as <code>OVERRIDDEN</code>, the <code>overrideLambda</code> field in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> must be specified with the ARN of a Lambda function.</p>
|
|
4989
5068
|
* @public
|
|
4990
5069
|
*/
|
|
4991
5070
|
parserMode?: CreationMode | undefined;
|
|
@@ -6888,870 +6967,762 @@ export interface RetrieveResponse {
|
|
|
6888
6967
|
nextToken?: string | undefined;
|
|
6889
6968
|
}
|
|
6890
6969
|
/**
|
|
6891
|
-
* <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>. See the examples below to see how to use these filters.</p>
|
|
6892
|
-
* <p>This data type is used in the following API operations:</p>
|
|
6893
|
-
* <ul>
|
|
6894
|
-
* <li>
|
|
6895
|
-
* <p>
|
|
6896
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>filter</code> field</p>
|
|
6897
|
-
* </li>
|
|
6898
|
-
* <li>
|
|
6899
|
-
* <p>
|
|
6900
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>filter</code> field</p>
|
|
6901
|
-
* </li>
|
|
6902
|
-
* </ul>
|
|
6903
6970
|
* @public
|
|
6904
6971
|
*/
|
|
6905
|
-
export
|
|
6972
|
+
export interface CreateSessionRequest {
|
|
6973
|
+
/**
|
|
6974
|
+
* <p>A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference,
|
|
6975
|
+
* and the type of device they are using.</p>
|
|
6976
|
+
* @public
|
|
6977
|
+
*/
|
|
6978
|
+
sessionMetadata?: Record<string, string> | undefined;
|
|
6979
|
+
/**
|
|
6980
|
+
* <p>The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key.
|
|
6981
|
+
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.
|
|
6982
|
+
* </p>
|
|
6983
|
+
* @public
|
|
6984
|
+
*/
|
|
6985
|
+
encryptionKeyArn?: string | undefined;
|
|
6986
|
+
/**
|
|
6987
|
+
* <p>Specify the key-value pairs for the tags that you want to attach to the session.</p>
|
|
6988
|
+
* @public
|
|
6989
|
+
*/
|
|
6990
|
+
tags?: Record<string, string> | undefined;
|
|
6991
|
+
}
|
|
6906
6992
|
/**
|
|
6907
6993
|
* @public
|
|
6994
|
+
* @enum
|
|
6908
6995
|
*/
|
|
6909
|
-
export declare
|
|
6996
|
+
export declare const SessionStatus: {
|
|
6997
|
+
readonly ACTIVE: "ACTIVE";
|
|
6998
|
+
readonly ENDED: "ENDED";
|
|
6999
|
+
readonly EXPIRED: "EXPIRED";
|
|
7000
|
+
};
|
|
7001
|
+
/**
|
|
7002
|
+
* @public
|
|
7003
|
+
*/
|
|
7004
|
+
export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus];
|
|
7005
|
+
/**
|
|
7006
|
+
* @public
|
|
7007
|
+
*/
|
|
7008
|
+
export interface CreateSessionResponse {
|
|
6910
7009
|
/**
|
|
6911
|
-
* <p>
|
|
6912
|
-
* <p>The following example would return data sources with an <code>animal</code> attribute whose value is <code>cat</code>:</p>
|
|
6913
|
-
* <p>
|
|
6914
|
-
* <code>"equals": \{ "key": "animal", "value": "cat" \}</code>
|
|
6915
|
-
* </p>
|
|
7010
|
+
* <p>The unique identifier for the session.</p>
|
|
6916
7011
|
* @public
|
|
6917
7012
|
*/
|
|
6918
|
-
|
|
6919
|
-
equals: FilterAttribute;
|
|
6920
|
-
notEquals?: never;
|
|
6921
|
-
greaterThan?: never;
|
|
6922
|
-
greaterThanOrEquals?: never;
|
|
6923
|
-
lessThan?: never;
|
|
6924
|
-
lessThanOrEquals?: never;
|
|
6925
|
-
in?: never;
|
|
6926
|
-
notIn?: never;
|
|
6927
|
-
startsWith?: never;
|
|
6928
|
-
listContains?: never;
|
|
6929
|
-
stringContains?: never;
|
|
6930
|
-
andAll?: never;
|
|
6931
|
-
orAll?: never;
|
|
6932
|
-
$unknown?: never;
|
|
6933
|
-
}
|
|
7013
|
+
sessionId: string | undefined;
|
|
6934
7014
|
/**
|
|
6935
|
-
* <p>
|
|
6936
|
-
*
|
|
6937
|
-
|
|
6938
|
-
|
|
6939
|
-
* </p>
|
|
6940
|
-
* @public
|
|
6941
|
-
*/
|
|
6942
|
-
interface NotEqualsMember {
|
|
6943
|
-
equals?: never;
|
|
6944
|
-
notEquals: FilterAttribute;
|
|
6945
|
-
greaterThan?: never;
|
|
6946
|
-
greaterThanOrEquals?: never;
|
|
6947
|
-
lessThan?: never;
|
|
6948
|
-
lessThanOrEquals?: never;
|
|
6949
|
-
in?: never;
|
|
6950
|
-
notIn?: never;
|
|
6951
|
-
startsWith?: never;
|
|
6952
|
-
listContains?: never;
|
|
6953
|
-
stringContains?: never;
|
|
6954
|
-
andAll?: never;
|
|
6955
|
-
orAll?: never;
|
|
6956
|
-
$unknown?: never;
|
|
6957
|
-
}
|
|
7015
|
+
* <p>The Amazon Resource Name (ARN) of the created session.</p>
|
|
7016
|
+
* @public
|
|
7017
|
+
*/
|
|
7018
|
+
sessionArn: string | undefined;
|
|
6958
7019
|
/**
|
|
6959
|
-
* <p>
|
|
6960
|
-
*
|
|
6961
|
-
|
|
6962
|
-
|
|
6963
|
-
* </p>
|
|
6964
|
-
* @public
|
|
6965
|
-
*/
|
|
6966
|
-
interface GreaterThanMember {
|
|
6967
|
-
equals?: never;
|
|
6968
|
-
notEquals?: never;
|
|
6969
|
-
greaterThan: FilterAttribute;
|
|
6970
|
-
greaterThanOrEquals?: never;
|
|
6971
|
-
lessThan?: never;
|
|
6972
|
-
lessThanOrEquals?: never;
|
|
6973
|
-
in?: never;
|
|
6974
|
-
notIn?: never;
|
|
6975
|
-
startsWith?: never;
|
|
6976
|
-
listContains?: never;
|
|
6977
|
-
stringContains?: never;
|
|
6978
|
-
andAll?: never;
|
|
6979
|
-
orAll?: never;
|
|
6980
|
-
$unknown?: never;
|
|
6981
|
-
}
|
|
7020
|
+
* <p>The current status of the session.</p>
|
|
7021
|
+
* @public
|
|
7022
|
+
*/
|
|
7023
|
+
sessionStatus: SessionStatus | undefined;
|
|
6982
7024
|
/**
|
|
6983
|
-
* <p>
|
|
6984
|
-
*
|
|
6985
|
-
|
|
6986
|
-
|
|
6987
|
-
|
|
6988
|
-
|
|
6989
|
-
|
|
6990
|
-
|
|
6991
|
-
|
|
6992
|
-
notEquals?: never;
|
|
6993
|
-
greaterThan?: never;
|
|
6994
|
-
greaterThanOrEquals: FilterAttribute;
|
|
6995
|
-
lessThan?: never;
|
|
6996
|
-
lessThanOrEquals?: never;
|
|
6997
|
-
in?: never;
|
|
6998
|
-
notIn?: never;
|
|
6999
|
-
startsWith?: never;
|
|
7000
|
-
listContains?: never;
|
|
7001
|
-
stringContains?: never;
|
|
7002
|
-
andAll?: never;
|
|
7003
|
-
orAll?: never;
|
|
7004
|
-
$unknown?: never;
|
|
7005
|
-
}
|
|
7025
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7026
|
+
* @public
|
|
7027
|
+
*/
|
|
7028
|
+
createdAt: Date | undefined;
|
|
7029
|
+
}
|
|
7030
|
+
/**
|
|
7031
|
+
* @public
|
|
7032
|
+
*/
|
|
7033
|
+
export interface DeleteSessionRequest {
|
|
7006
7034
|
/**
|
|
7007
|
-
* <p>
|
|
7008
|
-
*
|
|
7009
|
-
|
|
7010
|
-
|
|
7011
|
-
|
|
7012
|
-
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
|
|
7016
|
-
|
|
7017
|
-
|
|
7018
|
-
|
|
7019
|
-
|
|
7020
|
-
|
|
7021
|
-
in?: never;
|
|
7022
|
-
notIn?: never;
|
|
7023
|
-
startsWith?: never;
|
|
7024
|
-
listContains?: never;
|
|
7025
|
-
stringContains?: never;
|
|
7026
|
-
andAll?: never;
|
|
7027
|
-
orAll?: never;
|
|
7028
|
-
$unknown?: never;
|
|
7029
|
-
}
|
|
7035
|
+
* <p>The unique identifier for the session to be deleted. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7036
|
+
* @public
|
|
7037
|
+
*/
|
|
7038
|
+
sessionIdentifier: string | undefined;
|
|
7039
|
+
}
|
|
7040
|
+
/**
|
|
7041
|
+
* @public
|
|
7042
|
+
*/
|
|
7043
|
+
export interface DeleteSessionResponse {
|
|
7044
|
+
}
|
|
7045
|
+
/**
|
|
7046
|
+
* @public
|
|
7047
|
+
*/
|
|
7048
|
+
export interface EndSessionRequest {
|
|
7030
7049
|
/**
|
|
7031
|
-
* <p>
|
|
7032
|
-
*
|
|
7033
|
-
|
|
7034
|
-
|
|
7035
|
-
|
|
7036
|
-
|
|
7037
|
-
|
|
7038
|
-
|
|
7039
|
-
|
|
7040
|
-
notEquals?: never;
|
|
7041
|
-
greaterThan?: never;
|
|
7042
|
-
greaterThanOrEquals?: never;
|
|
7043
|
-
lessThan?: never;
|
|
7044
|
-
lessThanOrEquals: FilterAttribute;
|
|
7045
|
-
in?: never;
|
|
7046
|
-
notIn?: never;
|
|
7047
|
-
startsWith?: never;
|
|
7048
|
-
listContains?: never;
|
|
7049
|
-
stringContains?: never;
|
|
7050
|
-
andAll?: never;
|
|
7051
|
-
orAll?: never;
|
|
7052
|
-
$unknown?: never;
|
|
7053
|
-
}
|
|
7050
|
+
* <p>The unique identifier for the session to end. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7051
|
+
* @public
|
|
7052
|
+
*/
|
|
7053
|
+
sessionIdentifier: string | undefined;
|
|
7054
|
+
}
|
|
7055
|
+
/**
|
|
7056
|
+
* @public
|
|
7057
|
+
*/
|
|
7058
|
+
export interface EndSessionResponse {
|
|
7054
7059
|
/**
|
|
7055
|
-
* <p>
|
|
7056
|
-
*
|
|
7057
|
-
|
|
7058
|
-
|
|
7059
|
-
* </p>
|
|
7060
|
-
* @public
|
|
7061
|
-
*/
|
|
7062
|
-
interface InMember {
|
|
7063
|
-
equals?: never;
|
|
7064
|
-
notEquals?: never;
|
|
7065
|
-
greaterThan?: never;
|
|
7066
|
-
greaterThanOrEquals?: never;
|
|
7067
|
-
lessThan?: never;
|
|
7068
|
-
lessThanOrEquals?: never;
|
|
7069
|
-
in: FilterAttribute;
|
|
7070
|
-
notIn?: never;
|
|
7071
|
-
startsWith?: never;
|
|
7072
|
-
listContains?: never;
|
|
7073
|
-
stringContains?: never;
|
|
7074
|
-
andAll?: never;
|
|
7075
|
-
orAll?: never;
|
|
7076
|
-
$unknown?: never;
|
|
7077
|
-
}
|
|
7060
|
+
* <p>The unique identifier of the session you ended.</p>
|
|
7061
|
+
* @public
|
|
7062
|
+
*/
|
|
7063
|
+
sessionId: string | undefined;
|
|
7078
7064
|
/**
|
|
7079
|
-
* <p>
|
|
7080
|
-
*
|
|
7081
|
-
|
|
7082
|
-
|
|
7083
|
-
* </p>
|
|
7084
|
-
* @public
|
|
7085
|
-
*/
|
|
7086
|
-
interface NotInMember {
|
|
7087
|
-
equals?: never;
|
|
7088
|
-
notEquals?: never;
|
|
7089
|
-
greaterThan?: never;
|
|
7090
|
-
greaterThanOrEquals?: never;
|
|
7091
|
-
lessThan?: never;
|
|
7092
|
-
lessThanOrEquals?: never;
|
|
7093
|
-
in?: never;
|
|
7094
|
-
notIn: FilterAttribute;
|
|
7095
|
-
startsWith?: never;
|
|
7096
|
-
listContains?: never;
|
|
7097
|
-
stringContains?: never;
|
|
7098
|
-
andAll?: never;
|
|
7099
|
-
orAll?: never;
|
|
7100
|
-
$unknown?: never;
|
|
7101
|
-
}
|
|
7065
|
+
* <p>The Amazon Resource Name (ARN) of the session you ended.</p>
|
|
7066
|
+
* @public
|
|
7067
|
+
*/
|
|
7068
|
+
sessionArn: string | undefined;
|
|
7102
7069
|
/**
|
|
7103
|
-
* <p>
|
|
7104
|
-
*
|
|
7105
|
-
|
|
7106
|
-
|
|
7107
|
-
|
|
7108
|
-
|
|
7109
|
-
|
|
7110
|
-
|
|
7111
|
-
|
|
7112
|
-
notEquals?: never;
|
|
7113
|
-
greaterThan?: never;
|
|
7114
|
-
greaterThanOrEquals?: never;
|
|
7115
|
-
lessThan?: never;
|
|
7116
|
-
lessThanOrEquals?: never;
|
|
7117
|
-
in?: never;
|
|
7118
|
-
notIn?: never;
|
|
7119
|
-
startsWith: FilterAttribute;
|
|
7120
|
-
listContains?: never;
|
|
7121
|
-
stringContains?: never;
|
|
7122
|
-
andAll?: never;
|
|
7123
|
-
orAll?: never;
|
|
7124
|
-
$unknown?: never;
|
|
7125
|
-
}
|
|
7070
|
+
* <p>The current status of the session you ended.</p>
|
|
7071
|
+
* @public
|
|
7072
|
+
*/
|
|
7073
|
+
sessionStatus: SessionStatus | undefined;
|
|
7074
|
+
}
|
|
7075
|
+
/**
|
|
7076
|
+
* @public
|
|
7077
|
+
*/
|
|
7078
|
+
export interface GetSessionRequest {
|
|
7126
7079
|
/**
|
|
7127
|
-
* <p>
|
|
7128
|
-
*
|
|
7129
|
-
|
|
7130
|
-
|
|
7131
|
-
|
|
7132
|
-
|
|
7133
|
-
|
|
7134
|
-
|
|
7135
|
-
|
|
7136
|
-
notEquals?: never;
|
|
7137
|
-
greaterThan?: never;
|
|
7138
|
-
greaterThanOrEquals?: never;
|
|
7139
|
-
lessThan?: never;
|
|
7140
|
-
lessThanOrEquals?: never;
|
|
7141
|
-
in?: never;
|
|
7142
|
-
notIn?: never;
|
|
7143
|
-
startsWith?: never;
|
|
7144
|
-
listContains: FilterAttribute;
|
|
7145
|
-
stringContains?: never;
|
|
7146
|
-
andAll?: never;
|
|
7147
|
-
orAll?: never;
|
|
7148
|
-
$unknown?: never;
|
|
7149
|
-
}
|
|
7080
|
+
* <p>A unique identifier for the session to retrieve. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7081
|
+
* @public
|
|
7082
|
+
*/
|
|
7083
|
+
sessionIdentifier: string | undefined;
|
|
7084
|
+
}
|
|
7085
|
+
/**
|
|
7086
|
+
* @public
|
|
7087
|
+
*/
|
|
7088
|
+
export interface GetSessionResponse {
|
|
7150
7089
|
/**
|
|
7151
|
-
* <p>
|
|
7152
|
-
* <ul>
|
|
7153
|
-
* <li>
|
|
7154
|
-
* <p>A string that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animal</code> attribute that contains the substring <code>at</code> (for example <code>cat</code>).</p>
|
|
7155
|
-
* <p>
|
|
7156
|
-
* <code>"stringContains": \{ "key": "animal", "value": "at" \}</code>
|
|
7157
|
-
* </p>
|
|
7158
|
-
* </li>
|
|
7159
|
-
* <li>
|
|
7160
|
-
* <p>A list with a member that contains the <code>value</code> as a substring. The following example would return data sources with an <code>animals</code> attribute that is a list containing a member that contains the substring <code>at</code> (for example <code>["dog", "cat"]</code>).</p>
|
|
7161
|
-
* <p>
|
|
7162
|
-
* <code>"stringContains": \{ "key": "animals", "value": "at" \}</code>
|
|
7163
|
-
* </p>
|
|
7164
|
-
* </li>
|
|
7165
|
-
* </ul>
|
|
7090
|
+
* <p>The unique identifier for the session in UUID format.</p>
|
|
7166
7091
|
* @public
|
|
7167
7092
|
*/
|
|
7168
|
-
|
|
7169
|
-
equals?: never;
|
|
7170
|
-
notEquals?: never;
|
|
7171
|
-
greaterThan?: never;
|
|
7172
|
-
greaterThanOrEquals?: never;
|
|
7173
|
-
lessThan?: never;
|
|
7174
|
-
lessThanOrEquals?: never;
|
|
7175
|
-
in?: never;
|
|
7176
|
-
notIn?: never;
|
|
7177
|
-
startsWith?: never;
|
|
7178
|
-
listContains?: never;
|
|
7179
|
-
stringContains: FilterAttribute;
|
|
7180
|
-
andAll?: never;
|
|
7181
|
-
orAll?: never;
|
|
7182
|
-
$unknown?: never;
|
|
7183
|
-
}
|
|
7093
|
+
sessionId: string | undefined;
|
|
7184
7094
|
/**
|
|
7185
|
-
* <p>
|
|
7095
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
7186
7096
|
* @public
|
|
7187
7097
|
*/
|
|
7188
|
-
|
|
7189
|
-
equals?: never;
|
|
7190
|
-
notEquals?: never;
|
|
7191
|
-
greaterThan?: never;
|
|
7192
|
-
greaterThanOrEquals?: never;
|
|
7193
|
-
lessThan?: never;
|
|
7194
|
-
lessThanOrEquals?: never;
|
|
7195
|
-
in?: never;
|
|
7196
|
-
notIn?: never;
|
|
7197
|
-
startsWith?: never;
|
|
7198
|
-
listContains?: never;
|
|
7199
|
-
stringContains?: never;
|
|
7200
|
-
andAll: RetrievalFilter[];
|
|
7201
|
-
orAll?: never;
|
|
7202
|
-
$unknown?: never;
|
|
7203
|
-
}
|
|
7098
|
+
sessionArn: string | undefined;
|
|
7204
7099
|
/**
|
|
7205
|
-
* <p>
|
|
7100
|
+
* <p>The current status of the session.</p>
|
|
7206
7101
|
* @public
|
|
7207
7102
|
*/
|
|
7208
|
-
|
|
7209
|
-
equals?: never;
|
|
7210
|
-
notEquals?: never;
|
|
7211
|
-
greaterThan?: never;
|
|
7212
|
-
greaterThanOrEquals?: never;
|
|
7213
|
-
lessThan?: never;
|
|
7214
|
-
lessThanOrEquals?: never;
|
|
7215
|
-
in?: never;
|
|
7216
|
-
notIn?: never;
|
|
7217
|
-
startsWith?: never;
|
|
7218
|
-
listContains?: never;
|
|
7219
|
-
stringContains?: never;
|
|
7220
|
-
andAll?: never;
|
|
7221
|
-
orAll: RetrievalFilter[];
|
|
7222
|
-
$unknown?: never;
|
|
7223
|
-
}
|
|
7103
|
+
sessionStatus: SessionStatus | undefined;
|
|
7224
7104
|
/**
|
|
7105
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7225
7106
|
* @public
|
|
7226
7107
|
*/
|
|
7227
|
-
|
|
7228
|
-
|
|
7229
|
-
|
|
7230
|
-
|
|
7231
|
-
|
|
7232
|
-
|
|
7233
|
-
|
|
7234
|
-
|
|
7235
|
-
|
|
7236
|
-
|
|
7237
|
-
|
|
7238
|
-
|
|
7239
|
-
|
|
7240
|
-
|
|
7241
|
-
|
|
7242
|
-
|
|
7243
|
-
|
|
7244
|
-
equals: (value: FilterAttribute) => T;
|
|
7245
|
-
notEquals: (value: FilterAttribute) => T;
|
|
7246
|
-
greaterThan: (value: FilterAttribute) => T;
|
|
7247
|
-
greaterThanOrEquals: (value: FilterAttribute) => T;
|
|
7248
|
-
lessThan: (value: FilterAttribute) => T;
|
|
7249
|
-
lessThanOrEquals: (value: FilterAttribute) => T;
|
|
7250
|
-
in: (value: FilterAttribute) => T;
|
|
7251
|
-
notIn: (value: FilterAttribute) => T;
|
|
7252
|
-
startsWith: (value: FilterAttribute) => T;
|
|
7253
|
-
listContains: (value: FilterAttribute) => T;
|
|
7254
|
-
stringContains: (value: FilterAttribute) => T;
|
|
7255
|
-
andAll: (value: RetrievalFilter[]) => T;
|
|
7256
|
-
orAll: (value: RetrievalFilter[]) => T;
|
|
7257
|
-
_: (name: string, value: any) => T;
|
|
7258
|
-
}
|
|
7259
|
-
const visit: <T>(value: RetrievalFilter, visitor: Visitor<T>) => T;
|
|
7108
|
+
createdAt: Date | undefined;
|
|
7109
|
+
/**
|
|
7110
|
+
* <p>The timestamp for when the session was last modified.</p>
|
|
7111
|
+
* @public
|
|
7112
|
+
*/
|
|
7113
|
+
lastUpdatedAt: Date | undefined;
|
|
7114
|
+
/**
|
|
7115
|
+
* <p>A map of key-value pairs containing attributes persisted across the session.</p>
|
|
7116
|
+
* @public
|
|
7117
|
+
*/
|
|
7118
|
+
sessionMetadata?: Record<string, string> | undefined;
|
|
7119
|
+
/**
|
|
7120
|
+
* <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data.
|
|
7121
|
+
* For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
|
|
7122
|
+
* @public
|
|
7123
|
+
*/
|
|
7124
|
+
encryptionKeyArn?: string | undefined;
|
|
7260
7125
|
}
|
|
7261
7126
|
/**
|
|
7262
|
-
* <p>Configurations for how to perform the search query and return results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
7263
|
-
* <p>This data type is used in the following API operations:</p>
|
|
7264
|
-
* <ul>
|
|
7265
|
-
* <li>
|
|
7266
|
-
* <p>
|
|
7267
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>vectorSearchConfiguration</code> field</p>
|
|
7268
|
-
* </li>
|
|
7269
|
-
* <li>
|
|
7270
|
-
* <p>
|
|
7271
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>vectorSearchConfiguration</code> field</p>
|
|
7272
|
-
* </li>
|
|
7273
|
-
* </ul>
|
|
7274
7127
|
* @public
|
|
7275
7128
|
*/
|
|
7276
|
-
export interface
|
|
7129
|
+
export interface CreateInvocationRequest {
|
|
7277
7130
|
/**
|
|
7278
|
-
* <p>
|
|
7131
|
+
* <p>A unique identifier for the invocation in UUID format.</p>
|
|
7279
7132
|
* @public
|
|
7280
7133
|
*/
|
|
7281
|
-
|
|
7134
|
+
invocationId?: string | undefined;
|
|
7282
7135
|
/**
|
|
7283
|
-
* <p>
|
|
7136
|
+
* <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
|
|
7284
7137
|
* @public
|
|
7285
7138
|
*/
|
|
7286
|
-
|
|
7139
|
+
description?: string | undefined;
|
|
7287
7140
|
/**
|
|
7288
|
-
* <p>
|
|
7141
|
+
* <p>The unique identifier for the associated session for the invocation. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).
|
|
7142
|
+
* </p>
|
|
7289
7143
|
* @public
|
|
7290
7144
|
*/
|
|
7291
|
-
|
|
7145
|
+
sessionIdentifier: string | undefined;
|
|
7146
|
+
}
|
|
7147
|
+
/**
|
|
7148
|
+
* @public
|
|
7149
|
+
*/
|
|
7150
|
+
export interface CreateInvocationResponse {
|
|
7292
7151
|
/**
|
|
7293
|
-
* <p>
|
|
7152
|
+
* <p>The unique identifier for the session associated with the invocation.</p>
|
|
7294
7153
|
* @public
|
|
7295
7154
|
*/
|
|
7296
|
-
|
|
7155
|
+
sessionId: string | undefined;
|
|
7156
|
+
/**
|
|
7157
|
+
* <p>The unique identifier for the invocation.</p>
|
|
7158
|
+
* @public
|
|
7159
|
+
*/
|
|
7160
|
+
invocationId: string | undefined;
|
|
7297
7161
|
/**
|
|
7298
|
-
* <p>
|
|
7162
|
+
* <p>The timestamp for when the invocation was created.</p>
|
|
7299
7163
|
* @public
|
|
7300
7164
|
*/
|
|
7301
|
-
|
|
7165
|
+
createdAt: Date | undefined;
|
|
7302
7166
|
}
|
|
7303
7167
|
/**
|
|
7304
|
-
* <p>Contains configurations for knowledge base query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
7305
|
-
* <p>This data type is used in the following API operations:</p>
|
|
7306
|
-
* <ul>
|
|
7307
|
-
* <li>
|
|
7308
|
-
* <p>
|
|
7309
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>retrievalConfiguration</code> field</p>
|
|
7310
|
-
* </li>
|
|
7311
|
-
* <li>
|
|
7312
|
-
* <p>
|
|
7313
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>retrievalConfiguration</code> field</p>
|
|
7314
|
-
* </li>
|
|
7315
|
-
* </ul>
|
|
7316
7168
|
* @public
|
|
7317
7169
|
*/
|
|
7318
|
-
export interface
|
|
7170
|
+
export interface ListInvocationsRequest {
|
|
7319
7171
|
/**
|
|
7320
|
-
* <p>
|
|
7172
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
|
|
7173
|
+
* token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
|
|
7174
|
+
* </p>
|
|
7321
7175
|
* @public
|
|
7322
7176
|
*/
|
|
7323
|
-
|
|
7177
|
+
nextToken?: string | undefined;
|
|
7178
|
+
/**
|
|
7179
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
|
|
7180
|
+
* use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
|
|
7181
|
+
* batch of results.</p>
|
|
7182
|
+
* @public
|
|
7183
|
+
*/
|
|
7184
|
+
maxResults?: number | undefined;
|
|
7185
|
+
/**
|
|
7186
|
+
* <p>The unique identifier for the session to list invocations for. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7187
|
+
* @public
|
|
7188
|
+
*/
|
|
7189
|
+
sessionIdentifier: string | undefined;
|
|
7324
7190
|
}
|
|
7325
7191
|
/**
|
|
7326
|
-
* <p>
|
|
7327
|
-
* Details of the knowledge base associated withe inline agent.
|
|
7328
|
-
* </p>
|
|
7192
|
+
* <p>Contains details about an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7329
7193
|
* @public
|
|
7330
7194
|
*/
|
|
7331
|
-
export interface
|
|
7195
|
+
export interface InvocationSummary {
|
|
7332
7196
|
/**
|
|
7333
|
-
* <p>
|
|
7334
|
-
* The unique identifier for a knowledge base associated with the inline agent.
|
|
7335
|
-
* </p>
|
|
7197
|
+
* <p>The unique identifier for the session associated with the invocation.</p>
|
|
7336
7198
|
* @public
|
|
7337
7199
|
*/
|
|
7338
|
-
|
|
7200
|
+
sessionId: string | undefined;
|
|
7339
7201
|
/**
|
|
7340
|
-
* <p>
|
|
7341
|
-
* The description of the knowledge base associated with the inline agent.
|
|
7342
|
-
* </p>
|
|
7202
|
+
* <p>A unique identifier for the invocation in UUID format.</p>
|
|
7343
7203
|
* @public
|
|
7344
7204
|
*/
|
|
7345
|
-
|
|
7205
|
+
invocationId: string | undefined;
|
|
7346
7206
|
/**
|
|
7347
|
-
* <p>
|
|
7348
|
-
* The configurations to apply to the knowledge base during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.
|
|
7349
|
-
* </p>
|
|
7207
|
+
* <p>The timestamp for when the invocation was created.</p>
|
|
7350
7208
|
* @public
|
|
7351
7209
|
*/
|
|
7352
|
-
|
|
7210
|
+
createdAt: Date | undefined;
|
|
7353
7211
|
}
|
|
7354
7212
|
/**
|
|
7355
|
-
* <p>Configurations to apply to a knowledge base attached to the agent during query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb">Knowledge base retrieval configurations</a>.</p>
|
|
7356
7213
|
* @public
|
|
7357
7214
|
*/
|
|
7358
|
-
export interface
|
|
7215
|
+
export interface ListInvocationsResponse {
|
|
7359
7216
|
/**
|
|
7360
|
-
* <p>
|
|
7217
|
+
* <p>A list of invocation summaries associated with the session.</p>
|
|
7361
7218
|
* @public
|
|
7362
7219
|
*/
|
|
7363
|
-
|
|
7220
|
+
invocationSummaries: InvocationSummary[] | undefined;
|
|
7364
7221
|
/**
|
|
7365
|
-
* <p>
|
|
7222
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7366
7223
|
* @public
|
|
7367
7224
|
*/
|
|
7368
|
-
|
|
7225
|
+
nextToken?: string | undefined;
|
|
7369
7226
|
}
|
|
7370
7227
|
/**
|
|
7371
|
-
* <p>Contains details about the resource being queried.</p>
|
|
7372
|
-
* <p>This data type is used in the following API operations:</p>
|
|
7373
|
-
* <ul>
|
|
7374
|
-
* <li>
|
|
7375
|
-
* <p>
|
|
7376
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax">Retrieve request</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
|
|
7377
|
-
* </li>
|
|
7378
|
-
* <li>
|
|
7379
|
-
* <p>
|
|
7380
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax">RetrieveAndGenerate request</a> – in the <code>knowledgeBaseConfiguration</code> field</p>
|
|
7381
|
-
* </li>
|
|
7382
|
-
* </ul>
|
|
7383
7228
|
* @public
|
|
7384
7229
|
*/
|
|
7385
|
-
export interface
|
|
7230
|
+
export interface GetInvocationStepRequest {
|
|
7386
7231
|
/**
|
|
7387
|
-
* <p>The unique identifier
|
|
7232
|
+
* <p>The unique identifier for the invocation in UUID format.</p>
|
|
7388
7233
|
* @public
|
|
7389
7234
|
*/
|
|
7390
|
-
|
|
7391
|
-
/**
|
|
7392
|
-
* <p>The ARN of the foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a> used to generate a response.</p>
|
|
7393
|
-
* @public
|
|
7394
|
-
*/
|
|
7395
|
-
modelArn: string | undefined;
|
|
7235
|
+
invocationIdentifier: string | undefined;
|
|
7396
7236
|
/**
|
|
7397
|
-
* <p>
|
|
7237
|
+
* <p>The unique identifier (in UUID format) for the specific invocation step to retrieve.</p>
|
|
7398
7238
|
* @public
|
|
7399
7239
|
*/
|
|
7400
|
-
|
|
7240
|
+
invocationStepId: string | undefined;
|
|
7401
7241
|
/**
|
|
7402
|
-
* <p>
|
|
7242
|
+
* <p>The unique identifier for the invocation step's associated session. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7403
7243
|
* @public
|
|
7404
7244
|
*/
|
|
7405
|
-
|
|
7245
|
+
sessionIdentifier: string | undefined;
|
|
7246
|
+
}
|
|
7247
|
+
/**
|
|
7248
|
+
* @public
|
|
7249
|
+
* @enum
|
|
7250
|
+
*/
|
|
7251
|
+
export declare const ImageFormat: {
|
|
7252
|
+
readonly GIF: "gif";
|
|
7253
|
+
readonly JPEG: "jpeg";
|
|
7254
|
+
readonly PNG: "png";
|
|
7255
|
+
readonly WEBP: "webp";
|
|
7256
|
+
};
|
|
7257
|
+
/**
|
|
7258
|
+
* @public
|
|
7259
|
+
*/
|
|
7260
|
+
export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
|
|
7261
|
+
/**
|
|
7262
|
+
* <p>Information about the Amazon S3 bucket where the image is stored.</p>
|
|
7263
|
+
* @public
|
|
7264
|
+
*/
|
|
7265
|
+
export interface S3Location {
|
|
7406
7266
|
/**
|
|
7407
|
-
* <p>
|
|
7267
|
+
* <p>The path to the Amazon S3 bucket where the image is stored.</p>
|
|
7408
7268
|
* @public
|
|
7409
7269
|
*/
|
|
7410
|
-
|
|
7270
|
+
uri: string | undefined;
|
|
7411
7271
|
}
|
|
7412
7272
|
/**
|
|
7273
|
+
* <p>The source for an image.</p>
|
|
7413
7274
|
* @public
|
|
7414
7275
|
*/
|
|
7415
|
-
export
|
|
7276
|
+
export type ImageSource = ImageSource.BytesMember | ImageSource.S3LocationMember | ImageSource.$UnknownMember;
|
|
7277
|
+
/**
|
|
7278
|
+
* @public
|
|
7279
|
+
*/
|
|
7280
|
+
export declare namespace ImageSource {
|
|
7416
7281
|
/**
|
|
7417
|
-
* <p>The
|
|
7282
|
+
* <p> The raw image bytes for the image. If you use an Amazon Web Services SDK, you don't need to encode the image bytes in base64.</p>
|
|
7418
7283
|
* @public
|
|
7419
7284
|
*/
|
|
7420
|
-
|
|
7285
|
+
interface BytesMember {
|
|
7286
|
+
bytes: Uint8Array;
|
|
7287
|
+
s3Location?: never;
|
|
7288
|
+
$unknown?: never;
|
|
7289
|
+
}
|
|
7421
7290
|
/**
|
|
7422
|
-
* <p>
|
|
7291
|
+
* <p>The path to the Amazon S3 bucket where the image is stored.</p>
|
|
7423
7292
|
* @public
|
|
7424
7293
|
*/
|
|
7425
|
-
|
|
7294
|
+
interface S3LocationMember {
|
|
7295
|
+
bytes?: never;
|
|
7296
|
+
s3Location: S3Location;
|
|
7297
|
+
$unknown?: never;
|
|
7298
|
+
}
|
|
7426
7299
|
/**
|
|
7427
|
-
* <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
7428
7300
|
* @public
|
|
7429
7301
|
*/
|
|
7430
|
-
|
|
7302
|
+
interface $UnknownMember {
|
|
7303
|
+
bytes?: never;
|
|
7304
|
+
s3Location?: never;
|
|
7305
|
+
$unknown: [string, any];
|
|
7306
|
+
}
|
|
7307
|
+
interface Visitor<T> {
|
|
7308
|
+
bytes: (value: Uint8Array) => T;
|
|
7309
|
+
s3Location: (value: S3Location) => T;
|
|
7310
|
+
_: (name: string, value: any) => T;
|
|
7311
|
+
}
|
|
7312
|
+
const visit: <T>(value: ImageSource, visitor: Visitor<T>) => T;
|
|
7313
|
+
}
|
|
7314
|
+
/**
|
|
7315
|
+
* <p>Image content for an invocation step.</p>
|
|
7316
|
+
* @public
|
|
7317
|
+
*/
|
|
7318
|
+
export interface ImageBlock {
|
|
7431
7319
|
/**
|
|
7432
|
-
* <p>
|
|
7320
|
+
* <p>The format of the image.</p>
|
|
7433
7321
|
* @public
|
|
7434
7322
|
*/
|
|
7435
|
-
|
|
7323
|
+
format: ImageFormat | undefined;
|
|
7436
7324
|
/**
|
|
7437
|
-
* <p>
|
|
7325
|
+
* <p>The source for the image.</p>
|
|
7438
7326
|
* @public
|
|
7439
7327
|
*/
|
|
7440
|
-
|
|
7328
|
+
source: ImageSource | undefined;
|
|
7441
7329
|
}
|
|
7442
7330
|
/**
|
|
7443
|
-
* <p>
|
|
7444
|
-
*
|
|
7445
|
-
* <
|
|
7446
|
-
*
|
|
7447
|
-
*
|
|
7448
|
-
|
|
7449
|
-
|
|
7450
|
-
|
|
7331
|
+
* <p>A block of content that you pass to, or receive from, a Amazon Bedrock session in an invocation step. You pass the content to a
|
|
7332
|
+
* session in the <code>payLoad</code> of the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_PutInvocationStep.html">PutInvocationStep</a> API operation.
|
|
7333
|
+
* You retrieve the content with the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_GetInvocationStep.html">GetInvocationStep</a> API operation.</p>
|
|
7334
|
+
* <p>For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7335
|
+
* @public
|
|
7336
|
+
*/
|
|
7337
|
+
export type BedrockSessionContentBlock = BedrockSessionContentBlock.ImageMember | BedrockSessionContentBlock.TextMember | BedrockSessionContentBlock.$UnknownMember;
|
|
7338
|
+
/**
|
|
7451
7339
|
* @public
|
|
7452
7340
|
*/
|
|
7453
|
-
export
|
|
7341
|
+
export declare namespace BedrockSessionContentBlock {
|
|
7454
7342
|
/**
|
|
7455
|
-
* <p>The
|
|
7456
|
-
* <p>If you choose ot use <code>EXTERNAL_SOURCES</code>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</p>
|
|
7343
|
+
* <p>The text in the invocation step.</p>
|
|
7457
7344
|
* @public
|
|
7458
7345
|
*/
|
|
7459
|
-
|
|
7346
|
+
interface TextMember {
|
|
7347
|
+
text: string;
|
|
7348
|
+
image?: never;
|
|
7349
|
+
$unknown?: never;
|
|
7350
|
+
}
|
|
7460
7351
|
/**
|
|
7461
|
-
* <p>
|
|
7352
|
+
* <p>The image in the invocation step.</p>
|
|
7462
7353
|
* @public
|
|
7463
7354
|
*/
|
|
7464
|
-
|
|
7355
|
+
interface ImageMember {
|
|
7356
|
+
text?: never;
|
|
7357
|
+
image: ImageBlock;
|
|
7358
|
+
$unknown?: never;
|
|
7359
|
+
}
|
|
7465
7360
|
/**
|
|
7466
|
-
* <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
7467
7361
|
* @public
|
|
7468
7362
|
*/
|
|
7469
|
-
|
|
7363
|
+
interface $UnknownMember {
|
|
7364
|
+
text?: never;
|
|
7365
|
+
image?: never;
|
|
7366
|
+
$unknown: [string, any];
|
|
7367
|
+
}
|
|
7368
|
+
interface Visitor<T> {
|
|
7369
|
+
text: (value: string) => T;
|
|
7370
|
+
image: (value: ImageBlock) => T;
|
|
7371
|
+
_: (name: string, value: any) => T;
|
|
7372
|
+
}
|
|
7373
|
+
const visit: <T>(value: BedrockSessionContentBlock, visitor: Visitor<T>) => T;
|
|
7470
7374
|
}
|
|
7375
|
+
/**
|
|
7376
|
+
* <p>Payload content, such as text and images, for the invocation step.</p>
|
|
7377
|
+
* @public
|
|
7378
|
+
*/
|
|
7379
|
+
export type InvocationStepPayload = InvocationStepPayload.ContentBlocksMember | InvocationStepPayload.$UnknownMember;
|
|
7471
7380
|
/**
|
|
7472
7381
|
* @public
|
|
7473
7382
|
*/
|
|
7474
|
-
export
|
|
7383
|
+
export declare namespace InvocationStepPayload {
|
|
7384
|
+
/**
|
|
7385
|
+
* <p>The content for the invocation step.</p>
|
|
7386
|
+
* @public
|
|
7387
|
+
*/
|
|
7388
|
+
interface ContentBlocksMember {
|
|
7389
|
+
contentBlocks: BedrockSessionContentBlock[];
|
|
7390
|
+
$unknown?: never;
|
|
7391
|
+
}
|
|
7475
7392
|
/**
|
|
7476
|
-
*
|
|
7477
|
-
|
|
7478
|
-
|
|
7393
|
+
* @public
|
|
7394
|
+
*/
|
|
7395
|
+
interface $UnknownMember {
|
|
7396
|
+
contentBlocks?: never;
|
|
7397
|
+
$unknown: [string, any];
|
|
7398
|
+
}
|
|
7399
|
+
interface Visitor<T> {
|
|
7400
|
+
contentBlocks: (value: BedrockSessionContentBlock[]) => T;
|
|
7401
|
+
_: (name: string, value: any) => T;
|
|
7402
|
+
}
|
|
7403
|
+
const visit: <T>(value: InvocationStepPayload, visitor: Visitor<T>) => T;
|
|
7404
|
+
}
|
|
7405
|
+
/**
|
|
7406
|
+
* <p>Stores fine-grained state checkpoints, including text and images, for each interaction in an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>. </p>
|
|
7407
|
+
* @public
|
|
7408
|
+
*/
|
|
7409
|
+
export interface InvocationStep {
|
|
7410
|
+
/**
|
|
7411
|
+
* <p>The unique identifier of the session containing the invocation step.</p>
|
|
7479
7412
|
* @public
|
|
7480
7413
|
*/
|
|
7481
7414
|
sessionId: string | undefined;
|
|
7482
7415
|
/**
|
|
7483
|
-
* <p>
|
|
7484
|
-
* The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
|
|
7485
|
-
* </p>
|
|
7416
|
+
* <p>The unique identifier (in UUID format) for the invocation that includes the invocation step.</p>
|
|
7486
7417
|
* @public
|
|
7487
7418
|
*/
|
|
7488
|
-
|
|
7419
|
+
invocationId: string | undefined;
|
|
7489
7420
|
/**
|
|
7490
|
-
* <p>
|
|
7491
|
-
* Specifies whether to end the session with the inline agent or not.
|
|
7492
|
-
* </p>
|
|
7421
|
+
* <p>The unique identifier (in UUID format) for the invocation step.</p>
|
|
7493
7422
|
* @public
|
|
7494
7423
|
*/
|
|
7495
|
-
|
|
7424
|
+
invocationStepId: string | undefined;
|
|
7496
7425
|
/**
|
|
7497
|
-
* <p>
|
|
7498
|
-
* Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-events.html">Using trace</a>.
|
|
7499
|
-
*
|
|
7500
|
-
* </p>
|
|
7426
|
+
* <p>The timestamp for when the invocation step was created.</p>
|
|
7501
7427
|
* @public
|
|
7502
7428
|
*/
|
|
7503
|
-
|
|
7429
|
+
invocationStepTime: Date | undefined;
|
|
7504
7430
|
/**
|
|
7505
|
-
* <p>
|
|
7506
|
-
* The prompt text to send to the agent.
|
|
7507
|
-
* </p>
|
|
7508
|
-
* <note>
|
|
7509
|
-
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
7510
|
-
* </note>
|
|
7431
|
+
* <p>Payload content, such as text and images, for the invocation step.</p>
|
|
7511
7432
|
* @public
|
|
7512
7433
|
*/
|
|
7513
|
-
|
|
7434
|
+
payload: InvocationStepPayload | undefined;
|
|
7435
|
+
}
|
|
7436
|
+
/**
|
|
7437
|
+
* @public
|
|
7438
|
+
*/
|
|
7439
|
+
export interface GetInvocationStepResponse {
|
|
7514
7440
|
/**
|
|
7515
|
-
* <p>
|
|
7516
|
-
* Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an
|
|
7517
|
-
* action group to return control, results from invocation of the action group. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.
|
|
7518
|
-
* </p>
|
|
7519
|
-
* <note>
|
|
7520
|
-
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
7521
|
-
* </note>
|
|
7441
|
+
* <p>The complete details of the requested invocation step.</p>
|
|
7522
7442
|
* @public
|
|
7523
7443
|
*/
|
|
7524
|
-
|
|
7444
|
+
invocationStep: InvocationStep | undefined;
|
|
7445
|
+
}
|
|
7446
|
+
/**
|
|
7447
|
+
* @public
|
|
7448
|
+
*/
|
|
7449
|
+
export interface ListInvocationStepsRequest {
|
|
7525
7450
|
/**
|
|
7526
|
-
* <p>
|
|
7527
|
-
* The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns">model identifier (ID)</a> of the model to use for orchestration by the inline agent. For example, <code>meta.llama3-1-70b-instruct-v1:0</code>.
|
|
7528
|
-
* </p>
|
|
7451
|
+
* <p>The unique identifier (in UUID format) for the invocation to list invocation steps for.</p>
|
|
7529
7452
|
* @public
|
|
7530
7453
|
*/
|
|
7531
|
-
|
|
7454
|
+
invocationIdentifier?: string | undefined;
|
|
7532
7455
|
/**
|
|
7533
|
-
* <p>
|
|
7534
|
-
*
|
|
7535
|
-
*
|
|
7456
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
|
|
7457
|
+
* token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
|
|
7458
|
+
* </p>
|
|
7536
7459
|
* @public
|
|
7537
7460
|
*/
|
|
7538
|
-
|
|
7461
|
+
nextToken?: string | undefined;
|
|
7539
7462
|
/**
|
|
7540
|
-
* <p>
|
|
7541
|
-
*
|
|
7542
|
-
*
|
|
7543
|
-
* <p>A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.</p>
|
|
7463
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
|
|
7464
|
+
* use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
|
|
7465
|
+
* batch of results.</p>
|
|
7544
7466
|
* @public
|
|
7545
7467
|
*/
|
|
7546
|
-
|
|
7468
|
+
maxResults?: number | undefined;
|
|
7547
7469
|
/**
|
|
7548
|
-
* <p>
|
|
7549
|
-
* A list of action groups with each action group defining the action the inline agent needs to carry out.
|
|
7550
|
-
* </p>
|
|
7470
|
+
* <p>The unique identifier for the session associated with the invocation steps. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7551
7471
|
* @public
|
|
7552
7472
|
*/
|
|
7553
|
-
|
|
7473
|
+
sessionIdentifier: string | undefined;
|
|
7474
|
+
}
|
|
7475
|
+
/**
|
|
7476
|
+
* <p>Contains details about an invocation step within an invocation in a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7477
|
+
* @public
|
|
7478
|
+
*/
|
|
7479
|
+
export interface InvocationStepSummary {
|
|
7554
7480
|
/**
|
|
7555
|
-
* <p>
|
|
7556
|
-
* Contains information of the knowledge bases to associate with.
|
|
7557
|
-
* </p>
|
|
7481
|
+
* <p>The unique identifier for the session associated with the invocation step.</p>
|
|
7558
7482
|
* @public
|
|
7559
7483
|
*/
|
|
7560
|
-
|
|
7484
|
+
sessionId: string | undefined;
|
|
7561
7485
|
/**
|
|
7562
|
-
* <p>
|
|
7563
|
-
* The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html">guardrails</a> to assign to the inline agent.
|
|
7564
|
-
* </p>
|
|
7486
|
+
* <p>A unique identifier for the invocation in UUID format.</p>
|
|
7565
7487
|
* @public
|
|
7566
7488
|
*/
|
|
7567
|
-
|
|
7489
|
+
invocationId: string | undefined;
|
|
7568
7490
|
/**
|
|
7569
|
-
* <p>
|
|
7570
|
-
* Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
|
|
7571
|
-
* </p>
|
|
7491
|
+
* <p>The unique identifier (in UUID format) for the invocation step.</p>
|
|
7572
7492
|
* @public
|
|
7573
7493
|
*/
|
|
7574
|
-
|
|
7494
|
+
invocationStepId: string | undefined;
|
|
7575
7495
|
/**
|
|
7576
|
-
* <p>
|
|
7496
|
+
* <p>The timestamp for when the invocation step was created.</p>
|
|
7577
7497
|
* @public
|
|
7578
7498
|
*/
|
|
7579
|
-
|
|
7499
|
+
invocationStepTime: Date | undefined;
|
|
7500
|
+
}
|
|
7501
|
+
/**
|
|
7502
|
+
* @public
|
|
7503
|
+
*/
|
|
7504
|
+
export interface ListInvocationStepsResponse {
|
|
7580
7505
|
/**
|
|
7581
|
-
* <p>
|
|
7582
|
-
* Specifies the configurations for streaming.
|
|
7583
|
-
* </p>
|
|
7584
|
-
* <note>
|
|
7585
|
-
* <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
|
|
7586
|
-
* </note>
|
|
7506
|
+
* <p>A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.</p>
|
|
7587
7507
|
* @public
|
|
7588
7508
|
*/
|
|
7589
|
-
|
|
7509
|
+
invocationStepSummaries: InvocationStepSummary[] | undefined;
|
|
7510
|
+
/**
|
|
7511
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7512
|
+
* @public
|
|
7513
|
+
*/
|
|
7514
|
+
nextToken?: string | undefined;
|
|
7590
7515
|
}
|
|
7591
7516
|
/**
|
|
7592
7517
|
* @public
|
|
7593
7518
|
*/
|
|
7594
|
-
export interface
|
|
7519
|
+
export interface PutInvocationStepRequest {
|
|
7595
7520
|
/**
|
|
7596
|
-
* <p>The unique identifier
|
|
7521
|
+
* <p>The unique identifier for the session to add the invocation step to. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7597
7522
|
* @public
|
|
7598
7523
|
*/
|
|
7599
|
-
|
|
7524
|
+
sessionIdentifier: string | undefined;
|
|
7525
|
+
/**
|
|
7526
|
+
* <p>The unique identifier (in UUID format) of the invocation to add the invocation step to.</p>
|
|
7527
|
+
* @public
|
|
7528
|
+
*/
|
|
7529
|
+
invocationIdentifier: string | undefined;
|
|
7600
7530
|
/**
|
|
7601
|
-
* <p>
|
|
7531
|
+
* <p>The timestamp for when the invocation step occurred.</p>
|
|
7602
7532
|
* @public
|
|
7603
7533
|
*/
|
|
7604
|
-
|
|
7534
|
+
invocationStepTime: Date | undefined;
|
|
7605
7535
|
/**
|
|
7606
|
-
* <p>
|
|
7536
|
+
* <p>The payload for the invocation step, including text and images for the interaction.</p>
|
|
7607
7537
|
* @public
|
|
7608
7538
|
*/
|
|
7609
|
-
|
|
7539
|
+
payload: InvocationStepPayload | undefined;
|
|
7610
7540
|
/**
|
|
7611
|
-
* <p>
|
|
7541
|
+
* <p>The unique identifier of the invocation step in UUID format.</p>
|
|
7612
7542
|
* @public
|
|
7613
7543
|
*/
|
|
7614
|
-
|
|
7544
|
+
invocationStepId?: string | undefined;
|
|
7615
7545
|
}
|
|
7616
7546
|
/**
|
|
7617
7547
|
* @public
|
|
7618
7548
|
*/
|
|
7619
|
-
export interface
|
|
7549
|
+
export interface PutInvocationStepResponse {
|
|
7620
7550
|
/**
|
|
7621
|
-
* <p>The unique identifier of the
|
|
7622
|
-
* @public
|
|
7623
|
-
*/
|
|
7624
|
-
sessionId?: string | undefined;
|
|
7625
|
-
/**
|
|
7626
|
-
* <p>Contains the query to be made to the knowledge base.</p>
|
|
7551
|
+
* <p>The unique identifier of the invocation step in UUID format.</p>
|
|
7627
7552
|
* @public
|
|
7628
7553
|
*/
|
|
7629
|
-
|
|
7554
|
+
invocationStepId: string | undefined;
|
|
7555
|
+
}
|
|
7556
|
+
/**
|
|
7557
|
+
* @public
|
|
7558
|
+
*/
|
|
7559
|
+
export interface ListSessionsRequest {
|
|
7630
7560
|
/**
|
|
7631
|
-
* <p>
|
|
7561
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
|
|
7562
|
+
* use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
|
|
7563
|
+
* batch of results.</p>
|
|
7632
7564
|
* @public
|
|
7633
7565
|
*/
|
|
7634
|
-
|
|
7566
|
+
maxResults?: number | undefined;
|
|
7635
7567
|
/**
|
|
7636
|
-
* <p>
|
|
7568
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
|
|
7569
|
+
* token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
|
|
7570
|
+
* </p>
|
|
7637
7571
|
* @public
|
|
7638
7572
|
*/
|
|
7639
|
-
|
|
7573
|
+
nextToken?: string | undefined;
|
|
7640
7574
|
}
|
|
7641
7575
|
/**
|
|
7642
|
-
* <p>Contains
|
|
7576
|
+
* <p>Contains details about a session. For more information about sessions, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/sessions.html">Store and retrieve conversation history and context with Amazon Bedrock sessions</a>.</p>
|
|
7643
7577
|
* @public
|
|
7644
7578
|
*/
|
|
7645
|
-
export interface
|
|
7579
|
+
export interface SessionSummary {
|
|
7646
7580
|
/**
|
|
7647
|
-
* <p>
|
|
7581
|
+
* <p>The unique identifier for the session.</p>
|
|
7648
7582
|
* @public
|
|
7649
7583
|
*/
|
|
7650
|
-
|
|
7584
|
+
sessionId: string | undefined;
|
|
7651
7585
|
/**
|
|
7652
|
-
* <p>
|
|
7586
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
7653
7587
|
* @public
|
|
7654
7588
|
*/
|
|
7655
|
-
|
|
7589
|
+
sessionArn: string | undefined;
|
|
7656
7590
|
/**
|
|
7657
|
-
* <p>
|
|
7658
|
-
* <note>
|
|
7659
|
-
* <p>If you include this field, the <code>inputText</code> field will be ignored.</p>
|
|
7660
|
-
* </note>
|
|
7591
|
+
* <p>The current status of the session.</p>
|
|
7661
7592
|
* @public
|
|
7662
7593
|
*/
|
|
7663
|
-
|
|
7594
|
+
sessionStatus: SessionStatus | undefined;
|
|
7664
7595
|
/**
|
|
7665
|
-
* <p>The
|
|
7596
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7666
7597
|
* @public
|
|
7667
7598
|
*/
|
|
7668
|
-
|
|
7599
|
+
createdAt: Date | undefined;
|
|
7669
7600
|
/**
|
|
7670
|
-
* <p>
|
|
7601
|
+
* <p>The timestamp for when the session was last modified.</p>
|
|
7671
7602
|
* @public
|
|
7672
7603
|
*/
|
|
7673
|
-
|
|
7604
|
+
lastUpdatedAt: Date | undefined;
|
|
7605
|
+
}
|
|
7606
|
+
/**
|
|
7607
|
+
* @public
|
|
7608
|
+
*/
|
|
7609
|
+
export interface ListSessionsResponse {
|
|
7674
7610
|
/**
|
|
7675
|
-
* <p>
|
|
7611
|
+
* <p>A list of summaries for each session in your Amazon Web Services account.</p>
|
|
7676
7612
|
* @public
|
|
7677
7613
|
*/
|
|
7678
|
-
|
|
7614
|
+
sessionSummaries: SessionSummary[] | undefined;
|
|
7679
7615
|
/**
|
|
7680
|
-
* <p>
|
|
7616
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
7681
7617
|
* @public
|
|
7682
7618
|
*/
|
|
7683
|
-
|
|
7619
|
+
nextToken?: string | undefined;
|
|
7684
7620
|
}
|
|
7685
7621
|
/**
|
|
7686
7622
|
* @public
|
|
7687
7623
|
*/
|
|
7688
|
-
export interface
|
|
7624
|
+
export interface UpdateSessionRequest {
|
|
7689
7625
|
/**
|
|
7690
|
-
* <p>
|
|
7691
|
-
*
|
|
7692
|
-
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
7693
|
-
* </note>
|
|
7626
|
+
* <p>A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference,
|
|
7627
|
+
* and the type of device they are using.</p>
|
|
7694
7628
|
* @public
|
|
7695
7629
|
*/
|
|
7696
|
-
|
|
7630
|
+
sessionMetadata?: Record<string, string> | undefined;
|
|
7697
7631
|
/**
|
|
7698
|
-
* <p>The unique identifier of the
|
|
7632
|
+
* <p>The unique identifier of the session to modify. You can specify either the session's <code>sessionId</code> or its Amazon Resource Name (ARN).</p>
|
|
7699
7633
|
* @public
|
|
7700
7634
|
*/
|
|
7701
|
-
|
|
7635
|
+
sessionIdentifier: string | undefined;
|
|
7636
|
+
}
|
|
7637
|
+
/**
|
|
7638
|
+
* @public
|
|
7639
|
+
*/
|
|
7640
|
+
export interface UpdateSessionResponse {
|
|
7702
7641
|
/**
|
|
7703
|
-
* <p>The
|
|
7642
|
+
* <p>The unique identifier of the session you updated.</p>
|
|
7704
7643
|
* @public
|
|
7705
7644
|
*/
|
|
7706
|
-
|
|
7645
|
+
sessionId: string | undefined;
|
|
7707
7646
|
/**
|
|
7708
|
-
* <p>The
|
|
7647
|
+
* <p>The Amazon Resource Name (ARN) of the session that was updated.</p>
|
|
7709
7648
|
* @public
|
|
7710
7649
|
*/
|
|
7711
|
-
|
|
7650
|
+
sessionArn: string | undefined;
|
|
7712
7651
|
/**
|
|
7713
|
-
* <p>
|
|
7652
|
+
* <p>The status of the session you updated.</p>
|
|
7714
7653
|
* @public
|
|
7715
7654
|
*/
|
|
7716
|
-
|
|
7655
|
+
sessionStatus: SessionStatus | undefined;
|
|
7717
7656
|
/**
|
|
7718
|
-
* <p>
|
|
7657
|
+
* <p>The timestamp for when the session was created.</p>
|
|
7719
7658
|
* @public
|
|
7720
7659
|
*/
|
|
7721
|
-
|
|
7660
|
+
createdAt: Date | undefined;
|
|
7722
7661
|
/**
|
|
7723
|
-
* <p>The
|
|
7724
|
-
* <note>
|
|
7725
|
-
* <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
|
|
7726
|
-
* </note>
|
|
7662
|
+
* <p>The timestamp for when the session was last modified.</p>
|
|
7727
7663
|
* @public
|
|
7728
7664
|
*/
|
|
7729
|
-
|
|
7665
|
+
lastUpdatedAt: Date | undefined;
|
|
7666
|
+
}
|
|
7667
|
+
/**
|
|
7668
|
+
* @public
|
|
7669
|
+
*/
|
|
7670
|
+
export interface ListTagsForResourceRequest {
|
|
7730
7671
|
/**
|
|
7731
|
-
* <p>The
|
|
7672
|
+
* <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
|
|
7732
7673
|
* @public
|
|
7733
7674
|
*/
|
|
7734
|
-
|
|
7675
|
+
resourceArn: string | undefined;
|
|
7676
|
+
}
|
|
7677
|
+
/**
|
|
7678
|
+
* @public
|
|
7679
|
+
*/
|
|
7680
|
+
export interface ListTagsForResourceResponse {
|
|
7735
7681
|
/**
|
|
7736
|
-
* <p>
|
|
7682
|
+
* <p>The key-value pairs for the tags associated with the resource.</p>
|
|
7737
7683
|
* @public
|
|
7738
7684
|
*/
|
|
7739
|
-
|
|
7685
|
+
tags?: Record<string, string> | undefined;
|
|
7686
|
+
}
|
|
7687
|
+
/**
|
|
7688
|
+
* @public
|
|
7689
|
+
*/
|
|
7690
|
+
export interface TagResourceRequest {
|
|
7740
7691
|
/**
|
|
7741
|
-
* <p>
|
|
7742
|
-
*
|
|
7743
|
-
|
|
7744
|
-
|
|
7745
|
-
|
|
7746
|
-
*
|
|
7692
|
+
* <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
|
|
7693
|
+
* @public
|
|
7694
|
+
*/
|
|
7695
|
+
resourceArn: string | undefined;
|
|
7696
|
+
/**
|
|
7697
|
+
* <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
|
|
7698
|
+
* @public
|
|
7699
|
+
*/
|
|
7700
|
+
tags: Record<string, string> | undefined;
|
|
7701
|
+
}
|
|
7702
|
+
/**
|
|
7703
|
+
* @public
|
|
7704
|
+
*/
|
|
7705
|
+
export interface TagResourceResponse {
|
|
7706
|
+
}
|
|
7707
|
+
/**
|
|
7708
|
+
* @public
|
|
7709
|
+
*/
|
|
7710
|
+
export interface UntagResourceRequest {
|
|
7711
|
+
/**
|
|
7712
|
+
* <p>The Amazon Resource Name (ARN) of the resource from which to remove tags.</p>
|
|
7747
7713
|
* @public
|
|
7748
7714
|
*/
|
|
7749
|
-
|
|
7715
|
+
resourceArn: string | undefined;
|
|
7750
7716
|
/**
|
|
7751
|
-
* <p>
|
|
7717
|
+
* <p>A list of keys of the tags to remove from the resource.</p>
|
|
7752
7718
|
* @public
|
|
7753
7719
|
*/
|
|
7754
|
-
|
|
7720
|
+
tagKeys: string[] | undefined;
|
|
7721
|
+
}
|
|
7722
|
+
/**
|
|
7723
|
+
* @public
|
|
7724
|
+
*/
|
|
7725
|
+
export interface UntagResourceResponse {
|
|
7755
7726
|
}
|
|
7756
7727
|
/**
|
|
7757
7728
|
* @internal
|
|
@@ -8081,6 +8052,14 @@ export declare const MetadataFilterSensitiveLog: (obj: Metadata) => any;
|
|
|
8081
8052
|
* @internal
|
|
8082
8053
|
*/
|
|
8083
8054
|
export declare const RawResponseFilterSensitiveLog: (obj: RawResponse) => any;
|
|
8055
|
+
/**
|
|
8056
|
+
* @internal
|
|
8057
|
+
*/
|
|
8058
|
+
export declare const ReasoningTextBlockFilterSensitiveLog: (obj: ReasoningTextBlock) => any;
|
|
8059
|
+
/**
|
|
8060
|
+
* @internal
|
|
8061
|
+
*/
|
|
8062
|
+
export declare const ReasoningContentBlockFilterSensitiveLog: (obj: ReasoningContentBlock) => any;
|
|
8084
8063
|
/**
|
|
8085
8064
|
* @internal
|
|
8086
8065
|
*/
|
|
@@ -8324,52 +8303,20 @@ export declare const RetrieveResponseFilterSensitiveLog: (obj: RetrieveResponse)
|
|
|
8324
8303
|
/**
|
|
8325
8304
|
* @internal
|
|
8326
8305
|
*/
|
|
8327
|
-
export declare const
|
|
8328
|
-
/**
|
|
8329
|
-
* @internal
|
|
8330
|
-
*/
|
|
8331
|
-
export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (obj: KnowledgeBaseVectorSearchConfiguration) => any;
|
|
8332
|
-
/**
|
|
8333
|
-
* @internal
|
|
8334
|
-
*/
|
|
8335
|
-
export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
|
|
8336
|
-
/**
|
|
8337
|
-
* @internal
|
|
8338
|
-
*/
|
|
8339
|
-
export declare const KnowledgeBaseFilterSensitiveLog: (obj: KnowledgeBase) => any;
|
|
8340
|
-
/**
|
|
8341
|
-
* @internal
|
|
8342
|
-
*/
|
|
8343
|
-
export declare const KnowledgeBaseConfigurationFilterSensitiveLog: (obj: KnowledgeBaseConfiguration) => any;
|
|
8344
|
-
/**
|
|
8345
|
-
* @internal
|
|
8346
|
-
*/
|
|
8347
|
-
export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
|
|
8348
|
-
/**
|
|
8349
|
-
* @internal
|
|
8350
|
-
*/
|
|
8351
|
-
export declare const RetrieveRequestFilterSensitiveLog: (obj: RetrieveRequest) => any;
|
|
8352
|
-
/**
|
|
8353
|
-
* @internal
|
|
8354
|
-
*/
|
|
8355
|
-
export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
|
|
8356
|
-
/**
|
|
8357
|
-
* @internal
|
|
8358
|
-
*/
|
|
8359
|
-
export declare const InvokeInlineAgentRequestFilterSensitiveLog: (obj: InvokeInlineAgentRequest) => any;
|
|
8306
|
+
export declare const BedrockSessionContentBlockFilterSensitiveLog: (obj: BedrockSessionContentBlock) => any;
|
|
8360
8307
|
/**
|
|
8361
8308
|
* @internal
|
|
8362
8309
|
*/
|
|
8363
|
-
export declare const
|
|
8310
|
+
export declare const InvocationStepPayloadFilterSensitiveLog: (obj: InvocationStepPayload) => any;
|
|
8364
8311
|
/**
|
|
8365
8312
|
* @internal
|
|
8366
8313
|
*/
|
|
8367
|
-
export declare const
|
|
8314
|
+
export declare const InvocationStepFilterSensitiveLog: (obj: InvocationStep) => any;
|
|
8368
8315
|
/**
|
|
8369
8316
|
* @internal
|
|
8370
8317
|
*/
|
|
8371
|
-
export declare const
|
|
8318
|
+
export declare const GetInvocationStepResponseFilterSensitiveLog: (obj: GetInvocationStepResponse) => any;
|
|
8372
8319
|
/**
|
|
8373
8320
|
* @internal
|
|
8374
8321
|
*/
|
|
8375
|
-
export declare const
|
|
8322
|
+
export declare const PutInvocationStepRequestFilterSensitiveLog: (obj: PutInvocationStepRequest) => any;
|