[AWS SDK for JavaScript V3 API リファレンスガイド](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/)では、 AWS SDK for JavaScript バージョン3 (V3) のすべての API オペレーションについて詳しく説明します。
翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# SDK for JavaScript (v3) を使用した Amazon Bedrock エージェントの例
次のコード例は、Amazon Bedrock エージェントで AWS SDK for JavaScript (v3) を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。
*アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。
各例には完全なソースコードへのリンクが含まれており、コンテキスト内でコードを設定および実行する方法の手順を確認できます。
**Topics**
+ [はじめに](#get_started)
+ [アクション](#actions)
## はじめに
### Amazon Bedrock エージェントの始め方
次のコード例は、Amazon Bedrock エージェントの使用を開始する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/bedrock-agent#code-examples)での設定と実行の方法を確認してください。
```
import { fileURLToPath } from "node:url";
import {
BedrockAgentClient,
GetAgentCommand,
paginateListAgents,
} from "@aws-sdk/client-bedrock-agent";
/**
* @typedef {Object} AgentSummary
*/
/**
* A simple scenario to demonstrate basic setup and interaction with the Bedrock Agents Client.
*
* This function first initializes the Amazon Bedrock Agents client for a specific region.
* It then retrieves a list of existing agents using the streamlined paginator approach.
* For each agent found, it retrieves detailed information using a command object.
*
* Demonstrates:
* - Use of the Bedrock Agents client to initialize and communicate with the AWS service.
* - Listing resources in a paginated response pattern.
* - Accessing an individual resource using a command object.
*
* @returns {Promise} A promise that resolves when the function has completed execution.
*/
export const main = async () => {
const region = "us-east-1";
console.log("=".repeat(68));
console.log(`Initializing Amazon Bedrock Agents client for ${region}...`);
const client = new BedrockAgentClient({ region });
console.log("Retrieving the list of existing agents...");
const paginatorConfig = { client };
const pages = paginateListAgents(paginatorConfig, {});
/** @type {AgentSummary[]} */
const agentSummaries = [];
for await (const page of pages) {
agentSummaries.push(...page.agentSummaries);
}
console.log(`Found ${agentSummaries.length} agents in ${region}.`);
if (agentSummaries.length > 0) {
for (const agentSummary of agentSummaries) {
const agentId = agentSummary.agentId;
console.log("=".repeat(68));
console.log(`Retrieving agent with ID: ${agentId}:`);
console.log("-".repeat(68));
const command = new GetAgentCommand({ agentId });
const response = await client.send(command);
const agent = response.agent;
console.log(` Name: ${agent.agentName}`);
console.log(` Status: ${agent.agentStatus}`);
console.log(` ARN: ${agent.agentArn}`);
console.log(` Foundation model: ${agent.foundationModel}`);
}
}
console.log("=".repeat(68));
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
await main();
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の以下のトピックを参照してください。
+ [GetAgent](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/GetAgentCommand)
+ [ListAgents](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/ListAgentsCommand)
## アクション
### `CreateAgent`
次のコード例は、`CreateAgent` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/bedrock-agent#code-examples)での設定と実行の方法を確認してください。
エージェントを作成します。
```
import { fileURLToPath } from "node:url";
import { checkForPlaceholders } from "../lib/utils.js";
import {
BedrockAgentClient,
CreateAgentCommand,
} from "@aws-sdk/client-bedrock-agent";
/**
* Creates an Amazon Bedrock Agent.
*
* @param {string} agentName - A name for the agent that you create.
* @param {string} foundationModel - The foundation model to be used by the agent you create.
* @param {string} agentResourceRoleArn - The ARN of the IAM role with permissions required by the agent.
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An object containing details of the created agent.
*/
export const createAgent = async (
agentName,
foundationModel,
agentResourceRoleArn,
region = "us-east-1",
) => {
const client = new BedrockAgentClient({ region });
const command = new CreateAgentCommand({
agentName,
foundationModel,
agentResourceRoleArn,
});
const response = await client.send(command);
return response.agent;
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
// Replace the placeholders for agentName and accountId, and roleName with a unique name for the new agent,
// the id of your AWS account, and the name of an existing execution role that the agent can use inside your account.
// For foundationModel, specify the desired model. Ensure to remove the brackets '[]' before adding your data.
// A string (max 100 chars) that can include letters, numbers, dashes '-', and underscores '_'.
const agentName = "[your-bedrock-agent-name]";
// Your AWS account id.
const accountId = "[123456789012]";
// The name of the agent's execution role. It must be prefixed by `AmazonBedrockExecutionRoleForAgents_`.
const roleName = "[AmazonBedrockExecutionRoleForAgents_your-role-name]";
// The ARN for the agent's execution role.
// Follow the ARN format: 'arn:aws:iam::account-id:role/role-name'
const roleArn = `arn:aws:iam::${accountId}:role/${roleName}`;
// Specify the model for the agent. Change if a different model is preferred.
const foundationModel = "anthropic.claude-v2";
// Check for unresolved placeholders in agentName and roleArn.
checkForPlaceholders([agentName, roleArn]);
console.log("Creating a new agent...");
const agent = await createAgent(agentName, foundationModel, roleArn);
console.log(agent);
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[CreateAgent](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/CreateAgentCommand)」を参照してください。
### `DeleteAgent`
次のコード例は、`DeleteAgent` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/bedrock-agent#code-examples)での設定と実行の方法を確認してください。
エージェントを削除します。
```
import { fileURLToPath } from "node:url";
import { checkForPlaceholders } from "../lib/utils.js";
import {
BedrockAgentClient,
DeleteAgentCommand,
} from "@aws-sdk/client-bedrock-agent";
/**
* Deletes an Amazon Bedrock Agent.
*
* @param {string} agentId - The unique identifier of the agent to delete.
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An object containing the agent id, the status, and some additional metadata.
*/
export const deleteAgent = (agentId, region = "us-east-1") => {
const client = new BedrockAgentClient({ region });
const command = new DeleteAgentCommand({ agentId });
return client.send(command);
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
// Replace the placeholders for agentId with an existing agent's id.
// Ensure to remove the brackets (`[]`) before adding your data.
// The agentId must be an alphanumeric string with exactly 10 characters.
const agentId = "[ABC123DE45]";
// Check for unresolved placeholders in agentId.
checkForPlaceholders([agentId]);
console.log(`Deleting agent with ID ${agentId}...`);
const response = await deleteAgent(agentId);
console.log(response);
}
```
+ API の詳細については、「[AWS SDK for JavaScript API リファレンス](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/DeleteAgentCommand)」の「*DeleteAgent*」を参照してください。
### `GetAgent`
次のコード例は、`GetAgent` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/bedrock-agent#code-examples)での設定と実行の方法を確認してください。
エージェントを取得します。
```
import { fileURLToPath } from "node:url";
import { checkForPlaceholders } from "../lib/utils.js";
import {
BedrockAgentClient,
GetAgentCommand,
} from "@aws-sdk/client-bedrock-agent";
/**
* Retrieves the details of an Amazon Bedrock Agent.
*
* @param {string} agentId - The unique identifier of the agent.
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An object containing the agent details.
*/
export const getAgent = async (agentId, region = "us-east-1") => {
const client = new BedrockAgentClient({ region });
const command = new GetAgentCommand({ agentId });
const response = await client.send(command);
return response.agent;
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
// Replace the placeholders for agentId with an existing agent's id.
// Ensure to remove the brackets '[]' before adding your data.
// The agentId must be an alphanumeric string with exactly 10 characters.
const agentId = "[ABC123DE45]";
// Check for unresolved placeholders in agentId.
checkForPlaceholders([agentId]);
console.log(`Retrieving agent with ID ${agentId}...`);
const agent = await getAgent(agentId);
console.log(agent);
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[GetAgent](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/GetAgentCommand)」を参照してください。
### `ListAgentActionGroups`
次のコード例は、`ListAgentActionGroups` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/bedrock-agent#code-examples)での設定と実行の方法を確認してください。
エージェントのアクショングループを一覧表示します。
```
import { fileURLToPath } from "node:url";
import { checkForPlaceholders } from "../lib/utils.js";
import {
BedrockAgentClient,
ListAgentActionGroupsCommand,
paginateListAgentActionGroups,
} from "@aws-sdk/client-bedrock-agent";
/**
* Retrieves a list of Action Groups of an agent utilizing the paginator function.
*
* This function leverages a paginator, which abstracts the complexity of pagination, providing
* a straightforward way to handle paginated results inside a `for await...of` loop.
*
* @param {string} agentId - The unique identifier of the agent.
* @param {string} agentVersion - The version of the agent.
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An array of action group summaries.
*/
export const listAgentActionGroupsWithPaginator = async (
agentId,
agentVersion,
region = "us-east-1",
) => {
const client = new BedrockAgentClient({ region });
// Create a paginator configuration
const paginatorConfig = {
client,
pageSize: 10, // optional, added for demonstration purposes
};
const params = { agentId, agentVersion };
const pages = paginateListAgentActionGroups(paginatorConfig, params);
// Paginate until there are no more results
const actionGroupSummaries = [];
for await (const page of pages) {
actionGroupSummaries.push(...page.actionGroupSummaries);
}
return actionGroupSummaries;
};
/**
* Retrieves a list of Action Groups of an agent utilizing the ListAgentActionGroupsCommand.
*
* This function demonstrates the manual approach, sending a command to the client and processing the response.
* Pagination must manually be managed. For a simplified approach that abstracts away pagination logic, see
* the `listAgentActionGroupsWithPaginator()` example below.
*
* @param {string} agentId - The unique identifier of the agent.
* @param {string} agentVersion - The version of the agent.
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An array of action group summaries.
*/
export const listAgentActionGroupsWithCommandObject = async (
agentId,
agentVersion,
region = "us-east-1",
) => {
const client = new BedrockAgentClient({ region });
let nextToken;
const actionGroupSummaries = [];
do {
const command = new ListAgentActionGroupsCommand({
agentId,
agentVersion,
nextToken,
maxResults: 10, // optional, added for demonstration purposes
});
/** @type {{actionGroupSummaries: ActionGroupSummary[], nextToken?: string}} */
const response = await client.send(command);
for (const actionGroup of response.actionGroupSummaries || []) {
actionGroupSummaries.push(actionGroup);
}
nextToken = response.nextToken;
} while (nextToken);
return actionGroupSummaries;
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
// Replace the placeholders for agentId and agentVersion with an existing agent's id and version.
// Ensure to remove the brackets '[]' before adding your data.
// The agentId must be an alphanumeric string with exactly 10 characters.
const agentId = "[ABC123DE45]";
// A string either containing `DRAFT` or a number with 1-5 digits (e.g., '123' or 'DRAFT').
const agentVersion = "[DRAFT]";
// Check for unresolved placeholders in agentId and agentVersion.
checkForPlaceholders([agentId, agentVersion]);
console.log("=".repeat(68));
console.log(
"Listing agent action groups using ListAgentActionGroupsCommand:",
);
for (const actionGroup of await listAgentActionGroupsWithCommandObject(
agentId,
agentVersion,
)) {
console.log(actionGroup);
}
console.log("=".repeat(68));
console.log(
"Listing agent action groups using the paginateListAgents function:",
);
for (const actionGroup of await listAgentActionGroupsWithPaginator(
agentId,
agentVersion,
)) {
console.log(actionGroup);
}
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[ListAgentActionGroups](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/ListAgentActionGroupsCommand)」を参照してください。
### `ListAgents`
次のコード例は、`ListAgents` を使用する方法を示しています。
**SDK for JavaScript (v3)**
GitHub には、その他のリソースもあります。用例一覧を検索し、[AWS コード例リポジトリ](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javascriptv3/example_code/bedrock-agent#code-examples)での設定と実行の方法を確認してください。
アカウントに属するエージェントを一覧表示します。
```
import { fileURLToPath } from "node:url";
import {
BedrockAgentClient,
ListAgentsCommand,
paginateListAgents,
} from "@aws-sdk/client-bedrock-agent";
/**
* Retrieves a list of available Amazon Bedrock agents utilizing the paginator function.
*
* This function leverages a paginator, which abstracts the complexity of pagination, providing
* a straightforward way to handle paginated results inside a `for await...of` loop.
*
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An array of agent summaries.
*/
export const listAgentsWithPaginator = async (region = "us-east-1") => {
const client = new BedrockAgentClient({ region });
const paginatorConfig = {
client,
pageSize: 10, // optional, added for demonstration purposes
};
const pages = paginateListAgents(paginatorConfig, {});
// Paginate until there are no more results
const agentSummaries = [];
for await (const page of pages) {
agentSummaries.push(...page.agentSummaries);
}
return agentSummaries;
};
/**
* Retrieves a list of available Amazon Bedrock agents utilizing the ListAgentsCommand.
*
* This function demonstrates the manual approach, sending a command to the client and processing the response.
* Pagination must manually be managed. For a simplified approach that abstracts away pagination logic, see
* the `listAgentsWithPaginator()` example below.
*
* @param {string} [region='us-east-1'] - The AWS region in use.
* @returns {Promise} An array of agent summaries.
*/
export const listAgentsWithCommandObject = async (region = "us-east-1") => {
const client = new BedrockAgentClient({ region });
let nextToken;
const agentSummaries = [];
do {
const command = new ListAgentsCommand({
nextToken,
maxResults: 10, // optional, added for demonstration purposes
});
/** @type {{agentSummaries: AgentSummary[], nextToken?: string}} */
const paginatedResponse = await client.send(command);
agentSummaries.push(...(paginatedResponse.agentSummaries || []));
nextToken = paginatedResponse.nextToken;
} while (nextToken);
return agentSummaries;
};
// Invoke main function if this file was run directly.
if (process.argv[1] === fileURLToPath(import.meta.url)) {
console.log("=".repeat(68));
console.log("Listing agents using ListAgentsCommand:");
for (const agent of await listAgentsWithCommandObject()) {
console.log(agent);
}
console.log("=".repeat(68));
console.log("Listing agents using the paginateListAgents function:");
for (const agent of await listAgentsWithPaginator()) {
console.log(agent);
}
}
```
+ API の詳細については、「*AWS SDK for JavaScript API リファレンス*」の「[ListAgents](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/bedrock-agent/command/ListAgentsCommand)」を参照してください。