@aws-sdk/client-bedrock-agent-runtime 3.755.0 → 3.764.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.
Files changed (92) hide show
  1. package/README.md +119 -7
  2. package/dist-cjs/index.js +1035 -78
  3. package/dist-es/BedrockAgentRuntime.js +28 -0
  4. package/dist-es/commands/CreateInvocationCommand.js +22 -0
  5. package/dist-es/commands/CreateSessionCommand.js +22 -0
  6. package/dist-es/commands/DeleteSessionCommand.js +22 -0
  7. package/dist-es/commands/EndSessionCommand.js +22 -0
  8. package/dist-es/commands/GetInvocationStepCommand.js +23 -0
  9. package/dist-es/commands/GetSessionCommand.js +22 -0
  10. package/dist-es/commands/InvokeAgentCommand.js +2 -1
  11. package/dist-es/commands/InvokeInlineAgentCommand.js +2 -1
  12. package/dist-es/commands/ListInvocationStepsCommand.js +22 -0
  13. package/dist-es/commands/ListInvocationsCommand.js +22 -0
  14. package/dist-es/commands/ListSessionsCommand.js +22 -0
  15. package/dist-es/commands/ListTagsForResourceCommand.js +22 -0
  16. package/dist-es/commands/PutInvocationStepCommand.js +23 -0
  17. package/dist-es/commands/RetrieveAndGenerateCommand.js +2 -1
  18. package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +2 -1
  19. package/dist-es/commands/RetrieveCommand.js +2 -1
  20. package/dist-es/commands/TagResourceCommand.js +22 -0
  21. package/dist-es/commands/UntagResourceCommand.js +22 -0
  22. package/dist-es/commands/UpdateSessionCommand.js +22 -0
  23. package/dist-es/commands/index.js +14 -0
  24. package/dist-es/models/index.js +1 -0
  25. package/dist-es/models/models_0.js +76 -156
  26. package/dist-es/models/models_1.js +181 -0
  27. package/dist-es/pagination/ListInvocationStepsPaginator.js +4 -0
  28. package/dist-es/pagination/ListInvocationsPaginator.js +4 -0
  29. package/dist-es/pagination/ListSessionsPaginator.js +4 -0
  30. package/dist-es/pagination/index.js +3 -0
  31. package/dist-es/protocols/Aws_restJson1.js +560 -8
  32. package/dist-types/BedrockAgentRuntime.d.ts +100 -0
  33. package/dist-types/BedrockAgentRuntimeClient.d.ts +16 -2
  34. package/dist-types/commands/CreateInvocationCommand.d.ts +115 -0
  35. package/dist-types/commands/CreateSessionCommand.d.ts +133 -0
  36. package/dist-types/commands/DeleteSessionCommand.d.ts +89 -0
  37. package/dist-types/commands/EndSessionCommand.d.ts +93 -0
  38. package/dist-types/commands/GetInvocationStepCommand.d.ts +109 -0
  39. package/dist-types/commands/GetSessionCommand.d.ts +94 -0
  40. package/dist-types/commands/InvokeAgentCommand.d.ts +3 -1
  41. package/dist-types/commands/InvokeInlineAgentCommand.d.ts +216 -64
  42. package/dist-types/commands/ListInvocationStepsCommand.d.ts +97 -0
  43. package/dist-types/commands/ListInvocationsCommand.d.ts +95 -0
  44. package/dist-types/commands/ListSessionsCommand.d.ts +93 -0
  45. package/dist-types/commands/ListTagsForResourceCommand.d.ts +88 -0
  46. package/dist-types/commands/PutInvocationStepCommand.d.ts +134 -0
  47. package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +2 -1
  48. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -1
  49. package/dist-types/commands/RetrieveCommand.d.ts +2 -1
  50. package/dist-types/commands/TagResourceCommand.d.ts +91 -0
  51. package/dist-types/commands/UntagResourceCommand.d.ts +87 -0
  52. package/dist-types/commands/UpdateSessionCommand.d.ts +96 -0
  53. package/dist-types/commands/index.d.ts +14 -0
  54. package/dist-types/models/index.d.ts +1 -0
  55. package/dist-types/models/models_0.d.ts +605 -684
  56. package/dist-types/models/models_1.d.ts +1055 -0
  57. package/dist-types/pagination/ListInvocationStepsPaginator.d.ts +7 -0
  58. package/dist-types/pagination/ListInvocationsPaginator.d.ts +7 -0
  59. package/dist-types/pagination/ListSessionsPaginator.d.ts +7 -0
  60. package/dist-types/pagination/index.d.ts +3 -0
  61. package/dist-types/protocols/Aws_restJson1.d.ts +126 -0
  62. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +240 -0
  63. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +86 -2
  64. package/dist-types/ts3.4/commands/CreateInvocationCommand.d.ts +50 -0
  65. package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +50 -0
  66. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +50 -0
  67. package/dist-types/ts3.4/commands/EndSessionCommand.d.ts +47 -0
  68. package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +51 -0
  69. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +47 -0
  70. package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +2 -1
  71. package/dist-types/ts3.4/commands/InvokeInlineAgentCommand.d.ts +2 -4
  72. package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +51 -0
  73. package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +50 -0
  74. package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +47 -0
  75. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +51 -0
  76. package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +51 -0
  77. package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +2 -4
  78. package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -4
  79. package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +2 -1
  80. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +48 -0
  81. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +50 -0
  82. package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +50 -0
  83. package/dist-types/ts3.4/commands/index.d.ts +14 -0
  84. package/dist-types/ts3.4/models/index.d.ts +1 -0
  85. package/dist-types/ts3.4/models/models_0.d.ts +250 -374
  86. package/dist-types/ts3.4/models/models_1.d.ts +441 -0
  87. package/dist-types/ts3.4/pagination/ListInvocationStepsPaginator.d.ts +11 -0
  88. package/dist-types/ts3.4/pagination/ListInvocationsPaginator.d.ts +11 -0
  89. package/dist-types/ts3.4/pagination/ListSessionsPaginator.d.ts +11 -0
  90. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  91. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +168 -0
  92. package/package.json +12 -12
@@ -453,6 +453,19 @@ export interface AgentActionGroup {
453
453
  */
454
454
  functionSchema?: FunctionSchema | undefined;
455
455
  }
456
+ /**
457
+ * @public
458
+ * @enum
459
+ */
460
+ export declare const AgentCollaboration: {
461
+ readonly DISABLED: "DISABLED";
462
+ readonly SUPERVISOR: "SUPERVISOR";
463
+ readonly SUPERVISOR_ROUTER: "SUPERVISOR_ROUTER";
464
+ };
465
+ /**
466
+ * @public
467
+ */
468
+ export type AgentCollaboration = (typeof AgentCollaboration)[keyof typeof AgentCollaboration];
456
469
  /**
457
470
  * @public
458
471
  * @enum
@@ -4534,6 +4547,13 @@ export interface TracePart {
4534
4547
  * @public
4535
4548
  */
4536
4549
  callerChain?: Caller[] | undefined;
4550
+ /**
4551
+ * <p>
4552
+ * The time of the trace.
4553
+ * </p>
4554
+ * @public
4555
+ */
4556
+ eventTime?: Date | undefined;
4537
4557
  /**
4538
4558
  * <p>The part's collaborator name.</p>
4539
4559
  * @public
@@ -4923,77 +4943,75 @@ export interface InlineBedrockModelConfigurations {
4923
4943
  */
4924
4944
  performanceConfig?: PerformanceConfiguration | undefined;
4925
4945
  }
4946
+ /**
4947
+ * @public
4948
+ * @enum
4949
+ */
4950
+ export declare const RelayConversationHistory: {
4951
+ readonly DISABLED: "DISABLED";
4952
+ readonly TO_COLLABORATOR: "TO_COLLABORATOR";
4953
+ };
4954
+ /**
4955
+ * @public
4956
+ */
4957
+ export type RelayConversationHistory = (typeof RelayConversationHistory)[keyof typeof RelayConversationHistory];
4926
4958
  /**
4927
4959
  * <p>
4928
- * The configuration details for the guardrail.
4960
+ * Settings of an inline collaborator agent.
4929
4961
  * </p>
4930
4962
  * @public
4931
4963
  */
