@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSBedrockAgent extends Object implements AWSBedrockAgent
AWSBedrockAgent
. Convenient method forms pass through to the corresponding
overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateAgentKnowledgeBaseResult |
associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)
Associates a knowledge base with an agent.
|
CreateAgentResult |
createAgent(CreateAgentRequest request)
Creates an agent that orchestrates interactions between foundation models, data sources, software applications,
user conversations, and APIs to carry out tasks to help customers.
|
CreateAgentActionGroupResult |
createAgentActionGroup(CreateAgentActionGroupRequest request)
Creates an action group for an agent.
|
CreateAgentAliasResult |
createAgentAlias(CreateAgentAliasRequest request)
Creates an alias of an agent that can be used to deploy the agent.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest request)
Sets up a data source to be added to a knowledge base.
|
CreateKnowledgeBaseResult |
createKnowledgeBase(CreateKnowledgeBaseRequest request)
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest request)
Deletes an agent.
|
DeleteAgentActionGroupResult |
deleteAgentActionGroup(DeleteAgentActionGroupRequest request)
Deletes an action group in an agent.
|
DeleteAgentAliasResult |
deleteAgentAlias(DeleteAgentAliasRequest request)
Deletes an alias of an agent.
|
DeleteAgentVersionResult |
deleteAgentVersion(DeleteAgentVersionRequest request)
Deletes a version of an agent.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes a data source from a knowledge base.
|
DeleteKnowledgeBaseResult |
deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
Deletes a knowledge base.
|
DisassociateAgentKnowledgeBaseResult |
disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)
Disassociates a knowledge base from an agent.
|
GetAgentResult |
getAgent(GetAgentRequest request)
Gets information about an agent.
|
GetAgentActionGroupResult |
getAgentActionGroup(GetAgentActionGroupRequest request)
Gets information about an action group for an agent.
|
GetAgentAliasResult |
getAgentAlias(GetAgentAliasRequest request)
Gets information about an alias of an agent.
|
GetAgentKnowledgeBaseResult |
getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)
Gets information about a knowledge base associated with an agent.
|
GetAgentVersionResult |
getAgentVersion(GetAgentVersionRequest request)
Gets details about a version of an agent.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataSourceResult |
getDataSource(GetDataSourceRequest request)
Gets information about a data source.
|
GetIngestionJobResult |
getIngestionJob(GetIngestionJobRequest request)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
|
GetKnowledgeBaseResult |
getKnowledgeBase(GetKnowledgeBaseRequest request)
Gets information about a knoweldge base.
|
ListAgentActionGroupsResult |
listAgentActionGroups(ListAgentActionGroupsRequest request)
Lists the action groups for an agent and information about each one.
|
ListAgentAliasesResult |
listAgentAliases(ListAgentAliasesRequest request)
Lists the aliases of an agent and information about each one.
|
ListAgentKnowledgeBasesResult |
listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)
Lists knowledge bases associated with an agent and information about each one.
|
ListAgentsResult |
listAgents(ListAgentsRequest request)
Lists the agents belonging to an account and information about each agent.
|
ListAgentVersionsResult |
listAgentVersions(ListAgentVersionsRequest request)
Lists the versions of an agent and information about each version.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists the data sources in a knowledge base and information about each one.
|
ListIngestionJobsResult |
listIngestionJobs(ListIngestionJobsRequest request)
Lists the ingestion jobs for a data source and information about each of them.
|
ListKnowledgeBasesResult |
listKnowledgeBases(ListKnowledgeBasesRequest request)
Lists the knowledge bases in an account and information about each of them.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List all the tags for the resource you specify.
|
PrepareAgentResult |
prepareAgent(PrepareAgentRequest request)
Creates a
DRAFT version of the agent that can be used for internal testing. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartIngestionJobResult |
startIngestionJob(StartIngestionJobRequest request)
Begins an ingestion job, in which a data source is added to a knowledge base.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associate tags with a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Remove tags from a resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest request)
Updates the configuration of an agent.
|
UpdateAgentActionGroupResult |
updateAgentActionGroup(UpdateAgentActionGroupRequest request)
Updates the configuration for an action group for an agent.
|
UpdateAgentAliasResult |
updateAgentAlias(UpdateAgentAliasRequest request)
Updates configurations for an alias of an agent.
|
UpdateAgentKnowledgeBaseResult |
updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)
Updates the configuration for a knowledge base that has been associated with an agent.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates configurations for a data source.
|
UpdateKnowledgeBaseResult |
updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
Updates the configuration of a knowledge base with the fields that you specify.
|
public AssociateAgentKnowledgeBaseResult associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)
AWSBedrockAgent
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.
associateAgentKnowledgeBase
in interface AWSBedrockAgent
public CreateAgentResult createAgent(CreateAgentRequest request)
AWSBedrockAgent
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.
createAgent
in interface AWSBedrockAgent
public CreateAgentActionGroupResult createAgentActionGroup(CreateAgentActionGroupRequest request)
AWSBedrockAgent
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.
createAgentActionGroup
in interface AWSBedrockAgent
public CreateAgentAliasResult createAgentAlias(CreateAgentAliasRequest request)
AWSBedrockAgent
Creates an alias of an agent that can be used to deploy the agent.
createAgentAlias
in interface AWSBedrockAgent
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
AWSBedrockAgent
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
createDataSource
in interface AWSBedrockAgent
public CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)
AWSBedrockAgent
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.
createKnowledgeBase
in interface AWSBedrockAgent
public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
AWSBedrockAgent
Deletes an agent.
deleteAgent
in interface AWSBedrockAgent
public DeleteAgentActionGroupResult deleteAgentActionGroup(DeleteAgentActionGroupRequest request)
AWSBedrockAgent
Deletes an action group in an agent.
deleteAgentActionGroup
in interface AWSBedrockAgent
public DeleteAgentAliasResult deleteAgentAlias(DeleteAgentAliasRequest request)
AWSBedrockAgent
Deletes an alias of an agent.
deleteAgentAlias
in interface AWSBedrockAgent
public DeleteAgentVersionResult deleteAgentVersion(DeleteAgentVersionRequest request)
AWSBedrockAgent
Deletes a version of an agent.
deleteAgentVersion
in interface AWSBedrockAgent
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
AWSBedrockAgent
Deletes a data source from a knowledge base.
deleteDataSource
in interface AWSBedrockAgent
public DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
AWSBedrockAgent
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.
deleteKnowledgeBase
in interface AWSBedrockAgent
public DisassociateAgentKnowledgeBaseResult disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)
AWSBedrockAgent
Disassociates a knowledge base from an agent.
disassociateAgentKnowledgeBase
in interface AWSBedrockAgent
public GetAgentResult getAgent(GetAgentRequest request)
AWSBedrockAgent
Gets information about an agent.
getAgent
in interface AWSBedrockAgent
public GetAgentActionGroupResult getAgentActionGroup(GetAgentActionGroupRequest request)
AWSBedrockAgent
Gets information about an action group for an agent.
getAgentActionGroup
in interface AWSBedrockAgent
public GetAgentAliasResult getAgentAlias(GetAgentAliasRequest request)
AWSBedrockAgent
Gets information about an alias of an agent.
getAgentAlias
in interface AWSBedrockAgent
public GetAgentKnowledgeBaseResult getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)
AWSBedrockAgent
Gets information about a knowledge base associated with an agent.
getAgentKnowledgeBase
in interface AWSBedrockAgent
public GetAgentVersionResult getAgentVersion(GetAgentVersionRequest request)
AWSBedrockAgent
Gets details about a version of an agent.
getAgentVersion
in interface AWSBedrockAgent
public GetDataSourceResult getDataSource(GetDataSourceRequest request)
AWSBedrockAgent
Gets information about a data source.
getDataSource
in interface AWSBedrockAgent
public GetIngestionJobResult getIngestionJob(GetIngestionJobRequest request)
AWSBedrockAgent
Gets information about a ingestion job, in which a data source is added to a knowledge base.
getIngestionJob
in interface AWSBedrockAgent
public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
AWSBedrockAgent
Gets information about a knoweldge base.
getKnowledgeBase
in interface AWSBedrockAgent
public ListAgentActionGroupsResult listAgentActionGroups(ListAgentActionGroupsRequest request)
AWSBedrockAgent
Lists the action groups for an agent and information about each one.
listAgentActionGroups
in interface AWSBedrockAgent
public ListAgentAliasesResult listAgentAliases(ListAgentAliasesRequest request)
AWSBedrockAgent
Lists the aliases of an agent and information about each one.
listAgentAliases
in interface AWSBedrockAgent
public ListAgentKnowledgeBasesResult listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)
AWSBedrockAgent
Lists knowledge bases associated with an agent and information about each one.
listAgentKnowledgeBases
in interface AWSBedrockAgent
public ListAgentVersionsResult listAgentVersions(ListAgentVersionsRequest request)
AWSBedrockAgent
Lists the versions of an agent and information about each version.
listAgentVersions
in interface AWSBedrockAgent
public ListAgentsResult listAgents(ListAgentsRequest request)
AWSBedrockAgent
Lists the agents belonging to an account and information about each agent.
listAgents
in interface AWSBedrockAgent
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
AWSBedrockAgent
Lists the data sources in a knowledge base and information about each one.
listDataSources
in interface AWSBedrockAgent
public ListIngestionJobsResult listIngestionJobs(ListIngestionJobsRequest request)
AWSBedrockAgent
Lists the ingestion jobs for a data source and information about each of them.
listIngestionJobs
in interface AWSBedrockAgent
public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
AWSBedrockAgent
Lists the knowledge bases in an account and information about each of them.
listKnowledgeBases
in interface AWSBedrockAgent
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSBedrockAgent
List all the tags for the resource you specify.
listTagsForResource
in interface AWSBedrockAgent
public PrepareAgentResult prepareAgent(PrepareAgentRequest request)
AWSBedrockAgent
Creates a DRAFT
version of the agent that can be used for internal testing.
prepareAgent
in interface AWSBedrockAgent
public StartIngestionJobResult startIngestionJob(StartIngestionJobRequest request)
AWSBedrockAgent
Begins an ingestion job, in which a data source is added to a knowledge base.
startIngestionJob
in interface AWSBedrockAgent
public TagResourceResult tagResource(TagResourceRequest request)
AWSBedrockAgent
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
tagResource
in interface AWSBedrockAgent
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSBedrockAgent
Remove tags from a resource.
untagResource
in interface AWSBedrockAgent
public UpdateAgentResult updateAgent(UpdateAgentRequest request)
AWSBedrockAgent
Updates the configuration of an agent.
updateAgent
in interface AWSBedrockAgent
public UpdateAgentActionGroupResult updateAgentActionGroup(UpdateAgentActionGroupRequest request)
AWSBedrockAgent
Updates the configuration for an action group for an agent.
updateAgentActionGroup
in interface AWSBedrockAgent
public UpdateAgentAliasResult updateAgentAlias(UpdateAgentAliasRequest request)
AWSBedrockAgent
Updates configurations for an alias of an agent.
updateAgentAlias
in interface AWSBedrockAgent
public UpdateAgentKnowledgeBaseResult updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)
AWSBedrockAgent
Updates the configuration for a knowledge base that has been associated with an agent.
updateAgentKnowledgeBase
in interface AWSBedrockAgent
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
AWSBedrockAgent
Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing
chunkingConfiguration
.
updateDataSource
in interface AWSBedrockAgent
public UpdateKnowledgeBaseResult updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
AWSBedrockAgent
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.
updateKnowledgeBase
in interface AWSBedrockAgent
public void shutdown()
AWSBedrockAgent
shutdown
in interface AWSBedrockAgent
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSBedrockAgent
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSBedrockAgent
request
- The originally executed request.