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 that contains data sources from which information can be queried and used by LLMs.
-
#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 ingestion job, in which a data source is added to a knowledge base.
-
#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 ingestion jobs for a data source and information about each of them.
-
#list_knowledge_bases(params = {}) ⇒ Types::ListKnowledgeBasesResponse
Lists the knowledge bases in an account and information about each of them.
-
#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 an ingestion job, in which a data source is added to a knowledge base.
-
#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.
422 423 424 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 422 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.
484 485 486 487 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 484 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 you agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for you to troubleshoot.
675 676 677 678 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 675 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.
850 851 852 853 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 850 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.
934 935 936 937 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 934 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.
1233 1234 1235 1236 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1233 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.
1491 1492 1493 1494 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1491 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.
1580 1581 1582 1583 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1580 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.
1691 1692 1693 1694 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1691 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 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.
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.
1915 1916 1917 1918 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 1915 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.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2054 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.
2148 2149 2150 2151 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2148 def create_prompt_version(params = {}, = {}) req = build_request(:create_prompt_version, params) req.send_request() end |
#delete_agent(params = {}) ⇒ Types::DeleteAgentResponse
Deletes an agent.
2184 2185 2186 2187 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2184 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.
2220 2221 2222 2223 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2220 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.
2256 2257 2258 2259 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2256 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.
2298 2299 2300 2301 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2298 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.
2335 2336 2337 2338 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2335 def delete_data_source(params = {}, = {}) req = build_request(:delete_data_source, params) req.send_request() end |
#delete_flow(params = {}) ⇒ Types::DeleteFlowResponse
Deletes a flow.
2369 2370 2371 2372 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2369 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.
2403 2404 2405 2406 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2403 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.
2444 2445 2446 2447 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2444 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.
2480 2481 2482 2483 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2480 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.
2524 2525 2526 2527 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2524 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.
2556 2557 2558 2559 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2556 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.
2620 2621 2622 2623 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2620 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.
2679 2680 2681 2682 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2679 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.
2731 2732 2733 2734 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2731 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.
2774 2775 2776 2777 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2774 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.
2840 2841 2842 2843 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2840 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.
2947 2948 2949 2950 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 2947 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.
3044 3045 3046 3047 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3044 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.
3096 3097 3098 3099 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3096 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.
3192 3193 3194 3195 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3192 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 ingestion job, in which a data source is added to a knowledge base.
3245 3246 3247 3248 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3245 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.
3320 3321 3322 3323 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3320 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.
3394 3395 3396 3397 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3394 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.
3449 3450 3451 3452 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3449 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.
3504 3505 3506 3507 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3504 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.
3561 3562 3563 3564 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3561 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.
3615 3616 3617 3618 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3615 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.
3666 3667 3668 3669 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3666 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.
3720 3721 3722 3723 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3720 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.
3776 3777 3778 3779 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3776 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.
3833 3834 3835 3836 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3833 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.
3889 3890 3891 3892 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3889 def list_flows(params = {}, = {}) req = build_request(:list_flows, params) req.send_request() 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.
3973 3974 3975 3976 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 3973 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 and information about each of them.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4021 4022 4023 4024 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4021 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.
4084 4085 4086 4087 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4084 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.
4113 4114 4115 4116 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4113 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.
4149 4150 4151 4152 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4149 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.
4185 4186 4187 4188 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4185 def prepare_flow(params = {}, = {}) req = build_request(:prepare_flow, params) req.send_request() end |
#start_ingestion_job(params = {}) ⇒ Types::StartIngestionJobResponse
Begins an ingestion job, in which a data source is added to a knowledge base.
4252 4253 4254 4255 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4252 def start_ingestion_job(params = {}, = {}) req = build_request(:start_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.
4286 4287 4288 4289 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4286 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
4313 4314 4315 4316 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4313 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.
4456 4457 4458 4459 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4456 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.
4594 4595 4596 4597 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4594 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.
4662 4663 4664 4665 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4662 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.
4722 4723 4724 4725 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4722 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
.
4998 4999 5000 5001 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 4998 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.
5234 5235 5236 5237 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5234 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.
5303 5304 5305 5306 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5303 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.
5486 5487 5488 5489 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5486 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.
5603 5604 5605 5606 |
# File 'gems/aws-sdk-bedrockagent/lib/aws-sdk-bedrockagent/client.rb', line 5603 def update_prompt(params = {}, = {}) req = build_request(:update_prompt, params) req.send_request() end |