aws-sdk-bedrockagent 1.3.0 → 1.5.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagent/client.rb +1004 -648
- data/lib/aws-sdk-bedrockagent/client_api.rb +142 -140
- data/lib/aws-sdk-bedrockagent/errors.rb +4 -4
- data/lib/aws-sdk-bedrockagent/types.rb +1605 -1079
- data/lib/aws-sdk-bedrockagent.rb +1 -1
- data/sig/client.rbs +137 -137
- data/sig/errors.rbs +1 -1
- data/sig/types.rbs +143 -141
- metadata +2 -2
@@ -388,22 +388,33 @@ module Aws::BedrockAgent
|
|
388
388
|
|
389
389
|
# @!group API Operations
|
390
390
|
|
391
|
-
#
|
391
|
+
# Associates a knowledge base with an agent. If a knowledge base is
|
392
|
+
# associated and its `indexState` is set to `Enabled`, the agent queries
|
393
|
+
# the knowledge base for information to augment its response to the
|
394
|
+
# user.
|
392
395
|
#
|
393
396
|
# @option params [required, String] :agent_id
|
394
|
-
#
|
397
|
+
# The unique identifier of the agent with which you want to associate
|
398
|
+
# the knowledge base.
|
395
399
|
#
|
396
400
|
# @option params [required, String] :agent_version
|
397
|
-
#
|
398
|
-
#
|
399
|
-
# @option params [required, String] :knowledge_base_id
|
400
|
-
# Identifier for a resource.
|
401
|
+
# The version of the agent with which you want to associate the
|
402
|
+
# knowledge base.
|
401
403
|
#
|
402
404
|
# @option params [required, String] :description
|
403
|
-
#
|
405
|
+
# A description of what the agent should use the knowledge base for.
|
406
|
+
#
|
407
|
+
# @option params [required, String] :knowledge_base_id
|
408
|
+
# The unique identifier of the knowledge base to associate with the
|
409
|
+
# agent.
|
404
410
|
#
|
405
411
|
# @option params [String] :knowledge_base_state
|
406
|
-
#
|
412
|
+
# Specifies whether to use the knowledge base or not when sending an
|
413
|
+
# [InvokeAgent][1] request.
|
414
|
+
#
|
415
|
+
#
|
416
|
+
#
|
417
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
407
418
|
#
|
408
419
|
# @return [Types::AssociateAgentKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
409
420
|
#
|
@@ -414,8 +425,8 @@ module Aws::BedrockAgent
|
|
414
425
|
# resp = client.associate_agent_knowledge_base({
|
415
426
|
# agent_id: "Id", # required
|
416
427
|
# agent_version: "DraftVersion", # required
|
417
|
-
# knowledge_base_id: "Id", # required
|
418
428
|
# description: "Description", # required
|
429
|
+
# knowledge_base_id: "Id", # required
|
419
430
|
# knowledge_base_state: "ENABLED", # accepts ENABLED, DISABLED
|
420
431
|
# })
|
421
432
|
#
|
@@ -423,11 +434,11 @@ module Aws::BedrockAgent
|
|
423
434
|
#
|
424
435
|
# resp.agent_knowledge_base.agent_id #=> String
|
425
436
|
# resp.agent_knowledge_base.agent_version #=> String
|
426
|
-
# resp.agent_knowledge_base.knowledge_base_id #=> String
|
427
|
-
# resp.agent_knowledge_base.description #=> String
|
428
437
|
# resp.agent_knowledge_base.created_at #=> Time
|
429
|
-
# resp.agent_knowledge_base.
|
438
|
+
# resp.agent_knowledge_base.description #=> String
|
439
|
+
# resp.agent_knowledge_base.knowledge_base_id #=> String
|
430
440
|
# resp.agent_knowledge_base.knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
|
441
|
+
# resp.agent_knowledge_base.updated_at #=> Time
|
431
442
|
#
|
432
443
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AssociateAgentKnowledgeBase AWS API Documentation
|
433
444
|
#
|
@@ -438,40 +449,88 @@ module Aws::BedrockAgent
|
|
438
449
|
req.send_request(options)
|
439
450
|
end
|
440
451
|
|
441
|
-
# Creates an
|
452
|
+
# Creates an agent that orchestrates interactions between foundation
|
453
|
+
# models, data sources, software applications, user conversations, and
|
454
|
+
# APIs to carry out tasks to help customers.
|
455
|
+
#
|
456
|
+
# * Specify the following fields for security purposes.
|
457
|
+
#
|
458
|
+
# * `agentResourceRoleArn` – The Amazon Resource Name (ARN) of the
|
459
|
+
# role with permissions to invoke API operations on an agent.
|
460
|
+
#
|
461
|
+
# * (Optional) `customerEncryptionKeyArn` – The Amazon Resource Name
|
462
|
+
# (ARN) of a KMS key to encrypt the creation of the agent.
|
463
|
+
#
|
464
|
+
# * (Optional) `idleSessionTTLinSeconds` – Specify the number of
|
465
|
+
# seconds for which the agent should maintain session information.
|
466
|
+
# After this time expires, the subsequent `InvokeAgent` request
|
467
|
+
# begins a new session.
|
468
|
+
#
|
469
|
+
# * To override the default prompt behavior for agent orchestration and
|
470
|
+
# to use advanced prompts, include a `promptOverrideConfiguration`
|
471
|
+
# object. For more information, see [Advanced prompts][1].
|
472
|
+
#
|
473
|
+
# * If you agent fails to be created, the response returns a list of
|
474
|
+
# `failureReasons` alongside a list of `recommendedActions` for you to
|
475
|
+
# troubleshoot.
|
476
|
+
#
|
477
|
+
#
|
478
|
+
#
|
479
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
442
480
|
#
|
443
481
|
# @option params [required, String] :agent_name
|
444
|
-
#
|
482
|
+
# A name for the agent that you create.
|
483
|
+
#
|
484
|
+
# @option params [String] :agent_resource_role_arn
|
485
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
486
|
+
# invoke API operations on the agent.
|
445
487
|
#
|
446
488
|
# @option params [String] :client_token
|
447
|
-
#
|
489
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
490
|
+
# completes no more than one time. If this token matches a previous
|
491
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
492
|
+
# error. For more information, see [Ensuring idempotency][1].
|
448
493
|
#
|
449
494
|
# **A suitable default value is auto-generated.** You should normally
|
450
495
|
# not need to pass this option.**
|
451
496
|
#
|
452
|
-
# @option params [String] :instruction
|
453
|
-
# Instruction for the agent.
|
454
497
|
#
|
455
|
-
#
|
456
|
-
#
|
498
|
+
#
|
499
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
500
|
+
#
|
501
|
+
# @option params [String] :customer_encryption_key_arn
|
502
|
+
# The Amazon Resource Name (ARN) of the KMS key with which to encrypt
|
503
|
+
# the agent.
|
457
504
|
#
|
458
505
|
# @option params [String] :description
|
459
|
-
#
|
506
|
+
# A description of the agent.
|
460
507
|
#
|
461
|
-
# @option params [
|
462
|
-
#
|
508
|
+
# @option params [String] :foundation_model
|
509
|
+
# The foundation model to be used for orchestration by the agent you
|
510
|
+
# create.
|
463
511
|
#
|
464
|
-
# @option params [
|
465
|
-
#
|
512
|
+
# @option params [Integer] :idle_session_ttl_in_seconds
|
513
|
+
# The number of seconds for which Amazon Bedrock keeps information about
|
514
|
+
# a user's conversation with the agent.
|
466
515
|
#
|
467
|
-
#
|
468
|
-
#
|
516
|
+
# A user interaction remains active for the amount of time specified. If
|
517
|
+
# no conversation occurs during this time, the session expires and
|
518
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
469
519
|
#
|
470
|
-
# @option params [
|
471
|
-
#
|
520
|
+
# @option params [String] :instruction
|
521
|
+
# Instructions that tell the agent what it should do and how it should
|
522
|
+
# interact with users.
|
472
523
|
#
|
473
524
|
# @option params [Types::PromptOverrideConfiguration] :prompt_override_configuration
|
474
|
-
#
|
525
|
+
# Contains configurations to override prompts in different parts of an
|
526
|
+
# agent sequence. For more information, see [Advanced prompts][1].
|
527
|
+
#
|
528
|
+
#
|
529
|
+
#
|
530
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
531
|
+
#
|
532
|
+
# @option params [Hash<String,String>] :tags
|
533
|
+
# Any tags that you want to attach to the agent.
|
475
534
|
#
|
476
535
|
# @return [Types::CreateAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
477
536
|
#
|
@@ -481,71 +540,71 @@ module Aws::BedrockAgent
|
|
481
540
|
#
|
482
541
|
# resp = client.create_agent({
|
483
542
|
# agent_name: "Name", # required
|
543
|
+
# agent_resource_role_arn: "AgentRoleArn",
|
484
544
|
# client_token: "ClientToken",
|
485
|
-
#
|
486
|
-
# foundation_model: "ModelIdentifier",
|
545
|
+
# customer_encryption_key_arn: "KmsKeyArn",
|
487
546
|
# description: "Description",
|
547
|
+
# foundation_model: "ModelIdentifier",
|
488
548
|
# idle_session_ttl_in_seconds: 1,
|
489
|
-
#
|
490
|
-
# customer_encryption_key_arn: "KmsKeyArn",
|
491
|
-
# tags: {
|
492
|
-
# "TagKey" => "TagValue",
|
493
|
-
# },
|
549
|
+
# instruction: "Instruction",
|
494
550
|
# prompt_override_configuration: {
|
551
|
+
# override_lambda: "LambdaArn",
|
495
552
|
# prompt_configurations: [ # required
|
496
553
|
# {
|
497
|
-
# prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, KNOWLEDGE_BASE_RESPONSE_GENERATION
|
498
|
-
# prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
|
499
|
-
# prompt_state: "ENABLED", # accepts ENABLED, DISABLED
|
500
554
|
# base_prompt_template: "BasePromptTemplate",
|
501
555
|
# inference_configuration: {
|
502
|
-
# temperature: 1.0,
|
503
|
-
# top_p: 1.0,
|
504
|
-
# top_k: 1,
|
505
556
|
# maximum_length: 1,
|
506
557
|
# stop_sequences: ["String"],
|
558
|
+
# temperature: 1.0,
|
559
|
+
# top_k: 1,
|
560
|
+
# top_p: 1.0,
|
507
561
|
# },
|
508
562
|
# parser_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
|
563
|
+
# prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
|
564
|
+
# prompt_state: "ENABLED", # accepts ENABLED, DISABLED
|
565
|
+
# prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, KNOWLEDGE_BASE_RESPONSE_GENERATION
|
509
566
|
# },
|
510
567
|
# ],
|
511
|
-
#
|
568
|
+
# },
|
569
|
+
# tags: {
|
570
|
+
# "TagKey" => "TagValue",
|
512
571
|
# },
|
513
572
|
# })
|
514
573
|
#
|
515
574
|
# @example Response structure
|
516
575
|
#
|
576
|
+
# resp.agent.agent_arn #=> String
|
517
577
|
# resp.agent.agent_id #=> String
|
518
578
|
# resp.agent.agent_name #=> String
|
519
|
-
# resp.agent.
|
579
|
+
# resp.agent.agent_resource_role_arn #=> String
|
580
|
+
# resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
520
581
|
# resp.agent.agent_version #=> String
|
521
582
|
# resp.agent.client_token #=> String
|
522
|
-
# resp.agent.instruction #=> String
|
523
|
-
# resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
524
|
-
# resp.agent.foundation_model #=> String
|
525
|
-
# resp.agent.description #=> String
|
526
|
-
# resp.agent.idle_session_ttl_in_seconds #=> Integer
|
527
|
-
# resp.agent.agent_resource_role_arn #=> String
|
528
|
-
# resp.agent.customer_encryption_key_arn #=> String
|
529
583
|
# resp.agent.created_at #=> Time
|
530
|
-
# resp.agent.
|
531
|
-
# resp.agent.
|
584
|
+
# resp.agent.customer_encryption_key_arn #=> String
|
585
|
+
# resp.agent.description #=> String
|
532
586
|
# resp.agent.failure_reasons #=> Array
|
533
587
|
# resp.agent.failure_reasons[0] #=> String
|
534
|
-
# resp.agent.
|
535
|
-
# resp.agent.
|
588
|
+
# resp.agent.foundation_model #=> String
|
589
|
+
# resp.agent.idle_session_ttl_in_seconds #=> Integer
|
590
|
+
# resp.agent.instruction #=> String
|
591
|
+
# resp.agent.prepared_at #=> Time
|
592
|
+
# resp.agent.prompt_override_configuration.override_lambda #=> String
|
536
593
|
# resp.agent.prompt_override_configuration.prompt_configurations #=> Array
|
537
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
538
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
539
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
540
594
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
|
541
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
542
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
543
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
544
595
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
|
545
596
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
|
546
597
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
|
598
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
599
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
600
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
547
601
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
548
|
-
# resp.agent.prompt_override_configuration.
|
602
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
603
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
604
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
605
|
+
# resp.agent.recommended_actions #=> Array
|
606
|
+
# resp.agent.recommended_actions[0] #=> String
|
607
|
+
# resp.agent.updated_at #=> Time
|
549
608
|
#
|
550
609
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgent AWS API Documentation
|
551
610
|
#
|
@@ -556,37 +615,86 @@ module Aws::BedrockAgent
|
|
556
615
|
req.send_request(options)
|
557
616
|
end
|
558
617
|
|
559
|
-
# Creates an
|
618
|
+
# Creates an action group for an agent. An action group represents the
|
619
|
+
# actions that an agent can carry out for the customer by defining the
|
620
|
+
# APIs that an agent can call and the logic for calling them.
|
621
|
+
#
|
622
|
+
# To allow your agent to request the user for additional information
|
623
|
+
# when trying to complete a task, add an action group with the
|
624
|
+
# `parentActionGroupSignature` field set to `AMAZON.UserInput`. You must
|
625
|
+
# leave the `description`, `apiSchema`, and `actionGroupExecutor` fields
|
626
|
+
# blank for this action group. During orchestration, if your agent
|
627
|
+
# determines that it needs to invoke an API in an action group, but
|
628
|
+
# doesn't have enough information to complete the API request, it will
|
629
|
+
# invoke this action group instead and return an [Observation][1]
|
630
|
+
# reprompting the user for more information.
|
631
|
+
#
|
632
|
+
#
|
633
|
+
#
|
634
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
|
635
|
+
#
|
636
|
+
# @option params [Types::ActionGroupExecutor] :action_group_executor
|
637
|
+
# The Amazon Resource Name (ARN) of the Lambda function containing the
|
638
|
+
# business logic that is carried out upon invoking the action.
|
639
|
+
#
|
640
|
+
# @option params [required, String] :action_group_name
|
641
|
+
# The name to give the action group.
|
642
|
+
#
|
643
|
+
# @option params [String] :action_group_state
|
644
|
+
# Specifies whether the action group is available for the agent to
|
645
|
+
# invoke or not when sending an [InvokeAgent][1] request.
|
646
|
+
#
|
647
|
+
#
|
648
|
+
#
|
649
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
560
650
|
#
|
561
651
|
# @option params [required, String] :agent_id
|
562
|
-
#
|
652
|
+
# The unique identifier of the agent for which to create the action
|
653
|
+
# group.
|
563
654
|
#
|
564
655
|
# @option params [required, String] :agent_version
|
565
|
-
#
|
656
|
+
# The version of the agent for which to create the action group.
|
657
|
+
#
|
658
|
+
# @option params [Types::APISchema] :api_schema
|
659
|
+
# Contains either details about the S3 object containing the OpenAPI
|
660
|
+
# schema for the action group or the JSON or YAML-formatted payload
|
661
|
+
# defining the schema. For more information, see [Action group OpenAPI
|
662
|
+
# schemas][1].
|
663
|
+
#
|
566
664
|
#
|
567
|
-
#
|
568
|
-
#
|
665
|
+
#
|
666
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
569
667
|
#
|
570
668
|
# @option params [String] :client_token
|
571
|
-
#
|
669
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
670
|
+
# completes no more than one time. If this token matches a previous
|
671
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
672
|
+
# error. For more information, see [Ensuring idempotency][1].
|
572
673
|
#
|
573
674
|
# **A suitable default value is auto-generated.** You should normally
|
574
675
|
# not need to pass this option.**
|
575
676
|
#
|
677
|
+
#
|
678
|
+
#
|
679
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
680
|
+
#
|
576
681
|
# @option params [String] :description
|
577
|
-
#
|
682
|
+
# A description of the action group.
|
578
683
|
#
|
579
684
|
# @option params [String] :parent_action_group_signature
|
580
|
-
#
|
685
|
+
# To allow your agent to request the user for additional information
|
686
|
+
# when trying to complete a task, set this field to `AMAZON.UserInput`.
|
687
|
+
# You must leave the `description`, `apiSchema`, and
|
688
|
+
# `actionGroupExecutor` fields blank for this action group.
|
581
689
|
#
|
582
|
-
#
|
583
|
-
#
|
690
|
+
# During orchestration, if your agent determines that it needs to invoke
|
691
|
+
# an API in an action group, but doesn't have enough information to
|
692
|
+
# complete the API request, it will invoke this action group instead and
|
693
|
+
# return an [Observation][1] reprompting the user for more information.
|
584
694
|
#
|
585
|
-
# @option params [Types::APISchema] :api_schema
|
586
|
-
# Contains information about the API Schema for the Action Group
|
587
695
|
#
|
588
|
-
#
|
589
|
-
#
|
696
|
+
#
|
697
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
|
590
698
|
#
|
591
699
|
# @return [Types::CreateAgentActionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
592
700
|
#
|
@@ -595,41 +703,41 @@ module Aws::BedrockAgent
|
|
595
703
|
# @example Request syntax with placeholder values
|
596
704
|
#
|
597
705
|
# resp = client.create_agent_action_group({
|
598
|
-
# agent_id: "Id", # required
|
599
|
-
# agent_version: "DraftVersion", # required
|
600
|
-
# action_group_name: "Name", # required
|
601
|
-
# client_token: "ClientToken",
|
602
|
-
# description: "Description",
|
603
|
-
# parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
|
604
706
|
# action_group_executor: {
|
605
707
|
# lambda: "LambdaArn",
|
606
708
|
# },
|
709
|
+
# action_group_name: "Name", # required
|
710
|
+
# action_group_state: "ENABLED", # accepts ENABLED, DISABLED
|
711
|
+
# agent_id: "Id", # required
|
712
|
+
# agent_version: "DraftVersion", # required
|
607
713
|
# api_schema: {
|
714
|
+
# payload: "Payload",
|
608
715
|
# s3: {
|
609
716
|
# s3_bucket_name: "S3BucketName",
|
610
717
|
# s3_object_key: "S3ObjectKey",
|
611
718
|
# },
|
612
|
-
# payload: "Payload",
|
613
719
|
# },
|
614
|
-
#
|
720
|
+
# client_token: "ClientToken",
|
721
|
+
# description: "Description",
|
722
|
+
# parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
|
615
723
|
# })
|
616
724
|
#
|
617
725
|
# @example Response structure
|
618
726
|
#
|
619
|
-
# resp.agent_action_group.
|
620
|
-
# resp.agent_action_group.agent_version #=> String
|
727
|
+
# resp.agent_action_group.action_group_executor.lambda #=> String
|
621
728
|
# resp.agent_action_group.action_group_id #=> String
|
622
729
|
# resp.agent_action_group.action_group_name #=> String
|
730
|
+
# resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
|
731
|
+
# resp.agent_action_group.agent_id #=> String
|
732
|
+
# resp.agent_action_group.agent_version #=> String
|
733
|
+
# resp.agent_action_group.api_schema.payload #=> String
|
734
|
+
# resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
|
735
|
+
# resp.agent_action_group.api_schema.s3.s3_object_key #=> String
|
623
736
|
# resp.agent_action_group.client_token #=> String
|
624
|
-
# resp.agent_action_group.description #=> String
|
625
737
|
# resp.agent_action_group.created_at #=> Time
|
626
|
-
# resp.agent_action_group.
|
738
|
+
# resp.agent_action_group.description #=> String
|
627
739
|
# resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
|
628
|
-
# resp.agent_action_group.
|
629
|
-
# resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
|
630
|
-
# resp.agent_action_group.api_schema.s3.s3_object_key #=> String
|
631
|
-
# resp.agent_action_group.api_schema.payload #=> String
|
632
|
-
# resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
|
740
|
+
# resp.agent_action_group.updated_at #=> Time
|
633
741
|
#
|
634
742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroup AWS API Documentation
|
635
743
|
#
|
@@ -640,28 +748,35 @@ module Aws::BedrockAgent
|
|
640
748
|
req.send_request(options)
|
641
749
|
end
|
642
750
|
|
643
|
-
# Creates an
|
644
|
-
#
|
645
|
-
# @option params [required, String] :agent_id
|
646
|
-
# Id generated at the server side when an Agent is created
|
751
|
+
# Creates an alias of an agent that can be used to deploy the agent.
|
647
752
|
#
|
648
753
|
# @option params [required, String] :agent_alias_name
|
649
|
-
#
|
754
|
+
# The name of the alias.
|
755
|
+
#
|
756
|
+
# @option params [required, String] :agent_id
|
757
|
+
# The unique identifier of the agent.
|
650
758
|
#
|
651
759
|
# @option params [String] :client_token
|
652
|
-
#
|
760
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
761
|
+
# completes no more than one time. If this token matches a previous
|
762
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
763
|
+
# error. For more information, see [Ensuring idempotency][1].
|
653
764
|
#
|
654
765
|
# **A suitable default value is auto-generated.** You should normally
|
655
766
|
# not need to pass this option.**
|
656
767
|
#
|
768
|
+
#
|
769
|
+
#
|
770
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
771
|
+
#
|
657
772
|
# @option params [String] :description
|
658
|
-
#
|
773
|
+
# A description of the alias of the agent.
|
659
774
|
#
|
660
775
|
# @option params [Array<Types::AgentAliasRoutingConfigurationListItem>] :routing_configuration
|
661
|
-
#
|
776
|
+
# Contains details about the routing configuration of the alias.
|
662
777
|
#
|
663
778
|
# @option params [Hash<String,String>] :tags
|
664
|
-
#
|
779
|
+
# Any tags that you want to attach to the alias of the agent.
|
665
780
|
#
|
666
781
|
# @return [Types::CreateAgentAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
667
782
|
#
|
@@ -670,8 +785,8 @@ module Aws::BedrockAgent
|
|
670
785
|
# @example Request syntax with placeholder values
|
671
786
|
#
|
672
787
|
# resp = client.create_agent_alias({
|
673
|
-
# agent_id: "Id", # required
|
674
788
|
# agent_alias_name: "Name", # required
|
789
|
+
# agent_id: "Id", # required
|
675
790
|
# client_token: "ClientToken",
|
676
791
|
# description: "Description",
|
677
792
|
# routing_configuration: [
|
@@ -686,22 +801,22 @@ module Aws::BedrockAgent
|
|
686
801
|
#
|
687
802
|
# @example Response structure
|
688
803
|
#
|
689
|
-
# resp.agent_alias.
|
804
|
+
# resp.agent_alias.agent_alias_arn #=> String
|
805
|
+
# resp.agent_alias.agent_alias_history_events #=> Array
|
806
|
+
# resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
|
807
|
+
# resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
|
808
|
+
# resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
|
809
|
+
# resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
|
690
810
|
# resp.agent_alias.agent_alias_id #=> String
|
691
811
|
# resp.agent_alias.agent_alias_name #=> String
|
692
|
-
# resp.agent_alias.
|
812
|
+
# resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
813
|
+
# resp.agent_alias.agent_id #=> String
|
693
814
|
# resp.agent_alias.client_token #=> String
|
815
|
+
# resp.agent_alias.created_at #=> Time
|
694
816
|
# resp.agent_alias.description #=> String
|
695
817
|
# resp.agent_alias.routing_configuration #=> Array
|
696
818
|
# resp.agent_alias.routing_configuration[0].agent_version #=> String
|
697
|
-
# resp.agent_alias.created_at #=> Time
|
698
819
|
# resp.agent_alias.updated_at #=> Time
|
699
|
-
# resp.agent_alias.agent_alias_history_events #=> Array
|
700
|
-
# resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
|
701
|
-
# resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
|
702
|
-
# resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
|
703
|
-
# resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
|
704
|
-
# resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
705
820
|
#
|
706
821
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentAlias AWS API Documentation
|
707
822
|
#
|
@@ -712,31 +827,42 @@ module Aws::BedrockAgent
|
|
712
827
|
req.send_request(options)
|
713
828
|
end
|
714
829
|
|
715
|
-
#
|
830
|
+
# Sets up a data source to be added to a knowledge base.
|
716
831
|
#
|
717
|
-
#
|
718
|
-
#
|
832
|
+
# You can't change the `chunkingConfiguration` after you create the
|
833
|
+
# data source.
|
719
834
|
#
|
720
835
|
# @option params [String] :client_token
|
721
|
-
#
|
836
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
837
|
+
# completes no more than one time. If this token matches a previous
|
838
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
839
|
+
# error. For more information, see [Ensuring idempotency][1].
|
722
840
|
#
|
723
841
|
# **A suitable default value is auto-generated.** You should normally
|
724
842
|
# not need to pass this option.**
|
725
843
|
#
|
726
|
-
# @option params [required, String] :name
|
727
|
-
# Name for a resource.
|
728
844
|
#
|
729
|
-
#
|
730
|
-
#
|
845
|
+
#
|
846
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
731
847
|
#
|
732
848
|
# @option params [required, Types::DataSourceConfiguration] :data_source_configuration
|
733
|
-
#
|
849
|
+
# Contains metadata about where the data source is stored.
|
850
|
+
#
|
851
|
+
# @option params [String] :description
|
852
|
+
# A description of the data source.
|
853
|
+
#
|
854
|
+
# @option params [required, String] :knowledge_base_id
|
855
|
+
# The unique identifier of the knowledge base to which to add the data
|
856
|
+
# source.
|
857
|
+
#
|
858
|
+
# @option params [required, String] :name
|
859
|
+
# The name of the data source.
|
734
860
|
#
|
735
861
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
736
|
-
#
|
862
|
+
# Contains details about the server-side encryption for the data source.
|
737
863
|
#
|
738
864
|
# @option params [Types::VectorIngestionConfiguration] :vector_ingestion_configuration
|
739
|
-
#
|
865
|
+
# Contains details about how to ingest the documents in the data source.
|
740
866
|
#
|
741
867
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
742
868
|
#
|
@@ -745,17 +871,17 @@ module Aws::BedrockAgent
|
|
745
871
|
# @example Request syntax with placeholder values
|
746
872
|
#
|
747
873
|
# resp = client.create_data_source({
|
748
|
-
# knowledge_base_id: "Id", # required
|
749
874
|
# client_token: "ClientToken",
|
750
|
-
# name: "Name", # required
|
751
|
-
# description: "Description",
|
752
875
|
# data_source_configuration: { # required
|
753
|
-
# type: "S3", # required, accepts S3
|
754
876
|
# s3_configuration: {
|
755
877
|
# bucket_arn: "S3BucketArn", # required
|
756
878
|
# inclusion_prefixes: ["S3Prefix"],
|
757
879
|
# },
|
880
|
+
# type: "S3", # required, accepts S3
|
758
881
|
# },
|
882
|
+
# description: "Description",
|
883
|
+
# knowledge_base_id: "Id", # required
|
884
|
+
# name: "Name", # required
|
759
885
|
# server_side_encryption_configuration: {
|
760
886
|
# kms_key_arn: "KmsKeyArn",
|
761
887
|
# },
|
@@ -772,21 +898,21 @@ module Aws::BedrockAgent
|
|
772
898
|
#
|
773
899
|
# @example Response structure
|
774
900
|
#
|
775
|
-
# resp.data_source.
|
776
|
-
# resp.data_source.data_source_id #=> String
|
777
|
-
# resp.data_source.name #=> String
|
778
|
-
# resp.data_source.status #=> String, one of "AVAILABLE", "DELETING"
|
779
|
-
# resp.data_source.description #=> String
|
780
|
-
# resp.data_source.data_source_configuration.type #=> String, one of "S3"
|
901
|
+
# resp.data_source.created_at #=> Time
|
781
902
|
# resp.data_source.data_source_configuration.s3_configuration.bucket_arn #=> String
|
782
903
|
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
|
783
904
|
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
905
|
+
# resp.data_source.data_source_configuration.type #=> String, one of "S3"
|
906
|
+
# resp.data_source.data_source_id #=> String
|
907
|
+
# resp.data_source.description #=> String
|
908
|
+
# resp.data_source.knowledge_base_id #=> String
|
909
|
+
# resp.data_source.name #=> String
|
784
910
|
# resp.data_source.server_side_encryption_configuration.kms_key_arn #=> String
|
911
|
+
# resp.data_source.status #=> String, one of "AVAILABLE", "DELETING"
|
912
|
+
# resp.data_source.updated_at #=> Time
|
785
913
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE"
|
786
914
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
787
915
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
788
|
-
# resp.data_source.created_at #=> Time
|
789
|
-
# resp.data_source.updated_at #=> Time
|
790
916
|
#
|
791
917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateDataSource AWS API Documentation
|
792
918
|
#
|
@@ -797,31 +923,87 @@ module Aws::BedrockAgent
|
|
797
923
|
req.send_request(options)
|
798
924
|
end
|
799
925
|
|
800
|
-
#
|
926
|
+
# Creates a knowledge base that contains data sources from which
|
927
|
+
# information can be queried and used by LLMs. To create a knowledge
|
928
|
+
# base, you must first set up your data sources and configure a
|
929
|
+
# supported vector store. For more information, see [Set up your data
|
930
|
+
# for ingestion][1].
|
931
|
+
#
|
932
|
+
# <note markdown="1"> If you prefer to let Amazon Bedrock create and manage a vector store
|
933
|
+
# for you in Amazon OpenSearch Service, use the console. For more
|
934
|
+
# information, see [Create a knowledge base][2].
|
935
|
+
#
|
936
|
+
# </note>
|
937
|
+
#
|
938
|
+
# * Provide the `name` and an optional `description`.
|
939
|
+
#
|
940
|
+
# * Provide the Amazon Resource Name (ARN) with permissions to create a
|
941
|
+
# knowledge base in the `roleArn` field.
|
942
|
+
#
|
943
|
+
# * Provide the embedding model to use in the `embeddingModelArn` field
|
944
|
+
# in the `knowledgeBaseConfiguration` object.
|
945
|
+
#
|
946
|
+
# * Provide the configuration for your vector store in the
|
947
|
+
# `storageConfiguration` object.
|
948
|
+
#
|
949
|
+
# * For an Amazon OpenSearch Service database, use the
|
950
|
+
# `opensearchServerlessConfiguration` object. For more information,
|
951
|
+
# see [Create a vector store in Amazon OpenSearch Service][3].
|
952
|
+
#
|
953
|
+
# * For an Amazon Aurora database, use the `RdsConfiguration` object.
|
954
|
+
# For more information, see [Create a vector store in Amazon
|
955
|
+
# Aurora][4].
|
956
|
+
#
|
957
|
+
# * For a Pinecone database, use the `pineconeConfiguration` object.
|
958
|
+
# For more information, see [Create a vector store in Pinecone][5].
|
959
|
+
#
|
960
|
+
# * For a Redis Enterprise Cloud database, use the
|
961
|
+
# `redisEnterpriseCloudConfiguration` object. For more information,
|
962
|
+
# see [Create a vector store in Redis Enterprise Cloud][6].
|
963
|
+
#
|
964
|
+
#
|
965
|
+
#
|
966
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup.html
|
967
|
+
# [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-create
|
968
|
+
# [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html
|
969
|
+
# [4]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html
|
970
|
+
# [5]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html
|
971
|
+
# [6]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-redis.html
|
801
972
|
#
|
802
973
|
# @option params [String] :client_token
|
803
|
-
#
|
974
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
975
|
+
# completes no more than one time. If this token matches a previous
|
976
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
977
|
+
# error. For more information, see [Ensuring idempotency][1].
|
804
978
|
#
|
805
979
|
# **A suitable default value is auto-generated.** You should normally
|
806
980
|
# not need to pass this option.**
|
807
981
|
#
|
808
|
-
# @option params [required, String] :name
|
809
|
-
# Name for a resource.
|
810
982
|
#
|
811
|
-
# @option params [String] :description
|
812
|
-
# Description of the Resource.
|
813
983
|
#
|
814
|
-
#
|
815
|
-
#
|
984
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
985
|
+
#
|
986
|
+
# @option params [String] :description
|
987
|
+
# A description of the knowledge base.
|
816
988
|
#
|
817
989
|
# @option params [required, Types::KnowledgeBaseConfiguration] :knowledge_base_configuration
|
818
|
-
#
|
990
|
+
# Contains details about the embeddings model used for the knowledge
|
991
|
+
# base.
|
992
|
+
#
|
993
|
+
# @option params [required, String] :name
|
994
|
+
# A name for the knowledge base.
|
995
|
+
#
|
996
|
+
# @option params [required, String] :role_arn
|
997
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
998
|
+
# invoke API operations on the knowledge base.
|
819
999
|
#
|
820
1000
|
# @option params [required, Types::StorageConfiguration] :storage_configuration
|
821
|
-
#
|
1001
|
+
# Contains details about the configuration of the vector database used
|
1002
|
+
# for the knowledge base.
|
822
1003
|
#
|
823
1004
|
# @option params [Hash<String,String>] :tags
|
824
|
-
#
|
1005
|
+
# Specify the key-value pairs for the tags that you want to attach to
|
1006
|
+
# your knowledge base in this object.
|
825
1007
|
#
|
826
1008
|
# @return [Types::CreateKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
827
1009
|
#
|
@@ -831,57 +1013,57 @@ module Aws::BedrockAgent
|
|
831
1013
|
#
|
832
1014
|
# resp = client.create_knowledge_base({
|
833
1015
|
# client_token: "ClientToken",
|
834
|
-
# name: "Name", # required
|
835
1016
|
# description: "Description",
|
836
|
-
# role_arn: "KnowledgeBaseRoleArn", # required
|
837
1017
|
# knowledge_base_configuration: { # required
|
838
1018
|
# type: "VECTOR", # required, accepts VECTOR
|
839
1019
|
# vector_knowledge_base_configuration: {
|
840
1020
|
# embedding_model_arn: "BedrockEmbeddingModelArn", # required
|
841
1021
|
# },
|
842
1022
|
# },
|
1023
|
+
# name: "Name", # required
|
1024
|
+
# role_arn: "KnowledgeBaseRoleArn", # required
|
843
1025
|
# storage_configuration: { # required
|
844
|
-
# type: "OPENSEARCH_SERVERLESS", # required, accepts OPENSEARCH_SERVERLESS, PINECONE, REDIS_ENTERPRISE_CLOUD, RDS
|
845
1026
|
# opensearch_serverless_configuration: {
|
846
1027
|
# collection_arn: "OpenSearchServerlessCollectionArn", # required
|
847
|
-
# vector_index_name: "OpenSearchServerlessIndexName", # required
|
848
1028
|
# field_mapping: { # required
|
849
|
-
# vector_field: "FieldName", # required
|
850
|
-
# text_field: "FieldName", # required
|
851
1029
|
# metadata_field: "FieldName", # required
|
1030
|
+
# text_field: "FieldName", # required
|
1031
|
+
# vector_field: "FieldName", # required
|
852
1032
|
# },
|
1033
|
+
# vector_index_name: "OpenSearchServerlessIndexName", # required
|
853
1034
|
# },
|
854
1035
|
# pinecone_configuration: {
|
855
1036
|
# connection_string: "PineconeConnectionString", # required
|
856
1037
|
# credentials_secret_arn: "SecretArn", # required
|
857
|
-
# namespace: "PineconeNamespace",
|
858
1038
|
# field_mapping: { # required
|
859
|
-
# text_field: "FieldName", # required
|
860
1039
|
# metadata_field: "FieldName", # required
|
861
|
-
# },
|
862
|
-
# },
|
863
|
-
# redis_enterprise_cloud_configuration: {
|
864
|
-
# endpoint: "RedisEnterpriseCloudEndpoint", # required
|
865
|
-
# vector_index_name: "RedisEnterpriseCloudIndexName", # required
|
866
|
-
# credentials_secret_arn: "SecretArn", # required
|
867
|
-
# field_mapping: { # required
|
868
|
-
# vector_field: "FieldName", # required
|
869
1040
|
# text_field: "FieldName", # required
|
870
|
-
# metadata_field: "FieldName", # required
|
871
1041
|
# },
|
1042
|
+
# namespace: "PineconeNamespace",
|
872
1043
|
# },
|
873
1044
|
# rds_configuration: {
|
874
|
-
# resource_arn: "RdsArn", # required
|
875
1045
|
# credentials_secret_arn: "SecretArn", # required
|
876
1046
|
# database_name: "RdsDatabaseName", # required
|
877
|
-
# table_name: "RdsTableName", # required
|
878
1047
|
# field_mapping: { # required
|
1048
|
+
# metadata_field: "ColumnName", # required
|
879
1049
|
# primary_key_field: "ColumnName", # required
|
880
|
-
# vector_field: "ColumnName", # required
|
881
1050
|
# text_field: "ColumnName", # required
|
882
|
-
#
|
1051
|
+
# vector_field: "ColumnName", # required
|
1052
|
+
# },
|
1053
|
+
# resource_arn: "RdsArn", # required
|
1054
|
+
# table_name: "RdsTableName", # required
|
1055
|
+
# },
|
1056
|
+
# redis_enterprise_cloud_configuration: {
|
1057
|
+
# credentials_secret_arn: "SecretArn", # required
|
1058
|
+
# endpoint: "RedisEnterpriseCloudEndpoint", # required
|
1059
|
+
# field_mapping: { # required
|
1060
|
+
# metadata_field: "FieldName", # required
|
1061
|
+
# text_field: "FieldName", # required
|
1062
|
+
# vector_field: "FieldName", # required
|
883
1063
|
# },
|
1064
|
+
# vector_index_name: "RedisEnterpriseCloudIndexName", # required
|
884
1065
|
# },
|
1066
|
+
# type: "OPENSEARCH_SERVERLESS", # required, accepts OPENSEARCH_SERVERLESS, PINECONE, REDIS_ENTERPRISE_CLOUD, RDS
|
885
1067
|
# },
|
886
1068
|
# tags: {
|
887
1069
|
# "TagKey" => "TagValue",
|
@@ -890,43 +1072,43 @@ module Aws::BedrockAgent
|
|
890
1072
|
#
|
891
1073
|
# @example Response structure
|
892
1074
|
#
|
893
|
-
# resp.knowledge_base.
|
894
|
-
# resp.knowledge_base.name #=> String
|
895
|
-
# resp.knowledge_base.knowledge_base_arn #=> String
|
1075
|
+
# resp.knowledge_base.created_at #=> Time
|
896
1076
|
# resp.knowledge_base.description #=> String
|
897
|
-
# resp.knowledge_base.
|
1077
|
+
# resp.knowledge_base.failure_reasons #=> Array
|
1078
|
+
# resp.knowledge_base.failure_reasons[0] #=> String
|
1079
|
+
# resp.knowledge_base.knowledge_base_arn #=> String
|
898
1080
|
# resp.knowledge_base.knowledge_base_configuration.type #=> String, one of "VECTOR"
|
899
1081
|
# resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn #=> String
|
900
|
-
# resp.knowledge_base.
|
1082
|
+
# resp.knowledge_base.knowledge_base_id #=> String
|
1083
|
+
# resp.knowledge_base.name #=> String
|
1084
|
+
# resp.knowledge_base.role_arn #=> String
|
1085
|
+
# resp.knowledge_base.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED"
|
901
1086
|
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn #=> String
|
902
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
|
903
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
|
904
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
|
905
1087
|
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field #=> String
|
1088
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
|
1089
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
|
1090
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
|
906
1091
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.connection_string #=> String
|
907
1092
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn #=> String
|
908
|
-
# resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
|
909
|
-
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
|
910
1093
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field #=> String
|
911
|
-
# resp.knowledge_base.storage_configuration.
|
912
|
-
# resp.knowledge_base.storage_configuration.
|
913
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
|
914
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
|
915
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
|
916
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
|
917
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
|
1094
|
+
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
|
1095
|
+
# resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
|
918
1096
|
# resp.knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn #=> String
|
919
1097
|
# resp.knowledge_base.storage_configuration.rds_configuration.database_name #=> String
|
920
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.
|
1098
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field #=> String
|
921
1099
|
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field #=> String
|
922
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
|
923
1100
|
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field #=> String
|
924
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.
|
925
|
-
# resp.knowledge_base.
|
926
|
-
# resp.knowledge_base.
|
1101
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
|
1102
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
|
1103
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.table_name #=> String
|
1104
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
|
1105
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint #=> String
|
1106
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
|
1107
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
|
1108
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
|
1109
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name #=> String
|
1110
|
+
# resp.knowledge_base.storage_configuration.type #=> String, one of "OPENSEARCH_SERVERLESS", "PINECONE", "REDIS_ENTERPRISE_CLOUD", "RDS"
|
927
1111
|
# resp.knowledge_base.updated_at #=> Time
|
928
|
-
# resp.knowledge_base.failure_reasons #=> Array
|
929
|
-
# resp.knowledge_base.failure_reasons[0] #=> String
|
930
1112
|
#
|
931
1113
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBase AWS API Documentation
|
932
1114
|
#
|
@@ -937,14 +1119,15 @@ module Aws::BedrockAgent
|
|
937
1119
|
req.send_request(options)
|
938
1120
|
end
|
939
1121
|
|
940
|
-
# Deletes an
|
1122
|
+
# Deletes an agent.
|
941
1123
|
#
|
942
1124
|
# @option params [required, String] :agent_id
|
943
|
-
#
|
1125
|
+
# The unique identifier of the agent to delete.
|
944
1126
|
#
|
945
1127
|
# @option params [Boolean] :skip_resource_in_use_check
|
946
|
-
#
|
947
|
-
#
|
1128
|
+
# By default, this value is `false` and deletion is stopped if the
|
1129
|
+
# resource is in use. If you set it to `true`, the resource will be
|
1130
|
+
# deleted even if the resource is in use.
|
948
1131
|
#
|
949
1132
|
# @return [Types::DeleteAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
950
1133
|
#
|
@@ -972,29 +1155,30 @@ module Aws::BedrockAgent
|
|
972
1155
|
req.send_request(options)
|
973
1156
|
end
|
974
1157
|
|
975
|
-
# Deletes an
|
1158
|
+
# Deletes an action group in an agent.
|
1159
|
+
#
|
1160
|
+
# @option params [required, String] :action_group_id
|
1161
|
+
# The unique identifier of the action group to delete.
|
976
1162
|
#
|
977
1163
|
# @option params [required, String] :agent_id
|
978
|
-
#
|
1164
|
+
# The unique identifier of the agent that the action group belongs to.
|
979
1165
|
#
|
980
1166
|
# @option params [required, String] :agent_version
|
981
|
-
#
|
982
|
-
#
|
983
|
-
# @option params [required, String] :action_group_id
|
984
|
-
# Id generated at the server side when an Agent ActionGroup is created
|
1167
|
+
# The version of the agent that the action group belongs to.
|
985
1168
|
#
|
986
1169
|
# @option params [Boolean] :skip_resource_in_use_check
|
987
|
-
#
|
988
|
-
#
|
1170
|
+
# By default, this value is `false` and deletion is stopped if the
|
1171
|
+
# resource is in use. If you set it to `true`, the resource will be
|
1172
|
+
# deleted even if the resource is in use.
|
989
1173
|
#
|
990
1174
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
991
1175
|
#
|
992
1176
|
# @example Request syntax with placeholder values
|
993
1177
|
#
|
994
1178
|
# resp = client.delete_agent_action_group({
|
1179
|
+
# action_group_id: "Id", # required
|
995
1180
|
# agent_id: "Id", # required
|
996
1181
|
# agent_version: "DraftVersion", # required
|
997
|
-
# action_group_id: "Id", # required
|
998
1182
|
# skip_resource_in_use_check: false,
|
999
1183
|
# })
|
1000
1184
|
#
|
@@ -1007,32 +1191,32 @@ module Aws::BedrockAgent
|
|
1007
1191
|
req.send_request(options)
|
1008
1192
|
end
|
1009
1193
|
|
1010
|
-
# Deletes an
|
1011
|
-
#
|
1012
|
-
# @option params [required, String] :agent_id
|
1013
|
-
# Id generated at the server side when an Agent is created
|
1194
|
+
# Deletes an alias of an agent.
|
1014
1195
|
#
|
1015
1196
|
# @option params [required, String] :agent_alias_id
|
1016
|
-
#
|
1197
|
+
# The unique identifier of the alias to delete.
|
1198
|
+
#
|
1199
|
+
# @option params [required, String] :agent_id
|
1200
|
+
# The unique identifier of the agent that the alias belongs to.
|
1017
1201
|
#
|
1018
1202
|
# @return [Types::DeleteAgentAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1019
1203
|
#
|
1020
|
-
# * {Types::DeleteAgentAliasResponse#agent_id #agent_id} => String
|
1021
1204
|
# * {Types::DeleteAgentAliasResponse#agent_alias_id #agent_alias_id} => String
|
1022
1205
|
# * {Types::DeleteAgentAliasResponse#agent_alias_status #agent_alias_status} => String
|
1206
|
+
# * {Types::DeleteAgentAliasResponse#agent_id #agent_id} => String
|
1023
1207
|
#
|
1024
1208
|
# @example Request syntax with placeholder values
|
1025
1209
|
#
|
1026
1210
|
# resp = client.delete_agent_alias({
|
1027
|
-
# agent_id: "Id", # required
|
1028
1211
|
# agent_alias_id: "AgentAliasId", # required
|
1212
|
+
# agent_id: "Id", # required
|
1029
1213
|
# })
|
1030
1214
|
#
|
1031
1215
|
# @example Response structure
|
1032
1216
|
#
|
1033
|
-
# resp.agent_id #=> String
|
1034
1217
|
# resp.agent_alias_id #=> String
|
1035
1218
|
# resp.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
1219
|
+
# resp.agent_id #=> String
|
1036
1220
|
#
|
1037
1221
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAlias AWS API Documentation
|
1038
1222
|
#
|
@@ -1043,23 +1227,24 @@ module Aws::BedrockAgent
|
|
1043
1227
|
req.send_request(options)
|
1044
1228
|
end
|
1045
1229
|
|
1046
|
-
# Deletes
|
1230
|
+
# Deletes a version of an agent.
|
1047
1231
|
#
|
1048
1232
|
# @option params [required, String] :agent_id
|
1049
|
-
#
|
1233
|
+
# The unique identifier of the agent that the version belongs to.
|
1050
1234
|
#
|
1051
1235
|
# @option params [required, String] :agent_version
|
1052
|
-
#
|
1236
|
+
# The version of the agent to delete.
|
1053
1237
|
#
|
1054
1238
|
# @option params [Boolean] :skip_resource_in_use_check
|
1055
|
-
#
|
1056
|
-
#
|
1239
|
+
# By default, this value is `false` and deletion is stopped if the
|
1240
|
+
# resource is in use. If you set it to `true`, the resource will be
|
1241
|
+
# deleted even if the resource is in use.
|
1057
1242
|
#
|
1058
1243
|
# @return [Types::DeleteAgentVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1059
1244
|
#
|
1060
1245
|
# * {Types::DeleteAgentVersionResponse#agent_id #agent_id} => String
|
1061
|
-
# * {Types::DeleteAgentVersionResponse#agent_version #agent_version} => String
|
1062
1246
|
# * {Types::DeleteAgentVersionResponse#agent_status #agent_status} => String
|
1247
|
+
# * {Types::DeleteAgentVersionResponse#agent_version #agent_version} => String
|
1063
1248
|
#
|
1064
1249
|
# @example Request syntax with placeholder values
|
1065
1250
|
#
|
@@ -1072,8 +1257,8 @@ module Aws::BedrockAgent
|
|
1072
1257
|
# @example Response structure
|
1073
1258
|
#
|
1074
1259
|
# resp.agent_id #=> String
|
1075
|
-
# resp.agent_version #=> String
|
1076
1260
|
# resp.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1261
|
+
# resp.agent_version #=> String
|
1077
1262
|
#
|
1078
1263
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersion AWS API Documentation
|
1079
1264
|
#
|
@@ -1084,31 +1269,32 @@ module Aws::BedrockAgent
|
|
1084
1269
|
req.send_request(options)
|
1085
1270
|
end
|
1086
1271
|
|
1087
|
-
#
|
1088
|
-
#
|
1089
|
-
# @option params [required, String] :knowledge_base_id
|
1090
|
-
# Identifier for a resource.
|
1272
|
+
# Deletes a data source from a knowledge base.
|
1091
1273
|
#
|
1092
1274
|
# @option params [required, String] :data_source_id
|
1093
|
-
#
|
1275
|
+
# The unique identifier of the data source to delete.
|
1276
|
+
#
|
1277
|
+
# @option params [required, String] :knowledge_base_id
|
1278
|
+
# The unique identifier of the knowledge base from which to delete the
|
1279
|
+
# data source.
|
1094
1280
|
#
|
1095
1281
|
# @return [Types::DeleteDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1096
1282
|
#
|
1097
|
-
# * {Types::DeleteDataSourceResponse#knowledge_base_id #knowledge_base_id} => String
|
1098
1283
|
# * {Types::DeleteDataSourceResponse#data_source_id #data_source_id} => String
|
1284
|
+
# * {Types::DeleteDataSourceResponse#knowledge_base_id #knowledge_base_id} => String
|
1099
1285
|
# * {Types::DeleteDataSourceResponse#status #status} => String
|
1100
1286
|
#
|
1101
1287
|
# @example Request syntax with placeholder values
|
1102
1288
|
#
|
1103
1289
|
# resp = client.delete_data_source({
|
1104
|
-
# knowledge_base_id: "Id", # required
|
1105
1290
|
# data_source_id: "Id", # required
|
1291
|
+
# knowledge_base_id: "Id", # required
|
1106
1292
|
# })
|
1107
1293
|
#
|
1108
1294
|
# @example Response structure
|
1109
1295
|
#
|
1110
|
-
# resp.knowledge_base_id #=> String
|
1111
1296
|
# resp.data_source_id #=> String
|
1297
|
+
# resp.knowledge_base_id #=> String
|
1112
1298
|
# resp.status #=> String, one of "AVAILABLE", "DELETING"
|
1113
1299
|
#
|
1114
1300
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSource AWS API Documentation
|
@@ -1120,10 +1306,16 @@ module Aws::BedrockAgent
|
|
1120
1306
|
req.send_request(options)
|
1121
1307
|
end
|
1122
1308
|
|
1123
|
-
#
|
1309
|
+
# Deletes a knowledge base. Before deleting a knowledge base, you should
|
1310
|
+
# disassociate the knowledge base from any agents that it is associated
|
1311
|
+
# with by making a [DisassociateAgentKnowledgeBase][1] request.
|
1312
|
+
#
|
1313
|
+
#
|
1314
|
+
#
|
1315
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_DisassociateAgentKnowledgeBase.html
|
1124
1316
|
#
|
1125
1317
|
# @option params [required, String] :knowledge_base_id
|
1126
|
-
#
|
1318
|
+
# The unique identifier of the knowledge base to delete.
|
1127
1319
|
#
|
1128
1320
|
# @return [Types::DeleteKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1129
1321
|
#
|
@@ -1150,17 +1342,18 @@ module Aws::BedrockAgent
|
|
1150
1342
|
req.send_request(options)
|
1151
1343
|
end
|
1152
1344
|
|
1153
|
-
#
|
1345
|
+
# Disassociates a knowledge base from an agent.
|
1154
1346
|
#
|
1155
1347
|
# @option params [required, String] :agent_id
|
1156
|
-
#
|
1348
|
+
# The unique identifier of the agent from which to disassociate the
|
1349
|
+
# knowledge base.
|
1157
1350
|
#
|
1158
1351
|
# @option params [required, String] :agent_version
|
1159
|
-
#
|
1352
|
+
# The version of the agent from which to disassociate the knowledge
|
1353
|
+
# base.
|
1160
1354
|
#
|
1161
1355
|
# @option params [required, String] :knowledge_base_id
|
1162
|
-
#
|
1163
|
-
# an Agent
|
1356
|
+
# The unique identifier of the knowledge base to disassociate.
|
1164
1357
|
#
|
1165
1358
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1166
1359
|
#
|
@@ -1181,10 +1374,10 @@ module Aws::BedrockAgent
|
|
1181
1374
|
req.send_request(options)
|
1182
1375
|
end
|
1183
1376
|
|
1184
|
-
# Gets
|
1377
|
+
# Gets information about an agent.
|
1185
1378
|
#
|
1186
1379
|
# @option params [required, String] :agent_id
|
1187
|
-
#
|
1380
|
+
# The unique identifier of the agent.
|
1188
1381
|
#
|
1189
1382
|
# @return [Types::GetAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1190
1383
|
#
|
@@ -1198,38 +1391,38 @@ module Aws::BedrockAgent
|
|
1198
1391
|
#
|
1199
1392
|
# @example Response structure
|
1200
1393
|
#
|
1394
|
+
# resp.agent.agent_arn #=> String
|
1201
1395
|
# resp.agent.agent_id #=> String
|
1202
1396
|
# resp.agent.agent_name #=> String
|
1203
|
-
# resp.agent.
|
1397
|
+
# resp.agent.agent_resource_role_arn #=> String
|
1398
|
+
# resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1204
1399
|
# resp.agent.agent_version #=> String
|
1205
1400
|
# resp.agent.client_token #=> String
|
1206
|
-
# resp.agent.instruction #=> String
|
1207
|
-
# resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1208
|
-
# resp.agent.foundation_model #=> String
|
1209
|
-
# resp.agent.description #=> String
|
1210
|
-
# resp.agent.idle_session_ttl_in_seconds #=> Integer
|
1211
|
-
# resp.agent.agent_resource_role_arn #=> String
|
1212
|
-
# resp.agent.customer_encryption_key_arn #=> String
|
1213
1401
|
# resp.agent.created_at #=> Time
|
1214
|
-
# resp.agent.
|
1215
|
-
# resp.agent.
|
1402
|
+
# resp.agent.customer_encryption_key_arn #=> String
|
1403
|
+
# resp.agent.description #=> String
|
1216
1404
|
# resp.agent.failure_reasons #=> Array
|
1217
1405
|
# resp.agent.failure_reasons[0] #=> String
|
1218
|
-
# resp.agent.
|
1219
|
-
# resp.agent.
|
1406
|
+
# resp.agent.foundation_model #=> String
|
1407
|
+
# resp.agent.idle_session_ttl_in_seconds #=> Integer
|
1408
|
+
# resp.agent.instruction #=> String
|
1409
|
+
# resp.agent.prepared_at #=> Time
|
1410
|
+
# resp.agent.prompt_override_configuration.override_lambda #=> String
|
1220
1411
|
# resp.agent.prompt_override_configuration.prompt_configurations #=> Array
|
1221
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
1222
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
1223
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
1224
1412
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
|
1225
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
1226
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
1227
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
1228
1413
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
|
1229
1414
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
|
1230
1415
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
|
1416
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
1417
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
1418
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
1231
1419
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
1232
|
-
# resp.agent.prompt_override_configuration.
|
1420
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
1421
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
1422
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
1423
|
+
# resp.agent.recommended_actions #=> Array
|
1424
|
+
# resp.agent.recommended_actions[0] #=> String
|
1425
|
+
# resp.agent.updated_at #=> Time
|
1233
1426
|
#
|
1234
1427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgent AWS API Documentation
|
1235
1428
|
#
|
@@ -1240,16 +1433,17 @@ module Aws::BedrockAgent
|
|
1240
1433
|
req.send_request(options)
|
1241
1434
|
end
|
1242
1435
|
|
1243
|
-
# Gets an
|
1436
|
+
# Gets information about an action group for an agent.
|
1437
|
+
#
|
1438
|
+
# @option params [required, String] :action_group_id
|
1439
|
+
# The unique identifier of the action group for which to get
|
1440
|
+
# information.
|
1244
1441
|
#
|
1245
1442
|
# @option params [required, String] :agent_id
|
1246
|
-
#
|
1443
|
+
# The unique identifier of the agent that the action group belongs to.
|
1247
1444
|
#
|
1248
1445
|
# @option params [required, String] :agent_version
|
1249
|
-
#
|
1250
|
-
#
|
1251
|
-
# @option params [required, String] :action_group_id
|
1252
|
-
# Id generated at the server side when an Agent Action Group is created
|
1446
|
+
# The version of the agent that the action group belongs to.
|
1253
1447
|
#
|
1254
1448
|
# @return [Types::GetAgentActionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1255
1449
|
#
|
@@ -1258,27 +1452,27 @@ module Aws::BedrockAgent
|
|
1258
1452
|
# @example Request syntax with placeholder values
|
1259
1453
|
#
|
1260
1454
|
# resp = client.get_agent_action_group({
|
1455
|
+
# action_group_id: "Id", # required
|
1261
1456
|
# agent_id: "Id", # required
|
1262
1457
|
# agent_version: "Version", # required
|
1263
|
-
# action_group_id: "Id", # required
|
1264
1458
|
# })
|
1265
1459
|
#
|
1266
1460
|
# @example Response structure
|
1267
1461
|
#
|
1268
|
-
# resp.agent_action_group.
|
1269
|
-
# resp.agent_action_group.agent_version #=> String
|
1462
|
+
# resp.agent_action_group.action_group_executor.lambda #=> String
|
1270
1463
|
# resp.agent_action_group.action_group_id #=> String
|
1271
1464
|
# resp.agent_action_group.action_group_name #=> String
|
1465
|
+
# resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
|
1466
|
+
# resp.agent_action_group.agent_id #=> String
|
1467
|
+
# resp.agent_action_group.agent_version #=> String
|
1468
|
+
# resp.agent_action_group.api_schema.payload #=> String
|
1469
|
+
# resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
|
1470
|
+
# resp.agent_action_group.api_schema.s3.s3_object_key #=> String
|
1272
1471
|
# resp.agent_action_group.client_token #=> String
|
1273
|
-
# resp.agent_action_group.description #=> String
|
1274
1472
|
# resp.agent_action_group.created_at #=> Time
|
1275
|
-
# resp.agent_action_group.
|
1473
|
+
# resp.agent_action_group.description #=> String
|
1276
1474
|
# resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
|
1277
|
-
# resp.agent_action_group.
|
1278
|
-
# resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
|
1279
|
-
# resp.agent_action_group.api_schema.s3.s3_object_key #=> String
|
1280
|
-
# resp.agent_action_group.api_schema.payload #=> String
|
1281
|
-
# resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
|
1475
|
+
# resp.agent_action_group.updated_at #=> Time
|
1282
1476
|
#
|
1283
1477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentActionGroup AWS API Documentation
|
1284
1478
|
#
|
@@ -1289,13 +1483,14 @@ module Aws::BedrockAgent
|
|
1289
1483
|
req.send_request(options)
|
1290
1484
|
end
|
1291
1485
|
|
1292
|
-
#
|
1293
|
-
#
|
1294
|
-
# @option params [required, String] :agent_id
|
1295
|
-
# Id generated at the server side when an Agent is created
|
1486
|
+
# Gets information about an alias of an agent.
|
1296
1487
|
#
|
1297
1488
|
# @option params [required, String] :agent_alias_id
|
1298
|
-
#
|
1489
|
+
# The unique identifier of the alias for which to get information.
|
1490
|
+
#
|
1491
|
+
# @option params [required, String] :agent_id
|
1492
|
+
# The unique identifier of the agent to which the alias to get
|
1493
|
+
# information belongs.
|
1299
1494
|
#
|
1300
1495
|
# @return [Types::GetAgentAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1301
1496
|
#
|
@@ -1304,28 +1499,28 @@ module Aws::BedrockAgent
|
|
1304
1499
|
# @example Request syntax with placeholder values
|
1305
1500
|
#
|
1306
1501
|
# resp = client.get_agent_alias({
|
1307
|
-
# agent_id: "Id", # required
|
1308
1502
|
# agent_alias_id: "AgentAliasId", # required
|
1503
|
+
# agent_id: "Id", # required
|
1309
1504
|
# })
|
1310
1505
|
#
|
1311
1506
|
# @example Response structure
|
1312
1507
|
#
|
1313
|
-
# resp.agent_alias.
|
1508
|
+
# resp.agent_alias.agent_alias_arn #=> String
|
1509
|
+
# resp.agent_alias.agent_alias_history_events #=> Array
|
1510
|
+
# resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
|
1511
|
+
# resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
|
1512
|
+
# resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
|
1513
|
+
# resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
|
1314
1514
|
# resp.agent_alias.agent_alias_id #=> String
|
1315
1515
|
# resp.agent_alias.agent_alias_name #=> String
|
1316
|
-
# resp.agent_alias.
|
1516
|
+
# resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
1517
|
+
# resp.agent_alias.agent_id #=> String
|
1317
1518
|
# resp.agent_alias.client_token #=> String
|
1519
|
+
# resp.agent_alias.created_at #=> Time
|
1318
1520
|
# resp.agent_alias.description #=> String
|
1319
1521
|
# resp.agent_alias.routing_configuration #=> Array
|
1320
1522
|
# resp.agent_alias.routing_configuration[0].agent_version #=> String
|
1321
|
-
# resp.agent_alias.created_at #=> Time
|
1322
1523
|
# resp.agent_alias.updated_at #=> Time
|
1323
|
-
# resp.agent_alias.agent_alias_history_events #=> Array
|
1324
|
-
# resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
|
1325
|
-
# resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
|
1326
|
-
# resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
|
1327
|
-
# resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
|
1328
|
-
# resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
1329
1524
|
#
|
1330
1525
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentAlias AWS API Documentation
|
1331
1526
|
#
|
@@ -1336,17 +1531,17 @@ module Aws::BedrockAgent
|
|
1336
1531
|
req.send_request(options)
|
1337
1532
|
end
|
1338
1533
|
|
1339
|
-
# Gets a knowledge base associated
|
1340
|
-
# Version
|
1534
|
+
# Gets information about a knowledge base associated with an agent.
|
1341
1535
|
#
|
1342
1536
|
# @option params [required, String] :agent_id
|
1343
|
-
#
|
1537
|
+
# The unique identifier of the agent with which the knowledge base is
|
1538
|
+
# associated.
|
1344
1539
|
#
|
1345
1540
|
# @option params [required, String] :agent_version
|
1346
|
-
#
|
1541
|
+
# The version of the agent with which the knowledge base is associated.
|
1347
1542
|
#
|
1348
1543
|
# @option params [required, String] :knowledge_base_id
|
1349
|
-
#
|
1544
|
+
# The unique identifier of the knowledge base associated with the agent.
|
1350
1545
|
#
|
1351
1546
|
# @return [Types::GetAgentKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1352
1547
|
#
|
@@ -1364,11 +1559,11 @@ module Aws::BedrockAgent
|
|
1364
1559
|
#
|
1365
1560
|
# resp.agent_knowledge_base.agent_id #=> String
|
1366
1561
|
# resp.agent_knowledge_base.agent_version #=> String
|
1367
|
-
# resp.agent_knowledge_base.knowledge_base_id #=> String
|
1368
|
-
# resp.agent_knowledge_base.description #=> String
|
1369
1562
|
# resp.agent_knowledge_base.created_at #=> Time
|
1370
|
-
# resp.agent_knowledge_base.
|
1563
|
+
# resp.agent_knowledge_base.description #=> String
|
1564
|
+
# resp.agent_knowledge_base.knowledge_base_id #=> String
|
1371
1565
|
# resp.agent_knowledge_base.knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
|
1566
|
+
# resp.agent_knowledge_base.updated_at #=> Time
|
1372
1567
|
#
|
1373
1568
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentKnowledgeBase AWS API Documentation
|
1374
1569
|
#
|
@@ -1379,13 +1574,13 @@ module Aws::BedrockAgent
|
|
1379
1574
|
req.send_request(options)
|
1380
1575
|
end
|
1381
1576
|
|
1382
|
-
# Gets
|
1577
|
+
# Gets details about a version of an agent.
|
1383
1578
|
#
|
1384
1579
|
# @option params [required, String] :agent_id
|
1385
|
-
#
|
1580
|
+
# The unique identifier of the agent.
|
1386
1581
|
#
|
1387
1582
|
# @option params [required, String] :agent_version
|
1388
|
-
#
|
1583
|
+
# The version of the agent.
|
1389
1584
|
#
|
1390
1585
|
# @return [Types::GetAgentVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1391
1586
|
#
|
@@ -1400,36 +1595,36 @@ module Aws::BedrockAgent
|
|
1400
1595
|
#
|
1401
1596
|
# @example Response structure
|
1402
1597
|
#
|
1598
|
+
# resp.agent_version.agent_arn #=> String
|
1403
1599
|
# resp.agent_version.agent_id #=> String
|
1404
1600
|
# resp.agent_version.agent_name #=> String
|
1405
|
-
# resp.agent_version.agent_arn #=> String
|
1406
|
-
# resp.agent_version.version #=> String
|
1407
|
-
# resp.agent_version.instruction #=> String
|
1408
|
-
# resp.agent_version.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1409
|
-
# resp.agent_version.foundation_model #=> String
|
1410
|
-
# resp.agent_version.description #=> String
|
1411
|
-
# resp.agent_version.idle_session_ttl_in_seconds #=> Integer
|
1412
1601
|
# resp.agent_version.agent_resource_role_arn #=> String
|
1413
|
-
# resp.agent_version.
|
1602
|
+
# resp.agent_version.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1414
1603
|
# resp.agent_version.created_at #=> Time
|
1415
|
-
# resp.agent_version.
|
1604
|
+
# resp.agent_version.customer_encryption_key_arn #=> String
|
1605
|
+
# resp.agent_version.description #=> String
|
1416
1606
|
# resp.agent_version.failure_reasons #=> Array
|
1417
1607
|
# resp.agent_version.failure_reasons[0] #=> String
|
1418
|
-
# resp.agent_version.
|
1419
|
-
# resp.agent_version.
|
1608
|
+
# resp.agent_version.foundation_model #=> String
|
1609
|
+
# resp.agent_version.idle_session_ttl_in_seconds #=> Integer
|
1610
|
+
# resp.agent_version.instruction #=> String
|
1611
|
+
# resp.agent_version.prompt_override_configuration.override_lambda #=> String
|
1420
1612
|
# resp.agent_version.prompt_override_configuration.prompt_configurations #=> Array
|
1421
|
-
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
1422
|
-
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
1423
|
-
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
1424
1613
|
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
|
1425
|
-
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
1426
|
-
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
1427
|
-
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
1428
1614
|
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
|
1429
1615
|
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
|
1430
1616
|
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
|
1617
|
+
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
1618
|
+
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
1619
|
+
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
1431
1620
|
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
1432
|
-
# resp.agent_version.prompt_override_configuration.
|
1621
|
+
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
1622
|
+
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
1623
|
+
# resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
1624
|
+
# resp.agent_version.recommended_actions #=> Array
|
1625
|
+
# resp.agent_version.recommended_actions[0] #=> String
|
1626
|
+
# resp.agent_version.updated_at #=> Time
|
1627
|
+
# resp.agent_version.version #=> String
|
1433
1628
|
#
|
1434
1629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetAgentVersion AWS API Documentation
|
1435
1630
|
#
|
@@ -1440,13 +1635,14 @@ module Aws::BedrockAgent
|
|
1440
1635
|
req.send_request(options)
|
1441
1636
|
end
|
1442
1637
|
|
1443
|
-
#
|
1444
|
-
#
|
1445
|
-
# @option params [required, String] :knowledge_base_id
|
1446
|
-
# Identifier for a resource.
|
1638
|
+
# Gets information about a data source.
|
1447
1639
|
#
|
1448
1640
|
# @option params [required, String] :data_source_id
|
1449
|
-
#
|
1641
|
+
# The unique identifier of the data source.
|
1642
|
+
#
|
1643
|
+
# @option params [required, String] :knowledge_base_id
|
1644
|
+
# The unique identifier of the knowledge base that the data source was
|
1645
|
+
# added to.
|
1450
1646
|
#
|
1451
1647
|
# @return [Types::GetDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1452
1648
|
#
|
@@ -1455,27 +1651,27 @@ module Aws::BedrockAgent
|
|
1455
1651
|
# @example Request syntax with placeholder values
|
1456
1652
|
#
|
1457
1653
|
# resp = client.get_data_source({
|
1458
|
-
# knowledge_base_id: "Id", # required
|
1459
1654
|
# data_source_id: "Id", # required
|
1655
|
+
# knowledge_base_id: "Id", # required
|
1460
1656
|
# })
|
1461
1657
|
#
|
1462
1658
|
# @example Response structure
|
1463
1659
|
#
|
1464
|
-
# resp.data_source.
|
1660
|
+
# resp.data_source.created_at #=> Time
|
1661
|
+
# resp.data_source.data_source_configuration.s3_configuration.bucket_arn #=> String
|
1662
|
+
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
|
1663
|
+
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
1664
|
+
# resp.data_source.data_source_configuration.type #=> String, one of "S3"
|
1465
1665
|
# resp.data_source.data_source_id #=> String
|
1466
|
-
# resp.data_source.name #=> String
|
1467
|
-
# resp.data_source.status #=> String, one of "AVAILABLE", "DELETING"
|
1468
1666
|
# resp.data_source.description #=> String
|
1469
|
-
# resp.data_source.
|
1470
|
-
# resp.data_source.
|
1471
|
-
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
|
1472
|
-
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
1667
|
+
# resp.data_source.knowledge_base_id #=> String
|
1668
|
+
# resp.data_source.name #=> String
|
1473
1669
|
# resp.data_source.server_side_encryption_configuration.kms_key_arn #=> String
|
1670
|
+
# resp.data_source.status #=> String, one of "AVAILABLE", "DELETING"
|
1671
|
+
# resp.data_source.updated_at #=> Time
|
1474
1672
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE"
|
1475
1673
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
1476
1674
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
1477
|
-
# resp.data_source.created_at #=> Time
|
1478
|
-
# resp.data_source.updated_at #=> Time
|
1479
1675
|
#
|
1480
1676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetDataSource AWS API Documentation
|
1481
1677
|
#
|
@@ -1486,16 +1682,18 @@ module Aws::BedrockAgent
|
|
1486
1682
|
req.send_request(options)
|
1487
1683
|
end
|
1488
1684
|
|
1489
|
-
#
|
1490
|
-
#
|
1491
|
-
# @option params [required, String] :knowledge_base_id
|
1492
|
-
# Identifier for a resource.
|
1685
|
+
# Gets information about a ingestion job, in which a data source is
|
1686
|
+
# added to a knowledge base.
|
1493
1687
|
#
|
1494
1688
|
# @option params [required, String] :data_source_id
|
1495
|
-
#
|
1689
|
+
# The unique identifier of the data source in the ingestion job.
|
1496
1690
|
#
|
1497
1691
|
# @option params [required, String] :ingestion_job_id
|
1498
|
-
#
|
1692
|
+
# The unique identifier of the ingestion job.
|
1693
|
+
#
|
1694
|
+
# @option params [required, String] :knowledge_base_id
|
1695
|
+
# The unique identifier of the knowledge base for which the ingestion
|
1696
|
+
# job applies.
|
1499
1697
|
#
|
1500
1698
|
# @return [Types::GetIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1501
1699
|
#
|
@@ -1504,26 +1702,28 @@ module Aws::BedrockAgent
|
|
1504
1702
|
# @example Request syntax with placeholder values
|
1505
1703
|
#
|
1506
1704
|
# resp = client.get_ingestion_job({
|
1507
|
-
# knowledge_base_id: "Id", # required
|
1508
1705
|
# data_source_id: "Id", # required
|
1509
1706
|
# ingestion_job_id: "Id", # required
|
1707
|
+
# knowledge_base_id: "Id", # required
|
1510
1708
|
# })
|
1511
1709
|
#
|
1512
1710
|
# @example Response structure
|
1513
1711
|
#
|
1514
|
-
# resp.ingestion_job.knowledge_base_id #=> String
|
1515
1712
|
# resp.ingestion_job.data_source_id #=> String
|
1516
|
-
# resp.ingestion_job.ingestion_job_id #=> String
|
1517
1713
|
# resp.ingestion_job.description #=> String
|
1518
|
-
# resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
|
1519
|
-
# resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
|
1520
|
-
# resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
|
1521
|
-
# resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
|
1522
|
-
# resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
|
1523
|
-
# resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
|
1524
1714
|
# resp.ingestion_job.failure_reasons #=> Array
|
1525
1715
|
# resp.ingestion_job.failure_reasons[0] #=> String
|
1716
|
+
# resp.ingestion_job.ingestion_job_id #=> String
|
1717
|
+
# resp.ingestion_job.knowledge_base_id #=> String
|
1526
1718
|
# resp.ingestion_job.started_at #=> Time
|
1719
|
+
# resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
|
1720
|
+
# resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
|
1721
|
+
# resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
|
1722
|
+
# resp.ingestion_job.statistics.number_of_metadata_documents_modified #=> Integer
|
1723
|
+
# resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
|
1724
|
+
# resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
|
1725
|
+
# resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
|
1726
|
+
# resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
|
1527
1727
|
# resp.ingestion_job.updated_at #=> Time
|
1528
1728
|
#
|
1529
1729
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJob AWS API Documentation
|
@@ -1535,10 +1735,11 @@ module Aws::BedrockAgent
|
|
1535
1735
|
req.send_request(options)
|
1536
1736
|
end
|
1537
1737
|
|
1538
|
-
#
|
1738
|
+
# Gets information about a knoweldge base.
|
1539
1739
|
#
|
1540
1740
|
# @option params [required, String] :knowledge_base_id
|
1541
|
-
#
|
1741
|
+
# The unique identifier of the knowledge base for which to get
|
1742
|
+
# information.
|
1542
1743
|
#
|
1543
1744
|
# @return [Types::GetKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1544
1745
|
#
|
@@ -1552,43 +1753,43 @@ module Aws::BedrockAgent
|
|
1552
1753
|
#
|
1553
1754
|
# @example Response structure
|
1554
1755
|
#
|
1555
|
-
# resp.knowledge_base.
|
1556
|
-
# resp.knowledge_base.name #=> String
|
1557
|
-
# resp.knowledge_base.knowledge_base_arn #=> String
|
1756
|
+
# resp.knowledge_base.created_at #=> Time
|
1558
1757
|
# resp.knowledge_base.description #=> String
|
1559
|
-
# resp.knowledge_base.
|
1758
|
+
# resp.knowledge_base.failure_reasons #=> Array
|
1759
|
+
# resp.knowledge_base.failure_reasons[0] #=> String
|
1760
|
+
# resp.knowledge_base.knowledge_base_arn #=> String
|
1560
1761
|
# resp.knowledge_base.knowledge_base_configuration.type #=> String, one of "VECTOR"
|
1561
1762
|
# resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn #=> String
|
1562
|
-
# resp.knowledge_base.
|
1763
|
+
# resp.knowledge_base.knowledge_base_id #=> String
|
1764
|
+
# resp.knowledge_base.name #=> String
|
1765
|
+
# resp.knowledge_base.role_arn #=> String
|
1766
|
+
# resp.knowledge_base.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED"
|
1563
1767
|
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn #=> String
|
1564
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
|
1565
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
|
1566
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
|
1567
1768
|
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field #=> String
|
1769
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
|
1770
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
|
1771
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
|
1568
1772
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.connection_string #=> String
|
1569
1773
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn #=> String
|
1570
|
-
# resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
|
1571
|
-
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
|
1572
1774
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field #=> String
|
1573
|
-
# resp.knowledge_base.storage_configuration.
|
1574
|
-
# resp.knowledge_base.storage_configuration.
|
1575
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
|
1576
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
|
1577
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
|
1578
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
|
1579
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
|
1775
|
+
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
|
1776
|
+
# resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
|
1580
1777
|
# resp.knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn #=> String
|
1581
1778
|
# resp.knowledge_base.storage_configuration.rds_configuration.database_name #=> String
|
1582
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.
|
1779
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field #=> String
|
1583
1780
|
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field #=> String
|
1584
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
|
1585
1781
|
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field #=> String
|
1586
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.
|
1587
|
-
# resp.knowledge_base.
|
1588
|
-
# resp.knowledge_base.
|
1782
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
|
1783
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
|
1784
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.table_name #=> String
|
1785
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
|
1786
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint #=> String
|
1787
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
|
1788
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
|
1789
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
|
1790
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name #=> String
|
1791
|
+
# resp.knowledge_base.storage_configuration.type #=> String, one of "OPENSEARCH_SERVERLESS", "PINECONE", "REDIS_ENTERPRISE_CLOUD", "RDS"
|
1589
1792
|
# resp.knowledge_base.updated_at #=> Time
|
1590
|
-
# resp.knowledge_base.failure_reasons #=> Array
|
1591
|
-
# resp.knowledge_base.failure_reasons[0] #=> String
|
1592
1793
|
#
|
1593
1794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBase AWS API Documentation
|
1594
1795
|
#
|
@@ -1599,19 +1800,25 @@ module Aws::BedrockAgent
|
|
1599
1800
|
req.send_request(options)
|
1600
1801
|
end
|
1601
1802
|
|
1602
|
-
# Lists
|
1803
|
+
# Lists the action groups for an agent and information about each one.
|
1603
1804
|
#
|
1604
1805
|
# @option params [required, String] :agent_id
|
1605
|
-
#
|
1806
|
+
# The unique identifier of the agent.
|
1606
1807
|
#
|
1607
1808
|
# @option params [required, String] :agent_version
|
1608
|
-
#
|
1809
|
+
# The version of the agent.
|
1609
1810
|
#
|
1610
1811
|
# @option params [Integer] :max_results
|
1611
|
-
#
|
1812
|
+
# The maximum number of results to return in the response. If the total
|
1813
|
+
# number of results is greater than this value, use the token returned
|
1814
|
+
# in the response in the `nextToken` field when making another request
|
1815
|
+
# to return the next batch of results.
|
1612
1816
|
#
|
1613
1817
|
# @option params [String] :next_token
|
1614
|
-
#
|
1818
|
+
# If the total number of results is greater than the `maxResults` value
|
1819
|
+
# provided in the request, enter the token returned in the `nextToken`
|
1820
|
+
# field in the response in this field to return the next batch of
|
1821
|
+
# results.
|
1615
1822
|
#
|
1616
1823
|
# @return [Types::ListAgentActionGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1617
1824
|
#
|
@@ -1648,16 +1855,22 @@ module Aws::BedrockAgent
|
|
1648
1855
|
req.send_request(options)
|
1649
1856
|
end
|
1650
1857
|
|
1651
|
-
# Lists
|
1858
|
+
# Lists the aliases of an agent and information about each one.
|
1652
1859
|
#
|
1653
1860
|
# @option params [required, String] :agent_id
|
1654
|
-
#
|
1861
|
+
# The unique identifier of the agent.
|
1655
1862
|
#
|
1656
1863
|
# @option params [Integer] :max_results
|
1657
|
-
#
|
1864
|
+
# The maximum number of results to return in the response. If the total
|
1865
|
+
# number of results is greater than this value, use the token returned
|
1866
|
+
# in the response in the `nextToken` field when making another request
|
1867
|
+
# to return the next batch of results.
|
1658
1868
|
#
|
1659
1869
|
# @option params [String] :next_token
|
1660
|
-
#
|
1870
|
+
# If the total number of results is greater than the `maxResults` value
|
1871
|
+
# provided in the request, enter the token returned in the `nextToken`
|
1872
|
+
# field in the response in this field to return the next batch of
|
1873
|
+
# results.
|
1661
1874
|
#
|
1662
1875
|
# @return [Types::ListAgentAliasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1663
1876
|
#
|
@@ -1679,11 +1892,11 @@ module Aws::BedrockAgent
|
|
1679
1892
|
# resp.agent_alias_summaries #=> Array
|
1680
1893
|
# resp.agent_alias_summaries[0].agent_alias_id #=> String
|
1681
1894
|
# resp.agent_alias_summaries[0].agent_alias_name #=> String
|
1895
|
+
# resp.agent_alias_summaries[0].agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
1896
|
+
# resp.agent_alias_summaries[0].created_at #=> Time
|
1682
1897
|
# resp.agent_alias_summaries[0].description #=> String
|
1683
1898
|
# resp.agent_alias_summaries[0].routing_configuration #=> Array
|
1684
1899
|
# resp.agent_alias_summaries[0].routing_configuration[0].agent_version #=> String
|
1685
|
-
# resp.agent_alias_summaries[0].agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
1686
|
-
# resp.agent_alias_summaries[0].created_at #=> Time
|
1687
1900
|
# resp.agent_alias_summaries[0].updated_at #=> Time
|
1688
1901
|
# resp.next_token #=> String
|
1689
1902
|
#
|
@@ -1696,20 +1909,28 @@ module Aws::BedrockAgent
|
|
1696
1909
|
req.send_request(options)
|
1697
1910
|
end
|
1698
1911
|
|
1699
|
-
#
|
1700
|
-
#
|
1912
|
+
# Lists knowledge bases associated with an agent and information about
|
1913
|
+
# each one.
|
1701
1914
|
#
|
1702
1915
|
# @option params [required, String] :agent_id
|
1703
|
-
#
|
1916
|
+
# The unique identifier of the agent for which to return information
|
1917
|
+
# about knowledge bases associated with it.
|
1704
1918
|
#
|
1705
1919
|
# @option params [required, String] :agent_version
|
1706
|
-
#
|
1920
|
+
# The version of the agent for which to return information about
|
1921
|
+
# knowledge bases associated with it.
|
1707
1922
|
#
|
1708
1923
|
# @option params [Integer] :max_results
|
1709
|
-
#
|
1924
|
+
# The maximum number of results to return in the response. If the total
|
1925
|
+
# number of results is greater than this value, use the token returned
|
1926
|
+
# in the response in the `nextToken` field when making another request
|
1927
|
+
# to return the next batch of results.
|
1710
1928
|
#
|
1711
1929
|
# @option params [String] :next_token
|
1712
|
-
#
|
1930
|
+
# If the total number of results is greater than the `maxResults` value
|
1931
|
+
# provided in the request, enter the token returned in the `nextToken`
|
1932
|
+
# field in the response in this field to return the next batch of
|
1933
|
+
# results.
|
1713
1934
|
#
|
1714
1935
|
# @return [Types::ListAgentKnowledgeBasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1715
1936
|
#
|
@@ -1730,8 +1951,8 @@ module Aws::BedrockAgent
|
|
1730
1951
|
# @example Response structure
|
1731
1952
|
#
|
1732
1953
|
# resp.agent_knowledge_base_summaries #=> Array
|
1733
|
-
# resp.agent_knowledge_base_summaries[0].knowledge_base_id #=> String
|
1734
1954
|
# resp.agent_knowledge_base_summaries[0].description #=> String
|
1955
|
+
# resp.agent_knowledge_base_summaries[0].knowledge_base_id #=> String
|
1735
1956
|
# resp.agent_knowledge_base_summaries[0].knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
|
1736
1957
|
# resp.agent_knowledge_base_summaries[0].updated_at #=> Time
|
1737
1958
|
# resp.next_token #=> String
|
@@ -1745,16 +1966,22 @@ module Aws::BedrockAgent
|
|
1745
1966
|
req.send_request(options)
|
1746
1967
|
end
|
1747
1968
|
|
1748
|
-
# Lists
|
1969
|
+
# Lists the versions of an agent and information about each version.
|
1749
1970
|
#
|
1750
1971
|
# @option params [required, String] :agent_id
|
1751
|
-
#
|
1972
|
+
# The unique identifier of the agent.
|
1752
1973
|
#
|
1753
1974
|
# @option params [Integer] :max_results
|
1754
|
-
#
|
1975
|
+
# The maximum number of results to return in the response. If the total
|
1976
|
+
# number of results is greater than this value, use the token returned
|
1977
|
+
# in the response in the `nextToken` field when making another request
|
1978
|
+
# to return the next batch of results.
|
1755
1979
|
#
|
1756
1980
|
# @option params [String] :next_token
|
1757
|
-
#
|
1981
|
+
# If the total number of results is greater than the `maxResults` value
|
1982
|
+
# provided in the request, enter the token returned in the `nextToken`
|
1983
|
+
# field in the response in this field to return the next batch of
|
1984
|
+
# results.
|
1758
1985
|
#
|
1759
1986
|
# @return [Types::ListAgentVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1760
1987
|
#
|
@@ -1778,8 +2005,8 @@ module Aws::BedrockAgent
|
|
1778
2005
|
# resp.agent_version_summaries[0].agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1779
2006
|
# resp.agent_version_summaries[0].agent_version #=> String
|
1780
2007
|
# resp.agent_version_summaries[0].created_at #=> Time
|
1781
|
-
# resp.agent_version_summaries[0].updated_at #=> Time
|
1782
2008
|
# resp.agent_version_summaries[0].description #=> String
|
2009
|
+
# resp.agent_version_summaries[0].updated_at #=> Time
|
1783
2010
|
# resp.next_token #=> String
|
1784
2011
|
#
|
1785
2012
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgentVersions AWS API Documentation
|
@@ -1791,13 +2018,20 @@ module Aws::BedrockAgent
|
|
1791
2018
|
req.send_request(options)
|
1792
2019
|
end
|
1793
2020
|
|
1794
|
-
# Lists
|
2021
|
+
# Lists the agents belonging to an account and information about each
|
2022
|
+
# agent.
|
1795
2023
|
#
|
1796
2024
|
# @option params [Integer] :max_results
|
1797
|
-
#
|
2025
|
+
# The maximum number of results to return in the response. If the total
|
2026
|
+
# number of results is greater than this value, use the token returned
|
2027
|
+
# in the response in the `nextToken` field when making another request
|
2028
|
+
# to return the next batch of results.
|
1798
2029
|
#
|
1799
2030
|
# @option params [String] :next_token
|
1800
|
-
#
|
2031
|
+
# If the total number of results is greater than the `maxResults` value
|
2032
|
+
# provided in the request, enter the token returned in the `nextToken`
|
2033
|
+
# field in the response in this field to return the next batch of
|
2034
|
+
# results.
|
1801
2035
|
#
|
1802
2036
|
# @return [Types::ListAgentsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1803
2037
|
#
|
@@ -1820,8 +2054,8 @@ module Aws::BedrockAgent
|
|
1820
2054
|
# resp.agent_summaries[0].agent_name #=> String
|
1821
2055
|
# resp.agent_summaries[0].agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
1822
2056
|
# resp.agent_summaries[0].description #=> String
|
1823
|
-
# resp.agent_summaries[0].updated_at #=> Time
|
1824
2057
|
# resp.agent_summaries[0].latest_agent_version #=> String
|
2058
|
+
# resp.agent_summaries[0].updated_at #=> Time
|
1825
2059
|
# resp.next_token #=> String
|
1826
2060
|
#
|
1827
2061
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListAgents AWS API Documentation
|
@@ -1833,16 +2067,24 @@ module Aws::BedrockAgent
|
|
1833
2067
|
req.send_request(options)
|
1834
2068
|
end
|
1835
2069
|
|
1836
|
-
#
|
2070
|
+
# Lists the data sources in a knowledge base and information about each
|
2071
|
+
# one.
|
1837
2072
|
#
|
1838
2073
|
# @option params [required, String] :knowledge_base_id
|
1839
|
-
#
|
2074
|
+
# The unique identifier of the knowledge base for which to return a list
|
2075
|
+
# of information.
|
1840
2076
|
#
|
1841
2077
|
# @option params [Integer] :max_results
|
1842
|
-
#
|
2078
|
+
# The maximum number of results to return in the response. If the total
|
2079
|
+
# number of results is greater than this value, use the token returned
|
2080
|
+
# in the response in the `nextToken` field when making another request
|
2081
|
+
# to return the next batch of results.
|
1843
2082
|
#
|
1844
2083
|
# @option params [String] :next_token
|
1845
|
-
#
|
2084
|
+
# If the total number of results is greater than the `maxResults` value
|
2085
|
+
# provided in the request, enter the token returned in the `nextToken`
|
2086
|
+
# field in the response in this field to return the next batch of
|
2087
|
+
# results.
|
1846
2088
|
#
|
1847
2089
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1848
2090
|
#
|
@@ -1862,11 +2104,11 @@ module Aws::BedrockAgent
|
|
1862
2104
|
# @example Response structure
|
1863
2105
|
#
|
1864
2106
|
# resp.data_source_summaries #=> Array
|
1865
|
-
# resp.data_source_summaries[0].knowledge_base_id #=> String
|
1866
2107
|
# resp.data_source_summaries[0].data_source_id #=> String
|
2108
|
+
# resp.data_source_summaries[0].description #=> String
|
2109
|
+
# resp.data_source_summaries[0].knowledge_base_id #=> String
|
1867
2110
|
# resp.data_source_summaries[0].name #=> String
|
1868
2111
|
# resp.data_source_summaries[0].status #=> String, one of "AVAILABLE", "DELETING"
|
1869
|
-
# resp.data_source_summaries[0].description #=> String
|
1870
2112
|
# resp.data_source_summaries[0].updated_at #=> Time
|
1871
2113
|
# resp.next_token #=> String
|
1872
2114
|
#
|
@@ -1879,25 +2121,34 @@ module Aws::BedrockAgent
|
|
1879
2121
|
req.send_request(options)
|
1880
2122
|
end
|
1881
2123
|
|
1882
|
-
#
|
1883
|
-
#
|
1884
|
-
# @option params [required, String] :knowledge_base_id
|
1885
|
-
# Identifier for a resource.
|
2124
|
+
# Lists the ingestion jobs for a data source and information about each
|
2125
|
+
# of them.
|
1886
2126
|
#
|
1887
2127
|
# @option params [required, String] :data_source_id
|
1888
|
-
#
|
2128
|
+
# The unique identifier of the data source for which to return ingestion
|
2129
|
+
# jobs.
|
1889
2130
|
#
|
1890
2131
|
# @option params [Array<Types::IngestionJobFilter>] :filters
|
1891
|
-
#
|
2132
|
+
# Contains a definition of a filter for which to filter the results.
|
1892
2133
|
#
|
1893
|
-
# @option params [
|
1894
|
-
#
|
2134
|
+
# @option params [required, String] :knowledge_base_id
|
2135
|
+
# The unique identifier of the knowledge base for which to return
|
2136
|
+
# ingestion jobs.
|
1895
2137
|
#
|
1896
2138
|
# @option params [Integer] :max_results
|
1897
|
-
#
|
2139
|
+
# The maximum number of results to return in the response. If the total
|
2140
|
+
# number of results is greater than this value, use the token returned
|
2141
|
+
# in the response in the `nextToken` field when making another request
|
2142
|
+
# to return the next batch of results.
|
1898
2143
|
#
|
1899
2144
|
# @option params [String] :next_token
|
1900
|
-
#
|
2145
|
+
# If the total number of results is greater than the `maxResults` value
|
2146
|
+
# provided in the request, enter the token returned in the `nextToken`
|
2147
|
+
# field in the response in this field to return the next batch of
|
2148
|
+
# results.
|
2149
|
+
#
|
2150
|
+
# @option params [Types::IngestionJobSortBy] :sort_by
|
2151
|
+
# Contains details about how to sort the results.
|
1901
2152
|
#
|
1902
2153
|
# @return [Types::ListIngestionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1903
2154
|
#
|
@@ -1909,7 +2160,6 @@ module Aws::BedrockAgent
|
|
1909
2160
|
# @example Request syntax with placeholder values
|
1910
2161
|
#
|
1911
2162
|
# resp = client.list_ingestion_jobs({
|
1912
|
-
# knowledge_base_id: "Id", # required
|
1913
2163
|
# data_source_id: "Id", # required
|
1914
2164
|
# filters: [
|
1915
2165
|
# {
|
@@ -1918,29 +2168,32 @@ module Aws::BedrockAgent
|
|
1918
2168
|
# values: ["IngestionJobFilterValue"], # required
|
1919
2169
|
# },
|
1920
2170
|
# ],
|
2171
|
+
# knowledge_base_id: "Id", # required
|
2172
|
+
# max_results: 1,
|
2173
|
+
# next_token: "NextToken",
|
1921
2174
|
# sort_by: {
|
1922
2175
|
# attribute: "STATUS", # required, accepts STATUS, STARTED_AT
|
1923
2176
|
# order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
|
1924
2177
|
# },
|
1925
|
-
# max_results: 1,
|
1926
|
-
# next_token: "NextToken",
|
1927
2178
|
# })
|
1928
2179
|
#
|
1929
2180
|
# @example Response structure
|
1930
2181
|
#
|
1931
2182
|
# resp.ingestion_job_summaries #=> Array
|
1932
|
-
# resp.ingestion_job_summaries[0].knowledge_base_id #=> String
|
1933
2183
|
# resp.ingestion_job_summaries[0].data_source_id #=> String
|
1934
|
-
# resp.ingestion_job_summaries[0].ingestion_job_id #=> String
|
1935
2184
|
# resp.ingestion_job_summaries[0].description #=> String
|
1936
|
-
# resp.ingestion_job_summaries[0].
|
2185
|
+
# resp.ingestion_job_summaries[0].ingestion_job_id #=> String
|
2186
|
+
# resp.ingestion_job_summaries[0].knowledge_base_id #=> String
|
1937
2187
|
# resp.ingestion_job_summaries[0].started_at #=> Time
|
1938
|
-
# resp.ingestion_job_summaries[0].updated_at #=> Time
|
1939
|
-
# resp.ingestion_job_summaries[0].statistics.number_of_documents_scanned #=> Integer
|
1940
|
-
# resp.ingestion_job_summaries[0].statistics.number_of_new_documents_indexed #=> Integer
|
1941
|
-
# resp.ingestion_job_summaries[0].statistics.number_of_modified_documents_indexed #=> Integer
|
1942
2188
|
# resp.ingestion_job_summaries[0].statistics.number_of_documents_deleted #=> Integer
|
1943
2189
|
# resp.ingestion_job_summaries[0].statistics.number_of_documents_failed #=> Integer
|
2190
|
+
# resp.ingestion_job_summaries[0].statistics.number_of_documents_scanned #=> Integer
|
2191
|
+
# resp.ingestion_job_summaries[0].statistics.number_of_metadata_documents_modified #=> Integer
|
2192
|
+
# resp.ingestion_job_summaries[0].statistics.number_of_metadata_documents_scanned #=> Integer
|
2193
|
+
# resp.ingestion_job_summaries[0].statistics.number_of_modified_documents_indexed #=> Integer
|
2194
|
+
# resp.ingestion_job_summaries[0].statistics.number_of_new_documents_indexed #=> Integer
|
2195
|
+
# resp.ingestion_job_summaries[0].status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
|
2196
|
+
# resp.ingestion_job_summaries[0].updated_at #=> Time
|
1944
2197
|
# resp.next_token #=> String
|
1945
2198
|
#
|
1946
2199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListIngestionJobs AWS API Documentation
|
@@ -1952,13 +2205,20 @@ module Aws::BedrockAgent
|
|
1952
2205
|
req.send_request(options)
|
1953
2206
|
end
|
1954
2207
|
|
1955
|
-
#
|
2208
|
+
# Lists the knowledge bases in an account and information about each of
|
2209
|
+
# them.
|
1956
2210
|
#
|
1957
2211
|
# @option params [Integer] :max_results
|
1958
|
-
#
|
2212
|
+
# The maximum number of results to return in the response. If the total
|
2213
|
+
# number of results is greater than this value, use the token returned
|
2214
|
+
# in the response in the `nextToken` field when making another request
|
2215
|
+
# to return the next batch of results.
|
1959
2216
|
#
|
1960
2217
|
# @option params [String] :next_token
|
1961
|
-
#
|
2218
|
+
# If the total number of results is greater than the `maxResults` value
|
2219
|
+
# provided in the request, enter the token returned in the `nextToken`
|
2220
|
+
# field in the response in this field to return the next batch of
|
2221
|
+
# results.
|
1962
2222
|
#
|
1963
2223
|
# @return [Types::ListKnowledgeBasesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1964
2224
|
#
|
@@ -1977,9 +2237,9 @@ module Aws::BedrockAgent
|
|
1977
2237
|
# @example Response structure
|
1978
2238
|
#
|
1979
2239
|
# resp.knowledge_base_summaries #=> Array
|
2240
|
+
# resp.knowledge_base_summaries[0].description #=> String
|
1980
2241
|
# resp.knowledge_base_summaries[0].knowledge_base_id #=> String
|
1981
2242
|
# resp.knowledge_base_summaries[0].name #=> String
|
1982
|
-
# resp.knowledge_base_summaries[0].description #=> String
|
1983
2243
|
# resp.knowledge_base_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED"
|
1984
2244
|
# resp.knowledge_base_summaries[0].updated_at #=> Time
|
1985
2245
|
# resp.next_token #=> String
|
@@ -1993,10 +2253,10 @@ module Aws::BedrockAgent
|
|
1993
2253
|
req.send_request(options)
|
1994
2254
|
end
|
1995
2255
|
|
1996
|
-
# List tags for
|
2256
|
+
# List all the tags for the resource you specify.
|
1997
2257
|
#
|
1998
2258
|
# @option params [required, String] :resource_arn
|
1999
|
-
# ARN of
|
2259
|
+
# The Amazon Resource Name (ARN) of the resource for which to list tags.
|
2000
2260
|
#
|
2001
2261
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2002
2262
|
#
|
@@ -2022,10 +2282,12 @@ module Aws::BedrockAgent
|
|
2022
2282
|
req.send_request(options)
|
2023
2283
|
end
|
2024
2284
|
|
2025
|
-
#
|
2285
|
+
# Creates a `DRAFT` version of the agent that can be used for internal
|
2286
|
+
# testing.
|
2026
2287
|
#
|
2027
2288
|
# @option params [required, String] :agent_id
|
2028
|
-
#
|
2289
|
+
# The unique identifier of the agent for which to create a `DRAFT`
|
2290
|
+
# version.
|
2029
2291
|
#
|
2030
2292
|
# @return [Types::PrepareAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2031
2293
|
#
|
@@ -2056,22 +2318,31 @@ module Aws::BedrockAgent
|
|
2056
2318
|
req.send_request(options)
|
2057
2319
|
end
|
2058
2320
|
|
2059
|
-
#
|
2060
|
-
#
|
2061
|
-
# @option params [required, String] :knowledge_base_id
|
2062
|
-
# Identifier for a resource.
|
2063
|
-
#
|
2064
|
-
# @option params [required, String] :data_source_id
|
2065
|
-
# Identifier for a resource.
|
2321
|
+
# Begins an ingestion job, in which a data source is added to a
|
2322
|
+
# knowledge base.
|
2066
2323
|
#
|
2067
2324
|
# @option params [String] :client_token
|
2068
|
-
#
|
2325
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
2326
|
+
# completes no more than one time. If this token matches a previous
|
2327
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
2328
|
+
# error. For more information, see [Ensuring idempotency][1].
|
2069
2329
|
#
|
2070
2330
|
# **A suitable default value is auto-generated.** You should normally
|
2071
2331
|
# not need to pass this option.**
|
2072
2332
|
#
|
2333
|
+
#
|
2334
|
+
#
|
2335
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
2336
|
+
#
|
2337
|
+
# @option params [required, String] :data_source_id
|
2338
|
+
# The unique identifier of the data source to ingest.
|
2339
|
+
#
|
2073
2340
|
# @option params [String] :description
|
2074
|
-
#
|
2341
|
+
# A description of the ingestion job.
|
2342
|
+
#
|
2343
|
+
# @option params [required, String] :knowledge_base_id
|
2344
|
+
# The unique identifier of the knowledge base to which to add the data
|
2345
|
+
# source.
|
2075
2346
|
#
|
2076
2347
|
# @return [Types::StartIngestionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2077
2348
|
#
|
@@ -2080,27 +2351,29 @@ module Aws::BedrockAgent
|
|
2080
2351
|
# @example Request syntax with placeholder values
|
2081
2352
|
#
|
2082
2353
|
# resp = client.start_ingestion_job({
|
2083
|
-
# knowledge_base_id: "Id", # required
|
2084
|
-
# data_source_id: "Id", # required
|
2085
2354
|
# client_token: "ClientToken",
|
2355
|
+
# data_source_id: "Id", # required
|
2086
2356
|
# description: "Description",
|
2357
|
+
# knowledge_base_id: "Id", # required
|
2087
2358
|
# })
|
2088
2359
|
#
|
2089
2360
|
# @example Response structure
|
2090
2361
|
#
|
2091
|
-
# resp.ingestion_job.knowledge_base_id #=> String
|
2092
2362
|
# resp.ingestion_job.data_source_id #=> String
|
2093
|
-
# resp.ingestion_job.ingestion_job_id #=> String
|
2094
2363
|
# resp.ingestion_job.description #=> String
|
2095
|
-
# resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
|
2096
|
-
# resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
|
2097
|
-
# resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
|
2098
|
-
# resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
|
2099
|
-
# resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
|
2100
|
-
# resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
|
2101
2364
|
# resp.ingestion_job.failure_reasons #=> Array
|
2102
2365
|
# resp.ingestion_job.failure_reasons[0] #=> String
|
2366
|
+
# resp.ingestion_job.ingestion_job_id #=> String
|
2367
|
+
# resp.ingestion_job.knowledge_base_id #=> String
|
2103
2368
|
# resp.ingestion_job.started_at #=> Time
|
2369
|
+
# resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
|
2370
|
+
# resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
|
2371
|
+
# resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
|
2372
|
+
# resp.ingestion_job.statistics.number_of_metadata_documents_modified #=> Integer
|
2373
|
+
# resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
|
2374
|
+
# resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
|
2375
|
+
# resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
|
2376
|
+
# resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
|
2104
2377
|
# resp.ingestion_job.updated_at #=> Time
|
2105
2378
|
#
|
2106
2379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StartIngestionJob AWS API Documentation
|
@@ -2112,13 +2385,19 @@ module Aws::BedrockAgent
|
|
2112
2385
|
req.send_request(options)
|
2113
2386
|
end
|
2114
2387
|
|
2115
|
-
#
|
2388
|
+
# Associate tags with a resource. For more information, see [Tagging
|
2389
|
+
# resources][1] in the Amazon Bedrock User Guide.
|
2390
|
+
#
|
2391
|
+
#
|
2392
|
+
#
|
2393
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
|
2116
2394
|
#
|
2117
2395
|
# @option params [required, String] :resource_arn
|
2118
|
-
# ARN of
|
2396
|
+
# The Amazon Resource Name (ARN) of the resource to tag.
|
2119
2397
|
#
|
2120
2398
|
# @option params [required, Hash<String,String>] :tags
|
2121
|
-
#
|
2399
|
+
# An object containing key-value pairs that define the tags to attach to
|
2400
|
+
# the resource.
|
2122
2401
|
#
|
2123
2402
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2124
2403
|
#
|
@@ -2140,13 +2419,14 @@ module Aws::BedrockAgent
|
|
2140
2419
|
req.send_request(options)
|
2141
2420
|
end
|
2142
2421
|
|
2143
|
-
#
|
2422
|
+
# Remove tags from a resource.
|
2144
2423
|
#
|
2145
2424
|
# @option params [required, String] :resource_arn
|
2146
|
-
# ARN of
|
2425
|
+
# The Amazon Resource Name (ARN) of the resource from which to remove
|
2426
|
+
# tags.
|
2147
2427
|
#
|
2148
2428
|
# @option params [required, Array<String>] :tag_keys
|
2149
|
-
#
|
2429
|
+
# A list of keys of the tags to remove from the resource.
|
2150
2430
|
#
|
2151
2431
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2152
2432
|
#
|
@@ -2166,34 +2446,48 @@ module Aws::BedrockAgent
|
|
2166
2446
|
req.send_request(options)
|
2167
2447
|
end
|
2168
2448
|
|
2169
|
-
# Updates
|
2449
|
+
# Updates the configuration of an agent.
|
2170
2450
|
#
|
2171
2451
|
# @option params [required, String] :agent_id
|
2172
|
-
#
|
2452
|
+
# The unique identifier of the agent.
|
2173
2453
|
#
|
2174
2454
|
# @option params [required, String] :agent_name
|
2175
|
-
#
|
2455
|
+
# Specifies a new name for the agent.
|
2176
2456
|
#
|
2177
|
-
# @option params [String] :
|
2178
|
-
#
|
2457
|
+
# @option params [required, String] :agent_resource_role_arn
|
2458
|
+
# The Amazon Resource Name (ARN) of the IAM role with permissions to
|
2459
|
+
# invoke API operations on the agent.
|
2179
2460
|
#
|
2180
|
-
# @option params [String] :
|
2181
|
-
#
|
2461
|
+
# @option params [String] :customer_encryption_key_arn
|
2462
|
+
# The Amazon Resource Name (ARN) of the KMS key with which to encrypt
|
2463
|
+
# the agent.
|
2182
2464
|
#
|
2183
2465
|
# @option params [String] :description
|
2184
|
-
#
|
2466
|
+
# Specifies a new description of the agent.
|
2467
|
+
#
|
2468
|
+
# @option params [required, String] :foundation_model
|
2469
|
+
# Specifies a new foundation model to be used for orchestration by the
|
2470
|
+
# agent.
|
2185
2471
|
#
|
2186
2472
|
# @option params [Integer] :idle_session_ttl_in_seconds
|
2187
|
-
#
|
2473
|
+
# The number of seconds for which Amazon Bedrock keeps information about
|
2474
|
+
# a user's conversation with the agent.
|
2188
2475
|
#
|
2189
|
-
#
|
2190
|
-
#
|
2476
|
+
# A user interaction remains active for the amount of time specified. If
|
2477
|
+
# no conversation occurs during this time, the session expires and
|
2478
|
+
# Amazon Bedrock deletes any data provided before the timeout.
|
2191
2479
|
#
|
2192
|
-
# @option params [String] :
|
2193
|
-
#
|
2480
|
+
# @option params [String] :instruction
|
2481
|
+
# Specifies new instructions that tell the agent what it should do and
|
2482
|
+
# how it should interact with users.
|
2194
2483
|
#
|
2195
2484
|
# @option params [Types::PromptOverrideConfiguration] :prompt_override_configuration
|
2196
|
-
#
|
2485
|
+
# Contains configurations to override prompts in different parts of an
|
2486
|
+
# agent sequence. For more information, see [Advanced prompts][1].
|
2487
|
+
#
|
2488
|
+
#
|
2489
|
+
#
|
2490
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
|
2197
2491
|
#
|
2198
2492
|
# @return [Types::UpdateAgentResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2199
2493
|
#
|
@@ -2204,67 +2498,67 @@ module Aws::BedrockAgent
|
|
2204
2498
|
# resp = client.update_agent({
|
2205
2499
|
# agent_id: "Id", # required
|
2206
2500
|
# agent_name: "Name", # required
|
2207
|
-
# instruction: "Instruction",
|
2208
|
-
# foundation_model: "ModelIdentifier",
|
2209
|
-
# description: "Description",
|
2210
|
-
# idle_session_ttl_in_seconds: 1,
|
2211
2501
|
# agent_resource_role_arn: "AgentRoleArn", # required
|
2212
2502
|
# customer_encryption_key_arn: "KmsKeyArn",
|
2503
|
+
# description: "Description",
|
2504
|
+
# foundation_model: "ModelIdentifier", # required
|
2505
|
+
# idle_session_ttl_in_seconds: 1,
|
2506
|
+
# instruction: "Instruction",
|
2213
2507
|
# prompt_override_configuration: {
|
2508
|
+
# override_lambda: "LambdaArn",
|
2214
2509
|
# prompt_configurations: [ # required
|
2215
2510
|
# {
|
2216
|
-
# prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, KNOWLEDGE_BASE_RESPONSE_GENERATION
|
2217
|
-
# prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
|
2218
|
-
# prompt_state: "ENABLED", # accepts ENABLED, DISABLED
|
2219
2511
|
# base_prompt_template: "BasePromptTemplate",
|
2220
2512
|
# inference_configuration: {
|
2221
|
-
# temperature: 1.0,
|
2222
|
-
# top_p: 1.0,
|
2223
|
-
# top_k: 1,
|
2224
2513
|
# maximum_length: 1,
|
2225
2514
|
# stop_sequences: ["String"],
|
2515
|
+
# temperature: 1.0,
|
2516
|
+
# top_k: 1,
|
2517
|
+
# top_p: 1.0,
|
2226
2518
|
# },
|
2227
2519
|
# parser_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
|
2520
|
+
# prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
|
2521
|
+
# prompt_state: "ENABLED", # accepts ENABLED, DISABLED
|
2522
|
+
# prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, KNOWLEDGE_BASE_RESPONSE_GENERATION
|
2228
2523
|
# },
|
2229
2524
|
# ],
|
2230
|
-
# override_lambda: "LambdaArn",
|
2231
2525
|
# },
|
2232
2526
|
# })
|
2233
2527
|
#
|
2234
2528
|
# @example Response structure
|
2235
2529
|
#
|
2530
|
+
# resp.agent.agent_arn #=> String
|
2236
2531
|
# resp.agent.agent_id #=> String
|
2237
2532
|
# resp.agent.agent_name #=> String
|
2238
|
-
# resp.agent.
|
2533
|
+
# resp.agent.agent_resource_role_arn #=> String
|
2534
|
+
# resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
2239
2535
|
# resp.agent.agent_version #=> String
|
2240
2536
|
# resp.agent.client_token #=> String
|
2241
|
-
# resp.agent.instruction #=> String
|
2242
|
-
# resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
|
2243
|
-
# resp.agent.foundation_model #=> String
|
2244
|
-
# resp.agent.description #=> String
|
2245
|
-
# resp.agent.idle_session_ttl_in_seconds #=> Integer
|
2246
|
-
# resp.agent.agent_resource_role_arn #=> String
|
2247
|
-
# resp.agent.customer_encryption_key_arn #=> String
|
2248
2537
|
# resp.agent.created_at #=> Time
|
2249
|
-
# resp.agent.
|
2250
|
-
# resp.agent.
|
2538
|
+
# resp.agent.customer_encryption_key_arn #=> String
|
2539
|
+
# resp.agent.description #=> String
|
2251
2540
|
# resp.agent.failure_reasons #=> Array
|
2252
2541
|
# resp.agent.failure_reasons[0] #=> String
|
2253
|
-
# resp.agent.
|
2254
|
-
# resp.agent.
|
2542
|
+
# resp.agent.foundation_model #=> String
|
2543
|
+
# resp.agent.idle_session_ttl_in_seconds #=> Integer
|
2544
|
+
# resp.agent.instruction #=> String
|
2545
|
+
# resp.agent.prepared_at #=> Time
|
2546
|
+
# resp.agent.prompt_override_configuration.override_lambda #=> String
|
2255
2547
|
# resp.agent.prompt_override_configuration.prompt_configurations #=> Array
|
2256
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
2257
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
2258
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
2259
2548
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
|
2260
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
2261
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
2262
|
-
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
2263
2549
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
|
2264
2550
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
|
2265
2551
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
|
2552
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
|
2553
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
|
2554
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
|
2266
2555
|
# resp.agent.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
2267
|
-
# resp.agent.prompt_override_configuration.
|
2556
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
2557
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
|
2558
|
+
# resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
|
2559
|
+
# resp.agent.recommended_actions #=> Array
|
2560
|
+
# resp.agent.recommended_actions[0] #=> String
|
2561
|
+
# resp.agent.updated_at #=> Time
|
2268
2562
|
#
|
2269
2563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgent AWS API Documentation
|
2270
2564
|
#
|
@@ -2275,35 +2569,61 @@ module Aws::BedrockAgent
|
|
2275
2569
|
req.send_request(options)
|
2276
2570
|
end
|
2277
2571
|
|
2278
|
-
# Updates an
|
2572
|
+
# Updates the configuration for an action group for an agent.
|
2573
|
+
#
|
2574
|
+
# @option params [Types::ActionGroupExecutor] :action_group_executor
|
2575
|
+
# The Amazon Resource Name (ARN) of the Lambda function containing the
|
2576
|
+
# business logic that is carried out upon invoking the action.
|
2577
|
+
#
|
2578
|
+
# @option params [required, String] :action_group_id
|
2579
|
+
# The unique identifier of the action group.
|
2580
|
+
#
|
2581
|
+
# @option params [required, String] :action_group_name
|
2582
|
+
# Specifies a new name for the action group.
|
2583
|
+
#
|
2584
|
+
# @option params [String] :action_group_state
|
2585
|
+
# Specifies whether the action group is available for the agent to
|
2586
|
+
# invoke or not when sending an [InvokeAgent][1] request.
|
2587
|
+
#
|
2588
|
+
#
|
2589
|
+
#
|
2590
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
2279
2591
|
#
|
2280
2592
|
# @option params [required, String] :agent_id
|
2281
|
-
#
|
2593
|
+
# The unique identifier of the agent for which to update the action
|
2594
|
+
# group.
|
2282
2595
|
#
|
2283
2596
|
# @option params [required, String] :agent_version
|
2284
|
-
#
|
2597
|
+
# The unique identifier of the agent version for which to update the
|
2598
|
+
# action group.
|
2599
|
+
#
|
2600
|
+
# @option params [Types::APISchema] :api_schema
|
2601
|
+
# Contains either details about the S3 object containing the OpenAPI
|
2602
|
+
# schema for the action group or the JSON or YAML-formatted payload
|
2603
|
+
# defining the schema. For more information, see [Action group OpenAPI
|
2604
|
+
# schemas][1].
|
2285
2605
|
#
|
2286
|
-
# @option params [required, String] :action_group_id
|
2287
|
-
# Id generated at the server side when an Action Group is created under
|
2288
|
-
# Agent
|
2289
2606
|
#
|
2290
|
-
#
|
2291
|
-
#
|
2607
|
+
#
|
2608
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html
|
2292
2609
|
#
|
2293
2610
|
# @option params [String] :description
|
2294
|
-
#
|
2611
|
+
# Specifies a new name for the action group.
|
2295
2612
|
#
|
2296
2613
|
# @option params [String] :parent_action_group_signature
|
2297
|
-
#
|
2614
|
+
# To allow your agent to request the user for additional information
|
2615
|
+
# when trying to complete a task, set this field to `AMAZON.UserInput`.
|
2616
|
+
# You must leave the `description`, `apiSchema`, and
|
2617
|
+
# `actionGroupExecutor` fields blank for this action group.
|
2298
2618
|
#
|
2299
|
-
#
|
2300
|
-
#
|
2619
|
+
# During orchestration, if your agent determines that it needs to invoke
|
2620
|
+
# an API in an action group, but doesn't have enough information to
|
2621
|
+
# complete the API request, it will invoke this action group instead and
|
2622
|
+
# return an [Observation][1] reprompting the user for more information.
|
2301
2623
|
#
|
2302
|
-
# @option params [String] :action_group_state
|
2303
|
-
# State of the action group
|
2304
2624
|
#
|
2305
|
-
#
|
2306
|
-
#
|
2625
|
+
#
|
2626
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
|
2307
2627
|
#
|
2308
2628
|
# @return [Types::UpdateAgentActionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2309
2629
|
#
|
@@ -2312,41 +2632,41 @@ module Aws::BedrockAgent
|
|
2312
2632
|
# @example Request syntax with placeholder values
|
2313
2633
|
#
|
2314
2634
|
# resp = client.update_agent_action_group({
|
2315
|
-
# agent_id: "Id", # required
|
2316
|
-
# agent_version: "DraftVersion", # required
|
2317
|
-
# action_group_id: "Id", # required
|
2318
|
-
# action_group_name: "Name", # required
|
2319
|
-
# description: "Description",
|
2320
|
-
# parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
|
2321
2635
|
# action_group_executor: {
|
2322
2636
|
# lambda: "LambdaArn",
|
2323
2637
|
# },
|
2638
|
+
# action_group_id: "Id", # required
|
2639
|
+
# action_group_name: "Name", # required
|
2324
2640
|
# action_group_state: "ENABLED", # accepts ENABLED, DISABLED
|
2641
|
+
# agent_id: "Id", # required
|
2642
|
+
# agent_version: "DraftVersion", # required
|
2325
2643
|
# api_schema: {
|
2644
|
+
# payload: "Payload",
|
2326
2645
|
# s3: {
|
2327
2646
|
# s3_bucket_name: "S3BucketName",
|
2328
2647
|
# s3_object_key: "S3ObjectKey",
|
2329
2648
|
# },
|
2330
|
-
# payload: "Payload",
|
2331
2649
|
# },
|
2650
|
+
# description: "Description",
|
2651
|
+
# parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
|
2332
2652
|
# })
|
2333
2653
|
#
|
2334
2654
|
# @example Response structure
|
2335
2655
|
#
|
2336
|
-
# resp.agent_action_group.
|
2337
|
-
# resp.agent_action_group.agent_version #=> String
|
2656
|
+
# resp.agent_action_group.action_group_executor.lambda #=> String
|
2338
2657
|
# resp.agent_action_group.action_group_id #=> String
|
2339
2658
|
# resp.agent_action_group.action_group_name #=> String
|
2659
|
+
# resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
|
2660
|
+
# resp.agent_action_group.agent_id #=> String
|
2661
|
+
# resp.agent_action_group.agent_version #=> String
|
2662
|
+
# resp.agent_action_group.api_schema.payload #=> String
|
2663
|
+
# resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
|
2664
|
+
# resp.agent_action_group.api_schema.s3.s3_object_key #=> String
|
2340
2665
|
# resp.agent_action_group.client_token #=> String
|
2341
|
-
# resp.agent_action_group.description #=> String
|
2342
2666
|
# resp.agent_action_group.created_at #=> Time
|
2343
|
-
# resp.agent_action_group.
|
2667
|
+
# resp.agent_action_group.description #=> String
|
2344
2668
|
# resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
|
2345
|
-
# resp.agent_action_group.
|
2346
|
-
# resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
|
2347
|
-
# resp.agent_action_group.api_schema.s3.s3_object_key #=> String
|
2348
|
-
# resp.agent_action_group.api_schema.payload #=> String
|
2349
|
-
# resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
|
2669
|
+
# resp.agent_action_group.updated_at #=> Time
|
2350
2670
|
#
|
2351
2671
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroup AWS API Documentation
|
2352
2672
|
#
|
@@ -2357,22 +2677,22 @@ module Aws::BedrockAgent
|
|
2357
2677
|
req.send_request(options)
|
2358
2678
|
end
|
2359
2679
|
|
2360
|
-
# Updates
|
2361
|
-
#
|
2362
|
-
# @option params [required, String] :agent_id
|
2363
|
-
# Id generated at the server side when an Agent is created
|
2680
|
+
# Updates configurations for an alias of an agent.
|
2364
2681
|
#
|
2365
2682
|
# @option params [required, String] :agent_alias_id
|
2366
|
-
#
|
2683
|
+
# The unique identifier of the alias.
|
2367
2684
|
#
|
2368
2685
|
# @option params [required, String] :agent_alias_name
|
2369
|
-
#
|
2686
|
+
# Specifies a new name for the alias.
|
2687
|
+
#
|
2688
|
+
# @option params [required, String] :agent_id
|
2689
|
+
# The unique identifier of the agent.
|
2370
2690
|
#
|
2371
2691
|
# @option params [String] :description
|
2372
|
-
#
|
2692
|
+
# Specifies a new description for the alias.
|
2373
2693
|
#
|
2374
2694
|
# @option params [Array<Types::AgentAliasRoutingConfigurationListItem>] :routing_configuration
|
2375
|
-
#
|
2695
|
+
# Contains details about the routing configuration of the alias.
|
2376
2696
|
#
|
2377
2697
|
# @return [Types::UpdateAgentAliasResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2378
2698
|
#
|
@@ -2381,9 +2701,9 @@ module Aws::BedrockAgent
|
|
2381
2701
|
# @example Request syntax with placeholder values
|
2382
2702
|
#
|
2383
2703
|
# resp = client.update_agent_alias({
|
2384
|
-
# agent_id: "Id", # required
|
2385
2704
|
# agent_alias_id: "AgentAliasId", # required
|
2386
2705
|
# agent_alias_name: "Name", # required
|
2706
|
+
# agent_id: "Id", # required
|
2387
2707
|
# description: "Description",
|
2388
2708
|
# routing_configuration: [
|
2389
2709
|
# {
|
@@ -2394,22 +2714,22 @@ module Aws::BedrockAgent
|
|
2394
2714
|
#
|
2395
2715
|
# @example Response structure
|
2396
2716
|
#
|
2397
|
-
# resp.agent_alias.
|
2717
|
+
# resp.agent_alias.agent_alias_arn #=> String
|
2718
|
+
# resp.agent_alias.agent_alias_history_events #=> Array
|
2719
|
+
# resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
|
2720
|
+
# resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
|
2721
|
+
# resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
|
2722
|
+
# resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
|
2398
2723
|
# resp.agent_alias.agent_alias_id #=> String
|
2399
2724
|
# resp.agent_alias.agent_alias_name #=> String
|
2400
|
-
# resp.agent_alias.
|
2725
|
+
# resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
2726
|
+
# resp.agent_alias.agent_id #=> String
|
2401
2727
|
# resp.agent_alias.client_token #=> String
|
2728
|
+
# resp.agent_alias.created_at #=> Time
|
2402
2729
|
# resp.agent_alias.description #=> String
|
2403
2730
|
# resp.agent_alias.routing_configuration #=> Array
|
2404
2731
|
# resp.agent_alias.routing_configuration[0].agent_version #=> String
|
2405
|
-
# resp.agent_alias.created_at #=> Time
|
2406
2732
|
# resp.agent_alias.updated_at #=> Time
|
2407
|
-
# resp.agent_alias.agent_alias_history_events #=> Array
|
2408
|
-
# resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
|
2409
|
-
# resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
|
2410
|
-
# resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
|
2411
|
-
# resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
|
2412
|
-
# resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
|
2413
2733
|
#
|
2414
2734
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentAlias AWS API Documentation
|
2415
2735
|
#
|
@@ -2420,24 +2740,32 @@ module Aws::BedrockAgent
|
|
2420
2740
|
req.send_request(options)
|
2421
2741
|
end
|
2422
2742
|
|
2423
|
-
# Updates
|
2424
|
-
#
|
2743
|
+
# Updates the configuration for a knowledge base that has been
|
2744
|
+
# associated with an agent.
|
2425
2745
|
#
|
2426
2746
|
# @option params [required, String] :agent_id
|
2427
|
-
#
|
2747
|
+
# The unique identifier of the agent associated with the knowledge base
|
2748
|
+
# that you want to update.
|
2428
2749
|
#
|
2429
2750
|
# @option params [required, String] :agent_version
|
2430
|
-
#
|
2431
|
-
#
|
2432
|
-
# @option params [required, String] :knowledge_base_id
|
2433
|
-
# Id generated at the server side when a Knowledge Base is associated to
|
2434
|
-
# an Agent
|
2751
|
+
# The version of the agent associated with the knowledge base that you
|
2752
|
+
# want to update.
|
2435
2753
|
#
|
2436
2754
|
# @option params [String] :description
|
2437
|
-
#
|
2755
|
+
# Specifies a new description for the knowledge base associated with an
|
2756
|
+
# agent.
|
2757
|
+
#
|
2758
|
+
# @option params [required, String] :knowledge_base_id
|
2759
|
+
# The unique identifier of the knowledge base that has been associated
|
2760
|
+
# with an agent.
|
2438
2761
|
#
|
2439
2762
|
# @option params [String] :knowledge_base_state
|
2440
|
-
#
|
2763
|
+
# Specifies whether the agent uses the knowledge base or not when
|
2764
|
+
# sending an [InvokeAgent][1] request.
|
2765
|
+
#
|
2766
|
+
#
|
2767
|
+
#
|
2768
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
|
2441
2769
|
#
|
2442
2770
|
# @return [Types::UpdateAgentKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2443
2771
|
#
|
@@ -2448,8 +2776,8 @@ module Aws::BedrockAgent
|
|
2448
2776
|
# resp = client.update_agent_knowledge_base({
|
2449
2777
|
# agent_id: "Id", # required
|
2450
2778
|
# agent_version: "DraftVersion", # required
|
2451
|
-
# knowledge_base_id: "Id", # required
|
2452
2779
|
# description: "Description",
|
2780
|
+
# knowledge_base_id: "Id", # required
|
2453
2781
|
# knowledge_base_state: "ENABLED", # accepts ENABLED, DISABLED
|
2454
2782
|
# })
|
2455
2783
|
#
|
@@ -2457,11 +2785,11 @@ module Aws::BedrockAgent
|
|
2457
2785
|
#
|
2458
2786
|
# resp.agent_knowledge_base.agent_id #=> String
|
2459
2787
|
# resp.agent_knowledge_base.agent_version #=> String
|
2460
|
-
# resp.agent_knowledge_base.knowledge_base_id #=> String
|
2461
|
-
# resp.agent_knowledge_base.description #=> String
|
2462
2788
|
# resp.agent_knowledge_base.created_at #=> Time
|
2463
|
-
# resp.agent_knowledge_base.
|
2789
|
+
# resp.agent_knowledge_base.description #=> String
|
2790
|
+
# resp.agent_knowledge_base.knowledge_base_id #=> String
|
2464
2791
|
# resp.agent_knowledge_base.knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
|
2792
|
+
# resp.agent_knowledge_base.updated_at #=> Time
|
2465
2793
|
#
|
2466
2794
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentKnowledgeBase AWS API Documentation
|
2467
2795
|
#
|
@@ -2472,28 +2800,32 @@ module Aws::BedrockAgent
|
|
2472
2800
|
req.send_request(options)
|
2473
2801
|
end
|
2474
2802
|
|
2475
|
-
#
|
2803
|
+
# Updates configurations for a data source.
|
2476
2804
|
#
|
2477
|
-
#
|
2478
|
-
#
|
2805
|
+
# You can't change the `chunkingConfiguration` after you create the
|
2806
|
+
# data source. Specify the existing `chunkingConfiguration`.
|
2479
2807
|
#
|
2480
|
-
# @option params [required,
|
2481
|
-
#
|
2808
|
+
# @option params [required, Types::DataSourceConfiguration] :data_source_configuration
|
2809
|
+
# Contains details about the storage configuration of the data source.
|
2482
2810
|
#
|
2483
|
-
# @option params [required, String] :
|
2484
|
-
#
|
2811
|
+
# @option params [required, String] :data_source_id
|
2812
|
+
# The unique identifier of the data source.
|
2485
2813
|
#
|
2486
2814
|
# @option params [String] :description
|
2487
|
-
#
|
2815
|
+
# Specifies a new description for the data source.
|
2488
2816
|
#
|
2489
|
-
# @option params [required,
|
2490
|
-
#
|
2817
|
+
# @option params [required, String] :knowledge_base_id
|
2818
|
+
# The unique identifier of the knowledge base to which the data source
|
2819
|
+
# belongs.
|
2820
|
+
#
|
2821
|
+
# @option params [required, String] :name
|
2822
|
+
# Specifies a new name for the data source.
|
2491
2823
|
#
|
2492
2824
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
2493
|
-
#
|
2825
|
+
# Contains details about server-side encryption of the data source.
|
2494
2826
|
#
|
2495
2827
|
# @option params [Types::VectorIngestionConfiguration] :vector_ingestion_configuration
|
2496
|
-
#
|
2828
|
+
# Contains details about how to ingest the documents in the data source.
|
2497
2829
|
#
|
2498
2830
|
# @return [Types::UpdateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2499
2831
|
#
|
@@ -2502,17 +2834,17 @@ module Aws::BedrockAgent
|
|
2502
2834
|
# @example Request syntax with placeholder values
|
2503
2835
|
#
|
2504
2836
|
# resp = client.update_data_source({
|
2505
|
-
# knowledge_base_id: "Id", # required
|
2506
|
-
# data_source_id: "Id", # required
|
2507
|
-
# name: "Name", # required
|
2508
|
-
# description: "Description",
|
2509
2837
|
# data_source_configuration: { # required
|
2510
|
-
# type: "S3", # required, accepts S3
|
2511
2838
|
# s3_configuration: {
|
2512
2839
|
# bucket_arn: "S3BucketArn", # required
|
2513
2840
|
# inclusion_prefixes: ["S3Prefix"],
|
2514
2841
|
# },
|
2842
|
+
# type: "S3", # required, accepts S3
|
2515
2843
|
# },
|
2844
|
+
# data_source_id: "Id", # required
|
2845
|
+
# description: "Description",
|
2846
|
+
# knowledge_base_id: "Id", # required
|
2847
|
+
# name: "Name", # required
|
2516
2848
|
# server_side_encryption_configuration: {
|
2517
2849
|
# kms_key_arn: "KmsKeyArn",
|
2518
2850
|
# },
|
@@ -2529,21 +2861,21 @@ module Aws::BedrockAgent
|
|
2529
2861
|
#
|
2530
2862
|
# @example Response structure
|
2531
2863
|
#
|
2532
|
-
# resp.data_source.
|
2533
|
-
# resp.data_source.data_source_id #=> String
|
2534
|
-
# resp.data_source.name #=> String
|
2535
|
-
# resp.data_source.status #=> String, one of "AVAILABLE", "DELETING"
|
2536
|
-
# resp.data_source.description #=> String
|
2537
|
-
# resp.data_source.data_source_configuration.type #=> String, one of "S3"
|
2864
|
+
# resp.data_source.created_at #=> Time
|
2538
2865
|
# resp.data_source.data_source_configuration.s3_configuration.bucket_arn #=> String
|
2539
2866
|
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
|
2540
2867
|
# resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
2868
|
+
# resp.data_source.data_source_configuration.type #=> String, one of "S3"
|
2869
|
+
# resp.data_source.data_source_id #=> String
|
2870
|
+
# resp.data_source.description #=> String
|
2871
|
+
# resp.data_source.knowledge_base_id #=> String
|
2872
|
+
# resp.data_source.name #=> String
|
2541
2873
|
# resp.data_source.server_side_encryption_configuration.kms_key_arn #=> String
|
2874
|
+
# resp.data_source.status #=> String, one of "AVAILABLE", "DELETING"
|
2875
|
+
# resp.data_source.updated_at #=> Time
|
2542
2876
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE"
|
2543
2877
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
|
2544
2878
|
# resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer
|
2545
|
-
# resp.data_source.created_at #=> Time
|
2546
|
-
# resp.data_source.updated_at #=> Time
|
2547
2879
|
#
|
2548
2880
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateDataSource AWS API Documentation
|
2549
2881
|
#
|
@@ -2554,25 +2886,49 @@ module Aws::BedrockAgent
|
|
2554
2886
|
req.send_request(options)
|
2555
2887
|
end
|
2556
2888
|
|
2557
|
-
#
|
2889
|
+
# Updates the configuration of a knowledge base with the fields that you
|
2890
|
+
# specify. Because all fields will be overwritten, you must include the
|
2891
|
+
# same values for fields that you want to keep the same.
|
2558
2892
|
#
|
2559
|
-
#
|
2560
|
-
# Identifier for a resource.
|
2893
|
+
# You can change the following fields:
|
2561
2894
|
#
|
2562
|
-
#
|
2563
|
-
# Name for a resource.
|
2895
|
+
# * `name`
|
2564
2896
|
#
|
2565
|
-
#
|
2566
|
-
# Description of the Resource.
|
2897
|
+
# * `description`
|
2567
2898
|
#
|
2568
|
-
#
|
2569
|
-
#
|
2899
|
+
# * `roleArn`
|
2900
|
+
#
|
2901
|
+
# You can't change the `knowledgeBaseConfiguration` or
|
2902
|
+
# `storageConfiguration` fields, so you must specify the same
|
2903
|
+
# configurations as when you created the knowledge base. You can send a
|
2904
|
+
# [GetKnowledgeBase][1] request and copy the same configurations.
|
2905
|
+
#
|
2906
|
+
#
|
2907
|
+
#
|
2908
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetKnowledgeBase.html
|
2909
|
+
#
|
2910
|
+
# @option params [String] :description
|
2911
|
+
# Specifies a new description for the knowledge base.
|
2570
2912
|
#
|
2571
2913
|
# @option params [required, Types::KnowledgeBaseConfiguration] :knowledge_base_configuration
|
2572
|
-
#
|
2914
|
+
# Specifies the configuration for the embeddings model used for the
|
2915
|
+
# knowledge base. You must use the same configuration as when the
|
2916
|
+
# knowledge base was created.
|
2917
|
+
#
|
2918
|
+
# @option params [required, String] :knowledge_base_id
|
2919
|
+
# The unique identifier of the knowledge base to update.
|
2920
|
+
#
|
2921
|
+
# @option params [required, String] :name
|
2922
|
+
# Specifies a new name for the knowledge base.
|
2923
|
+
#
|
2924
|
+
# @option params [required, String] :role_arn
|
2925
|
+
# Specifies a different Amazon Resource Name (ARN) of the IAM role with
|
2926
|
+
# permissions to invoke API operations on the knowledge base.
|
2573
2927
|
#
|
2574
2928
|
# @option params [required, Types::StorageConfiguration] :storage_configuration
|
2575
|
-
#
|
2929
|
+
# Specifies the configuration for the vector store used for the
|
2930
|
+
# knowledge base. You must use the same configuration as when the
|
2931
|
+
# knowledge base was created.
|
2576
2932
|
#
|
2577
2933
|
# @return [Types::UpdateKnowledgeBaseResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2578
2934
|
#
|
@@ -2581,100 +2937,100 @@ module Aws::BedrockAgent
|
|
2581
2937
|
# @example Request syntax with placeholder values
|
2582
2938
|
#
|
2583
2939
|
# resp = client.update_knowledge_base({
|
2584
|
-
# knowledge_base_id: "Id", # required
|
2585
|
-
# name: "Name", # required
|
2586
2940
|
# description: "Description",
|
2587
|
-
# role_arn: "KnowledgeBaseRoleArn", # required
|
2588
2941
|
# knowledge_base_configuration: { # required
|
2589
2942
|
# type: "VECTOR", # required, accepts VECTOR
|
2590
2943
|
# vector_knowledge_base_configuration: {
|
2591
2944
|
# embedding_model_arn: "BedrockEmbeddingModelArn", # required
|
2592
2945
|
# },
|
2593
2946
|
# },
|
2947
|
+
# knowledge_base_id: "Id", # required
|
2948
|
+
# name: "Name", # required
|
2949
|
+
# role_arn: "KnowledgeBaseRoleArn", # required
|
2594
2950
|
# storage_configuration: { # required
|
2595
|
-
# type: "OPENSEARCH_SERVERLESS", # required, accepts OPENSEARCH_SERVERLESS, PINECONE, REDIS_ENTERPRISE_CLOUD, RDS
|
2596
2951
|
# opensearch_serverless_configuration: {
|
2597
2952
|
# collection_arn: "OpenSearchServerlessCollectionArn", # required
|
2598
|
-
# vector_index_name: "OpenSearchServerlessIndexName", # required
|
2599
2953
|
# field_mapping: { # required
|
2600
|
-
# vector_field: "FieldName", # required
|
2601
|
-
# text_field: "FieldName", # required
|
2602
2954
|
# metadata_field: "FieldName", # required
|
2955
|
+
# text_field: "FieldName", # required
|
2956
|
+
# vector_field: "FieldName", # required
|
2603
2957
|
# },
|
2958
|
+
# vector_index_name: "OpenSearchServerlessIndexName", # required
|
2604
2959
|
# },
|
2605
2960
|
# pinecone_configuration: {
|
2606
2961
|
# connection_string: "PineconeConnectionString", # required
|
2607
2962
|
# credentials_secret_arn: "SecretArn", # required
|
2608
|
-
# namespace: "PineconeNamespace",
|
2609
2963
|
# field_mapping: { # required
|
2610
|
-
# text_field: "FieldName", # required
|
2611
2964
|
# metadata_field: "FieldName", # required
|
2612
|
-
# },
|
2613
|
-
# },
|
2614
|
-
# redis_enterprise_cloud_configuration: {
|
2615
|
-
# endpoint: "RedisEnterpriseCloudEndpoint", # required
|
2616
|
-
# vector_index_name: "RedisEnterpriseCloudIndexName", # required
|
2617
|
-
# credentials_secret_arn: "SecretArn", # required
|
2618
|
-
# field_mapping: { # required
|
2619
|
-
# vector_field: "FieldName", # required
|
2620
2965
|
# text_field: "FieldName", # required
|
2621
|
-
# metadata_field: "FieldName", # required
|
2622
2966
|
# },
|
2967
|
+
# namespace: "PineconeNamespace",
|
2623
2968
|
# },
|
2624
2969
|
# rds_configuration: {
|
2625
|
-
# resource_arn: "RdsArn", # required
|
2626
2970
|
# credentials_secret_arn: "SecretArn", # required
|
2627
2971
|
# database_name: "RdsDatabaseName", # required
|
2628
|
-
# table_name: "RdsTableName", # required
|
2629
2972
|
# field_mapping: { # required
|
2973
|
+
# metadata_field: "ColumnName", # required
|
2630
2974
|
# primary_key_field: "ColumnName", # required
|
2631
|
-
# vector_field: "ColumnName", # required
|
2632
2975
|
# text_field: "ColumnName", # required
|
2633
|
-
#
|
2976
|
+
# vector_field: "ColumnName", # required
|
2634
2977
|
# },
|
2978
|
+
# resource_arn: "RdsArn", # required
|
2979
|
+
# table_name: "RdsTableName", # required
|
2635
2980
|
# },
|
2981
|
+
# redis_enterprise_cloud_configuration: {
|
2982
|
+
# credentials_secret_arn: "SecretArn", # required
|
2983
|
+
# endpoint: "RedisEnterpriseCloudEndpoint", # required
|
2984
|
+
# field_mapping: { # required
|
2985
|
+
# metadata_field: "FieldName", # required
|
2986
|
+
# text_field: "FieldName", # required
|
2987
|
+
# vector_field: "FieldName", # required
|
2988
|
+
# },
|
2989
|
+
# vector_index_name: "RedisEnterpriseCloudIndexName", # required
|
2990
|
+
# },
|
2991
|
+
# type: "OPENSEARCH_SERVERLESS", # required, accepts OPENSEARCH_SERVERLESS, PINECONE, REDIS_ENTERPRISE_CLOUD, RDS
|
2636
2992
|
# },
|
2637
2993
|
# })
|
2638
2994
|
#
|
2639
2995
|
# @example Response structure
|
2640
2996
|
#
|
2641
|
-
# resp.knowledge_base.
|
2642
|
-
# resp.knowledge_base.name #=> String
|
2643
|
-
# resp.knowledge_base.knowledge_base_arn #=> String
|
2997
|
+
# resp.knowledge_base.created_at #=> Time
|
2644
2998
|
# resp.knowledge_base.description #=> String
|
2645
|
-
# resp.knowledge_base.
|
2999
|
+
# resp.knowledge_base.failure_reasons #=> Array
|
3000
|
+
# resp.knowledge_base.failure_reasons[0] #=> String
|
3001
|
+
# resp.knowledge_base.knowledge_base_arn #=> String
|
2646
3002
|
# resp.knowledge_base.knowledge_base_configuration.type #=> String, one of "VECTOR"
|
2647
3003
|
# resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn #=> String
|
2648
|
-
# resp.knowledge_base.
|
3004
|
+
# resp.knowledge_base.knowledge_base_id #=> String
|
3005
|
+
# resp.knowledge_base.name #=> String
|
3006
|
+
# resp.knowledge_base.role_arn #=> String
|
3007
|
+
# resp.knowledge_base.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED"
|
2649
3008
|
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn #=> String
|
2650
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
|
2651
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
|
2652
|
-
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
|
2653
3009
|
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field #=> String
|
3010
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
|
3011
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
|
3012
|
+
# resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
|
2654
3013
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.connection_string #=> String
|
2655
3014
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn #=> String
|
2656
|
-
# resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
|
2657
|
-
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
|
2658
3015
|
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field #=> String
|
2659
|
-
# resp.knowledge_base.storage_configuration.
|
2660
|
-
# resp.knowledge_base.storage_configuration.
|
2661
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
|
2662
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
|
2663
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
|
2664
|
-
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
|
2665
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
|
3016
|
+
# resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
|
3017
|
+
# resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
|
2666
3018
|
# resp.knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn #=> String
|
2667
3019
|
# resp.knowledge_base.storage_configuration.rds_configuration.database_name #=> String
|
2668
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.
|
3020
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field #=> String
|
2669
3021
|
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field #=> String
|
2670
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
|
2671
3022
|
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field #=> String
|
2672
|
-
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.
|
2673
|
-
# resp.knowledge_base.
|
2674
|
-
# resp.knowledge_base.
|
3023
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
|
3024
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
|
3025
|
+
# resp.knowledge_base.storage_configuration.rds_configuration.table_name #=> String
|
3026
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
|
3027
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint #=> String
|
3028
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
|
3029
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
|
3030
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
|
3031
|
+
# resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name #=> String
|
3032
|
+
# resp.knowledge_base.storage_configuration.type #=> String, one of "OPENSEARCH_SERVERLESS", "PINECONE", "REDIS_ENTERPRISE_CLOUD", "RDS"
|
2675
3033
|
# resp.knowledge_base.updated_at #=> Time
|
2676
|
-
# resp.knowledge_base.failure_reasons #=> Array
|
2677
|
-
# resp.knowledge_base.failure_reasons[0] #=> String
|
2678
3034
|
#
|
2679
3035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateKnowledgeBase AWS API Documentation
|
2680
3036
|
#
|
@@ -2698,7 +3054,7 @@ module Aws::BedrockAgent
|
|
2698
3054
|
params: params,
|
2699
3055
|
config: config)
|
2700
3056
|
context[:gem_name] = 'aws-sdk-bedrockagent'
|
2701
|
-
context[:gem_version] = '1.
|
3057
|
+
context[:gem_version] = '1.5.0'
|
2702
3058
|
Seahorse::Client::Request.new(handlers, context)
|
2703
3059
|
end
|
2704
3060
|
|