@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBedrockAgentAsync extends AWSBedrockAgent
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBedrockAgentAsync
instead.
Describes the API operations for creating and managing Amazon Bedrock agents.
ENDPOINT_PREFIX
associateAgentKnowledgeBase, createAgent, createAgentActionGroup, createAgentAlias, createDataSource, createKnowledgeBase, deleteAgent, deleteAgentActionGroup, deleteAgentAlias, deleteAgentVersion, deleteDataSource, deleteKnowledgeBase, disassociateAgentKnowledgeBase, getAgent, getAgentActionGroup, getAgentAlias, getAgentKnowledgeBase, getAgentVersion, getCachedResponseMetadata, getDataSource, getIngestionJob, getKnowledgeBase, listAgentActionGroups, listAgentAliases, listAgentKnowledgeBases, listAgents, listAgentVersions, listDataSources, listIngestionJobs, listKnowledgeBases, listTagsForResource, prepareAgent, shutdown, startIngestionJob, tagResource, untagResource, updateAgent, updateAgentActionGroup, updateAgentAlias, updateAgentKnowledgeBase, updateDataSource, updateKnowledgeBase
Future<AssociateAgentKnowledgeBaseResult> associateAgentKnowledgeBaseAsync(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)
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.
associateAgentKnowledgeBaseRequest
- Future<AssociateAgentKnowledgeBaseResult> associateAgentKnowledgeBaseAsync(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest, AsyncHandler<AssociateAgentKnowledgeBaseRequest,AssociateAgentKnowledgeBaseResult> asyncHandler)
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.
associateAgentKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAgentResult> createAgentAsync(CreateAgentRequest createAgentRequest)
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.
createAgentRequest
- Future<CreateAgentResult> createAgentAsync(CreateAgentRequest createAgentRequest, AsyncHandler<CreateAgentRequest,CreateAgentResult> asyncHandler)
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.
createAgentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAgentActionGroupResult> createAgentActionGroupAsync(CreateAgentActionGroupRequest createAgentActionGroupRequest)
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.
createAgentActionGroupRequest
- Future<CreateAgentActionGroupResult> createAgentActionGroupAsync(CreateAgentActionGroupRequest createAgentActionGroupRequest, AsyncHandler<CreateAgentActionGroupRequest,CreateAgentActionGroupResult> asyncHandler)
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.
createAgentActionGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateAgentAliasResult> createAgentAliasAsync(CreateAgentAliasRequest createAgentAliasRequest)
Creates an alias of an agent that can be used to deploy the agent.
createAgentAliasRequest
- Future<CreateAgentAliasResult> createAgentAliasAsync(CreateAgentAliasRequest createAgentAliasRequest, AsyncHandler<CreateAgentAliasRequest,CreateAgentAliasResult> asyncHandler)
Creates an alias of an agent that can be used to deploy the agent.
createAgentAliasRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest)
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
createDataSourceRequest
- Future<CreateDataSourceResult> createDataSourceAsync(CreateDataSourceRequest createDataSourceRequest, AsyncHandler<CreateDataSourceRequest,CreateDataSourceResult> asyncHandler)
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
createDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<CreateKnowledgeBaseResult> createKnowledgeBaseAsync(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)
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.
createKnowledgeBaseRequest
- Future<CreateKnowledgeBaseResult> createKnowledgeBaseAsync(CreateKnowledgeBaseRequest createKnowledgeBaseRequest, AsyncHandler<CreateKnowledgeBaseRequest,CreateKnowledgeBaseResult> asyncHandler)
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.
createKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
deleteAgentRequest
- Future<DeleteAgentResult> deleteAgentAsync(DeleteAgentRequest deleteAgentRequest, AsyncHandler<DeleteAgentRequest,DeleteAgentResult> asyncHandler)
Deletes an agent.
deleteAgentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAgentActionGroupResult> deleteAgentActionGroupAsync(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest)
Deletes an action group in an agent.
deleteAgentActionGroupRequest
- Future<DeleteAgentActionGroupResult> deleteAgentActionGroupAsync(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest, AsyncHandler<DeleteAgentActionGroupRequest,DeleteAgentActionGroupResult> asyncHandler)
Deletes an action group in an agent.
deleteAgentActionGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAgentAliasResult> deleteAgentAliasAsync(DeleteAgentAliasRequest deleteAgentAliasRequest)
Deletes an alias of an agent.
deleteAgentAliasRequest
- Future<DeleteAgentAliasResult> deleteAgentAliasAsync(DeleteAgentAliasRequest deleteAgentAliasRequest, AsyncHandler<DeleteAgentAliasRequest,DeleteAgentAliasResult> asyncHandler)
Deletes an alias of an agent.
deleteAgentAliasRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteAgentVersionResult> deleteAgentVersionAsync(DeleteAgentVersionRequest deleteAgentVersionRequest)
Deletes a version of an agent.
deleteAgentVersionRequest
- Future<DeleteAgentVersionResult> deleteAgentVersionAsync(DeleteAgentVersionRequest deleteAgentVersionRequest, AsyncHandler<DeleteAgentVersionRequest,DeleteAgentVersionResult> asyncHandler)
Deletes a version of an agent.
deleteAgentVersionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes a data source from a knowledge base.
deleteDataSourceRequest
- Future<DeleteDataSourceResult> deleteDataSourceAsync(DeleteDataSourceRequest deleteDataSourceRequest, AsyncHandler<DeleteDataSourceRequest,DeleteDataSourceResult> asyncHandler)
Deletes a data source from a knowledge base.
deleteDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DeleteKnowledgeBaseResult> deleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)
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.
deleteKnowledgeBaseRequest
- Future<DeleteKnowledgeBaseResult> deleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest, AsyncHandler<DeleteKnowledgeBaseRequest,DeleteKnowledgeBaseResult> asyncHandler)
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.
deleteKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<DisassociateAgentKnowledgeBaseResult> disassociateAgentKnowledgeBaseAsync(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest)
Disassociates a knowledge base from an agent.
disassociateAgentKnowledgeBaseRequest
- Future<DisassociateAgentKnowledgeBaseResult> disassociateAgentKnowledgeBaseAsync(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest, AsyncHandler<DisassociateAgentKnowledgeBaseRequest,DisassociateAgentKnowledgeBaseResult> asyncHandler)
Disassociates a knowledge base from an agent.
disassociateAgentKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAgentResult> getAgentAsync(GetAgentRequest getAgentRequest)
Gets information about an agent.
getAgentRequest
- Future<GetAgentResult> getAgentAsync(GetAgentRequest getAgentRequest, AsyncHandler<GetAgentRequest,GetAgentResult> asyncHandler)
Gets information about an agent.
getAgentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAgentActionGroupResult> getAgentActionGroupAsync(GetAgentActionGroupRequest getAgentActionGroupRequest)
Gets information about an action group for an agent.
getAgentActionGroupRequest
- Future<GetAgentActionGroupResult> getAgentActionGroupAsync(GetAgentActionGroupRequest getAgentActionGroupRequest, AsyncHandler<GetAgentActionGroupRequest,GetAgentActionGroupResult> asyncHandler)
Gets information about an action group for an agent.
getAgentActionGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAgentAliasResult> getAgentAliasAsync(GetAgentAliasRequest getAgentAliasRequest)
Gets information about an alias of an agent.
getAgentAliasRequest
- Future<GetAgentAliasResult> getAgentAliasAsync(GetAgentAliasRequest getAgentAliasRequest, AsyncHandler<GetAgentAliasRequest,GetAgentAliasResult> asyncHandler)
Gets information about an alias of an agent.
getAgentAliasRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAgentKnowledgeBaseResult> getAgentKnowledgeBaseAsync(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest)
Gets information about a knowledge base associated with an agent.
getAgentKnowledgeBaseRequest
- Future<GetAgentKnowledgeBaseResult> getAgentKnowledgeBaseAsync(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest, AsyncHandler<GetAgentKnowledgeBaseRequest,GetAgentKnowledgeBaseResult> asyncHandler)
Gets information about a knowledge base associated with an agent.
getAgentKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetAgentVersionResult> getAgentVersionAsync(GetAgentVersionRequest getAgentVersionRequest)
Gets details about a version of an agent.
getAgentVersionRequest
- Future<GetAgentVersionResult> getAgentVersionAsync(GetAgentVersionRequest getAgentVersionRequest, AsyncHandler<GetAgentVersionRequest,GetAgentVersionResult> asyncHandler)
Gets details about a version of an agent.
getAgentVersionRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest getDataSourceRequest)
Gets information about a data source.
getDataSourceRequest
- Future<GetDataSourceResult> getDataSourceAsync(GetDataSourceRequest getDataSourceRequest, AsyncHandler<GetDataSourceRequest,GetDataSourceResult> asyncHandler)
Gets information about a data source.
getDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetIngestionJobResult> getIngestionJobAsync(GetIngestionJobRequest getIngestionJobRequest)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
getIngestionJobRequest
- Future<GetIngestionJobResult> getIngestionJobAsync(GetIngestionJobRequest getIngestionJobRequest, AsyncHandler<GetIngestionJobRequest,GetIngestionJobResult> asyncHandler)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
getIngestionJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<GetKnowledgeBaseResult> getKnowledgeBaseAsync(GetKnowledgeBaseRequest getKnowledgeBaseRequest)
Gets information about a knoweldge base.
getKnowledgeBaseRequest
- Future<GetKnowledgeBaseResult> getKnowledgeBaseAsync(GetKnowledgeBaseRequest getKnowledgeBaseRequest, AsyncHandler<GetKnowledgeBaseRequest,GetKnowledgeBaseResult> asyncHandler)
Gets information about a knoweldge base.
getKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAgentActionGroupsResult> listAgentActionGroupsAsync(ListAgentActionGroupsRequest listAgentActionGroupsRequest)
Lists the action groups for an agent and information about each one.
listAgentActionGroupsRequest
- Future<ListAgentActionGroupsResult> listAgentActionGroupsAsync(ListAgentActionGroupsRequest listAgentActionGroupsRequest, AsyncHandler<ListAgentActionGroupsRequest,ListAgentActionGroupsResult> asyncHandler)
Lists the action groups for an agent and information about each one.
listAgentActionGroupsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAgentAliasesResult> listAgentAliasesAsync(ListAgentAliasesRequest listAgentAliasesRequest)
Lists the aliases of an agent and information about each one.
listAgentAliasesRequest
- Future<ListAgentAliasesResult> listAgentAliasesAsync(ListAgentAliasesRequest listAgentAliasesRequest, AsyncHandler<ListAgentAliasesRequest,ListAgentAliasesResult> asyncHandler)
Lists the aliases of an agent and information about each one.
listAgentAliasesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAgentKnowledgeBasesResult> listAgentKnowledgeBasesAsync(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)
Lists knowledge bases associated with an agent and information about each one.
listAgentKnowledgeBasesRequest
- Future<ListAgentKnowledgeBasesResult> listAgentKnowledgeBasesAsync(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest, AsyncHandler<ListAgentKnowledgeBasesRequest,ListAgentKnowledgeBasesResult> asyncHandler)
Lists knowledge bases associated with an agent and information about each one.
listAgentKnowledgeBasesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAgentVersionsResult> listAgentVersionsAsync(ListAgentVersionsRequest listAgentVersionsRequest)
Lists the versions of an agent and information about each version.
listAgentVersionsRequest
- Future<ListAgentVersionsResult> listAgentVersionsAsync(ListAgentVersionsRequest listAgentVersionsRequest, AsyncHandler<ListAgentVersionsRequest,ListAgentVersionsResult> asyncHandler)
Lists the versions of an agent and information about each version.
listAgentVersionsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest listAgentsRequest)
Lists the agents belonging to an account and information about each agent.
listAgentsRequest
- Future<ListAgentsResult> listAgentsAsync(ListAgentsRequest listAgentsRequest, AsyncHandler<ListAgentsRequest,ListAgentsResult> asyncHandler)
Lists the agents belonging to an account and information about each agent.
listAgentsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources in a knowledge base and information about each one.
listDataSourcesRequest
- Future<ListDataSourcesResult> listDataSourcesAsync(ListDataSourcesRequest listDataSourcesRequest, AsyncHandler<ListDataSourcesRequest,ListDataSourcesResult> asyncHandler)
Lists the data sources in a knowledge base and information about each one.
listDataSourcesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListIngestionJobsResult> listIngestionJobsAsync(ListIngestionJobsRequest listIngestionJobsRequest)
Lists the ingestion jobs for a data source and information about each of them.
listIngestionJobsRequest
- Future<ListIngestionJobsResult> listIngestionJobsAsync(ListIngestionJobsRequest listIngestionJobsRequest, AsyncHandler<ListIngestionJobsRequest,ListIngestionJobsResult> asyncHandler)
Lists the ingestion jobs for a data source and information about each of them.
listIngestionJobsRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListKnowledgeBasesResult> listKnowledgeBasesAsync(ListKnowledgeBasesRequest listKnowledgeBasesRequest)
Lists the knowledge bases in an account and information about each of them.
listKnowledgeBasesRequest
- Future<ListKnowledgeBasesResult> listKnowledgeBasesAsync(ListKnowledgeBasesRequest listKnowledgeBasesRequest, AsyncHandler<ListKnowledgeBasesRequest,ListKnowledgeBasesResult> asyncHandler)
Lists the knowledge bases in an account and information about each of them.
listKnowledgeBasesRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
List all the tags for the resource you specify.
listTagsForResourceRequest
- Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
List all the tags for the resource you specify.
listTagsForResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<PrepareAgentResult> prepareAgentAsync(PrepareAgentRequest prepareAgentRequest)
Creates a DRAFT
version of the agent that can be used for internal testing.
prepareAgentRequest
- Future<PrepareAgentResult> prepareAgentAsync(PrepareAgentRequest prepareAgentRequest, AsyncHandler<PrepareAgentRequest,PrepareAgentResult> asyncHandler)
Creates a DRAFT
version of the agent that can be used for internal testing.
prepareAgentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<StartIngestionJobResult> startIngestionJobAsync(StartIngestionJobRequest startIngestionJobRequest)
Begins an ingestion job, in which a data source is added to a knowledge base.
startIngestionJobRequest
- Future<StartIngestionJobResult> startIngestionJobAsync(StartIngestionJobRequest startIngestionJobRequest, AsyncHandler<StartIngestionJobRequest,StartIngestionJobResult> asyncHandler)
Begins an ingestion job, in which a data source is added to a knowledge base.
startIngestionJobRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest)
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
tagResourceRequest
- Future<TagResourceResult> tagResourceAsync(TagResourceRequest tagResourceRequest, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
tagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest)
Remove tags from a resource.
untagResourceRequest
- Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest untagResourceRequest, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
Remove tags from a resource.
untagResourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest updateAgentRequest)
Updates the configuration of an agent.
updateAgentRequest
- Future<UpdateAgentResult> updateAgentAsync(UpdateAgentRequest updateAgentRequest, AsyncHandler<UpdateAgentRequest,UpdateAgentResult> asyncHandler)
Updates the configuration of an agent.
updateAgentRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAgentActionGroupResult> updateAgentActionGroupAsync(UpdateAgentActionGroupRequest updateAgentActionGroupRequest)
Updates the configuration for an action group for an agent.
updateAgentActionGroupRequest
- Future<UpdateAgentActionGroupResult> updateAgentActionGroupAsync(UpdateAgentActionGroupRequest updateAgentActionGroupRequest, AsyncHandler<UpdateAgentActionGroupRequest,UpdateAgentActionGroupResult> asyncHandler)
Updates the configuration for an action group for an agent.
updateAgentActionGroupRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAgentAliasResult> updateAgentAliasAsync(UpdateAgentAliasRequest updateAgentAliasRequest)
Updates configurations for an alias of an agent.
updateAgentAliasRequest
- Future<UpdateAgentAliasResult> updateAgentAliasAsync(UpdateAgentAliasRequest updateAgentAliasRequest, AsyncHandler<UpdateAgentAliasRequest,UpdateAgentAliasResult> asyncHandler)
Updates configurations for an alias of an agent.
updateAgentAliasRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateAgentKnowledgeBaseResult> updateAgentKnowledgeBaseAsync(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest)
Updates the configuration for a knowledge base that has been associated with an agent.
updateAgentKnowledgeBaseRequest
- Future<UpdateAgentKnowledgeBaseResult> updateAgentKnowledgeBaseAsync(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest, AsyncHandler<UpdateAgentKnowledgeBaseRequest,UpdateAgentKnowledgeBaseResult> asyncHandler)
Updates the configuration for a knowledge base that has been associated with an agent.
updateAgentKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest)
Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing
chunkingConfiguration
.
updateDataSourceRequest
- Future<UpdateDataSourceResult> updateDataSourceAsync(UpdateDataSourceRequest updateDataSourceRequest, AsyncHandler<UpdateDataSourceRequest,UpdateDataSourceResult> asyncHandler)
Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing
chunkingConfiguration
.
updateDataSourceRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Future<UpdateKnowledgeBaseResult> updateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest)
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.
updateKnowledgeBaseRequest
- Future<UpdateKnowledgeBaseResult> updateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest, AsyncHandler<UpdateKnowledgeBaseRequest,UpdateKnowledgeBaseResult> asyncHandler)
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.
updateKnowledgeBaseRequest
- asyncHandler
- Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.