Class: Aws::BedrockAgent::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BedrockAgent::Client
- 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
API Operations collapse
-
#associate_agent_knowledge_base(params = {}) ⇒ Types::AssociateAgentKnowledgeBaseResponse
Associates a knowledge base with an agent.
-
#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.
-
#create_agent_action_group(params = {}) ⇒ Types::CreateAgentActionGroupResponse
Creates an action group for an agent.
-
#create_agent_alias(params = {}) ⇒ Types::CreateAgentAliasResponse
Creates an alias of an agent that can be used to deploy the agent.
-
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source connector for a knowledge base.
-
#create_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a prompt flow that you can use to send an input through various steps to yield an output.
-
#create_flow_alias(params = {}) ⇒ Types::CreateFlowAliasResponse
Creates an alias of a flow for deployment.
-
#create_flow_version(params = {}) ⇒ Types::CreateFlowVersionResponse
Creates a version of the flow that you can deploy.
-
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base.
-
#create_prompt(params = {}) ⇒ Types::CreatePromptResponse
Creates a prompt in your prompt library that you can add to a flow.
-
#create_prompt_version(params = {}) ⇒ Types::CreatePromptVersionResponse
Creates a static snapshot of your prompt that can be deployed to production.
-
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an agent.
-
#delete_agent_action_group(params = {}) ⇒ Struct
Deletes an action group in an agent.
-
#delete_agent_alias(params = {}) ⇒ Types::DeleteAgentAliasResponse
Deletes an alias of an agent.
-
#delete_agent_version(params = {}) ⇒ Types::DeleteAgentVersionResponse
Deletes a version of an agent.
-
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes a data source from a knowledge base.
-
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow.
-
#delete_flow_alias(params = {}) ⇒ Types::DeleteFlowAliasResponse
Deletes an alias of a flow.
-
#delete_flow_version(params = {}) ⇒ Types::DeleteFlowVersionResponse
Deletes a version of a flow.
-
#delete_knowledge_base(params = {}) ⇒ Types::DeleteKnowledgeBaseResponse
Deletes a knowledge base.
-
#delete_prompt(params = {}) ⇒ Types::DeletePromptResponse
Deletes a prompt or a version of it, depending on whether you include the
promptVersion
field or not. -
#disassociate_agent_knowledge_base(params = {}) ⇒ Struct
Disassociates a knowledge base from an agent.
-
#get_agent(params = {}) ⇒ Types::GetAgentResponse
Gets information about an agent.
-
#get_agent_action_group(params = {}) ⇒ Types::GetAgentActionGroupResponse
Gets information about an action group for an agent.
-
#get_agent_alias(params = {}) ⇒ Types::GetAgentAliasResponse
Gets information about an alias of an agent.
-
#get_agent_knowledge_base(params = {}) ⇒ Types::GetAgentKnowledgeBaseResponse
Gets information about a knowledge base associated with an agent.
-
#get_agent_version(params = {}) ⇒ Types::GetAgentVersionResponse
Gets details about a version of an agent.
-
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Gets information about a data source.
-
#get_flow(params = {}) ⇒ Types::GetFlowResponse
Retrieves information about a flow.
-
#get_flow_alias(params = {}) ⇒ Types::GetFlowAliasResponse
Retrieves information about a flow.
-
#get_flow_version(params = {}) ⇒ Types::GetFlowVersionResponse
Retrieves information about a version of a flow.
-
#get_ingestion_job(params = {}) ⇒ Types::GetIngestionJobResponse
Gets information about a data ingestion job.
-
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Gets information about a knoweldge base.
-
#get_prompt(params = {}) ⇒ Types::GetPromptResponse
Retrieves information about the working draft (
DRAFT
version) of a prompt or a version of it, depending on whether you include thepromptVersion
field or not. -
#list_agent_action_groups(params = {}) ⇒ Types::ListAgentActionGroupsResponse
Lists the action groups for an agent and information about each one.
-
#list_agent_aliases(params = {}) ⇒ Types::ListAgentAliasesResponse
Lists the aliases of an agent and information about each one.
-
#list_agent_knowledge_bases(params = {}) ⇒ Types::ListAgentKnowledgeBasesResponse
Lists knowledge bases associated with an agent and information about each one.
-
#list_agent_versions(params = {}) ⇒ Types::ListAgentVersionsResponse
Lists the versions of an agent and information about each version.
-
#list_agents(params = {}) ⇒ Types::ListAgentsResponse
Lists the agents belonging to an account and information about each agent.
-
#list_data_sources(params = {}) ⇒ Types::ListDataSourcesResponse
Lists the data sources in a knowledge base and information about each one.
-
#list_flow_aliases(params = {}) ⇒ Types::ListFlowAliasesResponse
Returns a list of aliases for a flow.
-
#list_flow_versions(params = {}) ⇒ Types::ListFlowVersionsResponse
Returns a list of information about each flow.
-
#list_flows(params = {}) ⇒ Types::ListFlowsResponse
Returns a list of flows and information about each flow.
-
#list_ingestion_jobs(params = {}) ⇒ Types::ListIngestionJobsResponse
Lists the data ingestion jobs for a data source.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases in an account.
-
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Returns either information about the working draft (
DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifier
field or not. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all the tags for the resource you specify.
-
#prepare_agent(params = {}) ⇒ Types::PrepareAgentResponse
Creates a
DRAFT
version of the agent that can be used for internal testing. -
#prepare_flow(params = {}) ⇒ Types::PrepareFlowResponse
Prepares the
DRAFT
version of a flow so that it can be invoked. -
#start_ingestion_job(params = {}) ⇒ Types::StartIngestionJobResponse
Begins a data ingestion job.
-
#stop_ingestion_job(params = {}) ⇒ Types::StopIngestionJobResponse
Stops a currently running data ingestion job.
-
#tag_resource(params = {}) ⇒ Struct
Associate tags with a resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
-
#update_agent(params = {}) ⇒ Types::UpdateAgentResponse
Updates the configuration of an agent.
-
#update_agent_action_group(params = {}) ⇒ Types::UpdateAgentActionGroupResponse
Updates the configuration for an action group for an agent.
-
#update_agent_alias(params = {}) ⇒ Types::UpdateAgentAliasResponse
Updates configurations for an alias of an agent.
-
#update_agent_knowledge_base(params = {}) ⇒ Types::UpdateAgentKnowledgeBaseResponse
Updates the configuration for a knowledge base that has been associated with an agent.
-
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates the configurations for a data source connector.
-
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Modifies a flow.
-
#update_flow_alias(params = {}) ⇒ Types::UpdateFlowAliasResponse
Modifies the alias of a flow.
-
#update_knowledge_base(params = {}) ⇒ Types::UpdateKnowledgeBaseResponse
Updates the configuration of a knowledge base with the fields that you specify.
-
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Modifies a prompt in your prompt library.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
444 445 446 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 444 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.
506 507 508 509 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 506 def associate_agent_knowledge_base(params = {}, = {}) req = build_request(:associate_agent_knowledge_base, params) req.send_request() 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 subsequentInvokeAgent
request begins a new session.
To enable your agent to retain conversational context across multiple sessions, include a
memoryConfiguration
object. For more information, see Configure memory.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 your agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for you to troubleshoot.The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
701 702 703 704 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 701 def create_agent(params = {}, = {}) req = build_request(:create_agent, params) req.send_request() 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
.
To allow your agent to generate, run, and troubleshoot code when
trying to complete a task, add an action group with the
parentActionGroupSignature
field set to AMAZON.CodeInterpreter
.
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.
876 877 878 879 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 876 def create_agent_action_group(params = {}, = {}) req = build_request(:create_agent_action_group, params) req.send_request() end |
#create_agent_alias(params = {}) ⇒ Types::CreateAgentAliasResponse
Creates an alias of an agent that can be used to deploy the agent.
960 961 962 963 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 960 def create_agent_alias(params = {}, = {}) req = build_request(:create_agent_alias, params) req.send_request() end |
#create_data_source(params = {}) ⇒ Types::CreateDataSourceResponse
Creates a data source connector for a knowledge base.
You can't change the chunkingConfiguration
after you create the
data source connector.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1259 def create_data_source(params = {}, = {}) req = build_request(:create_data_source, params) req.send_request() end |
#create_flow(params = {}) ⇒ Types::CreateFlowResponse
Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
1515 1516 1517 1518 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1515 def create_flow(params = {}, = {}) req = build_request(:create_flow, params) req.send_request() end |
#create_flow_alias(params = {}) ⇒ Types::CreateFlowAliasResponse
Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
1604 1605 1606 1607 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1604 def create_flow_alias(params = {}, = {}) req = build_request(:create_flow_alias, params) req.send_request() end |
#create_flow_version(params = {}) ⇒ Types::CreateFlowVersionResponse
Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
1714 1715 1716 1717 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1714 def create_flow_version(params = {}, = {}) req = build_request(:create_flow_version, params) req.send_request() end |
#create_knowledge_base(params = {}) ⇒ Types::CreateKnowledgeBaseResponse
Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base.
Provide the
name
and an optionaldescription
.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 theknowledgeBaseConfiguration
object.Provide the configuration for your vector store in the
storageConfiguration
object.For an Amazon OpenSearch Service database, use the
opensearchServerlessConfiguration
object. For more information, see Create a vector store in Amazon OpenSearch Service.For an Amazon Aurora database, use the
RdsConfiguration
object. For more information, see Create a vector store in Amazon Aurora.For a Pinecone database, use the
pineconeConfiguration
object. For more information, see Create a vector store in Pinecone.For a Redis Enterprise Cloud database, use the
redisEnterpriseCloudConfiguration
object. For more information, see Create a vector store in Redis Enterprise Cloud.
1938 1939 1940 1941 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1938 def create_knowledge_base(params = {}, = {}) req = build_request(:create_knowledge_base, params) req.send_request() end |
#create_prompt(params = {}) ⇒ Types::CreatePromptResponse
Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2084 def create_prompt(params = {}, = {}) req = build_request(:create_prompt, params) req.send_request() end |
#create_prompt_version(params = {}) ⇒ Types::CreatePromptVersionResponse
Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
2180 2181 2182 2183 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2180 def create_prompt_version(params = {}, = {}) req = build_request(:create_prompt_version, params) req.send_request() end |
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an agent.
2216 2217 2218 2219 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2216 def delete_agent(params = {}, = {}) req = build_request(:delete_agent, params) req.send_request() end |
#delete_agent_action_group(params = {}) ⇒ Struct
Deletes an action group in an agent.
2252 2253 2254 2255 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2252 def delete_agent_action_group(params = {}, = {}) req = build_request(:delete_agent_action_group, params) req.send_request() end |
#delete_agent_alias(params = {}) ⇒ Types::DeleteAgentAliasResponse
Deletes an alias of an agent.
2288 2289 2290 2291 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2288 def delete_agent_alias(params = {}, = {}) req = build_request(:delete_agent_alias, params) req.send_request() end |
#delete_agent_version(params = {}) ⇒ Types::DeleteAgentVersionResponse
Deletes a version of an agent.
2330 2331 2332 2333 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2330 def delete_agent_version(params = {}, = {}) req = build_request(:delete_agent_version, params) req.send_request() end |
#delete_data_source(params = {}) ⇒ Types::DeleteDataSourceResponse
Deletes a data source from a knowledge base.
2367 2368 2369 2370 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2367 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow.
2401 2402 2403 2404 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2401 def delete_flow(params = {}, = {}) req = build_request(:delete_flow, params) req.send_request() end |
#delete_flow_alias(params = {}) ⇒ Types::DeleteFlowAliasResponse
Deletes an alias of a flow.
2435 2436 2437 2438 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2435 def delete_flow_alias(params = {}, = {}) req = build_request(:delete_flow_alias, params) req.send_request() end |
#delete_flow_version(params = {}) ⇒ Types::DeleteFlowVersionResponse
Deletes a version of a flow.
2476 2477 2478 2479 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2476 def delete_flow_version(params = {}, = {}) req = build_request(:delete_flow_version, params) req.send_request() 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.
2512 2513 2514 2515 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2512 def delete_knowledge_base(params = {}, = {}) req = build_request(:delete_knowledge_base, params) req.send_request() end |
#delete_prompt(params = {}) ⇒ Types::DeletePromptResponse
Deletes a prompt or a version of it, depending on whether you include
the promptVersion
field or not. For more information, see Delete
prompts from the Prompt management tool and Delete a version of a
prompt from the Prompt management tool in the Amazon Bedrock User
Guide.
2556 2557 2558 2559 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2556 def delete_prompt(params = {}, = {}) req = build_request(:delete_prompt, params) req.send_request() end |
#disassociate_agent_knowledge_base(params = {}) ⇒ Struct
Disassociates a knowledge base from an agent.
2588 2589 2590 2591 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2588 def disassociate_agent_knowledge_base(params = {}, = {}) req = build_request(:disassociate_agent_knowledge_base, params) req.send_request() end |
#get_agent(params = {}) ⇒ Types::GetAgentResponse
Gets information about an agent.
2652 2653 2654 2655 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2652 def get_agent(params = {}, = {}) req = build_request(:get_agent, params) req.send_request() end |
#get_agent_action_group(params = {}) ⇒ Types::GetAgentActionGroupResponse
Gets information about an action group for an agent.
2711 2712 2713 2714 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2711 def get_agent_action_group(params = {}, = {}) req = build_request(:get_agent_action_group, params) req.send_request() end |
#get_agent_alias(params = {}) ⇒ Types::GetAgentAliasResponse
Gets information about an alias of an agent.
2763 2764 2765 2766 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2763 def get_agent_alias(params = {}, = {}) req = build_request(:get_agent_alias, params) req.send_request() end |
#get_agent_knowledge_base(params = {}) ⇒ Types::GetAgentKnowledgeBaseResponse
Gets information about a knowledge base associated with an agent.
2806 2807 2808 2809 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2806 def get_agent_knowledge_base(params = {}, = {}) req = build_request(:get_agent_knowledge_base, params) req.send_request() end |
#get_agent_version(params = {}) ⇒ Types::GetAgentVersionResponse
Gets details about a version of an agent.
2872 2873 2874 2875 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2872 def get_agent_version(params = {}, = {}) req = build_request(:get_agent_version, params) req.send_request() end |
#get_data_source(params = {}) ⇒ Types::GetDataSourceResponse
Gets information about a data source.
2978 2979 2980 2981 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2978 def get_data_source(params = {}, = {}) req = build_request(:get_data_source, params) req.send_request() end |
#get_flow(params = {}) ⇒ Types::GetFlowResponse
Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
3074 3075 3076 3077 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3074 def get_flow(params = {}, = {}) req = build_request(:get_flow, params) req.send_request() end |
#get_flow_alias(params = {}) ⇒ Types::GetFlowAliasResponse
Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
3126 3127 3128 3129 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3126 def get_flow_alias(params = {}, = {}) req = build_request(:get_flow_alias, params) req.send_request() end |
#get_flow_version(params = {}) ⇒ Types::GetFlowVersionResponse
Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
3221 3222 3223 3224 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3221 def get_flow_version(params = {}, = {}) req = build_request(:get_flow_version, params) req.send_request() end |
#get_ingestion_job(params = {}) ⇒ Types::GetIngestionJobResponse
Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
3277 3278 3279 3280 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3277 def get_ingestion_job(params = {}, = {}) req = build_request(:get_ingestion_job, params) req.send_request() end |
#get_knowledge_base(params = {}) ⇒ Types::GetKnowledgeBaseResponse
Gets information about a knoweldge base.
3352 3353 3354 3355 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3352 def get_knowledge_base(params = {}, = {}) req = build_request(:get_knowledge_base, params) req.send_request() end |
#get_prompt(params = {}) ⇒ Types::GetPromptResponse
Retrieves information about the working draft (DRAFT
version) of a
prompt or a version of it, depending on whether you include the
promptVersion
field or not. For more information, see View
information about prompts using Prompt management and View
information about a version of your prompt in the Amazon Bedrock
User Guide.
3428 3429 3430 3431 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3428 def get_prompt(params = {}, = {}) req = build_request(:get_prompt, params) req.send_request() 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.
3483 3484 3485 3486 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3483 def list_agent_action_groups(params = {}, = {}) req = build_request(:list_agent_action_groups, params) req.send_request() 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.
3538 3539 3540 3541 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3538 def list_agent_aliases(params = {}, = {}) req = build_request(:list_agent_aliases, params) req.send_request() 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.
3595 3596 3597 3598 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3595 def list_agent_knowledge_bases(params = {}, = {}) req = build_request(:list_agent_knowledge_bases, params) req.send_request() 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.
3649 3650 3651 3652 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3649 def list_agent_versions(params = {}, = {}) req = build_request(:list_agent_versions, params) req.send_request() 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.
3700 3701 3702 3703 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3700 def list_agents(params = {}, = {}) req = build_request(:list_agents, params) req.send_request() 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.
3754 3755 3756 3757 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3754 def list_data_sources(params = {}, = {}) req = build_request(:list_data_sources, params) req.send_request() end |
#list_flow_aliases(params = {}) ⇒ Types::ListFlowAliasesResponse
Returns a list of aliases for a flow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3810 3811 3812 3813 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3810 def list_flow_aliases(params = {}, = {}) req = build_request(:list_flow_aliases, params) req.send_request() end |
#list_flow_versions(params = {}) ⇒ Types::ListFlowVersionsResponse
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3867 3868 3869 3870 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3867 def list_flow_versions(params = {}, = {}) req = build_request(:list_flow_versions, params) req.send_request() end |
#list_flows(params = {}) ⇒ Types::ListFlowsResponse
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3923 3924 3925 3926 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3923 def list_flows(params = {}, = {}) req = build_request(:list_flows, params) req.send_request() end |
#list_ingestion_jobs(params = {}) ⇒ Types::ListIngestionJobsResponse
Lists the data ingestion jobs for a data source. The list also includes information about each job.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4007 4008 4009 4010 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4007 def list_ingestion_jobs(params = {}, = {}) req = build_request(:list_ingestion_jobs, params) req.send_request() end |
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4055 4056 4057 4058 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4055 def list_knowledge_bases(params = {}, = {}) req = build_request(:list_knowledge_bases, params) req.send_request() end |
#list_prompts(params = {}) ⇒ Types::ListPromptsResponse
Returns either information about the working draft (DRAFT
version)
of each prompt in an account, or information about of all versions of
a prompt, depending on whether you include the promptIdentifier
field or not. For more information, see View information about
prompts using Prompt management in the Amazon Bedrock User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4118 4119 4120 4121 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4118 def list_prompts(params = {}, = {}) req = build_request(:list_prompts, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all the tags for the resource you specify.
4147 4148 4149 4150 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4147 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#prepare_agent(params = {}) ⇒ Types::PrepareAgentResponse
Creates a DRAFT
version of the agent that can be used for internal
testing.
4183 4184 4185 4186 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4183 def prepare_agent(params = {}, = {}) req = build_request(:prepare_agent, params) req.send_request() end |
#prepare_flow(params = {}) ⇒ Types::PrepareFlowResponse
Prepares the DRAFT
version of a flow so that it can be invoked. For
more information, see Test a flow in Amazon Bedrock in the Amazon
Bedrock User Guide.
4219 4220 4221 4222 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4219 def prepare_flow(params = {}, = {}) req = build_request(:prepare_flow, params) req.send_request() end |
#start_ingestion_job(params = {}) ⇒ Types::StartIngestionJobResponse
Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
4287 4288 4289 4290 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4287 def start_ingestion_job(params = {}, = {}) req = build_request(:start_ingestion_job, params) req.send_request() end |
#stop_ingestion_job(params = {}) ⇒ Types::StopIngestionJobResponse
Stops a currently running data ingestion job. You can send a
StartIngestionJob
request again to ingest the rest of your data when
you are ready.
4342 4343 4344 4345 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4342 def stop_ingestion_job(params = {}, = {}) req = build_request(:stop_ingestion_job, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
4376 4377 4378 4379 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4376 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
4403 4404 4405 4406 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4403 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_agent(params = {}) ⇒ Types::UpdateAgentResponse
Updates the configuration of an agent.
4546 4547 4548 4549 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4546 def update_agent(params = {}, = {}) req = build_request(:update_agent, params) req.send_request() end |
#update_agent_action_group(params = {}) ⇒ Types::UpdateAgentActionGroupResponse
Updates the configuration for an action group for an agent.
4684 4685 4686 4687 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4684 def update_agent_action_group(params = {}, = {}) req = build_request(:update_agent_action_group, params) req.send_request() end |
#update_agent_alias(params = {}) ⇒ Types::UpdateAgentAliasResponse
Updates configurations for an alias of an agent.
4752 4753 4754 4755 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4752 def update_agent_alias(params = {}, = {}) req = build_request(:update_agent_alias, params) req.send_request() end |
#update_agent_knowledge_base(params = {}) ⇒ Types::UpdateAgentKnowledgeBaseResponse
Updates the configuration for a knowledge base that has been associated with an agent.
4812 4813 4814 4815 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4812 def update_agent_knowledge_base(params = {}, = {}) req = build_request(:update_agent_knowledge_base, params) req.send_request() end |
#update_data_source(params = {}) ⇒ Types::UpdateDataSourceResponse
Updates the configurations for a data source connector.
You can't change the chunkingConfiguration
after you create the
data source connector. Specify the existing chunkingConfiguration
.
5088 5089 5090 5091 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5088 def update_data_source(params = {}, = {}) req = build_request(:update_data_source, params) req.send_request() end |
#update_flow(params = {}) ⇒ Types::UpdateFlowResponse
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
5322 5323 5324 5325 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5322 def update_flow(params = {}, = {}) req = build_request(:update_flow, params) req.send_request() end |
#update_flow_alias(params = {}) ⇒ Types::UpdateFlowAliasResponse
Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
5391 5392 5393 5394 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5391 def update_flow_alias(params = {}, = {}) req = build_request(:update_flow_alias, params) req.send_request() 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.
5574 5575 5576 5577 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5574 def update_knowledge_base(params = {}, = {}) req = build_request(:update_knowledge_base, params) req.send_request() end |
#update_prompt(params = {}) ⇒ Types::UpdatePromptResponse
Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
5698 5699 5700 5701 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5698 def update_prompt(params = {}, = {}) req = build_request(:update_prompt, params) req.send_request() end |