Class: AWS.BedrockAgent
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.BedrockAgent
- Identifier:
- bedrockagent
- API Version:
- 2023-06-05
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Describes the API operations for creating and managing Amazon Bedrock agents.
Sending a Request Using BedrockAgent
var bedrockagent = new AWS.BedrockAgent();
bedrockagent.associateAgentKnowledgeBase(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the BedrockAgent object uses this specific API, you can
construct the object by passing the apiVersion option to the constructor:
var bedrockagent = new AWS.BedrockAgent({apiVersion: '2023-06-05'});
You can also set the API version globally in AWS.config.apiVersions using
the bedrockagent service identifier:
AWS.config.apiVersions = {
bedrockagent: '2023-06-05',
// other service API versions
};
var bedrockagent = new AWS.BedrockAgent();
Constructor Summary collapse
-
new AWS.BedrockAgent(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
associateAgentKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Associates a knowledge base with an agent.
-
createAgent(params = {}, callback) ⇒ AWS.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.
-
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.
-
-
-
createAgentActionGroup(params = {}, callback) ⇒ AWS.Request
Creates an action group for an agent.
-
createAgentAlias(params = {}, callback) ⇒ AWS.Request
Creates an alias of an agent that can be used to deploy the agent.
.
-
createDataSource(params = {}, callback) ⇒ AWS.Request
Creates a data source connector for a knowledge base.
.You can't change the
chunkingConfigurationafter you create the data source connector. -
createFlow(params = {}, callback) ⇒ AWS.Request
Creates a prompt flow that you can use to send an input through various steps to yield an output.
-
createFlowAlias(params = {}, callback) ⇒ AWS.Request
Creates an alias of a flow for deployment.
-
createFlowVersion(params = {}, callback) ⇒ AWS.Request
Creates a version of the flow that you can deploy.
-
createKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
-
createPrompt(params = {}, callback) ⇒ AWS.Request
Creates a prompt in your prompt library that you can add to a flow.
-
createPromptVersion(params = {}, callback) ⇒ AWS.Request
Creates a static snapshot of your prompt that can be deployed to production.
-
deleteAgent(params = {}, callback) ⇒ AWS.Request
Deletes an agent.
.
-
deleteAgentActionGroup(params = {}, callback) ⇒ AWS.Request
Deletes an action group in an agent.
.
-
deleteAgentAlias(params = {}, callback) ⇒ AWS.Request
Deletes an alias of an agent.
.
-
deleteAgentVersion(params = {}, callback) ⇒ AWS.Request
Deletes a version of an agent.
.
-
deleteDataSource(params = {}, callback) ⇒ AWS.Request
Deletes a data source from a knowledge base.
.
-
deleteFlow(params = {}, callback) ⇒ AWS.Request
Deletes a flow.
.
-
deleteFlowAlias(params = {}, callback) ⇒ AWS.Request
Deletes an alias of a flow.
.
-
deleteFlowVersion(params = {}, callback) ⇒ AWS.Request
Deletes a version of a flow.
.
-
deleteKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Deletes a knowledge base.
-
deletePrompt(params = {}, callback) ⇒ AWS.Request
Deletes a prompt or a version of it, depending on whether you include the
promptVersionfield or not. -
disassociateAgentKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Disassociates a knowledge base from an agent.
.
-
getAgent(params = {}, callback) ⇒ AWS.Request
Gets information about an agent.
.
-
getAgentActionGroup(params = {}, callback) ⇒ AWS.Request
Gets information about an action group for an agent.
.
-
getAgentAlias(params = {}, callback) ⇒ AWS.Request
Gets information about an alias of an agent.
.
-
getAgentKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Gets information about a knowledge base associated with an agent.
.
-
getAgentVersion(params = {}, callback) ⇒ AWS.Request
Gets details about a version of an agent.
.
-
getDataSource(params = {}, callback) ⇒ AWS.Request
Gets information about a data source.
.
-
getFlow(params = {}, callback) ⇒ AWS.Request
Retrieves information about a flow.
-
getFlowAlias(params = {}, callback) ⇒ AWS.Request
Retrieves information about a flow.
-
getFlowVersion(params = {}, callback) ⇒ AWS.Request
Retrieves information about a version of a flow.
-
getIngestionJob(params = {}, callback) ⇒ AWS.Request
Gets information about a ingestion job, in which a data source is added to a knowledge base.
.
-
getKnowledgeBase(params = {}, callback) ⇒ AWS.Request
Gets information about a knoweldge base.
.