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