4932
- export interface GuardrailConfigurationWithArn {
4933
- /**
4934
- * <p>
4935
- * The unique identifier for the guardrail.
4936
- * </p>
4937
- * @public
4938
- */
4939
- guardrailIdentifier: string | undefined;
4964
+ export interface CollaboratorConfiguration {
4940
4965
  /**
4941
4966
  * <p>
4942
- * The version of the guardrail.
4967
+ * Name of the inline collaborator agent which must be the same name as specified for <code>agentName</code>.
4943
4968
  * </p>
4944
4969
  * @public
4945
4970
  */
4946
- guardrailVersion: string | undefined;
4947
- }
4948
- /**
4949
- * <p>
4950
- * Contains parameters that specify various attributes that persist across a session or prompt. You can define session state
4951
- * attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <code>InvokeInlineAgent</code> request.
4952
- * Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior.
4953
- * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>
4954
- * </p>
4955
- * @public
4956
- */
4957
- export interface InlineSessionState {
4971
+ collaboratorName: string | undefined;
4958
4972
  /**
4959
4973
  * <p>
4960
- * Contains attributes that persist across a session and the values of those attributes.
4974
+ * Instructions that tell the inline collaborator agent what it should do and how it should interact with users.
4961
4975
  * </p>
4962
4976
  * @public
4963
4977
  */
4964
- sessionAttributes?: Record<string, string> | undefined;
4978
+ collaboratorInstruction: string | undefined;
4965
4979
  /**
4966
4980
  * <p>
4967
- * Contains attributes that persist across a session and the values of those attributes.
4981
+ * The Amazon Resource Name (ARN) of the inline collaborator agent.
4968
4982
  * </p>
4969
4983
  * @public
4970
4984
  */
4971
- promptSessionAttributes?: Record<string, string> | undefined;
4985
+ agentAliasArn?: string | undefined;
4972
4986
  /**
4973
4987
  * <p>
4974
- * Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a>.
4988
+ * A relay conversation history for the inline collaborator agent.
4975
4989
  * </p>
4976
- * <note>
4977
- * <p>If you include this field in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
4978
- * </note>
4979
4990
  * @public
4980
4991
  */
4981
- returnControlInvocationResults?: InvocationResultMember[] | undefined;
4992
+ relayConversationHistory?: RelayConversationHistory | undefined;
4993
+ }
4994
+ /**
4995
+ * <p>
4996
+ * The configuration details for the guardrail.
4997
+ * </p>
4998
+ * @public
4999
+ */
5000
+ export interface GuardrailConfigurationWithArn {
4982
5001
  /**
4983
5002
  * <p>
4984
- * The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeInlineAgent</code> response for the action
4985
- * whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a>.
5003
+ * The unique identifier for the guardrail.
4986
5004
  * </p>
4987
5005
  * @public
4988
5006
  */
4989
- invocationId?: string | undefined;
5007
+ guardrailIdentifier: string | undefined;
4990
5008
  /**
4991
5009
  * <p>
4992
- * Contains information about the files used by code interpreter.
5010
+ * The version of the guardrail.
4993
5011
  * </p>
4994
5012
  * @public
4995
5013
  */
4996
- files?: InputFile[] | undefined;
5014
+ guardrailVersion: string | undefined;
4997
5015
  }
4998
5016
  /**
4999
5017
  * @public
@@ -5068,6 +5086,13 @@ export interface PromptConfiguration {
5068
5086
  * @public
5069
5087
  */
5070
5088
  parserMode?: CreationMode | undefined;
5089
+ /**
5090
+ * <p>
5091
+ * The foundation model to use.
5092
+ * </p>
5093
+ * @public
5094
+ */
5095
+ foundationModel?: string | undefined;
5071
5096
  /**
5072
5097
  * <p>If the Converse or ConverseStream operations support the model,
5073
5098
  * <code>additionalModelRequestFields</code> contains additional inference parameters,
@@ -5099,6 +5124,63 @@ export interface PromptOverrideConfiguration {
5099
5124
  */
5100
5125
  overrideLambda?: string | undefined;
5101
5126
  }
5127
+ /**
5128
+ * <p>
5129
+ * Contains parameters that specify various attributes that persist across a session or prompt. You can define session state
5130
+ * attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <code>InvokeInlineAgent</code> request.
5131
+ * Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent's behavior.
5132
+ * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>
5133
+ * </p>
5134
+ * @public
5135
+ */
5136
+ export interface InlineSessionState {
5137
+ /**
5138
+ * <p>
5139
+ * Contains attributes that persist across a session and the values of those attributes.
5140
+ * </p>
5141
+ * @public
5142
+ */
5143
+ sessionAttributes?: Record<string, string> | undefined;
5144
+ /**
5145
+ * <p>
5146
+ * Contains attributes that persist across a session and the values of those attributes.
5147
+ * </p>
5148
+ * @public
5149
+ */
5150
+ promptSessionAttributes?: Record<string, string> | undefined;
5151
+ /**
5152
+ * <p>
5153
+ * Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a>.
5154
+ * </p>
5155
+ * <note>
5156
+ * <p>If you include this field in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
5157
+ * </note>
5158
+ * @public
5159
+ */
5160
+ returnControlInvocationResults?: InvocationResultMember[] | undefined;
5161
+ /**
5162
+ * <p>
5163
+ * The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeInlineAgent</code> response for the action
5164
+ * whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a>.
5165
+ * </p>
5166
+ * @public
5167
+ */
5168
+ invocationId?: string | undefined;
5169
+ /**
5170
+ * <p>
5171
+ * Contains information about the files used by code interpreter.
5172
+ * </p>
5173
+ * @public
5174
+ */
5175
+ files?: InputFile[] | undefined;
5176
+ /**
5177
+ * <p>
5178
+ * Contains the conversation history that persist across sessions.
5179
+ * </p>
5180
+ * @public
5181
+ */
5182
+ conversationHistory?: ConversationHistory | undefined;
5183
+ }
5102
5184
  /**
5103
5185
  * <p>Contains a part of an agent response and citations for it. </p>
5104
5186
  * @public
@@ -6966,871 +7048,738 @@ export interface RetrieveResponse {
6966
7048
  */
6967
7049
  nextToken?: string | undefined;
6968
7050
  }
6969
- /**
6970
- * <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>
6971
- * <p>This data type is used in the following API operations:</p>
6972
- * <ul>
6973
- * <li>
6974
- * <p>
6975
- * <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>
6976
- * </li>
6977
- * <li>
6978
- * <p>
6979
- * <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>
6980
- * </li>
6981
- * </ul>
6982
- * @public
6983
- */
6984
- export type RetrievalFilter = RetrievalFilter.AndAllMember | RetrievalFilter.EqualsMember | RetrievalFilter.GreaterThanMember | RetrievalFilter.GreaterThanOrEqualsMember | RetrievalFilter.InMember | RetrievalFilter.LessThanMember | RetrievalFilter.LessThanOrEqualsMember | RetrievalFilter.ListContainsMember | RetrievalFilter.NotEqualsMember | RetrievalFilter.NotInMember | RetrievalFilter.OrAllMember | RetrievalFilter.StartsWithMember | RetrievalFilter.StringContainsMember | RetrievalFilter.$UnknownMember;
6985
7051
  /**
6986
7052
  * @public
6987
7053
  */
