View Source AWS.BedrockAgent (aws-elixir v1.0.0)
Describes the API operations for creating and managing Amazon Bedrock agents.
Summary
Functions
Associates a knowledge base with an agent.
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Creates an action group for an agent.
Creates an alias of an agent that can be used to deploy the agent.
Sets up a data source to be added to a knowledge base.
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
Deletes an agent.
Deletes an action group in an agent.
Deletes an alias of an agent.
Deletes a version of an agent.
Deletes a data source from a knowledge base.
Deletes a knowledge base.
Disassociates a knowledge base from an agent.
Gets information about an agent.
Gets information about an action group for an agent.
Gets information about an alias of an agent.
Gets information about a knowledge base associated with an agent.
Gets details about a version of an agent.
Gets information about a data source.
Gets information about a ingestion job, in which a data source is added to a knowledge base.
Gets information about a knoweldge base.
Lists the action groups for an agent and information about each one.
Lists the aliases of an agent and information about each one.
Lists knowledge bases associated with an agent and information about each one.
Lists the versions of an agent and information about each version.
Lists the agents belonging to an account and information about each agent.
Lists the data sources in a knowledge base and information about each one.
Lists the ingestion jobs for a data source and information about each of them.
Lists the knowledge bases in an account and information about each of them.
List all the tags for the resource you specify.
Creates a DRAFT
version of the agent that can be used for internal testing.
Begins an ingestion job, in which a data source is added to a knowledge base.
Associate tags with a resource.
Remove tags from a resource.
Updates the configuration of an agent.
Updates the configuration for an action group for an agent.
Updates configurations for an alias of an agent.
Updates the configuration for a knowledge base that has been associated with an agent.
Updates configurations for a data source.
Updates the configuration of a knowledge base with the fields that you specify.
Functions
associate_agent_knowledge_base(client, agent_id, agent_version, input, options \\ [])
View SourceAssociates 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.
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.
create_agent_action_group(client, agent_id, agent_version, input, options \\ [])
View SourceCreates 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.
Creates an alias of an agent that can be used to deploy the agent.
create_data_source(client, knowledge_base_id, input, options \\ [])
View SourceSets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
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.
*
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.
Deletes an agent.
delete_agent_action_group(client, action_group_id, agent_id, agent_version, input, options \\ [])
View SourceDeletes an action group in an agent.
delete_agent_alias(client, agent_alias_id, agent_id, input, options \\ [])
View SourceDeletes an alias of an agent.
delete_agent_version(client, agent_id, agent_version, input, options \\ [])
View SourceDeletes a version of an agent.
delete_data_source(client, data_source_id, knowledge_base_id, input, options \\ [])
View SourceDeletes a data source from a knowledge base.
delete_knowledge_base(client, knowledge_base_id, input, options \\ [])
View SourceDeletes 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.
disassociate_agent_knowledge_base(client, agent_id, agent_version, knowledge_base_id, input, options \\ [])
View SourceDisassociates a knowledge base from an agent.
Gets information about an agent.
get_agent_action_group(client, action_group_id, agent_id, agent_version, options \\ [])
View SourceGets information about an action group for an agent.
Gets information about an alias of an agent.
get_agent_knowledge_base(client, agent_id, agent_version, knowledge_base_id, options \\ [])
View SourceGets information about a knowledge base associated with an agent.
Gets details about a version of an agent.
get_data_source(client, data_source_id, knowledge_base_id, options \\ [])
View SourceGets information about a data source.
get_ingestion_job(client, data_source_id, ingestion_job_id, knowledge_base_id, options \\ [])
View SourceGets information about a ingestion job, in which a data source is added to a knowledge base.
Gets information about a knoweldge base.
list_agent_action_groups(client, agent_id, agent_version, input, options \\ [])
View SourceLists the action groups for an agent and information about each one.
Lists the aliases of an agent and information about each one.
list_agent_knowledge_bases(client, agent_id, agent_version, input, options \\ [])
View SourceLists knowledge bases associated with an agent and information about each one.
Lists the versions of an agent and information about each version.
Lists the agents belonging to an account and information about each agent.
list_data_sources(client, knowledge_base_id, input, options \\ [])
View SourceLists the data sources in a knowledge base and information about each one.
list_ingestion_jobs(client, data_source_id, knowledge_base_id, input, options \\ [])
View SourceLists the ingestion jobs for a data source and information about each of them.
Lists the knowledge bases in an account and information about each of them.
List all the tags for the resource you specify.
Creates a DRAFT
version of the agent that can be used for internal testing.
start_ingestion_job(client, data_source_id, knowledge_base_id, input, options \\ [])
View SourceBegins an ingestion job, in which a data source is added to a knowledge base.
Associate tags with a resource.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
Remove tags from a resource.
Updates the configuration of an agent.
update_agent_action_group(client, action_group_id, agent_id, agent_version, input, options \\ [])
View SourceUpdates the configuration for an action group for an agent.
update_agent_alias(client, agent_alias_id, agent_id, input, options \\ [])
View SourceUpdates configurations for an alias of an agent.
update_agent_knowledge_base(client, agent_id, agent_version, knowledge_base_id, input, options \\ [])
View SourceUpdates the configuration for a knowledge base that has been associated with an agent.
update_data_source(client, data_source_id, knowledge_base_id, input, options \\ [])
View SourceUpdates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source.
Specify the existing chunkingConfiguration
.
update_knowledge_base(client, knowledge_base_id, input, options \\ [])
View SourceUpdates 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.