aws-sdk-bedrockagent 1.1.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
data/sig/client.rbs ADDED
@@ -0,0 +1,803 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module BedrockAgent
10
+ class Client < ::Seahorse::Client::Base
11
+ include ::Aws::ClientStubs
12
+
13
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#initialize-instance_method
14
+ def self.new: (
15
+ ?credentials: untyped,
16
+ ?region: String,
17
+ ?access_key_id: String,
18
+ ?active_endpoint_cache: bool,
19
+ ?adaptive_retry_wait_to_fill: bool,
20
+ ?client_side_monitoring: bool,
21
+ ?client_side_monitoring_client_id: String,
22
+ ?client_side_monitoring_host: String,
23
+ ?client_side_monitoring_port: Integer,
24
+ ?client_side_monitoring_publisher: untyped,
25
+ ?convert_params: bool,
26
+ ?correct_clock_skew: bool,
27
+ ?defaults_mode: String,
28
+ ?disable_host_prefix_injection: bool,
29
+ ?disable_request_compression: bool,
30
+ ?endpoint: String,
31
+ ?endpoint_cache_max_entries: Integer,
32
+ ?endpoint_cache_max_threads: Integer,
33
+ ?endpoint_cache_poll_interval: Integer,
34
+ ?endpoint_discovery: bool,
35
+ ?ignore_configured_endpoint_urls: bool,
36
+ ?log_formatter: untyped,
37
+ ?log_level: Symbol,
38
+ ?logger: untyped,
39
+ ?max_attempts: Integer,
40
+ ?profile: String,
41
+ ?request_min_compression_size_bytes: Integer,
42
+ ?retry_backoff: Proc,
43
+ ?retry_base_delay: Float,
44
+ ?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
45
+ ?retry_limit: Integer,
46
+ ?retry_max_delay: Integer,
47
+ ?retry_mode: ("legacy" | "standard" | "adaptive"),
48
+ ?sdk_ua_app_id: String,
49
+ ?secret_access_key: String,
50
+ ?session_token: String,
51
+ ?stub_responses: untyped,
52
+ ?token_provider: untyped,
53
+ ?use_dualstack_endpoint: bool,
54
+ ?use_fips_endpoint: bool,
55
+ ?validate_params: bool,
56
+ ?endpoint_provider: untyped,
57
+ ?http_proxy: String,
58
+ ?http_open_timeout: (Float | Integer),
59
+ ?http_read_timeout: (Float | Integer),
60
+ ?http_idle_timeout: (Float | Integer),
61
+ ?http_continue_timeout: (Float | Integer),
62
+ ?ssl_timeout: (Float | Integer | nil),
63
+ ?http_wire_trace: bool,
64
+ ?ssl_verify_peer: bool,
65
+ ?ssl_ca_bundle: String,
66
+ ?ssl_ca_directory: String,
67
+ ?ssl_ca_store: String,
68
+ ?on_chunk_received: Proc,
69
+ ?on_chunk_sent: Proc,
70
+ ?raise_response_errors: bool
71
+ ) -> instance
72
+ | (?Hash[Symbol, untyped]) -> instance
73
+
74
+
75
+ interface _AssociateAgentKnowledgeBaseResponseSuccess
76
+ include ::Seahorse::Client::_ResponseSuccess[Types::AssociateAgentKnowledgeBaseResponse]
77
+ def agent_knowledge_base: () -> Types::AgentKnowledgeBase
78
+ end
79
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#associate_agent_knowledge_base-instance_method
80
+ def associate_agent_knowledge_base: (
81
+ agent_id: ::String,
82
+ agent_version: ::String,
83
+ knowledge_base_id: ::String,
84
+ description: ::String,
85
+ ?knowledge_base_state: ("ENABLED" | "DISABLED")
86
+ ) -> _AssociateAgentKnowledgeBaseResponseSuccess
87
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateAgentKnowledgeBaseResponseSuccess
88
+
89
+ interface _CreateAgentResponseSuccess
90
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateAgentResponse]
91
+ def agent: () -> Types::Agent
92
+ end
93
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_agent-instance_method
94
+ def create_agent: (
95
+ agent_name: ::String,
96
+ ?client_token: ::String,
97
+ ?instruction: ::String,
98
+ ?foundation_model: ::String,
99
+ ?description: ::String,
100
+ ?idle_session_ttl_in_seconds: ::Integer,
101
+ agent_resource_role_arn: ::String,
102
+ ?customer_encryption_key_arn: ::String,
103
+ ?tags: Hash[::String, ::String],
104
+ ?prompt_override_configuration: {
105
+ prompt_configurations: Array[
106
+ {
107
+ prompt_type: ("PRE_PROCESSING" | "ORCHESTRATION" | "POST_PROCESSING" | "KNOWLEDGE_BASE_RESPONSE_GENERATION")?,
108
+ prompt_creation_mode: ("DEFAULT" | "OVERRIDDEN")?,
109
+ prompt_state: ("ENABLED" | "DISABLED")?,
110
+ base_prompt_template: ::String?,
111
+ inference_configuration: {
112
+ temperature: ::Float?,
113
+ top_p: ::Float?,
114
+ top_k: ::Integer?,
115
+ maximum_length: ::Integer?,
116
+ stop_sequences: Array[::String]?
117
+ }?,
118
+ parser_mode: ("DEFAULT" | "OVERRIDDEN")?
119
+ },
120
+ ],
121
+ override_lambda: ::String?
122
+ }
123
+ ) -> _CreateAgentResponseSuccess
124
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgentResponseSuccess
125
+
126
+ interface _CreateAgentActionGroupResponseSuccess
127
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateAgentActionGroupResponse]
128
+ def agent_action_group: () -> Types::AgentActionGroup
129
+ end
130
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_agent_action_group-instance_method
131
+ def create_agent_action_group: (
132
+ agent_id: ::String,
133
+ agent_version: ::String,
134
+ action_group_name: ::String,
135
+ ?client_token: ::String,
136
+ ?description: ::String,
137
+ ?parent_action_group_signature: ("AMAZON.UserInput"),
138
+ ?action_group_executor: {
139
+ lambda: ::String?
140
+ },
141
+ ?api_schema: {
142
+ s3: {
143
+ s3_bucket_name: ::String?,
144
+ s3_object_key: ::String?
145
+ }?,
146
+ payload: ::String?
147
+ },
148
+ ?action_group_state: ("ENABLED" | "DISABLED")
149
+ ) -> _CreateAgentActionGroupResponseSuccess
150
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgentActionGroupResponseSuccess
151
+
152
+ interface _CreateAgentAliasResponseSuccess
153
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateAgentAliasResponse]
154
+ def agent_alias: () -> Types::AgentAlias
155
+ end
156
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_agent_alias-instance_method
157
+ def create_agent_alias: (
158
+ agent_id: ::String,
159
+ agent_alias_name: ::String,
160
+ ?client_token: ::String,
161
+ ?description: ::String,
162
+ ?routing_configuration: Array[
163
+ {
164
+ agent_version: ::String
165
+ },
166
+ ],
167
+ ?tags: Hash[::String, ::String]
168
+ ) -> _CreateAgentAliasResponseSuccess
169
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAgentAliasResponseSuccess
170
+
171
+ interface _CreateDataSourceResponseSuccess
172
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateDataSourceResponse]
173
+ def data_source: () -> Types::DataSource
174
+ end
175
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_data_source-instance_method
176
+ def create_data_source: (
177
+ knowledge_base_id: ::String,
178
+ ?client_token: ::String,
179
+ name: ::String,
180
+ ?description: ::String,
181
+ data_source_configuration: {
182
+ type: ("S3"),
183
+ s3_configuration: {
184
+ bucket_arn: ::String,
185
+ inclusion_prefixes: Array[::String]?
186
+ }?
187
+ },
188
+ ?server_side_encryption_configuration: {
189
+ kms_key_arn: ::String?
190
+ },
191
+ ?vector_ingestion_configuration: {
192
+ chunking_configuration: {
193
+ chunking_strategy: ("FIXED_SIZE" | "NONE"),
194
+ fixed_size_chunking_configuration: {
195
+ max_tokens: ::Integer,
196
+ overlap_percentage: ::Integer
197
+ }?
198
+ }?
199
+ }
200
+ ) -> _CreateDataSourceResponseSuccess
201
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDataSourceResponseSuccess
202
+
203
+ interface _CreateKnowledgeBaseResponseSuccess
204
+ include ::Seahorse::Client::_ResponseSuccess[Types::CreateKnowledgeBaseResponse]
205
+ def knowledge_base: () -> Types::KnowledgeBase
206
+ end
207
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#create_knowledge_base-instance_method
208
+ def create_knowledge_base: (
209
+ ?client_token: ::String,
210
+ name: ::String,
211
+ ?description: ::String,
212
+ role_arn: ::String,
213
+ knowledge_base_configuration: {
214
+ type: ("VECTOR"),
215
+ vector_knowledge_base_configuration: {
216
+ embedding_model_arn: ::String
217
+ }?
218
+ },
219
+ storage_configuration: {
220
+ type: ("OPENSEARCH_SERVERLESS" | "PINECONE" | "REDIS_ENTERPRISE_CLOUD" | "RDS"),
221
+ opensearch_serverless_configuration: {
222
+ collection_arn: ::String,
223
+ vector_index_name: ::String,
224
+ field_mapping: {
225
+ vector_field: ::String,
226
+ text_field: ::String,
227
+ metadata_field: ::String
228
+ }
229
+ }?,
230
+ pinecone_configuration: {
231
+ connection_string: ::String,
232
+ credentials_secret_arn: ::String,
233
+ namespace: ::String?,
234
+ field_mapping: {
235
+ text_field: ::String,
236
+ metadata_field: ::String
237
+ }
238
+ }?,
239
+ redis_enterprise_cloud_configuration: {
240
+ endpoint: ::String,
241
+ vector_index_name: ::String,
242
+ credentials_secret_arn: ::String,
243
+ field_mapping: {
244
+ vector_field: ::String,
245
+ text_field: ::String,
246
+ metadata_field: ::String
247
+ }
248
+ }?,
249
+ rds_configuration: {
250
+ resource_arn: ::String,
251
+ credentials_secret_arn: ::String,
252
+ database_name: ::String,
253
+ table_name: ::String,
254
+ field_mapping: {
255
+ primary_key_field: ::String,
256
+ vector_field: ::String,
257
+ text_field: ::String,
258
+ metadata_field: ::String
259
+ }
260
+ }?
261
+ },
262
+ ?tags: Hash[::String, ::String]
263
+ ) -> _CreateKnowledgeBaseResponseSuccess
264
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateKnowledgeBaseResponseSuccess
265
+
266
+ interface _DeleteAgentResponseSuccess
267
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAgentResponse]
268
+ def agent_id: () -> ::String
269
+ def agent_status: () -> ("CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING")
270
+ end
271
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_agent-instance_method
272
+ def delete_agent: (
273
+ agent_id: ::String,
274
+ ?skip_resource_in_use_check: bool
275
+ ) -> _DeleteAgentResponseSuccess
276
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAgentResponseSuccess
277
+
278
+ interface _DeleteAgentActionGroupResponseSuccess
279
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAgentActionGroupResponse]
280
+ end
281
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_agent_action_group-instance_method
282
+ def delete_agent_action_group: (
283
+ agent_id: ::String,
284
+ agent_version: ::String,
285
+ action_group_id: ::String,
286
+ ?skip_resource_in_use_check: bool
287
+ ) -> _DeleteAgentActionGroupResponseSuccess
288
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAgentActionGroupResponseSuccess
289
+
290
+ interface _DeleteAgentAliasResponseSuccess
291
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAgentAliasResponse]
292
+ def agent_id: () -> ::String
293
+ def agent_alias_id: () -> ::String
294
+ def agent_alias_status: () -> ("CREATING" | "PREPARED" | "FAILED" | "UPDATING" | "DELETING")
295
+ end
296
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_agent_alias-instance_method
297
+ def delete_agent_alias: (
298
+ agent_id: ::String,
299
+ agent_alias_id: ::String
300
+ ) -> _DeleteAgentAliasResponseSuccess
301
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAgentAliasResponseSuccess
302
+
303
+ interface _DeleteAgentVersionResponseSuccess
304
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteAgentVersionResponse]
305
+ def agent_id: () -> ::String
306
+ def agent_version: () -> ::String
307
+ def agent_status: () -> ("CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING")
308
+ end
309
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_agent_version-instance_method
310
+ def delete_agent_version: (
311
+ agent_id: ::String,
312
+ agent_version: ::String,
313
+ ?skip_resource_in_use_check: bool
314
+ ) -> _DeleteAgentVersionResponseSuccess
315
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteAgentVersionResponseSuccess
316
+
317
+ interface _DeleteDataSourceResponseSuccess
318
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDataSourceResponse]
319
+ def knowledge_base_id: () -> ::String
320
+ def data_source_id: () -> ::String
321
+ def status: () -> ("AVAILABLE" | "DELETING")
322
+ end
323
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_data_source-instance_method
324
+ def delete_data_source: (
325
+ knowledge_base_id: ::String,
326
+ data_source_id: ::String
327
+ ) -> _DeleteDataSourceResponseSuccess
328
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDataSourceResponseSuccess
329
+
330
+ interface _DeleteKnowledgeBaseResponseSuccess
331
+ include ::Seahorse::Client::_ResponseSuccess[Types::DeleteKnowledgeBaseResponse]
332
+ def knowledge_base_id: () -> ::String
333
+ def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "UPDATING" | "FAILED")
334
+ end
335
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#delete_knowledge_base-instance_method
336
+ def delete_knowledge_base: (
337
+ knowledge_base_id: ::String
338
+ ) -> _DeleteKnowledgeBaseResponseSuccess
339
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteKnowledgeBaseResponseSuccess
340
+
341
+ interface _DisassociateAgentKnowledgeBaseResponseSuccess
342
+ include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateAgentKnowledgeBaseResponse]
343
+ end
344
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#disassociate_agent_knowledge_base-instance_method
345
+ def disassociate_agent_knowledge_base: (
346
+ agent_id: ::String,
347
+ agent_version: ::String,
348
+ knowledge_base_id: ::String
349
+ ) -> _DisassociateAgentKnowledgeBaseResponseSuccess
350
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateAgentKnowledgeBaseResponseSuccess
351
+
352
+ interface _GetAgentResponseSuccess
353
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAgentResponse]
354
+ def agent: () -> Types::Agent
355
+ end
356
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_agent-instance_method
357
+ def get_agent: (
358
+ agent_id: ::String
359
+ ) -> _GetAgentResponseSuccess
360
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAgentResponseSuccess
361
+
362
+ interface _GetAgentActionGroupResponseSuccess
363
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAgentActionGroupResponse]
364
+ def agent_action_group: () -> Types::AgentActionGroup
365
+ end
366
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_agent_action_group-instance_method
367
+ def get_agent_action_group: (
368
+ agent_id: ::String,
369
+ agent_version: ::String,
370
+ action_group_id: ::String
371
+ ) -> _GetAgentActionGroupResponseSuccess
372
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAgentActionGroupResponseSuccess
373
+
374
+ interface _GetAgentAliasResponseSuccess
375
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAgentAliasResponse]
376
+ def agent_alias: () -> Types::AgentAlias
377
+ end
378
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_agent_alias-instance_method
379
+ def get_agent_alias: (
380
+ agent_id: ::String,
381
+ agent_alias_id: ::String
382
+ ) -> _GetAgentAliasResponseSuccess
383
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAgentAliasResponseSuccess
384
+
385
+ interface _GetAgentKnowledgeBaseResponseSuccess
386
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAgentKnowledgeBaseResponse]
387
+ def agent_knowledge_base: () -> Types::AgentKnowledgeBase
388
+ end
389
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_agent_knowledge_base-instance_method
390
+ def get_agent_knowledge_base: (
391
+ agent_id: ::String,
392
+ agent_version: ::String,
393
+ knowledge_base_id: ::String
394
+ ) -> _GetAgentKnowledgeBaseResponseSuccess
395
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAgentKnowledgeBaseResponseSuccess
396
+
397
+ interface _GetAgentVersionResponseSuccess
398
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetAgentVersionResponse]
399
+ def agent_version: () -> Types::AgentVersion
400
+ end
401
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_agent_version-instance_method
402
+ def get_agent_version: (
403
+ agent_id: ::String,
404
+ agent_version: ::String
405
+ ) -> _GetAgentVersionResponseSuccess
406
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetAgentVersionResponseSuccess
407
+
408
+ interface _GetDataSourceResponseSuccess
409
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetDataSourceResponse]
410
+ def data_source: () -> Types::DataSource
411
+ end
412
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_data_source-instance_method
413
+ def get_data_source: (
414
+ knowledge_base_id: ::String,
415
+ data_source_id: ::String
416
+ ) -> _GetDataSourceResponseSuccess
417
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetDataSourceResponseSuccess
418
+
419
+ interface _GetIngestionJobResponseSuccess
420
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetIngestionJobResponse]
421
+ def ingestion_job: () -> Types::IngestionJob
422
+ end
423
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_ingestion_job-instance_method
424
+ def get_ingestion_job: (
425
+ knowledge_base_id: ::String,
426
+ data_source_id: ::String,
427
+ ingestion_job_id: ::String
428
+ ) -> _GetIngestionJobResponseSuccess
429
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetIngestionJobResponseSuccess
430
+
431
+ interface _GetKnowledgeBaseResponseSuccess
432
+ include ::Seahorse::Client::_ResponseSuccess[Types::GetKnowledgeBaseResponse]
433
+ def knowledge_base: () -> Types::KnowledgeBase
434
+ end
435
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#get_knowledge_base-instance_method
436
+ def get_knowledge_base: (
437
+ knowledge_base_id: ::String
438
+ ) -> _GetKnowledgeBaseResponseSuccess
439
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetKnowledgeBaseResponseSuccess
440
+
441
+ interface _ListAgentActionGroupsResponseSuccess
442
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAgentActionGroupsResponse]
443
+ def action_group_summaries: () -> ::Array[Types::ActionGroupSummary]
444
+ def next_token: () -> ::String
445
+ end
446
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_agent_action_groups-instance_method
447
+ def list_agent_action_groups: (
448
+ agent_id: ::String,
449
+ agent_version: ::String,
450
+ ?max_results: ::Integer,
451
+ ?next_token: ::String
452
+ ) -> _ListAgentActionGroupsResponseSuccess
453
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAgentActionGroupsResponseSuccess
454
+
455
+ interface _ListAgentAliasesResponseSuccess
456
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAgentAliasesResponse]
457
+ def agent_alias_summaries: () -> ::Array[Types::AgentAliasSummary]
458
+ def next_token: () -> ::String
459
+ end
460
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_agent_aliases-instance_method
461
+ def list_agent_aliases: (
462
+ agent_id: ::String,
463
+ ?max_results: ::Integer,
464
+ ?next_token: ::String
465
+ ) -> _ListAgentAliasesResponseSuccess
466
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAgentAliasesResponseSuccess
467
+
468
+ interface _ListAgentKnowledgeBasesResponseSuccess
469
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAgentKnowledgeBasesResponse]
470
+ def agent_knowledge_base_summaries: () -> ::Array[Types::AgentKnowledgeBaseSummary]
471
+ def next_token: () -> ::String
472
+ end
473
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_agent_knowledge_bases-instance_method
474
+ def list_agent_knowledge_bases: (
475
+ agent_id: ::String,
476
+ agent_version: ::String,
477
+ ?max_results: ::Integer,
478
+ ?next_token: ::String
479
+ ) -> _ListAgentKnowledgeBasesResponseSuccess
480
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAgentKnowledgeBasesResponseSuccess
481
+
482
+ interface _ListAgentVersionsResponseSuccess
483
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAgentVersionsResponse]
484
+ def agent_version_summaries: () -> ::Array[Types::AgentVersionSummary]
485
+ def next_token: () -> ::String
486
+ end
487
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_agent_versions-instance_method
488
+ def list_agent_versions: (
489
+ agent_id: ::String,
490
+ ?max_results: ::Integer,
491
+ ?next_token: ::String
492
+ ) -> _ListAgentVersionsResponseSuccess
493
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAgentVersionsResponseSuccess
494
+
495
+ interface _ListAgentsResponseSuccess
496
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListAgentsResponse]
497
+ def agent_summaries: () -> ::Array[Types::AgentSummary]
498
+ def next_token: () -> ::String
499
+ end
500
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_agents-instance_method
501
+ def list_agents: (
502
+ ?max_results: ::Integer,
503
+ ?next_token: ::String
504
+ ) -> _ListAgentsResponseSuccess
505
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAgentsResponseSuccess
506
+
507
+ interface _ListDataSourcesResponseSuccess
508
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListDataSourcesResponse]
509
+ def data_source_summaries: () -> ::Array[Types::DataSourceSummary]
510
+ def next_token: () -> ::String
511
+ end
512
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_data_sources-instance_method
513
+ def list_data_sources: (
514
+ knowledge_base_id: ::String,
515
+ ?max_results: ::Integer,
516
+ ?next_token: ::String
517
+ ) -> _ListDataSourcesResponseSuccess
518
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDataSourcesResponseSuccess
519
+
520
+ interface _ListIngestionJobsResponseSuccess
521
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListIngestionJobsResponse]
522
+ def ingestion_job_summaries: () -> ::Array[Types::IngestionJobSummary]
523
+ def next_token: () -> ::String
524
+ end
525
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_ingestion_jobs-instance_method
526
+ def list_ingestion_jobs: (
527
+ knowledge_base_id: ::String,
528
+ data_source_id: ::String,
529
+ ?filters: Array[
530
+ {
531
+ attribute: ("STATUS"),
532
+ operator: ("EQ"),
533
+ values: Array[::String]
534
+ },
535
+ ],
536
+ ?sort_by: {
537
+ attribute: ("STATUS" | "STARTED_AT"),
538
+ order: ("ASCENDING" | "DESCENDING")
539
+ },
540
+ ?max_results: ::Integer,
541
+ ?next_token: ::String
542
+ ) -> _ListIngestionJobsResponseSuccess
543
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListIngestionJobsResponseSuccess
544
+
545
+ interface _ListKnowledgeBasesResponseSuccess
546
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListKnowledgeBasesResponse]
547
+ def knowledge_base_summaries: () -> ::Array[Types::KnowledgeBaseSummary]
548
+ def next_token: () -> ::String
549
+ end
550
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_knowledge_bases-instance_method
551
+ def list_knowledge_bases: (
552
+ ?max_results: ::Integer,
553
+ ?next_token: ::String
554
+ ) -> _ListKnowledgeBasesResponseSuccess
555
+ | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListKnowledgeBasesResponseSuccess
556
+
557
+ interface _ListTagsForResourceResponseSuccess
558
+ include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
559
+ def tags: () -> ::Hash[::String, ::String]
560
+ end
561
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#list_tags_for_resource-instance_method
562
+ def list_tags_for_resource: (
563
+ resource_arn: ::String
564
+ ) -> _ListTagsForResourceResponseSuccess
565
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
566
+
567
+ interface _PrepareAgentResponseSuccess
568
+ include ::Seahorse::Client::_ResponseSuccess[Types::PrepareAgentResponse]
569
+ def agent_id: () -> ::String
570
+ def agent_status: () -> ("CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING")
571
+ def agent_version: () -> ::String
572
+ def prepared_at: () -> ::Time
573
+ end
574
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#prepare_agent-instance_method
575
+ def prepare_agent: (
576
+ agent_id: ::String
577
+ ) -> _PrepareAgentResponseSuccess
578
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PrepareAgentResponseSuccess
579
+
580
+ interface _StartIngestionJobResponseSuccess
581
+ include ::Seahorse::Client::_ResponseSuccess[Types::StartIngestionJobResponse]
582
+ def ingestion_job: () -> Types::IngestionJob
583
+ end
584
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#start_ingestion_job-instance_method
585
+ def start_ingestion_job: (
586
+ knowledge_base_id: ::String,
587
+ data_source_id: ::String,
588
+ ?client_token: ::String,
589
+ ?description: ::String
590
+ ) -> _StartIngestionJobResponseSuccess
591
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartIngestionJobResponseSuccess
592
+
593
+ interface _TagResourceResponseSuccess
594
+ include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
595
+ end
596
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#tag_resource-instance_method
597
+ def tag_resource: (
598
+ resource_arn: ::String,
599
+ tags: Hash[::String, ::String]
600
+ ) -> _TagResourceResponseSuccess
601
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
602
+
603
+ interface _UntagResourceResponseSuccess
604
+ include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
605
+ end
606
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#untag_resource-instance_method
607
+ def untag_resource: (
608
+ resource_arn: ::String,
609
+ tag_keys: Array[::String]
610
+ ) -> _UntagResourceResponseSuccess
611
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
612
+
613
+ interface _UpdateAgentResponseSuccess
614
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAgentResponse]
615
+ def agent: () -> Types::Agent
616
+ end
617
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_agent-instance_method
618
+ def update_agent: (
619
+ agent_id: ::String,
620
+ agent_name: ::String,
621
+ ?instruction: ::String,
622
+ ?foundation_model: ::String,
623
+ ?description: ::String,
624
+ ?idle_session_ttl_in_seconds: ::Integer,
625
+ agent_resource_role_arn: ::String,
626
+ ?customer_encryption_key_arn: ::String,
627
+ ?prompt_override_configuration: {
628
+ prompt_configurations: Array[
629
+ {
630
+ prompt_type: ("PRE_PROCESSING" | "ORCHESTRATION" | "POST_PROCESSING" | "KNOWLEDGE_BASE_RESPONSE_GENERATION")?,
631
+ prompt_creation_mode: ("DEFAULT" | "OVERRIDDEN")?,
632
+ prompt_state: ("ENABLED" | "DISABLED")?,
633
+ base_prompt_template: ::String?,
634
+ inference_configuration: {
635
+ temperature: ::Float?,
636
+ top_p: ::Float?,
637
+ top_k: ::Integer?,
638
+ maximum_length: ::Integer?,
639
+ stop_sequences: Array[::String]?
640
+ }?,
641
+ parser_mode: ("DEFAULT" | "OVERRIDDEN")?
642
+ },
643
+ ],
644
+ override_lambda: ::String?
645
+ }
646
+ ) -> _UpdateAgentResponseSuccess
647
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgentResponseSuccess
648
+
649
+ interface _UpdateAgentActionGroupResponseSuccess
650
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAgentActionGroupResponse]
651
+ def agent_action_group: () -> Types::AgentActionGroup
652
+ end
653
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_agent_action_group-instance_method
654
+ def update_agent_action_group: (
655
+ agent_id: ::String,
656
+ agent_version: ::String,
657
+ action_group_id: ::String,
658
+ action_group_name: ::String,
659
+ ?description: ::String,
660
+ ?parent_action_group_signature: ("AMAZON.UserInput"),
661
+ ?action_group_executor: {
662
+ lambda: ::String?
663
+ },
664
+ ?action_group_state: ("ENABLED" | "DISABLED"),
665
+ ?api_schema: {
666
+ s3: {
667
+ s3_bucket_name: ::String?,
668
+ s3_object_key: ::String?
669
+ }?,
670
+ payload: ::String?
671
+ }
672
+ ) -> _UpdateAgentActionGroupResponseSuccess
673
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgentActionGroupResponseSuccess
674
+
675
+ interface _UpdateAgentAliasResponseSuccess
676
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAgentAliasResponse]
677
+ def agent_alias: () -> Types::AgentAlias
678
+ end
679
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_agent_alias-instance_method
680
+ def update_agent_alias: (
681
+ agent_id: ::String,
682
+ agent_alias_id: ::String,
683
+ agent_alias_name: ::String,
684
+ ?description: ::String,
685
+ ?routing_configuration: Array[
686
+ {
687
+ agent_version: ::String
688
+ },
689
+ ]
690
+ ) -> _UpdateAgentAliasResponseSuccess
691
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgentAliasResponseSuccess
692
+
693
+ interface _UpdateAgentKnowledgeBaseResponseSuccess
694
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateAgentKnowledgeBaseResponse]
695
+ def agent_knowledge_base: () -> Types::AgentKnowledgeBase
696
+ end
697
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_agent_knowledge_base-instance_method
698
+ def update_agent_knowledge_base: (
699
+ agent_id: ::String,
700
+ agent_version: ::String,
701
+ knowledge_base_id: ::String,
702
+ ?description: ::String,
703
+ ?knowledge_base_state: ("ENABLED" | "DISABLED")
704
+ ) -> _UpdateAgentKnowledgeBaseResponseSuccess
705
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateAgentKnowledgeBaseResponseSuccess
706
+
707
+ interface _UpdateDataSourceResponseSuccess
708
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateDataSourceResponse]
709
+ def data_source: () -> Types::DataSource
710
+ end
711
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_data_source-instance_method
712
+ def update_data_source: (
713
+ knowledge_base_id: ::String,
714
+ data_source_id: ::String,
715
+ name: ::String,
716
+ ?description: ::String,
717
+ data_source_configuration: {
718
+ type: ("S3"),
719
+ s3_configuration: {
720
+ bucket_arn: ::String,
721
+ inclusion_prefixes: Array[::String]?
722
+ }?
723
+ },
724
+ ?server_side_encryption_configuration: {
725
+ kms_key_arn: ::String?
726
+ },
727
+ ?vector_ingestion_configuration: {
728
+ chunking_configuration: {
729
+ chunking_strategy: ("FIXED_SIZE" | "NONE"),
730
+ fixed_size_chunking_configuration: {
731
+ max_tokens: ::Integer,
732
+ overlap_percentage: ::Integer
733
+ }?
734
+ }?
735
+ }
736
+ ) -> _UpdateDataSourceResponseSuccess
737
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDataSourceResponseSuccess
738
+
739
+ interface _UpdateKnowledgeBaseResponseSuccess
740
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateKnowledgeBaseResponse]
741
+ def knowledge_base: () -> Types::KnowledgeBase
742
+ end
743
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/BedrockAgent/Client.html#update_knowledge_base-instance_method
744
+ def update_knowledge_base: (
745
+ knowledge_base_id: ::String,
746
+ name: ::String,
747
+ ?description: ::String,
748
+ role_arn: ::String,
749
+ knowledge_base_configuration: {
750
+ type: ("VECTOR"),
751
+ vector_knowledge_base_configuration: {
752
+ embedding_model_arn: ::String
753
+ }?
754
+ },
755
+ storage_configuration: {
756
+ type: ("OPENSEARCH_SERVERLESS" | "PINECONE" | "REDIS_ENTERPRISE_CLOUD" | "RDS"),
757
+ opensearch_serverless_configuration: {
758
+ collection_arn: ::String,
759
+ vector_index_name: ::String,
760
+ field_mapping: {
761
+ vector_field: ::String,
762
+ text_field: ::String,
763
+ metadata_field: ::String
764
+ }
765
+ }?,
766
+ pinecone_configuration: {
767
+ connection_string: ::String,
768
+ credentials_secret_arn: ::String,
769
+ namespace: ::String?,
770
+ field_mapping: {
771
+ text_field: ::String,
772
+ metadata_field: ::String
773
+ }
774
+ }?,
775
+ redis_enterprise_cloud_configuration: {
776
+ endpoint: ::String,
777
+ vector_index_name: ::String,
778
+ credentials_secret_arn: ::String,
779
+ field_mapping: {
780
+ vector_field: ::String,
781
+ text_field: ::String,
782
+ metadata_field: ::String
783
+ }
784
+ }?,
785
+ rds_configuration: {
786
+ resource_arn: ::String,
787
+ credentials_secret_arn: ::String,
788
+ database_name: ::String,
789
+ table_name: ::String,
790
+ field_mapping: {
791
+ primary_key_field: ::String,
792
+ vector_field: ::String,
793
+ text_field: ::String,
794
+ metadata_field: ::String
795
+ }
796
+ }?
797
+ }
798
+ ) -> _UpdateKnowledgeBaseResponseSuccess
799
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateKnowledgeBaseResponseSuccess
800
+ end
801
+ end
802
+ end
803
+