6988
- export declare namespace RetrievalFilter {
6989
- /**
6990
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value matches the <code>value</code> in this object.</p>
6991
- * <p>The following example would return data sources with an <code>animal</code> attribute whose value is <code>cat</code>:</p>
6992
- * <p>
6993
- * <code>"equals": \{ "key": "animal", "value": "cat" \}</code>
6994
- * </p>
6995
- * @public
6996
- */
6997
- interface EqualsMember {
6998
- equals: FilterAttribute;
6999
- notEquals?: never;
7000
- greaterThan?: never;
7001
- greaterThanOrEquals?: never;
7002
- lessThan?: never;
7003
- lessThanOrEquals?: never;
7004
- in?: never;
7005
- notIn?: never;
7006
- startsWith?: never;
7007
- listContains?: never;
7008
- stringContains?: never;
7009
- andAll?: never;
7010
- orAll?: never;
7011
- $unknown?: never;
7012
- }
7013
- /**
7014
- * <p>Knowledge base data sources that contain a metadata attribute whose name matches the <code>key</code> and whose value doesn't match the <code>value</code> in this object are returned.</p>
7015
- * <p>The following example would return data sources that don't contain an <code>animal</code> attribute whose value is <code>cat</code>.</p>
7016
- * <p>
7017
- * <code>"notEquals": \{ "key": "animal", "value": "cat" \}</code>
7018
- * </p>
7019
- * @public
7020
- */
7021
- interface NotEqualsMember {
7022
- equals?: never;
7023
- notEquals: FilterAttribute;
7024
- greaterThan?: never;
7025
- greaterThanOrEquals?: never;
7026
- lessThan?: never;
7027
- lessThanOrEquals?: never;
7028
- in?: never;
7029
- notIn?: never;
7030
- startsWith?: never;
7031
- listContains?: never;
7032
- stringContains?: never;
7033
- andAll?: never;
7034
- orAll?: never;
7035
- $unknown?: never;
7036
- }
7037
- /**
7038
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than the <code>value</code> in this object.</p>
7039
- * <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than <code>1989</code>:</p>
7040
- * <p>
7041
- * <code>"greaterThan": \{ "key": "year", "value": 1989 \}</code>
7042
- * </p>
7043
- * @public
7044
- */
7045
- interface GreaterThanMember {
7046
- equals?: never;
7047
- notEquals?: never;
7048
- greaterThan: FilterAttribute;
7049
- greaterThanOrEquals?: never;
7050
- lessThan?: never;
7051
- lessThanOrEquals?: never;
7052
- in?: never;
7053
- notIn?: never;
7054
- startsWith?: never;
7055
- listContains?: never;
7056
- stringContains?: never;
7057
- andAll?: never;
7058
- orAll?: never;
7059
- $unknown?: never;
7060
- }
7061
- /**
7062
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is greater than or equal to the <code>value</code> in this object.</p>
7063
- * <p>The following example would return data sources with an <code>year</code> attribute whose value is greater than or equal to <code>1989</code>:</p>
7064
- * <p>
7065
- * <code>"greaterThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
7066
- * </p>
7067
- * @public
7068
- */
7069
- interface GreaterThanOrEqualsMember {
7070
- equals?: never;
7071
- notEquals?: never;
7072
- greaterThan?: never;
7073
- greaterThanOrEquals: FilterAttribute;
7074
- lessThan?: never;
7075
- lessThanOrEquals?: never;
7076
- in?: never;
7077
- notIn?: never;
7078
- startsWith?: never;
7079
- listContains?: never;
7080
- stringContains?: never;
7081
- andAll?: never;
7082
- orAll?: never;
7083
- $unknown?: never;
7084
- }
7085
- /**
7086
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than the <code>value</code> in this object.</p>
7087
- * <p>The following example would return data sources with an <code>year</code> attribute whose value is less than to <code>1989</code>.</p>
7088
- * <p>
7089
- * <code>"lessThan": \{ "key": "year", "value": 1989 \}</code>
7090
- * </p>
7091
- * @public
7092
- */
7093
- interface LessThanMember {
7094
- equals?: never;
7095
- notEquals?: never;
7096
- greaterThan?: never;
7097
- greaterThanOrEquals?: never;
7098
- lessThan: FilterAttribute;
7099
- lessThanOrEquals?: never;
7100
- in?: never;
7101
- notIn?: never;
7102
- startsWith?: never;
7103
- listContains?: never;
7104
- stringContains?: never;
7105
- andAll?: never;
7106
- orAll?: never;
7107
- $unknown?: never;
7108
- }
7109
- /**
7110
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is less than or equal to the <code>value</code> in this object.</p>
7111
- * <p>The following example would return data sources with an <code>year</code> attribute whose value is less than or equal to <code>1989</code>.</p>
7112
- * <p>
7113
- * <code>"lessThanOrEquals": \{ "key": "year", "value": 1989 \}</code>
7114
- * </p>
7115
- * @public
7116
- */
7117
- interface LessThanOrEqualsMember {
7118
- equals?: never;
7119
- notEquals?: never;
7120
- greaterThan?: never;
7121
- greaterThanOrEquals?: never;
7122
- lessThan?: never;
7123
- lessThanOrEquals: FilterAttribute;
7124
- in?: never;
7125
- notIn?: never;
7126
- startsWith?: never;
7127
- listContains?: never;
7128
- stringContains?: never;
7129
- andAll?: never;
7130
- orAll?: never;
7131
- $unknown?: never;
7132
- }
7133
- /**
7134
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is in the list specified in the <code>value</code> in this object.</p>
7135
- * <p>The following example would return data sources with an <code>animal</code> attribute that is either <code>cat</code> or <code>dog</code>:</p>
7136
- * <p>
7137
- * <code>"in": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
7138
- * </p>
7139
- * @public
7140
- */
7141
- interface InMember {
7142
- equals?: never;
7143
- notEquals?: never;
7144
- greaterThan?: never;
7145
- greaterThanOrEquals?: never;
7146
- lessThan?: never;
7147
- lessThanOrEquals?: never;
7148
- in: FilterAttribute;
7149
- notIn?: never;
7150
- startsWith?: never;
7151
- listContains?: never;
7152
- stringContains?: never;
7153
- andAll?: never;
7154
- orAll?: never;
7155
- $unknown?: never;
7156
- }
7157
- /**
7158
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value isn't in the list specified in the <code>value</code> in this object.</p>
7159
- * <p>The following example would return data sources whose <code>animal</code> attribute is neither <code>cat</code> nor <code>dog</code>.</p>
7160
- * <p>
7161
- * <code>"notIn": \{ "key": "animal", "value": ["cat", "dog"] \}</code>
7162
- * </p>
7163
- * @public
7164
- */
7165
- interface NotInMember {
7166
- equals?: never;
7167
- notEquals?: never;
7168
- greaterThan?: never;
7169
- greaterThanOrEquals?: never;
7170
- lessThan?: never;
7171
- lessThanOrEquals?: never;
7172
- in?: never;
7173
- notIn: FilterAttribute;
7174
- startsWith?: never;
7175
- listContains?: never;
7176
- stringContains?: never;
7177
- andAll?: never;
7178
- orAll?: never;
7179
- $unknown?: never;
7180
- }
7181
- /**
7182
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value starts with the <code>value</code> in this object. This filter is currently only supported for Amazon OpenSearch Serverless vector stores.</p>
7183
- * <p>The following example would return data sources with an <code>animal</code> attribute starts with <code>ca</code> (for example, <code>cat</code> or <code>camel</code>).</p>
7184
- * <p>
7185
- * <code>"startsWith": \{ "key": "animal", "value": "ca" \}</code>
7186
- * </p>
7187
- * @public
7188
- */
7189
- interface StartsWithMember {
7190
- equals?: never;
7191
- notEquals?: never;
7192
- greaterThan?: never;
7193
- greaterThanOrEquals?: never;
7194
- lessThan?: never;
7195
- lessThanOrEquals?: never;
7196
- in?: never;
7197
- notIn?: never;
7198
- startsWith: FilterAttribute;
7199
- listContains?: never;
7200
- stringContains?: never;
7201
- andAll?: never;
7202
- orAll?: never;
7203
- $unknown?: never;
7204
- }
7205
- /**
7206
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is a list that contains the <code>value</code> as one of its members.</p>
7207
- * <p>The following example would return data sources with an <code>animals</code> attribute that is a list containing a <code>cat</code> member (for example <code>["dog", "cat"]</code>).</p>
7208
- * <p>
7209
- * <code>"listContains": \{ "key": "animals", "value": "cat" \}</code>
7210
- * </p>
7211
- * @public
7212
- */
7213
- interface ListContainsMember {
7214
- equals?: never;
7215
- notEquals?: never;
7216
- greaterThan?: never;
7217
- greaterThanOrEquals?: never;
7218
- lessThan?: never;
7219
- lessThanOrEquals?: never;
7220
- in?: never;
7221
- notIn?: never;
7222
- startsWith?: never;
7223
- listContains: FilterAttribute;
7224
- stringContains?: never;
7225
- andAll?: never;
7226
- orAll?: never;
7227
- $unknown?: never;
7228
- }
7229
- /**
7230
- * <p>Knowledge base data sources are returned if they contain a metadata attribute whose name matches the <code>key</code> and whose value is one of the following:</p>
7231
- * <ul>
7232
- * <li>
7233
- * <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>
7234
- * <p>
7235
- * <code>"stringContains": \{ "key": "animal", "value": "at" \}</code>
7236
- * </p>
7237
- * </li>
7238
- * <li>
7239
- * <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>
7240
- * <p>
7241
- * <code>"stringContains": \{ "key": "animals", "value": "at" \}</code>
7242
- * </p>
7243
- * </li>
7244
- * </ul>
7245
- * @public
7246
- */
7247
- interface StringContainsMember {
7248
- equals?: never;
7249
- notEquals?: never;
7250
- greaterThan?: never;
7251
- greaterThanOrEquals?: never;
7252
- lessThan?: never;
7253
- lessThanOrEquals?: never;
7254
- in?: never;
7255
- notIn?: never;
7256
- startsWith?: never;
7257
- listContains?: never;
7258
- stringContains: FilterAttribute;
7259
- andAll?: never;
7260
- orAll?: never;
7261
- $unknown?: never;
7262
- }
7054
+ export interface CreateSessionRequest {
7263
7055
  /**
7264
- * <p>Knowledge base data sources are returned if their metadata attributes fulfill all the filter conditions inside this list.</p>
7056
+ * <p>A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference,
7057
+ * and the type of device they are using.</p>
7265
7058
  * @public
7266
7059
  */
7267
- interface AndAllMember {
7268
- equals?: never;
7269
- notEquals?: never;
7270
- greaterThan?: never;
7271
- greaterThanOrEquals?: never;
7272
- lessThan?: never;
7273
- lessThanOrEquals?: never;
7274
- in?: never;
7275
- notIn?: never;
7276
- startsWith?: never;
7277
- listContains?: never;
7278
- stringContains?: never;
7279
- andAll: RetrievalFilter[];
7280
- orAll?: never;
7281
- $unknown?: never;
7282
- }
7060
+ sessionMetadata?: Record<string, string> | undefined;
7283
7061
  /**
7284
- * <p>Knowledge base data sources are returned if their metadata attributes fulfill at least one of the filter conditions inside this list.</p>
7062
+ * <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.
7063
+ * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.
7064
+ * </p>
7285
7065
  * @public
7286
7066
  */
7287
- interface OrAllMember {
7288
- equals?: never;
7289
- notEquals?: never;
7290
- greaterThan?: never;
7291
- greaterThanOrEquals?: never;
7292
- lessThan?: never;
7293
- lessThanOrEquals?: never;
7294
- in?: never;
7295
- notIn?: never;
7296
- startsWith?: never;
7297
- listContains?: never;
7298
- stringContains?: never;
7299
- andAll?: never;
7300
- orAll: RetrievalFilter[];
7301
- $unknown?: never;
7302
- }
7067
+ encryptionKeyArn?: string | undefined;
7303
7068
  /**
7069
+ * <p>Specify the key-value pairs for the tags that you want to attach to the session.</p>
7304
7070
  * @public
7305
7071
  */
7306
- interface $UnknownMember {
7307
- equals?: never;
7308
- notEquals?: never;
7309
- greaterThan?: never;
7310
- greaterThanOrEquals?: never;
7311
- lessThan?: never;
7312
- lessThanOrEquals?: never;
7313
- in?: never;
7314
- notIn?: never;
7315
- startsWith?: never;
7316
- listContains?: never;
7317
- stringContains?: never;
7318
- andAll?: never;
7319
- orAll?: never;
7320
- $unknown: [string, any];
7321
- }
7322
- interface Visitor<T> {
7323
- equals: (value: FilterAttribute) => T;
7324
- notEquals: (value: FilterAttribute) => T;
7325
- greaterThan: (value: FilterAttribute) => T;
7326
- greaterThanOrEquals: (value: FilterAttribute) => T;
7327
- lessThan: (value: FilterAttribute) => T;
7328
- lessThanOrEquals: (value: FilterAttribute) => T;
7329
- in: (value: FilterAttribute) => T;
7330
- notIn: (value: FilterAttribute) => T;
7331
- startsWith: (value: FilterAttribute) => T;
7332
- listContains: (value: FilterAttribute) => T;
7333
- stringContains: (value: FilterAttribute) => T;
7334
- andAll: (value: RetrievalFilter[]) => T;
7335
- orAll: (value: RetrievalFilter[]) => T;
7336
- _: (name: string, value: any) => T;
7337
- }
7338
- const visit: <T>(value: RetrievalFilter, visitor: Visitor<T>) => T;
7072
+ tags?: Record<string, string> | undefined;
7339
7073
  }
7340
7074
  /**
7341
- * <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>
7342
- * <p>This data type is used in the following API operations:</p>
7343
- * <ul>
7344
- * <li>
7345
- * <p>
7346
- * <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>
7347
- * </li>
7348
- * <li>
7349
- * <p>
7350
- * <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>
7351
- * </li>
7352
- * </ul>
7075
+ * @public
7076
+ * @enum
7077
+ */
7078
+ export declare const SessionStatus: {
7079
+ readonly ACTIVE: "ACTIVE";
7080
+ readonly ENDED: "ENDED";
7081
+ readonly EXPIRED: "EXPIRED";
7082
+ };
7083
+ /**
7084
+ * @public
7085
+ */
7086
+ export type SessionStatus = (typeof SessionStatus)[keyof typeof SessionStatus];
7087
+ /**
7353
7088
  * @public
7354
7089
  */
7355
- export interface KnowledgeBaseVectorSearchConfiguration {
7090
+ export interface CreateSessionResponse {
7356
7091
  /**
7357
- * <p>The number of source chunks to retrieve.</p>
7092
+ * <p>The unique identifier for the session.</p>
7358
7093
  * @public
7359
7094
  */
7360
- numberOfResults?: number | undefined;
7095
+ sessionId: string | undefined;
7361
7096
  /**
7362
- * <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</p>
7097
+ * <p>The Amazon Resource Name (ARN) of the created session.</p>
7363
7098
  * @public
7364
7099
  */
7365
- overrideSearchType?: SearchType | undefined;
7100
+ sessionArn: string | undefined;
7366
7101
  /**
7367
- * <p>Specifies the filters to use on the metadata 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>.</p>
7102
+ * <p>The current status of the session.</p>
7368
7103
  * @public
7369
7104
  */
7370
- filter?: RetrievalFilter | undefined;
7105
+ sessionStatus: SessionStatus | undefined;
7371
7106
  /**
7372
- * <p>Contains configurations for reranking the retrieved results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html">Improve the relevance of query responses with a reranker model</a>.</p>
7107
+ * <p>The timestamp for when the session was created.</p>
7373
7108
  * @public
7374
7109
  */
7375
- rerankingConfiguration?: VectorSearchRerankingConfiguration | undefined;
7110
+ createdAt: Date | undefined;
7111
+ }
7112
+ /**
7113
+ * @public
7114
+ */
7115
+ export interface DeleteSessionRequest {
7376
7116
  /**
7377
- * <p>Settings for implicit filtering.</p>
7117
+ * <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>
7378
7118
  * @public
7379
7119
  */
7380
- implicitFilterConfiguration?: ImplicitFilterConfiguration | undefined;
7120
+ sessionIdentifier: string | undefined;
7121
+ }
7122
+ /**
7123
+ * @public
7124
+ */
7125
+ export interface DeleteSessionResponse {
7381
7126
  }
7382
7127
  /**
7383
- * <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>
7384
- * <p>This data type is used in the following API operations:</p>
7385
- * <ul>
7386
- * <li>
7387
- * <p>
7388
- * <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>
7389
- * </li>
7390
- * <li>
7391
- * <p>
7392
- * <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>
7393
- * </li>
7394
- * </ul>
7395
7128
  * @public
7396
7129
  */
7397
- export interface KnowledgeBaseRetrievalConfiguration {
7130
+ export interface EndSessionRequest {
7398
7131
  /**
7399
- * <p>Contains details about how the results from the vector search should be returned. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
7132
+ * <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>
7400
7133
  * @public
7401
7134
  */
7402
- vectorSearchConfiguration: KnowledgeBaseVectorSearchConfiguration | undefined;
7135
+ sessionIdentifier: string | undefined;
7403
7136
  }
7404
7137
  /**
7405
- * <p>
7406
- * Details of the knowledge base associated withe inline agent.
7407
- * </p>
7408
7138
  * @public
7409
7139
  */
7410
- export interface KnowledgeBase {
7140
+ export interface EndSessionResponse {
7411
7141
  /**
7412
- * <p>
7413
- * The unique identifier for a knowledge base associated with the inline agent.
7414
- * </p>
7142
+ * <p>The unique identifier of the session you ended.</p>
7415
7143
  * @public
7416
7144
  */
7417
- knowledgeBaseId: string | undefined;
7145
+ sessionId: string | undefined;
7418
7146
  /**
7419
- * <p>
7420
- * The description of the knowledge base associated with the inline agent.
7421
- * </p>
7147
+ * <p>The Amazon Resource Name (ARN) of the session you ended.</p>
7422
7148
  * @public
7423
7149
  */
7424
- description: string | undefined;
7150
+ sessionArn: string | undefined;
7425
7151
  /**
7426
- * <p>
7427
- * 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>.
7428
- * </p>
7152
+ * <p>The current status of the session you ended.</p>
7429
7153
  * @public
7430
7154
  */
7431
- retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
7155
+ sessionStatus: SessionStatus | undefined;
7432
7156
  }
7433
7157
  /**
7434
- * <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>
7435
7158
  * @public
7436
7159
  */
7437
- export interface KnowledgeBaseConfiguration {
7160
+ export interface GetSessionRequest {
7438
7161
  /**
7439
- * <p>The unique identifier for a knowledge base attached to the agent.</p>
7162
+ * <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>
7440
7163
  * @public
7441
7164
  */
7442
- knowledgeBaseId: string | undefined;
7165
+ sessionIdentifier: string | undefined;
7166
+ }
7167
+ /**
7168
+ * @public
7169
+ */
7170
+ export interface GetSessionResponse {
7443
7171
  /**
7444
- * <p>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>.</p>
7172
+ * <p>The unique identifier for the session in UUID format.</p>
7445
7173
  * @public
7446
7174
  */
7447
- retrievalConfiguration: KnowledgeBaseRetrievalConfiguration | undefined;
7448
- }
7449
- /**
7450
- * <p>Contains details about the resource being queried.</p>
7451
- * <p>This data type is used in the following API operations:</p>
7452
- * <ul>
7453
- * <li>
7454
- * <p>
7455
- * <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>
7456
- * </li>
7457
- * <li>
7458
- * <p>
7459
- * <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>
7460
- * </li>
7461
- * </ul>
7175
+ sessionId: string | undefined;
7176
+ /**
7177
+ * <p>The Amazon Resource Name (ARN) of the session.</p>
7178
+ * @public
7179
+ */
7180
+ sessionArn: string | undefined;
7181
+ /**
7182
+ * <p>The current status of the session.</p>
7183
+ * @public
7184
+ */
7185
+ sessionStatus: SessionStatus | undefined;
7186
+ /**
7187
+ * <p>The timestamp for when the session was created.</p>
7188
+ * @public
7189
+ */
7190
+ createdAt: Date | undefined;
7191
+ /**
7192
+ * <p>The timestamp for when the session was last modified.</p>
7193
+ * @public
7194
+ */
7195
+ lastUpdatedAt: Date | undefined;
7196
+ /**
7197
+ * <p>A map of key-value pairs containing attributes persisted across the session.</p>
7198
+ * @public
7199
+ */
7200
+ sessionMetadata?: Record<string, string> | undefined;
7201
+ /**
7202
+ * <p>The Amazon Resource Name (ARN) of the Key Management Service key used to encrypt the session data.
7203
+ * For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/session-encryption.html">Amazon Bedrock session encryption</a>.</p>
7204
+ * @public
7205
+ */
7206
+ encryptionKeyArn?: string | undefined;
7207
+ }
7208
+ /**
7462
7209
  * @public
7463
7210
  */
7464
- export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
7211
+ export interface CreateInvocationRequest {
7212
+ /**
7213
+ * <p>A unique identifier for the invocation in UUID format.</p>
7214
+ * @public
7215
+ */
7216
+ invocationId?: string | undefined;
7465
7217
  /**
7466
- * <p>The unique identifier of the knowledge base that is queried.</p>
7218
+ * <p>A description for the interactions in the invocation. For example, "User asking about weather in Seattle".</p>
7467
7219
  * @public
7468
7220
  */
7469
- knowledgeBaseId: string | undefined;
7221
+ description?: string | undefined;
7470
7222
  /**
7471
- * <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>
7223
+ * <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).
7224
+ * </p>
7472
7225
  * @public
7473
7226
  */
7474
- modelArn: string | undefined;
7227
+ sessionIdentifier: string | undefined;
7228
+ }
7229
+ /**
7230
+ * @public
7231
+ */
7232
+ export interface CreateInvocationResponse {
7475
7233
  /**
7476
- * <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
7234
+ * <p>The unique identifier for the session associated with the invocation.</p>
7477
7235
  * @public
7478
7236
  */
7479
- retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
7237
+ sessionId: string | undefined;
7480
7238
  /**
7481
- * <p>Contains configurations for response generation based on the knowledge base query results.</p>
7239
+ * <p>The unique identifier for the invocation.</p>
7482
7240
  * @public
7483
7241
  */
7484
- generationConfiguration?: GenerationConfiguration | undefined;
7242
+ invocationId: string | undefined;
7485
7243
  /**
7486
- * <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
7244
+ * <p>The timestamp for when the invocation was created.</p>
7487
7245
  * @public
7488
7246
  */
7489
- orchestrationConfiguration?: OrchestrationConfiguration | undefined;
7247
+ createdAt: Date | undefined;
7490
7248
  }
7491
7249
  /**
7492
7250
  * @public
7493
7251
  */
7494
- export interface RetrieveRequest {
7252
+ export interface ListInvocationsRequest {
7495
7253
  /**
7496
- * <p>The unique identifier of the knowledge base to query.</p>
7254
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
7255
+ * token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
7256
+ * </p>
7497
7257
  * @public
7498
7258
  */
7499
- knowledgeBaseId: string | undefined;
7259
+ nextToken?: string | undefined;
7500
7260
  /**
7501
- * <p>Contains the query to send the knowledge base.</p>
7261
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
7262
+ * use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
7263
+ * batch of results.</p>
7502
7264
  * @public
7503
7265
  */
7504
- retrievalQuery: KnowledgeBaseQuery | undefined;
7266
+ maxResults?: number | undefined;
7505
7267
  /**
7506
- * <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>
7268
+ * <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>
7507
7269
  * @public
7508
7270
  */
7509
- retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
7271
+ sessionIdentifier: string | undefined;
7272
+ }
7273
+ /**
7274
+ * <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>
7275
+ * @public
7276
+ */
7277
+ export interface InvocationSummary {
7510
7278
  /**
7511
- * <p>Guardrail settings.</p>
7279
+ * <p>The unique identifier for the session associated with the invocation.</p>
7512
7280
  * @public
7513
7281
  */
7514
- guardrailConfiguration?: GuardrailConfiguration | undefined;
7282
+ sessionId: string | undefined;
7515
7283
  /**
7516
- * <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
7284
+ * <p>A unique identifier for the invocation in UUID format.</p>
7285
+ * @public
7286
+ */
7287
+ invocationId: string | undefined;
7288
+ /**
7289
+ * <p>The timestamp for when the invocation was created.</p>
7290
+ * @public
7291
+ */
7292
+ createdAt: Date | undefined;
7293
+ }
7294
+ /**
7295
+ * @public
7296
+ */
7297
+ export interface ListInvocationsResponse {
7298
+ /**
7299
+ * <p>A list of invocation summaries associated with the session.</p>
7300
+ * @public
7301
+ */
7302
+ invocationSummaries: InvocationSummary[] | undefined;
7303
+ /**
7304
+ * <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>
7517
7305
  * @public
7518
7306
  */
7519
7307
  nextToken?: string | undefined;
7520
7308
  }
7521
7309
  /**
7522
- * <p>Contains details about the resource being queried.</p>
7523
- * <p>This data type is used in the following API operations:</p>
7524
- * <ul>
7525
- * <li>
7526
- * <p>
7527
- * <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>retrieveAndGenerateConfiguration</code> field</p>
7528
- * </li>
7529
- * </ul>
7530
7310
  * @public
7531
7311
  */
7532
- export interface RetrieveAndGenerateConfiguration {
7312
+ export interface GetInvocationStepRequest {
7533
7313
  /**
7534
- * <p>The type of resource that contains your data for retrieving information and generating responses.</p>
7535
- * <p>If you choose ot use <code>EXTERNAL_SOURCES</code>, then currently only Claude 3 Sonnet models for knowledge bases are supported.</p>
7314
+ * <p>The unique identifier for the invocation in UUID format.</p>
7536
7315
  * @public
7537
7316
  */
7538
- type: RetrieveAndGenerateType | undefined;
7317
+ invocationIdentifier: string | undefined;
7539
7318
  /**
7540
- * <p>Contains details about the knowledge base for retrieving information and generating responses.</p>
7319
+ * <p>The unique identifier (in UUID format) for the specific invocation step to retrieve.</p>
7541
7320
  * @public
7542
7321
  */
7543
- knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
7322
+ invocationStepId: string | undefined;
7544
7323
  /**
7545
- * <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
7324
+ * <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>
7546
7325
  * @public
7547
7326
  */
7548
- externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
7327
+ sessionIdentifier: string | undefined;
7549
7328
  }
7550
7329
  /**
7551
7330
  * @public
7331
+ * @enum
7552
7332
  */
7553
- export interface InvokeInlineAgentRequest {
7333
+ export declare const ImageFormat: {
7334
+ readonly GIF: "gif";
7335
+ readonly JPEG: "jpeg";
7336
+ readonly PNG: "png";
7337
+ readonly WEBP: "webp";
7338
+ };
7339
+ /**
7340
+ * @public
7341
+ */
7342
+ export type ImageFormat = (typeof ImageFormat)[keyof typeof ImageFormat];
7343
+ /**
7344
+ * <p>Information about the Amazon S3 bucket where the image is stored.</p>
7345
+ * @public
7346
+ */
7347
+ export interface S3Location {
7554
7348
  /**
7555
- * <p>
7556
- * The unique identifier of the session. Use the same value across requests to continue the same conversation.
7557
- * </p>
7349
+ * <p>The path to the Amazon S3 bucket where the image is stored.</p>
7558
7350
  * @public
7559
7351
  */
7560
- sessionId: string | undefined;
7352
+ uri: string | undefined;
7353
+ }
7354
+ /**
7355
+ * <p>The source for an image.</p>
7356
+ * @public
7357
+ */
7358
+ export type ImageSource = ImageSource.BytesMember | ImageSource.S3LocationMember | ImageSource.$UnknownMember;
7359
+ /**
7360
+ * @public
7361
+ */
7362
+ export declare namespace ImageSource {
7561
7363
  /**
7562
- * <p>
7563
- * The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
7564
- * </p>
7364
+ * <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>
7565
7365
  * @public
7566
7366
  */
7567
- customerEncryptionKeyArn?: string | undefined;
7367
+ interface BytesMember {
7368
+ bytes: Uint8Array;
7369
+ s3Location?: never;
7370
+ $unknown?: never;
7371
+ }
7568
7372
  /**
7569
- * <p>
7570
- * Specifies whether to end the session with the inline agent or not.
7571
- * </p>
7373
+ * <p>The path to the Amazon S3 bucket where the image is stored.</p>
7572
7374
  * @public
7573
7375
  */
7574
- endSession?: boolean | undefined;
7376
+ interface S3LocationMember {
7377
+ bytes?: never;
7378
+ s3Location: S3Location;
7379
+ $unknown?: never;
7380
+ }
7575
7381
  /**
7576
- * <p>
7577
- * 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>.
7578
- *
7579
- * </p>
7580
7382
  * @public
7581
7383
  */
7582
- enableTrace?: boolean | undefined;
7384
+ interface $UnknownMember {
7385
+ bytes?: never;
7386
+ s3Location?: never;
7387
+ $unknown: [string, any];
7388
+ }
7389
+ interface Visitor<T> {
7390
+ bytes: (value: Uint8Array) => T;
7391
+ s3Location: (value: S3Location) => T;
7392
+ _: (name: string, value: any) => T;
7393
+ }
7394
+ const visit: <T>(value: ImageSource, visitor: Visitor<T>) => T;
7395
+ }
7396
+ /**
7397
+ * <p>Image content for an invocation step.</p>
7398
+ * @public
7399
+ */
7400
+ export interface ImageBlock {
7583
7401
  /**
7584
- * <p>
7585
- * The prompt text to send to the agent.
7586
- * </p>
7587
- * <note>
7588
- * <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
7589
- * </note>
7402
+ * <p>The format of the image.</p>
7590
7403
  * @public
7591
7404
  */
7592
- inputText?: string | undefined;
7405
+ format: ImageFormat | undefined;
7593
7406
  /**
7594
- * <p>
7595
- * Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an
7596
- * 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>.
7597
- * </p>
7598
- * <note>
7599
- * <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
7600
- * </note>
7407
+ * <p>The source for the image.</p>
7601
7408
  * @public
7602
7409
  */
7603
- inlineSessionState?: InlineSessionState | undefined;
7410
+ source: ImageSource | undefined;
7411
+ }
7412
+ /**
7413
+ * <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
7414
+ * 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.
7415
+ * 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>
7416
+ * <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>
7417
+ * @public
7418
+ */
7419
+ export type BedrockSessionContentBlock = BedrockSessionContentBlock.ImageMember | BedrockSessionContentBlock.TextMember | BedrockSessionContentBlock.$UnknownMember;
7420
+ /**
7421
+ * @public
7422
+ */
7423
+ export declare namespace BedrockSessionContentBlock {
7604
7424
  /**
7605
- * <p>
7606
- * 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>.
7607
- * </p>
7425
+ * <p>The text in the invocation step.</p>
7608
7426
  * @public
7609
7427
  */
7610
- foundationModel: string | undefined;
7428
+ interface TextMember {
7429
+ text: string;
7430
+ image?: never;
7431
+ $unknown?: never;
7432
+ }
7611
7433
  /**
7612
- * <p>
7613
- * The instructions that tell the inline agent what it should do and how it should interact with users.
7614
- * </p>
7434
+ * <p>The image in the invocation step.</p>
7615
7435
  * @public
7616
7436
  */
7617
- instruction: string | undefined;
7437
+ interface ImageMember {
7438
+ text?: never;
7439
+ image: ImageBlock;
7440
+ $unknown?: never;
7441
+ }
7618
7442
  /**
7619
- * <p>
7620
- * The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent <code>InvokeInlineAgent</code> request begins a new session.
7621
- * </p>
7622
- * <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>
7623
7443
  * @public
7624
7444
  */
7625
- idleSessionTTLInSeconds?: number | undefined;
7445
+ interface $UnknownMember {
7446
+ text?: never;
7447
+ image?: never;
7448
+ $unknown: [string, any];
7449
+ }
7450
+ interface Visitor<T> {
7451
+ text: (value: string) => T;
7452
+ image: (value: ImageBlock) => T;
7453
+ _: (name: string, value: any) => T;
7454
+ }
7455
+ const visit: <T>(value: BedrockSessionContentBlock, visitor: Visitor<T>) => T;
7456
+ }
7457
+ /**
7458
+ * <p>Payload content, such as text and images, for the invocation step.</p>
7459
+ * @public
7460
+ */
7461
+ export type InvocationStepPayload = InvocationStepPayload.ContentBlocksMember | InvocationStepPayload.$UnknownMember;
7462
+ /**
7463
+ * @public
7464
+ */
7465
+ export declare namespace InvocationStepPayload {
7626
7466
  /**
7627
- * <p>
7628
- * A list of action groups with each action group defining the action the inline agent needs to carry out.
7629
- * </p>
7467
+ * <p>The content for the invocation step.</p>
7630
7468
  * @public
7631
7469
  */
7632
- actionGroups?: AgentActionGroup[] | undefined;
7470
+ interface ContentBlocksMember {
7471
+ contentBlocks: BedrockSessionContentBlock[];
7472
+ $unknown?: never;
7473
+ }
7633
7474
  /**
7634
- * <p>
7635
- * Contains information of the knowledge bases to associate with.
7636
- * </p>
7637
7475
  * @public
7638
7476
  */
7639
- knowledgeBases?: KnowledgeBase[] | undefined;
7477
+ interface $UnknownMember {
7478
+ contentBlocks?: never;
7479
+ $unknown: [string, any];
7480
+ }
7481
+ interface Visitor<T> {
7482
+ contentBlocks: (value: BedrockSessionContentBlock[]) => T;
7483
+ _: (name: string, value: any) => T;
7484
+ }
7485
+ const visit: <T>(value: InvocationStepPayload, visitor: Visitor<T>) => T;
7486
+ }
7487
+ /**
7488
+ * <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>
7489
+ * @public
7490
+ */
7491
+ export interface InvocationStep {
7640
7492
  /**
7641
- * <p>
7642
- * The <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html">guardrails</a> to assign to the inline agent.
7643
- * </p>
7493
+ * <p>The unique identifier of the session containing the invocation step.</p>
7644
7494
  * @public
7645
7495
  */
7646
- guardrailConfiguration?: GuardrailConfigurationWithArn | undefined;
7496
+ sessionId: string | undefined;
7647
7497
  /**
7648
- * <p>
7649
- * Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
7650
- * </p>
7498
+ * <p>The unique identifier (in UUID format) for the invocation that includes the invocation step.</p>
7651
7499
  * @public
7652
7500
  */
7653
- promptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
7501
+ invocationId: string | undefined;
7654
7502
  /**
7655
- * <p>Model settings for the request.</p>
7503
+ * <p>The unique identifier (in UUID format) for the invocation step.</p>
7656
7504
  * @public
7657
7505
  */
7658
- bedrockModelConfigurations?: InlineBedrockModelConfigurations | undefined;
7506
+ invocationStepId: string | undefined;
7659
7507
  /**
7660
- * <p>
7661
- * Specifies the configurations for streaming.
7662
- * </p>
7663
- * <note>
7664
- * <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
7665
- * </note>
7508
+ * <p>The timestamp for when the invocation step was created.</p>
7666
7509
  * @public
7667
7510
  */
7668
- streamingConfigurations?: StreamingConfigurations | undefined;
7511
+ invocationStepTime: Date | undefined;
7512
+ /**
7513
+ * <p>Payload content, such as text and images, for the invocation step.</p>
7514
+ * @public
7515
+ */
7516
+ payload: InvocationStepPayload | undefined;
7669
7517
  }
7670
7518
  /**
7671
7519
  * @public
7672
7520
  */
7673
- export interface RetrieveAndGenerateRequest {
7521
+ export interface GetInvocationStepResponse {
7674
7522
  /**
7675
- * <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
7523
+ * <p>The complete details of the requested invocation step.</p>
7676
7524
  * @public
7677
7525
  */
7678
- sessionId?: string | undefined;
7526
+ invocationStep: InvocationStep | undefined;
7527
+ }
7528
+ /**
7529
+ * @public
7530
+ */
7531
+ export interface ListInvocationStepsRequest {
7679
7532
  /**
7680
- * <p>Contains the query to be made to the knowledge base.</p>
7533
+ * <p>The unique identifier (in UUID format) for the invocation to list invocation steps for.</p>
7681
7534
  * @public
7682
7535
  */
7683
- input: RetrieveAndGenerateInput | undefined;
7536
+ invocationIdentifier?: string | undefined;
7684
7537
  /**
7685
- * <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>
7538
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
7539
+ * token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
7540
+ * </p>
7686
7541
  * @public
7687
7542
  */
7688
- retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
7543
+ nextToken?: string | undefined;
7689
7544
  /**
7690
- * <p>Contains details about the session with the knowledge base.</p>
7545
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
7546
+ * use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
7547
+ * batch of results.</p>
7691
7548
  * @public
7692
7549
  */
7693
- sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
7550
+ maxResults?: number | undefined;
7551
+ /**
7552
+ * <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>
7553
+ * @public
7554
+ */
7555
+ sessionIdentifier: string | undefined;
7694
7556
  }
7695
7557
  /**
7558
+ * <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>
7696
7559
  * @public
7697
7560
  */
7698
- export interface RetrieveAndGenerateStreamRequest {
7561
+ export interface InvocationStepSummary {
7699
7562
  /**
7700
- * <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
7563
+ * <p>The unique identifier for the session associated with the invocation step.</p>
7701
7564
  * @public
7702
7565
  */
7703
- sessionId?: string | undefined;
7566
+ sessionId: string | undefined;
7704
7567
  /**
7705
- * <p>Contains the query to be made to the knowledge base.</p>
7568
+ * <p>A unique identifier for the invocation in UUID format.</p>
7706
7569
  * @public
7707
7570
  */
7708
- input: RetrieveAndGenerateInput | undefined;
7571
+ invocationId: string | undefined;
7709
7572
  /**
7710
- * <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>
7573
+ * <p>The unique identifier (in UUID format) for the invocation step.</p>
7711
7574
  * @public
7712
7575
  */
7713
- retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
7576
+ invocationStepId: string | undefined;
7714
7577
  /**
7715
- * <p>Contains details about the session with the knowledge base.</p>
7578
+ * <p>The timestamp for when the invocation step was created.</p>
7716
7579
  * @public
7717
7580
  */
7718
- sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
7581
+ invocationStepTime: Date | undefined;
7719
7582
  }
7720
7583
  /**
7721
- * <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
7722
7584
  * @public
7723
7585
  */
7724
- export interface SessionState {
7586
+ export interface ListInvocationStepsResponse {
7725
7587
  /**
7726
- * <p>Contains attributes that persist across a session and the values of those attributes.</p>
7588
+ * <p>A list of summaries for each invocation step associated with a session and if you specified it, an invocation within the session.</p>
7727
7589
  * @public
7728
7590
  */
7729
- sessionAttributes?: Record<string, string> | undefined;
7591
+ invocationStepSummaries: InvocationStepSummary[] | undefined;
7730
7592
  /**
7731
- * <p>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
7593
+ * <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>
7732
7594
  * @public
7733
7595
  */
7734
- promptSessionAttributes?: Record<string, string> | undefined;
7596
+ nextToken?: string | undefined;
7597
+ }
7598
+ /**
7599
+ * @public
7600
+ */
7601
+ export interface PutInvocationStepRequest {
7735
7602
  /**
7736
- * <p>Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
7737
- * <note>
7738
- * <p>If you include this field, the <code>inputText</code> field will be ignored.</p>
7739
- * </note>
7603
+ * <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>
7740
7604
  * @public
7741
7605
  */
7742
- returnControlInvocationResults?: InvocationResultMember[] | undefined;
7606
+ sessionIdentifier: string | undefined;
7743
7607
  /**
7744
- * <p>The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeAgent</code> response for the action whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
7608
+ * <p>The unique identifier (in UUID format) of the invocation to add the invocation step to.</p>
7745
7609
  * @public
7746
7610
  */
7747
- invocationId?: string | undefined;
7611
+ invocationIdentifier: string | undefined;
7748
7612
  /**
7749
- * <p>Contains information about the files used by code interpreter.</p>
7613
+ * <p>The timestamp for when the invocation step occurred.</p>
7750
7614
  * @public
7751
7615
  */
7752
- files?: InputFile[] | undefined;
7616
+ invocationStepTime: Date | undefined;
7753
7617
  /**
7754
- * <p>An array of configurations, each of which applies to a knowledge base attached to the agent.</p>
7618
+ * <p>The payload for the invocation step, including text and images for the interaction.</p>
7755
7619
  * @public
7756
7620
  */
7757
- knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
7621
+ payload: InvocationStepPayload | undefined;
7758
7622
  /**
7759
- * <p>The state's conversation history.</p>
7623
+ * <p>The unique identifier of the invocation step in UUID format.</p>
7760
7624
  * @public
7761
7625
  */
7762
- conversationHistory?: ConversationHistory | undefined;
7626
+ invocationStepId?: string | undefined;
7763
7627
  }
7764
7628
  /**
7765
7629
  * @public
7766
7630
  */
7767
- export interface InvokeAgentRequest {
7631
+ export interface PutInvocationStepResponse {
7768
7632
  /**
7769
- * <p>Contains parameters that specify various attributes of the session. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
7770
- * <note>
7771
- * <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
7772
- * </note>
7633
+ * <p>The unique identifier of the invocation step in UUID format.</p>
7773
7634
  * @public
7774
7635
  */
7775
- sessionState?: SessionState | undefined;
7636
+ invocationStepId: string | undefined;
7637
+ }
7638
+ /**
7639
+ * @public
7640
+ */
7641
+ export interface ListSessionsRequest {
7776
7642
  /**
7777
- * <p>The unique identifier of the agent to use.</p>
7643
+ * <p>The maximum number of results to return in the response. If the total number of results is greater than this value,
7644
+ * use the token returned in the response in the <code>nextToken</code> field when making another request to return the next
7645
+ * batch of results.</p>
7778
7646
  * @public
7779
7647
  */
7780
- agentId: string | undefined;
7648
+ maxResults?: number | undefined;
7781
7649
  /**
7782
- * <p>The alias of the agent to use.</p>
7650
+ * <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the
7651
+ * token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.
7652
+ * </p>
7783
7653
  * @public
7784
7654
  */
7785
- agentAliasId: string | undefined;
7655
+ nextToken?: string | undefined;
7656
+ }
7657
+ /**
7658
+ * <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>
7659
+ * @public
7660
+ */
7661
+ export interface SessionSummary {
7786
7662
  /**
7787
- * <p>The unique identifier of the session. Use the same value across requests to continue the same conversation.</p>
7663
+ * <p>The unique identifier for the session.</p>
7788
7664
  * @public
7789
7665
  */
7790
7666
  sessionId: string | undefined;
7791
7667
  /**
7792
- * <p>Specifies whether to end the session with the agent or not.</p>
7668
+ * <p>The Amazon Resource Name (ARN) of the session.</p>
7793
7669
  * @public
7794
7670
  */
7795
- endSession?: boolean | undefined;
7671
+ sessionArn: string | undefined;
7796
7672
  /**
7797
- * <p>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/agents-test.html#trace-events">Trace enablement</a>.</p>
7673
+ * <p>The current status of the session.</p>
7798
7674
  * @public
7799
7675
  */
7800
- enableTrace?: boolean | undefined;
7676
+ sessionStatus: SessionStatus | undefined;
7801
7677
  /**
7802
- * <p>The prompt text to send the agent.</p>
7803
- * <note>
7804
- * <p>If you include <code>returnControlInvocationResults</code> in the <code>sessionState</code> field, the <code>inputText</code> field will be ignored.</p>
7805
- * </note>
7678
+ * <p>The timestamp for when the session was created.</p>
7806
7679
  * @public
7807
7680
  */
7808
- inputText?: string | undefined;
7681
+ createdAt: Date | undefined;
7809
7682
  /**
7810
- * <p>The unique identifier of the agent memory.</p>
7683
+ * <p>The timestamp for when the session was last modified.</p>
7811
7684
  * @public
7812
7685
  */
7813
- memoryId?: string | undefined;
7686
+ lastUpdatedAt: Date | undefined;
7687
+ }
7688
+ /**
7689
+ * @public
7690
+ */
7691
+ export interface ListSessionsResponse {
7814
7692
  /**
7815
- * <p>Model performance settings for the request.</p>
7693
+ * <p>A list of summaries for each session in your Amazon Web Services account.</p>
7816
7694
  * @public
7817
7695
  */
7818
- bedrockModelConfigurations?: BedrockModelConfigurations | undefined;
7696
+ sessionSummaries: SessionSummary[] | undefined;
7819
7697
  /**
7820
- * <p>
7821
- * Specifies the configurations for streaming.
7822
- * </p>
7823
- * <note>
7824
- * <p>To use agent streaming, you need permissions to perform the <code>bedrock:InvokeModelWithResponseStream</code> action.</p>
7825
- * </note>
7698
+ * <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>
7699
+ * @public
7700
+ */
7701
+ nextToken?: string | undefined;
7702
+ }
7703
+ /**
7704
+ * @public
7705
+ */
7706
+ export interface UpdateSessionRequest {
7707
+ /**
7708
+ * <p>A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference,
7709
+ * and the type of device they are using.</p>
7710
+ * @public
7711
+ */
7712
+ sessionMetadata?: Record<string, string> | undefined;
7713
+ /**
7714
+ * <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>
7715
+ * @public
7716
+ */
7717
+ sessionIdentifier: string | undefined;
7718
+ }
7719
+ /**
7720
+ * @public
7721
+ */
7722
+ export interface UpdateSessionResponse {
7723
+ /**
7724
+ * <p>The unique identifier of the session you updated.</p>
7725
+ * @public
7726
+ */
7727
+ sessionId: string | undefined;
7728
+ /**
7729
+ * <p>The Amazon Resource Name (ARN) of the session that was updated.</p>
7730
+ * @public
7731
+ */
7732
+ sessionArn: string | undefined;
7733
+ /**
7734
+ * <p>The status of the session you updated.</p>
7735
+ * @public
7736
+ */
7737
+ sessionStatus: SessionStatus | undefined;
7738
+ /**
7739
+ * <p>The timestamp for when the session was created.</p>
7740
+ * @public
7741
+ */
7742
+ createdAt: Date | undefined;
7743
+ /**
7744
+ * <p>The timestamp for when the session was last modified.</p>
7745
+ * @public
7746
+ */
7747
+ lastUpdatedAt: Date | undefined;
7748
+ }
7749
+ /**
7750
+ * @public
7751
+ */
7752
+ export interface ListTagsForResourceRequest {
7753
+ /**
7754
+ * <p>The Amazon Resource Name (ARN) of the resource for which to list tags.</p>
7755
+ * @public
7756
+ */
7757
+ resourceArn: string | undefined;
7758
+ }
7759
+ /**
7760
+ * @public
7761
+ */
7762
+ export interface ListTagsForResourceResponse {
7763
+ /**
7764
+ * <p>The key-value pairs for the tags associated with the resource.</p>
7765
+ * @public
7766
+ */
7767
+ tags?: Record<string, string> | undefined;
7768
+ }
7769
+ /**
7770
+ * @public
7771
+ */
7772
+ export interface TagResourceRequest {
7773
+ /**
7774
+ * <p>The Amazon Resource Name (ARN) of the resource to tag.</p>
7826
7775
  * @public
7827
7776
  */
7828
- streamingConfigurations?: StreamingConfigurations | undefined;
7777
+ resourceArn: string | undefined;
7829
7778
  /**
7830
- * <p>The ARN of the resource making the request.</p>
7779
+ * <p>An object containing key-value pairs that define the tags to attach to the resource.</p>
7831
7780
  * @public
7832
7781
  */
7833
- sourceArn?: string | undefined;
7782
+ tags: Record<string, string> | undefined;
7834
7783
  }
7835
7784
  /**
7836
7785
  * @internal
@@ -8247,7 +8196,7 @@ export declare const InvokeAgentResponseFilterSensitiveLog: (obj: InvokeAgentRes
8247
8196
  /**
8248
8197
  * @internal
8249
8198
  */
8250
- export declare const InlineSessionStateFilterSensitiveLog: (obj: InlineSessionState) => any;
8199
+ export declare const CollaboratorConfigurationFilterSensitiveLog: (obj: CollaboratorConfiguration) => any;
8251
8200
  /**
8252
8201
  * @internal
8253
8202
  */
@@ -8256,6 +8205,10 @@ export declare const PromptConfigurationFilterSensitiveLog: (obj: PromptConfigur
8256
8205
  * @internal
8257
8206
  */
8258
8207
  export declare const PromptOverrideConfigurationFilterSensitiveLog: (obj: PromptOverrideConfiguration) => any;
8208
+ /**
8209
+ * @internal
8210
+ */
8211
+ export declare const InlineSessionStateFilterSensitiveLog: (obj: InlineSessionState) => any;
8259
8212
  /**
8260
8213
  * @internal
8261
8214
  */
@@ -8411,52 +8364,20 @@ export declare const RetrieveResponseFilterSensitiveLog: (obj: RetrieveResponse)
8411
8364
  /**
8412
8365
  * @internal
8413
8366
  */
8414
- export declare const RetrievalFilterFilterSensitiveLog: (obj: RetrievalFilter) => any;
8415
- /**
8416
- * @internal
8417
- */
8418
- export declare const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog: (obj: KnowledgeBaseVectorSearchConfiguration) => any;
8419
- /**
8420
- * @internal
8421
- */
8422
- export declare const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrievalConfiguration) => any;
8423
- /**
8424
- * @internal
8425
- */
8426
- export declare const KnowledgeBaseFilterSensitiveLog: (obj: KnowledgeBase) => any;
8427
- /**
8428
- * @internal
8429
- */
8430
- export declare const KnowledgeBaseConfigurationFilterSensitiveLog: (obj: KnowledgeBaseConfiguration) => any;
8431
- /**
8432
- * @internal
8433
- */
8434
- export declare const KnowledgeBaseRetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: KnowledgeBaseRetrieveAndGenerateConfiguration) => any;
8435
- /**
8436
- * @internal
8437
- */
8438
- export declare const RetrieveRequestFilterSensitiveLog: (obj: RetrieveRequest) => any;
8439
- /**
8440
- * @internal
8441
- */
8442
- export declare const RetrieveAndGenerateConfigurationFilterSensitiveLog: (obj: RetrieveAndGenerateConfiguration) => any;
8443
- /**
8444
- * @internal
8445
- */
8446
- export declare const InvokeInlineAgentRequestFilterSensitiveLog: (obj: InvokeInlineAgentRequest) => any;
8367
+ export declare const BedrockSessionContentBlockFilterSensitiveLog: (obj: BedrockSessionContentBlock) => any;
8447
8368
  /**
8448
8369
  * @internal
8449
8370
  */
8450
- export declare const RetrieveAndGenerateRequestFilterSensitiveLog: (obj: RetrieveAndGenerateRequest) => any;
8371
+ export declare const InvocationStepPayloadFilterSensitiveLog: (obj: InvocationStepPayload) => any;
8451
8372
  /**
8452
8373
  * @internal
8453
8374
  */
8454
- export declare const RetrieveAndGenerateStreamRequestFilterSensitiveLog: (obj: RetrieveAndGenerateStreamRequest) => any;
8375
+ export declare const InvocationStepFilterSensitiveLog: (obj: InvocationStep) => any;
8455
8376
  /**
8456
8377
  * @internal
8457
8378
  */
8458
- export declare const SessionStateFilterSensitiveLog: (obj: SessionState) => any;
8379
+ export declare const GetInvocationStepResponseFilterSensitiveLog: (obj: GetInvocationStepResponse) => any;
8459
8380
  /**
8460
8381
  * @internal
8461
8382
  */
8462
- export declare const InvokeAgentRequestFilterSensitiveLog: (obj: InvokeAgentRequest) => any;
8383
+ export declare const PutInvocationStepRequestFilterSensitiveLog: (obj: PutInvocationStepRequest) => any;