Class: Aws::BedrockAgent::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb

Overview

An API client for BedrockAgent. To construct a client, you need to configure a :region and :credentials.

client = Aws::BedrockAgent::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::BedrockAgent::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::BedrockAgent::EndpointParameters

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



410
411
412
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 410

def initialize(*args)
  super
end

Instance Method Details

#associate_agent_knowledge_base(params = {}) ⇒ Types::AssociateAgentKnowledgeBaseResponse

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

Examples:

Request syntax with placeholder values


resp = client.associate_agent_knowledge_base({
  agent_id: "Id", # required
  agent_version: "DraftVersion", # required
  description: "Description", # required
  knowledge_base_id: "Id", # required
  knowledge_base_state: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.agent_knowledge_base.agent_id #=> String
resp.agent_knowledge_base.agent_version #=> String
resp.agent_knowledge_base.created_at #=> Time
resp.agent_knowledge_base.description #=> String
resp.agent_knowledge_base.knowledge_base_id #=> String
resp.agent_knowledge_base.knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_knowledge_base.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent with which you want to associate the knowledge base.

  • :agent_version (required, String) —

    The version of the agent with which you want to associate the knowledge base.

  • :description (required, String) —

    A description of what the agent should use the knowledge base for.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to associate with the agent.

  • :knowledge_base_state (String) —

    Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Returns:

See Also:



472
473
474
475
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 472

def associate_agent_knowledge_base(params = {}, options = {})
  req = build_request(:associate_agent_knowledge_base, params)
  req.send_request(options)
end

#create_agent(params = {}) ⇒ Types::CreateAgentResponse

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

  • Specify the following fields for security purposes.

    • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

    • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

    • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

  • To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

  • If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

Examples:

Request syntax with placeholder values


resp = client.create_agent({
  agent_name: "Name", # required
  agent_resource_role_arn: "AgentRoleArn",
  client_token: "ClientToken",
  customer_encryption_key_arn: "KmsKeyArn",
  description: "Description",
  foundation_model: "ModelIdentifier",
  guardrail_configuration: {
    guardrail_identifier: "GuardrailIdentifier",
    guardrail_version: "GuardrailVersion",
  },
  idle_session_ttl_in_seconds: 1,
  instruction: "Instruction",
  prompt_override_configuration: {
    override_lambda: "LambdaArn",
    prompt_configurations: [ # required
      {
        base_prompt_template: "BasePromptTemplate",
        inference_configuration: {
          maximum_length: 1,
          stop_sequences: ["String"],
          temperature: 1.0,
          top_k: 1,
          top_p: 1.0,
        },
        parser_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
        prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
        prompt_state: "ENABLED", # accepts ENABLED, DISABLED
        prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, KNOWLEDGE_BASE_RESPONSE_GENERATION
      },
    ],
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.agent.agent_arn #=> String
resp.agent.agent_id #=> String
resp.agent.agent_name #=> String
resp.agent.agent_resource_role_arn #=> String
resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent.agent_version #=> String
resp.agent.client_token #=> String
resp.agent.created_at #=> Time
resp.agent.customer_encryption_key_arn #=> String
resp.agent.description #=> String
resp.agent.failure_reasons #=> Array
resp.agent.failure_reasons[0] #=> String
resp.agent.foundation_model #=> String
resp.agent.guardrail_configuration.guardrail_identifier #=> String
resp.agent.guardrail_configuration.guardrail_version #=> String
resp.agent.idle_session_ttl_in_seconds #=> Integer
resp.agent.instruction #=> String
resp.agent.prepared_at #=> Time
resp.agent.prompt_override_configuration.override_lambda #=> String
resp.agent.prompt_override_configuration.prompt_configurations #=> Array
resp.agent.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
resp.agent.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
resp.agent.recommended_actions #=> Array
resp.agent.recommended_actions[0] #=> String
resp.agent.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_name (required, String) —

    A name for the agent that you create.

  • :agent_resource_role_arn (String) —

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :customer_encryption_key_arn (String) —

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

  • :description (String) —

    A description of the agent.

  • :foundation_model (String) —

    The foundation model to be used for orchestration by the agent you create.

  • :guardrail_configuration (Types::GuardrailConfiguration) —

    The unique Guardrail configuration assigned to the agent when it is created.

  • :idle_session_ttl_in_seconds (Integer) —

    The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

  • :instruction (String) —

    Instructions that tell the agent what it should do and how it should interact with users.

  • :prompt_override_configuration (Types::PromptOverrideConfiguration) —

    Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

  • :tags (Hash<String,String>) —

    Any tags that you want to attach to the agent.

Returns:

See Also:



648
649
650
651
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 648

def create_agent(params = {}, options = {})
  req = build_request(:create_agent, params)
  req.send_request(options)
end

#create_agent_action_group(params = {}) ⇒ Types::CreateAgentActionGroupResponse

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Examples:

Request syntax with placeholder values


resp = client.create_agent_action_group({
  action_group_executor: {
    custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
    lambda: "LambdaArn",
  },
  action_group_name: "Name", # required
  action_group_state: "ENABLED", # accepts ENABLED, DISABLED
  agent_id: "Id", # required
  agent_version: "DraftVersion", # required
  api_schema: {
    payload: "Payload",
    s3: {
      s3_bucket_name: "S3BucketName",
      s3_object_key: "S3ObjectKey",
    },
  },
  client_token: "ClientToken",
  description: "Description",
  function_schema: {
    functions: [
      {
        description: "FunctionDescription",
        name: "Name", # required
        parameters: {
          "Name" => {
            description: "ParameterDescription",
            required: false,
            type: "string", # required, accepts string, number, integer, boolean, array
          },
        },
      },
    ],
  },
  parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
})

Response structure


resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
resp.agent_action_group.action_group_executor.lambda #=> String
resp.agent_action_group.action_group_id #=> String
resp.agent_action_group.action_group_name #=> String
resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_action_group.agent_id #=> String
resp.agent_action_group.agent_version #=> String
resp.agent_action_group.api_schema.payload #=> String
resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
resp.agent_action_group.api_schema.s3.s3_object_key #=> String
resp.agent_action_group.client_token #=> String
resp.agent_action_group.created_at #=> Time
resp.agent_action_group.description #=> String
resp.agent_action_group.function_schema.functions #=> Array
resp.agent_action_group.function_schema.functions[0].description #=> String
resp.agent_action_group.function_schema.functions[0].name #=> String
resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
resp.agent_action_group.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_group_executor (Types::ActionGroupExecutor) —

    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

  • :action_group_name (required, String) —

    The name to give the action group.

  • :action_group_state (String) —

    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

  • :agent_id (required, String) —

    The unique identifier of the agent for which to create the action group.

  • :agent_version (required, String) —

    The version of the agent for which to create the action group.

  • :api_schema (Types::APISchema) —

    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the action group.

  • :function_schema (Types::FunctionSchema) —

    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

  • :parent_action_group_signature (String) —

    To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

    During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Returns:

See Also:



811
812
813
814
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 811

def create_agent_action_group(params = {}, options = {})
  req = build_request(:create_agent_action_group, params)
  req.send_request(options)
end

#create_agent_alias(params = {}) ⇒ Types::CreateAgentAliasResponse

Creates an alias of an agent that can be used to deploy the agent.

Examples:

Request syntax with placeholder values


resp = client.create_agent_alias({
  agent_alias_name: "Name", # required
  agent_id: "Id", # required
  client_token: "ClientToken",
  description: "Description",
  routing_configuration: [
    {
      agent_version: "Version",
      provisioned_throughput: "ProvisionedModelIdentifier",
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.agent_alias.agent_alias_arn #=> String
resp.agent_alias.agent_alias_history_events #=> Array
resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
resp.agent_alias.agent_alias_id #=> String
resp.agent_alias.agent_alias_name #=> String
resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
resp.agent_alias.agent_id #=> String
resp.agent_alias.client_token #=> String
resp.agent_alias.created_at #=> Time
resp.agent_alias.description #=> String
resp.agent_alias.failure_reasons #=> Array
resp.agent_alias.failure_reasons[0] #=> String
resp.agent_alias.routing_configuration #=> Array
resp.agent_alias.routing_configuration[0].agent_version #=> String
resp.agent_alias.routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_alias_name (required, String) —

    The name of the alias.

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the alias of the agent.

  • :routing_configuration (Array<Types::AgentAliasRoutingConfigurationListItem>) —

    Contains details about the routing configuration of the alias.

  • :tags (Hash<String,String>) —

    Any tags that you want to attach to the alias of the agent.

Returns:

See Also:



895
896
897
898
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 895

def create_agent_alias(params = {}, options = {})
  req = build_request(:create_agent_alias, params)
  req.send_request(options)
end

#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse

Sets up a data source to be added to a knowledge base.

You can't change the chunkingConfiguration after you create the data source.

Examples:

Request syntax with placeholder values


resp = client.create_data_source({
  client_token: "ClientToken",
  data_deletion_policy: "RETAIN", # accepts RETAIN, DELETE
  data_source_configuration: { # required
    s3_configuration: {
      bucket_arn: "S3BucketArn", # required
      bucket_owner_account_id: "BucketOwnerAccountId",
      inclusion_prefixes: ["S3Prefix"],
    },
    type: "S3", # required, accepts S3
  },
  description: "Description",
  knowledge_base_id: "Id", # required
  name: "Name", # required
  server_side_encryption_configuration: {
    kms_key_arn: "KmsKeyArn",
  },
  vector_ingestion_configuration: {
    chunking_configuration: {
      chunking_strategy: "FIXED_SIZE", # required, accepts FIXED_SIZE, NONE
      fixed_size_chunking_configuration: {
        max_tokens: 1, # required
        overlap_percentage: 1, # required
      },
    },
  },
})

Response structure


resp.data_source.created_at #=> Time
resp.data_source.data_deletion_policy #=> String, one of "RETAIN", "DELETE"
resp.data_source.data_source_configuration.s3_configuration.bucket_arn #=> String
resp.data_source.data_source_configuration.s3_configuration. #=> String
resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
resp.data_source.data_source_configuration.type #=> String, one of "S3"
resp.data_source.data_source_id #=> String
resp.data_source.description #=> String
resp.data_source.failure_reasons #=> Array
resp.data_source.failure_reasons[0] #=> String
resp.data_source.knowledge_base_id #=> String
resp.data_source.name #=> String
resp.data_source.server_side_encryption_configuration.kms_key_arn #=> String
resp.data_source.status #=> String, one of "AVAILABLE", "DELETING", "DELETE_UNSUCCESSFUL"
resp.data_source.updated_at #=> Time
resp.data_source.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE"
resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :data_deletion_policy (String) —

    The data deletion policy assigned to the data source.

  • :data_source_configuration (required, Types::DataSourceConfiguration) —

    Contains metadata about where the data source is stored.

  • :description (String) —

    A description of the data source.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to which to add the data source.

  • :name (required, String) —

    The name of the data source.

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

    Contains details about the server-side encryption for the data source.

  • :vector_ingestion_configuration (Types::VectorIngestionConfiguration) —

    Contains details about how to ingest the documents in the data source.

Returns:

See Also:



1000
1001
1002
1003
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1000

def create_data_source(params = {}, options = {})
  req = build_request(:create_data_source, params)
  req.send_request(options)
end

#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse

Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.

If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.

  • Provide the name and an optional description.

  • Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

  • Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

  • Provide the configuration for your vector store in the storageConfiguration object.

Examples:

Request syntax with placeholder values


resp = client.create_knowledge_base({
  client_token: "ClientToken",
  description: "Description",
  knowledge_base_configuration: { # required
    type: "VECTOR", # required, accepts VECTOR
    vector_knowledge_base_configuration: {
      embedding_model_arn: "BedrockEmbeddingModelArn", # required
      embedding_model_configuration: {
        bedrock_embedding_model_configuration: {
          dimensions: 1,
        },
      },
    },
  },
  name: "Name", # required
  role_arn: "KnowledgeBaseRoleArn", # required
  storage_configuration: { # required
    mongo_db_atlas_configuration: {
      collection_name: "MongoDbAtlasCollectionName", # required
      credentials_secret_arn: "SecretArn", # required
      database_name: "MongoDbAtlasDatabaseName", # required
      endpoint: "MongoDbAtlasEndpoint", # required
      endpoint_service_name: "MongoDbAtlasEndpointServiceName",
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
        vector_field: "FieldName", # required
      },
      vector_index_name: "MongoDbAtlasIndexName", # required
    },
    opensearch_serverless_configuration: {
      collection_arn: "OpenSearchServerlessCollectionArn", # required
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
        vector_field: "FieldName", # required
      },
      vector_index_name: "OpenSearchServerlessIndexName", # required
    },
    pinecone_configuration: {
      connection_string: "PineconeConnectionString", # required
      credentials_secret_arn: "SecretArn", # required
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
      },
      namespace: "PineconeNamespace",
    },
    rds_configuration: {
      credentials_secret_arn: "SecretArn", # required
      database_name: "RdsDatabaseName", # required
      field_mapping: { # required
        metadata_field: "ColumnName", # required
        primary_key_field: "ColumnName", # required
        text_field: "ColumnName", # required
        vector_field: "ColumnName", # required
      },
      resource_arn: "RdsArn", # required
      table_name: "RdsTableName", # required
    },
    redis_enterprise_cloud_configuration: {
      credentials_secret_arn: "SecretArn", # required
      endpoint: "RedisEnterpriseCloudEndpoint", # required
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
        vector_field: "FieldName", # required
      },
      vector_index_name: "RedisEnterpriseCloudIndexName", # required
    },
    type: "OPENSEARCH_SERVERLESS", # required, accepts OPENSEARCH_SERVERLESS, PINECONE, REDIS_ENTERPRISE_CLOUD, RDS, MONGO_DB_ATLAS
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.knowledge_base.created_at #=> Time
resp.knowledge_base.description #=> String
resp.knowledge_base.failure_reasons #=> Array
resp.knowledge_base.failure_reasons[0] #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_configuration.type #=> String, one of "VECTOR"
resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn #=> String
resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_configuration.bedrock_embedding_model_configuration.dimensions #=> Integer
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.role_arn #=> String
resp.knowledge_base.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED", "DELETE_UNSUCCESSFUL"
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.collection_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.database_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint_service_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.connection_string #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
resp.knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.rds_configuration.database_name #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
resp.knowledge_base.storage_configuration.rds_configuration.table_name #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.type #=> String, one of "OPENSEARCH_SERVERLESS", "PINECONE", "REDIS_ENTERPRISE_CLOUD", "RDS", "MONGO_DB_ATLAS"
resp.knowledge_base.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the knowledge base.

  • :knowledge_base_configuration (required, Types::KnowledgeBaseConfiguration) —

    Contains details about the embeddings model used for the knowledge base.

  • :name (required, String) —

    A name for the knowledge base.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

  • :storage_configuration (required, Types::StorageConfiguration) —

    Contains details about the configuration of the vector database used for the knowledge base.

  • :tags (Hash<String,String>) —

    Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

Returns:

See Also:



1224
1225
1226
1227
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1224

def create_knowledge_base(params = {}, options = {})
  req = build_request(:create_knowledge_base, params)
  req.send_request(options)
end

#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse

Deletes an agent.

Examples:

Request syntax with placeholder values


resp = client.delete_agent({
  agent_id: "Id", # required
  skip_resource_in_use_check: false,
})

Response structure


resp.agent_id #=> String
resp.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent to delete.

  • :skip_resource_in_use_check (Boolean) —

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Returns:

See Also:



1260
1261
1262
1263
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1260

def delete_agent(params = {}, options = {})
  req = build_request(:delete_agent, params)
  req.send_request(options)
end

#delete_agent_action_group(params = {}) ⇒ Struct

Deletes an action group in an agent.

Examples:

Request syntax with placeholder values


resp = client.delete_agent_action_group({
  action_group_id: "Id", # required
  agent_id: "Id", # required
  agent_version: "DraftVersion", # required
  skip_resource_in_use_check: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_group_id (required, String) —

    The unique identifier of the action group to delete.

  • :agent_id (required, String) —

    The unique identifier of the agent that the action group belongs to.

  • :agent_version (required, String) —

    The version of the agent that the action group belongs to.

  • :skip_resource_in_use_check (Boolean) —

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1296
1297
1298
1299
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1296

def delete_agent_action_group(params = {}, options = {})
  req = build_request(:delete_agent_action_group, params)
  req.send_request(options)
end

#delete_agent_alias(params = {}) ⇒ Types::DeleteAgentAliasResponse

Deletes an alias of an agent.

Examples:

Request syntax with placeholder values


resp = client.delete_agent_alias({
  agent_alias_id: "AgentAliasId", # required
  agent_id: "Id", # required
})

Response structure


resp.agent_alias_id #=> String
resp.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
resp.agent_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_alias_id (required, String) —

    The unique identifier of the alias to delete.

  • :agent_id (required, String) —

    The unique identifier of the agent that the alias belongs to.

Returns:

See Also:



1332
1333
1334
1335
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1332

def delete_agent_alias(params = {}, options = {})
  req = build_request(:delete_agent_alias, params)
  req.send_request(options)
end

#delete_agent_version(params = {}) ⇒ Types::DeleteAgentVersionResponse

Deletes a version of an agent.

Examples:

Request syntax with placeholder values


resp = client.delete_agent_version({
  agent_id: "Id", # required
  agent_version: "NumericalVersion", # required
  skip_resource_in_use_check: false,
})

Response structure


resp.agent_id #=> String
resp.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent_version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent that the version belongs to.

  • :agent_version (required, String) —

    The version of the agent to delete.

  • :skip_resource_in_use_check (Boolean) —

    By default, this value is false and deletion is stopped if the resource is in use. If you set it to true, the resource will be deleted even if the resource is in use.

Returns:

See Also:



1374
1375
1376
1377
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1374

def delete_agent_version(params = {}, options = {})
  req = build_request(:delete_agent_version, params)
  req.send_request(options)
end

#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse

Deletes a data source from a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.delete_data_source({
  data_source_id: "Id", # required
  knowledge_base_id: "Id", # required
})

Response structure


resp.data_source_id #=> String
resp.knowledge_base_id #=> String
resp.status #=> String, one of "AVAILABLE", "DELETING", "DELETE_UNSUCCESSFUL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_source_id (required, String) —

    The unique identifier of the data source to delete.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base from which to delete the data source.

Returns:

See Also:



1411
1412
1413
1414
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1411

def delete_data_source(params = {}, options = {})
  req = build_request(:delete_data_source, params)
  req.send_request(options)
end

#delete_knowledge_base(params = {}) ⇒ Types::DeleteKnowledgeBaseResponse

Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.

Examples:

Request syntax with placeholder values


resp = client.delete_knowledge_base({
  knowledge_base_id: "Id", # required
})

Response structure


resp.knowledge_base_id #=> String
resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED", "DELETE_UNSUCCESSFUL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to delete.

Returns:

See Also:



1447
1448
1449
1450
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1447

def delete_knowledge_base(params = {}, options = {})
  req = build_request(:delete_knowledge_base, params)
  req.send_request(options)
end

#disassociate_agent_knowledge_base(params = {}) ⇒ Struct

Disassociates a knowledge base from an agent.

Examples:

Request syntax with placeholder values


resp = client.disassociate_agent_knowledge_base({
  agent_id: "Id", # required
  agent_version: "DraftVersion", # required
  knowledge_base_id: "Id", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent from which to disassociate the knowledge base.

  • :agent_version (required, String) —

    The version of the agent from which to disassociate the knowledge base.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to disassociate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1479
1480
1481
1482
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1479

def disassociate_agent_knowledge_base(params = {}, options = {})
  req = build_request(:disassociate_agent_knowledge_base, params)
  req.send_request(options)
end

#get_agent(params = {}) ⇒ Types::GetAgentResponse

Gets information about an agent.

Examples:

Request syntax with placeholder values


resp = client.get_agent({
  agent_id: "Id", # required
})

Response structure


resp.agent.agent_arn #=> String
resp.agent.agent_id #=> String
resp.agent.agent_name #=> String
resp.agent.agent_resource_role_arn #=> String
resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent.agent_version #=> String
resp.agent.client_token #=> String
resp.agent.created_at #=> Time
resp.agent.customer_encryption_key_arn #=> String
resp.agent.description #=> String
resp.agent.failure_reasons #=> Array
resp.agent.failure_reasons[0] #=> String
resp.agent.foundation_model #=> String
resp.agent.guardrail_configuration.guardrail_identifier #=> String
resp.agent.guardrail_configuration.guardrail_version #=> String
resp.agent.idle_session_ttl_in_seconds #=> Integer
resp.agent.instruction #=> String
resp.agent.prepared_at #=> Time
resp.agent.prompt_override_configuration.override_lambda #=> String
resp.agent.prompt_override_configuration.prompt_configurations #=> Array
resp.agent.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
resp.agent.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
resp.agent.recommended_actions #=> Array
resp.agent.recommended_actions[0] #=> String
resp.agent.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent.

Returns:

See Also:



1540
1541
1542
1543
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1540

def get_agent(params = {}, options = {})
  req = build_request(:get_agent, params)
  req.send_request(options)
end

#get_agent_action_group(params = {}) ⇒ Types::GetAgentActionGroupResponse

Gets information about an action group for an agent.

Examples:

Request syntax with placeholder values


resp = client.get_agent_action_group({
  action_group_id: "Id", # required
  agent_id: "Id", # required
  agent_version: "Version", # required
})

Response structure


resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
resp.agent_action_group.action_group_executor.lambda #=> String
resp.agent_action_group.action_group_id #=> String
resp.agent_action_group.action_group_name #=> String
resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_action_group.agent_id #=> String
resp.agent_action_group.agent_version #=> String
resp.agent_action_group.api_schema.payload #=> String
resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
resp.agent_action_group.api_schema.s3.s3_object_key #=> String
resp.agent_action_group.client_token #=> String
resp.agent_action_group.created_at #=> Time
resp.agent_action_group.description #=> String
resp.agent_action_group.function_schema.functions #=> Array
resp.agent_action_group.function_schema.functions[0].description #=> String
resp.agent_action_group.function_schema.functions[0].name #=> String
resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
resp.agent_action_group.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_group_id (required, String) —

    The unique identifier of the action group for which to get information.

  • :agent_id (required, String) —

    The unique identifier of the agent that the action group belongs to.

  • :agent_version (required, String) —

    The version of the agent that the action group belongs to.

Returns:

See Also:



1598
1599
1600
1601
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1598

def get_agent_action_group(params = {}, options = {})
  req = build_request(:get_agent_action_group, params)
  req.send_request(options)
end

#get_agent_alias(params = {}) ⇒ Types::GetAgentAliasResponse

Gets information about an alias of an agent.

Examples:

Request syntax with placeholder values


resp = client.get_agent_alias({
  agent_alias_id: "AgentAliasId", # required
  agent_id: "Id", # required
})

Response structure


resp.agent_alias.agent_alias_arn #=> String
resp.agent_alias.agent_alias_history_events #=> Array
resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
resp.agent_alias.agent_alias_id #=> String
resp.agent_alias.agent_alias_name #=> String
resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
resp.agent_alias.agent_id #=> String
resp.agent_alias.client_token #=> String
resp.agent_alias.created_at #=> Time
resp.agent_alias.description #=> String
resp.agent_alias.failure_reasons #=> Array
resp.agent_alias.failure_reasons[0] #=> String
resp.agent_alias.routing_configuration #=> Array
resp.agent_alias.routing_configuration[0].agent_version #=> String
resp.agent_alias.routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_alias_id (required, String) —

    The unique identifier of the alias for which to get information.

  • :agent_id (required, String) —

    The unique identifier of the agent to which the alias to get information belongs.

Returns:

See Also:



1650
1651
1652
1653
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1650

def get_agent_alias(params = {}, options = {})
  req = build_request(:get_agent_alias, params)
  req.send_request(options)
end

#get_agent_knowledge_base(params = {}) ⇒ Types::GetAgentKnowledgeBaseResponse

Gets information about a knowledge base associated with an agent.

Examples:

Request syntax with placeholder values


resp = client.get_agent_knowledge_base({
  agent_id: "Id", # required
  agent_version: "Version", # required
  knowledge_base_id: "Id", # required
})

Response structure


resp.agent_knowledge_base.agent_id #=> String
resp.agent_knowledge_base.agent_version #=> String
resp.agent_knowledge_base.created_at #=> Time
resp.agent_knowledge_base.description #=> String
resp.agent_knowledge_base.knowledge_base_id #=> String
resp.agent_knowledge_base.knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_knowledge_base.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent with which the knowledge base is associated.

  • :agent_version (required, String) —

    The version of the agent with which the knowledge base is associated.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base associated with the agent.

Returns:

See Also:



1693
1694
1695
1696
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1693

def get_agent_knowledge_base(params = {}, options = {})
  req = build_request(:get_agent_knowledge_base, params)
  req.send_request(options)
end

#get_agent_version(params = {}) ⇒ Types::GetAgentVersionResponse

Gets details about a version of an agent.

Examples:

Request syntax with placeholder values


resp = client.get_agent_version({
  agent_id: "Id", # required
  agent_version: "NumericalVersion", # required
})

Response structure


resp.agent_version.agent_arn #=> String
resp.agent_version.agent_id #=> String
resp.agent_version.agent_name #=> String
resp.agent_version.agent_resource_role_arn #=> String
resp.agent_version.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent_version.created_at #=> Time
resp.agent_version.customer_encryption_key_arn #=> String
resp.agent_version.description #=> String
resp.agent_version.failure_reasons #=> Array
resp.agent_version.failure_reasons[0] #=> String
resp.agent_version.foundation_model #=> String
resp.agent_version.guardrail_configuration.guardrail_identifier #=> String
resp.agent_version.guardrail_configuration.guardrail_version #=> String
resp.agent_version.idle_session_ttl_in_seconds #=> Integer
resp.agent_version.instruction #=> String
resp.agent_version.prompt_override_configuration.override_lambda #=> String
resp.agent_version.prompt_override_configuration.prompt_configurations #=> Array
resp.agent_version.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
resp.agent_version.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
resp.agent_version.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_version.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
resp.agent_version.recommended_actions #=> Array
resp.agent_version.recommended_actions[0] #=> String
resp.agent_version.updated_at #=> Time
resp.agent_version.version #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :agent_version (required, String) —

    The version of the agent.

Returns:

See Also:



1756
1757
1758
1759
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1756

def get_agent_version(params = {}, options = {})
  req = build_request(:get_agent_version, params)
  req.send_request(options)
end

#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse

Gets information about a data source.

Examples:

Request syntax with placeholder values


resp = client.get_data_source({
  data_source_id: "Id", # required
  knowledge_base_id: "Id", # required
})

Response structure


resp.data_source.created_at #=> Time
resp.data_source.data_deletion_policy #=> String, one of "RETAIN", "DELETE"
resp.data_source.data_source_configuration.s3_configuration.bucket_arn #=> String
resp.data_source.data_source_configuration.s3_configuration. #=> String
resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
resp.data_source.data_source_configuration.type #=> String, one of "S3"
resp.data_source.data_source_id #=> String
resp.data_source.description #=> String
resp.data_source.failure_reasons #=> Array
resp.data_source.failure_reasons[0] #=> String
resp.data_source.knowledge_base_id #=> String
resp.data_source.name #=> String
resp.data_source.server_side_encryption_configuration.kms_key_arn #=> String
resp.data_source.status #=> String, one of "AVAILABLE", "DELETING", "DELETE_UNSUCCESSFUL"
resp.data_source.updated_at #=> Time
resp.data_source.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE"
resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_source_id (required, String) —

    The unique identifier of the data source.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base that the data source was added to.

Returns:

See Also:



1807
1808
1809
1810
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1807

def get_data_source(params = {}, options = {})
  req = build_request(:get_data_source, params)
  req.send_request(options)
end

#get_ingestion_job(params = {}) ⇒ Types::GetIngestionJobResponse

Gets information about a ingestion job, in which a data source is added to a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.get_ingestion_job({
  data_source_id: "Id", # required
  ingestion_job_id: "Id", # required
  knowledge_base_id: "Id", # required
})

Response structure


resp.ingestion_job.data_source_id #=> String
resp.ingestion_job.description #=> String
resp.ingestion_job.failure_reasons #=> Array
resp.ingestion_job.failure_reasons[0] #=> String
resp.ingestion_job.ingestion_job_id #=> String
resp.ingestion_job.knowledge_base_id #=> String
resp.ingestion_job.started_at #=> Time
resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
resp.ingestion_job.statistics.number_of_metadata_documents_modified #=> Integer
resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
resp.ingestion_job.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_source_id (required, String) —

    The unique identifier of the data source in the ingestion job.

  • :ingestion_job_id (required, String) —

    The unique identifier of the ingestion job.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base for which the ingestion job applies.

Returns:

See Also:



1860
1861
1862
1863
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1860

def get_ingestion_job(params = {}, options = {})
  req = build_request(:get_ingestion_job, params)
  req.send_request(options)
end

#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse

Gets information about a knoweldge base.

Examples:

Request syntax with placeholder values


resp = client.get_knowledge_base({
  knowledge_base_id: "Id", # required
})

Response structure


resp.knowledge_base.created_at #=> Time
resp.knowledge_base.description #=> String
resp.knowledge_base.failure_reasons #=> Array
resp.knowledge_base.failure_reasons[0] #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_configuration.type #=> String, one of "VECTOR"
resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn #=> String
resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_configuration.bedrock_embedding_model_configuration.dimensions #=> Integer
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.role_arn #=> String
resp.knowledge_base.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED", "DELETE_UNSUCCESSFUL"
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.collection_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.database_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint_service_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.connection_string #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
resp.knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.rds_configuration.database_name #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
resp.knowledge_base.storage_configuration.rds_configuration.table_name #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.type #=> String, one of "OPENSEARCH_SERVERLESS", "PINECONE", "REDIS_ENTERPRISE_CLOUD", "RDS", "MONGO_DB_ATLAS"
resp.knowledge_base.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base for which to get information.

Returns:

See Also:



1935
1936
1937
1938
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1935

def get_knowledge_base(params = {}, options = {})
  req = build_request(:get_knowledge_base, params)
  req.send_request(options)
end

#list_agent_action_groups(params = {}) ⇒ Types::ListAgentActionGroupsResponse

Lists the action groups for an agent and information about each one.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_agent_action_groups({
  agent_id: "Id", # required
  agent_version: "Version", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.action_group_summaries #=> Array
resp.action_group_summaries[0].action_group_id #=> String
resp.action_group_summaries[0].action_group_name #=> String
resp.action_group_summaries[0].action_group_state #=> String, one of "ENABLED", "DISABLED"
resp.action_group_summaries[0].description #=> String
resp.action_group_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :agent_version (required, String) —

    The version of the agent.

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



1990
1991
1992
1993
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1990

def list_agent_action_groups(params = {}, options = {})
  req = build_request(:list_agent_action_groups, params)
  req.send_request(options)
end

#list_agent_aliases(params = {}) ⇒ Types::ListAgentAliasesResponse

Lists the aliases of an agent and information about each one.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_agent_aliases({
  agent_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.agent_alias_summaries #=> Array
resp.agent_alias_summaries[0].agent_alias_id #=> String
resp.agent_alias_summaries[0].agent_alias_name #=> String
resp.agent_alias_summaries[0].agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
resp.agent_alias_summaries[0].created_at #=> Time
resp.agent_alias_summaries[0].description #=> String
resp.agent_alias_summaries[0].routing_configuration #=> Array
resp.agent_alias_summaries[0].routing_configuration[0].agent_version #=> String
resp.agent_alias_summaries[0].routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



2045
2046
2047
2048
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2045

def list_agent_aliases(params = {}, options = {})
  req = build_request(:list_agent_aliases, params)
  req.send_request(options)
end

#list_agent_knowledge_bases(params = {}) ⇒ Types::ListAgentKnowledgeBasesResponse

Lists knowledge bases associated with an agent and information about each one.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_agent_knowledge_bases({
  agent_id: "Id", # required
  agent_version: "Version", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.agent_knowledge_base_summaries #=> Array
resp.agent_knowledge_base_summaries[0].description #=> String
resp.agent_knowledge_base_summaries[0].knowledge_base_id #=> String
resp.agent_knowledge_base_summaries[0].knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_knowledge_base_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent for which to return information about knowledge bases associated with it.

  • :agent_version (required, String) —

    The version of the agent for which to return information about knowledge bases associated with it.

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



2102
2103
2104
2105
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2102

def list_agent_knowledge_bases(params = {}, options = {})
  req = build_request(:list_agent_knowledge_bases, params)
  req.send_request(options)
end

#list_agent_versions(params = {}) ⇒ Types::ListAgentVersionsResponse

Lists the versions of an agent and information about each version.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_agent_versions({
  agent_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.agent_version_summaries #=> Array
resp.agent_version_summaries[0].agent_name #=> String
resp.agent_version_summaries[0].agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent_version_summaries[0].agent_version #=> String
resp.agent_version_summaries[0].created_at #=> Time
resp.agent_version_summaries[0].description #=> String
resp.agent_version_summaries[0].guardrail_configuration.guardrail_identifier #=> String
resp.agent_version_summaries[0].guardrail_configuration.guardrail_version #=> String
resp.agent_version_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



2156
2157
2158
2159
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2156

def list_agent_versions(params = {}, options = {})
  req = build_request(:list_agent_versions, params)
  req.send_request(options)
end

#list_agents(params = {}) ⇒ Types::ListAgentsResponse

Lists the agents belonging to an account and information about each agent.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_agents({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.agent_summaries #=> Array
resp.agent_summaries[0].agent_id #=> String
resp.agent_summaries[0].agent_name #=> String
resp.agent_summaries[0].agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent_summaries[0].description #=> String
resp.agent_summaries[0].guardrail_configuration.guardrail_identifier #=> String
resp.agent_summaries[0].guardrail_configuration.guardrail_version #=> String
resp.agent_summaries[0].latest_agent_version #=> String
resp.agent_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



2207
2208
2209
2210
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2207

def list_agents(params = {}, options = {})
  req = build_request(:list_agents, params)
  req.send_request(options)
end

#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse

Lists the data sources in a knowledge base and information about each one.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_data_sources({
  knowledge_base_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.data_source_summaries #=> Array
resp.data_source_summaries[0].data_source_id #=> String
resp.data_source_summaries[0].description #=> String
resp.data_source_summaries[0].knowledge_base_id #=> String
resp.data_source_summaries[0].name #=> String
resp.data_source_summaries[0].status #=> String, one of "AVAILABLE", "DELETING", "DELETE_UNSUCCESSFUL"
resp.data_source_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base for which to return a list of information.

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



2261
2262
2263
2264
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2261

def list_data_sources(params = {}, options = {})
  req = build_request(:list_data_sources, params)
  req.send_request(options)
end

#list_ingestion_jobs(params = {}) ⇒ Types::ListIngestionJobsResponse

Lists the ingestion jobs for a data source and information about each of them.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_ingestion_jobs({
  data_source_id: "Id", # required
  filters: [
    {
      attribute: "STATUS", # required, accepts STATUS
      operator: "EQ", # required, accepts EQ
      values: ["IngestionJobFilterValue"], # required
    },
  ],
  knowledge_base_id: "Id", # required
  max_results: 1,
  next_token: "NextToken",
  sort_by: {
    attribute: "STATUS", # required, accepts STATUS, STARTED_AT
    order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.ingestion_job_summaries #=> Array
resp.ingestion_job_summaries[0].data_source_id #=> String
resp.ingestion_job_summaries[0].description #=> String
resp.ingestion_job_summaries[0].ingestion_job_id #=> String
resp.ingestion_job_summaries[0].knowledge_base_id #=> String
resp.ingestion_job_summaries[0].started_at #=> Time
resp.ingestion_job_summaries[0].statistics.number_of_documents_deleted #=> Integer
resp.ingestion_job_summaries[0].statistics.number_of_documents_failed #=> Integer
resp.ingestion_job_summaries[0].statistics.number_of_documents_scanned #=> Integer
resp.ingestion_job_summaries[0].statistics.number_of_metadata_documents_modified #=> Integer
resp.ingestion_job_summaries[0].statistics.number_of_metadata_documents_scanned #=> Integer
resp.ingestion_job_summaries[0].statistics.number_of_modified_documents_indexed #=> Integer
resp.ingestion_job_summaries[0].statistics.number_of_new_documents_indexed #=> Integer
resp.ingestion_job_summaries[0].status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
resp.ingestion_job_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_source_id (required, String) —

    The unique identifier of the data source for which to return ingestion jobs.

  • :filters (Array<Types::IngestionJobFilter>) —

    Contains a definition of a filter for which to filter the results.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base for which to return ingestion jobs.

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

  • :sort_by (Types::IngestionJobSortBy) —

    Contains details about how to sort the results.

Returns:

See Also:



2345
2346
2347
2348
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2345

def list_ingestion_jobs(params = {}, options = {})
  req = build_request(:list_ingestion_jobs, params)
  req.send_request(options)
end

#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse

Lists the knowledge bases in an account and information about each of them.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_knowledge_bases({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.knowledge_base_summaries #=> Array
resp.knowledge_base_summaries[0].description #=> String
resp.knowledge_base_summaries[0].knowledge_base_id #=> String
resp.knowledge_base_summaries[0].name #=> String
resp.knowledge_base_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED", "DELETE_UNSUCCESSFUL"
resp.knowledge_base_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

  • :next_token (String) —

    If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

See Also:



2393
2394
2395
2396
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2393

def list_knowledge_bases(params = {}, options = {})
  req = build_request(:list_knowledge_bases, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

List all the tags for the resource you specify.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourcesArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which to list tags.

Returns:

See Also:



2422
2423
2424
2425
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2422

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#prepare_agent(params = {}) ⇒ Types::PrepareAgentResponse

Creates a DRAFT version of the agent that can be used for internal testing.

Examples:

Request syntax with placeholder values


resp = client.prepare_agent({
  agent_id: "Id", # required
})

Response structure


resp.agent_id #=> String
resp.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent_version #=> String
resp.prepared_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent for which to create a DRAFT version.

Returns:

See Also:



2458
2459
2460
2461
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2458

def prepare_agent(params = {}, options = {})
  req = build_request(:prepare_agent, params)
  req.send_request(options)
end

#start_ingestion_job(params = {}) ⇒ Types::StartIngestionJobResponse

Begins an ingestion job, in which a data source is added to a knowledge base.

Examples:

Request syntax with placeholder values


resp = client.start_ingestion_job({
  client_token: "ClientToken",
  data_source_id: "Id", # required
  description: "Description",
  knowledge_base_id: "Id", # required
})

Response structure


resp.ingestion_job.data_source_id #=> String
resp.ingestion_job.description #=> String
resp.ingestion_job.failure_reasons #=> Array
resp.ingestion_job.failure_reasons[0] #=> String
resp.ingestion_job.ingestion_job_id #=> String
resp.ingestion_job.knowledge_base_id #=> String
resp.ingestion_job.started_at #=> Time
resp.ingestion_job.statistics.number_of_documents_deleted #=> Integer
resp.ingestion_job.statistics.number_of_documents_failed #=> Integer
resp.ingestion_job.statistics.number_of_documents_scanned #=> Integer
resp.ingestion_job.statistics.number_of_metadata_documents_modified #=> Integer
resp.ingestion_job.statistics.number_of_metadata_documents_scanned #=> Integer
resp.ingestion_job.statistics.number_of_modified_documents_indexed #=> Integer
resp.ingestion_job.statistics.number_of_new_documents_indexed #=> Integer
resp.ingestion_job.status #=> String, one of "STARTING", "IN_PROGRESS", "COMPLETE", "FAILED"
resp.ingestion_job.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (String) —

    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :data_source_id (required, String) —

    The unique identifier of the data source to ingest.

  • :description (String) —

    A description of the ingestion job.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to which to add the data source.

Returns:

See Also:



2525
2526
2527
2528
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2525

def start_ingestion_job(params = {}, options = {})
  req = build_request(:start_ingestion_job, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourcesArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to tag.

  • :tags (required, Hash<String,String>) —

    An object containing key-value pairs that define the tags to attach to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2559
2560
2561
2562
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2559

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Remove tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableResourcesArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

  • :tag_keys (required, Array<String>) —

    A list of keys of the tags to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2586
2587
2588
2589
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2586

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_agent(params = {}) ⇒ Types::UpdateAgentResponse

Updates the configuration of an agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent({
  agent_id: "Id", # required
  agent_name: "Name", # required
  agent_resource_role_arn: "AgentRoleArn", # required
  customer_encryption_key_arn: "KmsKeyArn",
  description: "Description",
  foundation_model: "ModelIdentifier", # required
  guardrail_configuration: {
    guardrail_identifier: "GuardrailIdentifier",
    guardrail_version: "GuardrailVersion",
  },
  idle_session_ttl_in_seconds: 1,
  instruction: "Instruction",
  prompt_override_configuration: {
    override_lambda: "LambdaArn",
    prompt_configurations: [ # required
      {
        base_prompt_template: "BasePromptTemplate",
        inference_configuration: {
          maximum_length: 1,
          stop_sequences: ["String"],
          temperature: 1.0,
          top_k: 1,
          top_p: 1.0,
        },
        parser_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
        prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
        prompt_state: "ENABLED", # accepts ENABLED, DISABLED
        prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, POST_PROCESSING, KNOWLEDGE_BASE_RESPONSE_GENERATION
      },
    ],
  },
})

Response structure


resp.agent.agent_arn #=> String
resp.agent.agent_id #=> String
resp.agent.agent_name #=> String
resp.agent.agent_resource_role_arn #=> String
resp.agent.agent_status #=> String, one of "CREATING", "PREPARING", "PREPARED", "NOT_PREPARED", "DELETING", "FAILED", "VERSIONING", "UPDATING"
resp.agent.agent_version #=> String
resp.agent.client_token #=> String
resp.agent.created_at #=> Time
resp.agent.customer_encryption_key_arn #=> String
resp.agent.description #=> String
resp.agent.failure_reasons #=> Array
resp.agent.failure_reasons[0] #=> String
resp.agent.foundation_model #=> String
resp.agent.guardrail_configuration.guardrail_identifier #=> String
resp.agent.guardrail_configuration.guardrail_version #=> String
resp.agent.idle_session_ttl_in_seconds #=> Integer
resp.agent.instruction #=> String
resp.agent.prepared_at #=> Time
resp.agent.prompt_override_configuration.override_lambda #=> String
resp.agent.prompt_override_configuration.prompt_configurations #=> Array
resp.agent.prompt_override_configuration.prompt_configurations[0].base_prompt_template #=> String
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.maximum_length #=> Integer
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences #=> Array
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.stop_sequences[0] #=> String
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.temperature #=> Float
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_k #=> Integer
resp.agent.prompt_override_configuration.prompt_configurations[0].inference_configuration.top_p #=> Float
resp.agent.prompt_override_configuration.prompt_configurations[0].parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_state #=> String, one of "ENABLED", "DISABLED"
resp.agent.prompt_override_configuration.prompt_configurations[0].prompt_type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "POST_PROCESSING", "KNOWLEDGE_BASE_RESPONSE_GENERATION"
resp.agent.recommended_actions #=> Array
resp.agent.recommended_actions[0] #=> String
resp.agent.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :agent_name (required, String) —

    Specifies a new name for the agent.

  • :agent_resource_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

  • :customer_encryption_key_arn (String) —

    The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

  • :description (String) —

    Specifies a new description of the agent.

  • :foundation_model (required, String) —

    Specifies a new foundation model to be used for orchestration by the agent.

  • :guardrail_configuration (Types::GuardrailConfiguration) —

    The unique Guardrail configuration assigned to the agent when it is updated.

  • :idle_session_ttl_in_seconds (Integer) —

    The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

    A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

  • :instruction (String) —

    Specifies new instructions that tell the agent what it should do and how it should interact with users.

  • :prompt_override_configuration (Types::PromptOverrideConfiguration) —

    Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Returns:

See Also:



2719
2720
2721
2722
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2719

def update_agent(params = {}, options = {})
  req = build_request(:update_agent, params)
  req.send_request(options)
end

#update_agent_action_group(params = {}) ⇒ Types::UpdateAgentActionGroupResponse

Updates the configuration for an action group for an agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent_action_group({
  action_group_executor: {
    custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
    lambda: "LambdaArn",
  },
  action_group_id: "Id", # required
  action_group_name: "Name", # required
  action_group_state: "ENABLED", # accepts ENABLED, DISABLED
  agent_id: "Id", # required
  agent_version: "DraftVersion", # required
  api_schema: {
    payload: "Payload",
    s3: {
      s3_bucket_name: "S3BucketName",
      s3_object_key: "S3ObjectKey",
    },
  },
  description: "Description",
  function_schema: {
    functions: [
      {
        description: "FunctionDescription",
        name: "Name", # required
        parameters: {
          "Name" => {
            description: "ParameterDescription",
            required: false,
            type: "string", # required, accepts string, number, integer, boolean, array
          },
        },
      },
    ],
  },
  parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput
})

Response structure


resp.agent_action_group.action_group_executor.custom_control #=> String, one of "RETURN_CONTROL"
resp.agent_action_group.action_group_executor.lambda #=> String
resp.agent_action_group.action_group_id #=> String
resp.agent_action_group.action_group_name #=> String
resp.agent_action_group.action_group_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_action_group.agent_id #=> String
resp.agent_action_group.agent_version #=> String
resp.agent_action_group.api_schema.payload #=> String
resp.agent_action_group.api_schema.s3.s3_bucket_name #=> String
resp.agent_action_group.api_schema.s3.s3_object_key #=> String
resp.agent_action_group.client_token #=> String
resp.agent_action_group.created_at #=> Time
resp.agent_action_group.description #=> String
resp.agent_action_group.function_schema.functions #=> Array
resp.agent_action_group.function_schema.functions[0].description #=> String
resp.agent_action_group.function_schema.functions[0].name #=> String
resp.agent_action_group.function_schema.functions[0].parameters #=> Hash
resp.agent_action_group.function_schema.functions[0].parameters["Name"].description #=> String
resp.agent_action_group.function_schema.functions[0].parameters["Name"].required #=> Boolean
resp.agent_action_group.function_schema.functions[0].parameters["Name"].type #=> String, one of "string", "number", "integer", "boolean", "array"
resp.agent_action_group.parent_action_signature #=> String, one of "AMAZON.UserInput"
resp.agent_action_group.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :action_group_executor (Types::ActionGroupExecutor) —

    The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.

  • :action_group_id (required, String) —

    The unique identifier of the action group.

  • :action_group_name (required, String) —

    Specifies a new name for the action group.

  • :action_group_state (String) —

    Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

  • :agent_id (required, String) —

    The unique identifier of the agent for which to update the action group.

  • :agent_version (required, String) —

    The unique identifier of the agent version for which to update the action group.

  • :api_schema (Types::APISchema) —

    Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas.

  • :description (String) —

    Specifies a new name for the action group.

  • :function_schema (Types::FunctionSchema) —

    Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

  • :parent_action_group_signature (String) —

    To allow your agent to request the user for additional information when trying to complete a task, set this field to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group.

    During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Returns:

See Also:



2855
2856
2857
2858
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2855

def update_agent_action_group(params = {}, options = {})
  req = build_request(:update_agent_action_group, params)
  req.send_request(options)
end

#update_agent_alias(params = {}) ⇒ Types::UpdateAgentAliasResponse

Updates configurations for an alias of an agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent_alias({
  agent_alias_id: "AgentAliasId", # required
  agent_alias_name: "Name", # required
  agent_id: "Id", # required
  description: "Description",
  routing_configuration: [
    {
      agent_version: "Version",
      provisioned_throughput: "ProvisionedModelIdentifier",
    },
  ],
})

Response structure


resp.agent_alias.agent_alias_arn #=> String
resp.agent_alias.agent_alias_history_events #=> Array
resp.agent_alias.agent_alias_history_events[0].end_date #=> Time
resp.agent_alias.agent_alias_history_events[0].routing_configuration #=> Array
resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].agent_version #=> String
resp.agent_alias.agent_alias_history_events[0].routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias.agent_alias_history_events[0].start_date #=> Time
resp.agent_alias.agent_alias_id #=> String
resp.agent_alias.agent_alias_name #=> String
resp.agent_alias.agent_alias_status #=> String, one of "CREATING", "PREPARED", "FAILED", "UPDATING", "DELETING"
resp.agent_alias.agent_id #=> String
resp.agent_alias.client_token #=> String
resp.agent_alias.created_at #=> Time
resp.agent_alias.description #=> String
resp.agent_alias.failure_reasons #=> Array
resp.agent_alias.failure_reasons[0] #=> String
resp.agent_alias.routing_configuration #=> Array
resp.agent_alias.routing_configuration[0].agent_version #=> String
resp.agent_alias.routing_configuration[0].provisioned_throughput #=> String
resp.agent_alias.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_alias_id (required, String) —

    The unique identifier of the alias.

  • :agent_alias_name (required, String) —

    Specifies a new name for the alias.

  • :agent_id (required, String) —

    The unique identifier of the agent.

  • :description (String) —

    Specifies a new description for the alias.

  • :routing_configuration (Array<Types::AgentAliasRoutingConfigurationListItem>) —

    Contains details about the routing configuration of the alias.

Returns:

See Also:



2923
2924
2925
2926
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2923

def update_agent_alias(params = {}, options = {})
  req = build_request(:update_agent_alias, params)
  req.send_request(options)
end

#update_agent_knowledge_base(params = {}) ⇒ Types::UpdateAgentKnowledgeBaseResponse

Updates the configuration for a knowledge base that has been associated with an agent.

Examples:

Request syntax with placeholder values


resp = client.update_agent_knowledge_base({
  agent_id: "Id", # required
  agent_version: "DraftVersion", # required
  description: "Description",
  knowledge_base_id: "Id", # required
  knowledge_base_state: "ENABLED", # accepts ENABLED, DISABLED
})

Response structure


resp.agent_knowledge_base.agent_id #=> String
resp.agent_knowledge_base.agent_version #=> String
resp.agent_knowledge_base.created_at #=> Time
resp.agent_knowledge_base.description #=> String
resp.agent_knowledge_base.knowledge_base_id #=> String
resp.agent_knowledge_base.knowledge_base_state #=> String, one of "ENABLED", "DISABLED"
resp.agent_knowledge_base.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :agent_id (required, String) —

    The unique identifier of the agent associated with the knowledge base that you want to update.

  • :agent_version (required, String) —

    The version of the agent associated with the knowledge base that you want to update.

  • :description (String) —

    Specifies a new description for the knowledge base associated with an agent.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base that has been associated with an agent.

  • :knowledge_base_state (String) —

    Specifies whether the agent uses the knowledge base or not when sending an InvokeAgent request.

Returns:

See Also:



2983
2984
2985
2986
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2983

def update_agent_knowledge_base(params = {}, options = {})
  req = build_request(:update_agent_knowledge_base, params)
  req.send_request(options)
end

#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse

Updates configurations for a data source.

You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.

Examples:

Request syntax with placeholder values


resp = client.update_data_source({
  data_deletion_policy: "RETAIN", # accepts RETAIN, DELETE
  data_source_configuration: { # required
    s3_configuration: {
      bucket_arn: "S3BucketArn", # required
      bucket_owner_account_id: "BucketOwnerAccountId",
      inclusion_prefixes: ["S3Prefix"],
    },
    type: "S3", # required, accepts S3
  },
  data_source_id: "Id", # required
  description: "Description",
  knowledge_base_id: "Id", # required
  name: "Name", # required
  server_side_encryption_configuration: {
    kms_key_arn: "KmsKeyArn",
  },
  vector_ingestion_configuration: {
    chunking_configuration: {
      chunking_strategy: "FIXED_SIZE", # required, accepts FIXED_SIZE, NONE
      fixed_size_chunking_configuration: {
        max_tokens: 1, # required
        overlap_percentage: 1, # required
      },
    },
  },
})

Response structure


resp.data_source.created_at #=> Time
resp.data_source.data_deletion_policy #=> String, one of "RETAIN", "DELETE"
resp.data_source.data_source_configuration.s3_configuration.bucket_arn #=> String
resp.data_source.data_source_configuration.s3_configuration. #=> String
resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes #=> Array
resp.data_source.data_source_configuration.s3_configuration.inclusion_prefixes[0] #=> String
resp.data_source.data_source_configuration.type #=> String, one of "S3"
resp.data_source.data_source_id #=> String
resp.data_source.description #=> String
resp.data_source.failure_reasons #=> Array
resp.data_source.failure_reasons[0] #=> String
resp.data_source.knowledge_base_id #=> String
resp.data_source.name #=> String
resp.data_source.server_side_encryption_configuration.kms_key_arn #=> String
resp.data_source.status #=> String, one of "AVAILABLE", "DELETING", "DELETE_UNSUCCESSFUL"
resp.data_source.updated_at #=> Time
resp.data_source.vector_ingestion_configuration.chunking_configuration.chunking_strategy #=> String, one of "FIXED_SIZE", "NONE"
resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.max_tokens #=> Integer
resp.data_source.vector_ingestion_configuration.chunking_configuration.fixed_size_chunking_configuration.overlap_percentage #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :data_deletion_policy (String) —

    The data deletion policy of the updated data source.

  • :data_source_configuration (required, Types::DataSourceConfiguration) —

    Contains details about the storage configuration of the data source.

  • :data_source_id (required, String) —

    The unique identifier of the data source.

  • :description (String) —

    Specifies a new description for the data source.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to which the data source belongs.

  • :name (required, String) —

    Specifies a new name for the data source.

  • :server_side_encryption_configuration (Types::ServerSideEncryptionConfiguration) —

    Contains details about server-side encryption of the data source.

  • :vector_ingestion_configuration (Types::VectorIngestionConfiguration) —

    Contains details about how to ingest the documents in the data source.

Returns:

See Also:



3078
3079
3080
3081
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3078

def update_data_source(params = {}, options = {})
  req = build_request(:update_data_source, params)
  req.send_request(options)
end

#update_knowledge_base(params = {}) ⇒ Types::UpdateKnowledgeBaseResponse

Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

You can change the following fields:

  • name

  • description

  • roleArn

You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.

Examples:

Request syntax with placeholder values


resp = client.update_knowledge_base({
  description: "Description",
  knowledge_base_configuration: { # required
    type: "VECTOR", # required, accepts VECTOR
    vector_knowledge_base_configuration: {
      embedding_model_arn: "BedrockEmbeddingModelArn", # required
      embedding_model_configuration: {
        bedrock_embedding_model_configuration: {
          dimensions: 1,
        },
      },
    },
  },
  knowledge_base_id: "Id", # required
  name: "Name", # required
  role_arn: "KnowledgeBaseRoleArn", # required
  storage_configuration: { # required
    mongo_db_atlas_configuration: {
      collection_name: "MongoDbAtlasCollectionName", # required
      credentials_secret_arn: "SecretArn", # required
      database_name: "MongoDbAtlasDatabaseName", # required
      endpoint: "MongoDbAtlasEndpoint", # required
      endpoint_service_name: "MongoDbAtlasEndpointServiceName",
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
        vector_field: "FieldName", # required
      },
      vector_index_name: "MongoDbAtlasIndexName", # required
    },
    opensearch_serverless_configuration: {
      collection_arn: "OpenSearchServerlessCollectionArn", # required
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
        vector_field: "FieldName", # required
      },
      vector_index_name: "OpenSearchServerlessIndexName", # required
    },
    pinecone_configuration: {
      connection_string: "PineconeConnectionString", # required
      credentials_secret_arn: "SecretArn", # required
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
      },
      namespace: "PineconeNamespace",
    },
    rds_configuration: {
      credentials_secret_arn: "SecretArn", # required
      database_name: "RdsDatabaseName", # required
      field_mapping: { # required
        metadata_field: "ColumnName", # required
        primary_key_field: "ColumnName", # required
        text_field: "ColumnName", # required
        vector_field: "ColumnName", # required
      },
      resource_arn: "RdsArn", # required
      table_name: "RdsTableName", # required
    },
    redis_enterprise_cloud_configuration: {
      credentials_secret_arn: "SecretArn", # required
      endpoint: "RedisEnterpriseCloudEndpoint", # required
      field_mapping: { # required
        metadata_field: "FieldName", # required
        text_field: "FieldName", # required
        vector_field: "FieldName", # required
      },
      vector_index_name: "RedisEnterpriseCloudIndexName", # required
    },
    type: "OPENSEARCH_SERVERLESS", # required, accepts OPENSEARCH_SERVERLESS, PINECONE, REDIS_ENTERPRISE_CLOUD, RDS, MONGO_DB_ATLAS
  },
})

Response structure


resp.knowledge_base.created_at #=> Time
resp.knowledge_base.description #=> String
resp.knowledge_base.failure_reasons #=> Array
resp.knowledge_base.failure_reasons[0] #=> String
resp.knowledge_base.knowledge_base_arn #=> String
resp.knowledge_base.knowledge_base_configuration.type #=> String, one of "VECTOR"
resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_arn #=> String
resp.knowledge_base.knowledge_base_configuration.vector_knowledge_base_configuration.embedding_model_configuration.bedrock_embedding_model_configuration.dimensions #=> Integer
resp.knowledge_base.knowledge_base_id #=> String
resp.knowledge_base.name #=> String
resp.knowledge_base.role_arn #=> String
resp.knowledge_base.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "UPDATING", "FAILED", "DELETE_UNSUCCESSFUL"
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.collection_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.database_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.endpoint_service_name #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.mongo_db_atlas_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.collection_arn #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.opensearch_serverless_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.connection_string #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.pinecone_configuration.namespace #=> String
resp.knowledge_base.storage_configuration.rds_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.rds_configuration.database_name #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.primary_key_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.rds_configuration.resource_arn #=> String
resp.knowledge_base.storage_configuration.rds_configuration.table_name #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.credentials_secret_arn #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.endpoint #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.metadata_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.text_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.field_mapping.vector_field #=> String
resp.knowledge_base.storage_configuration.redis_enterprise_cloud_configuration.vector_index_name #=> String
resp.knowledge_base.storage_configuration.type #=> String, one of "OPENSEARCH_SERVERLESS", "PINECONE", "REDIS_ENTERPRISE_CLOUD", "RDS", "MONGO_DB_ATLAS"
resp.knowledge_base.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :description (String) —

    Specifies a new description for the knowledge base.

  • :knowledge_base_configuration (required, Types::KnowledgeBaseConfiguration) —

    Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.

  • :knowledge_base_id (required, String) —

    The unique identifier of the knowledge base to update.

  • :name (required, String) —

    Specifies a new name for the knowledge base.

  • :role_arn (required, String) —

    Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

  • :storage_configuration (required, Types::StorageConfiguration) —

    Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.

Returns:

See Also:



3261
3262
3263
3264
 
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3261

def update_knowledge_base(params = {}, options = {})
  req = build_request(:update_knowledge_base, params)
  req.send_request(options)
end