Skip to content

README.md

Latest commit

 

History

History
53 lines (35 loc) · 3.16 KB

README.md

File metadata and controls

53 lines (35 loc) · 3.16 KB

Amazon Bedrock Runtime Converse API with Tool for the SDK for JavaScript (v3)

Overview

This example shows how to use AWS SDKs and the Amazon Bedrock Converse API to call a custom tool from a large language model (LLM) as part of a multistep conversation. The example creates a weather tool that leverages the Open-Meteo API to retrieve current weather information based on user input.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.

Scenario

This example illustrates a typical interaction between a generative AI model, an application, and connected tools or APIs to solve a problem or achieve a specific goal. The scenario follows these steps:

  1. Set up the system prompt and tool configuration.
  2. Specify the AI model to be used (e.g., Anthropic Claude 3 Sonnet).
  3. Create a client to interact with Amazon Bedrock.
  4. Prompt the user for their weather request.
  5. Send the user input including the conversation history to the model.
  6. The model processes the input and determines if a connected tool or API needs to be used. If this is the case, the model returns a tool use request with specific parameters needed to invoke the tool, and a unique tool use ID to correlate tool responses to the request.
  7. The scenario application invokes the tool to fetch weather data, and append the response and tool use ID to the conversation.
  8. The model uses the tool response to generate a final response. If additional tool requests are needed, the process is repeated.
  9. Once the final response is received and printed, the application returns to the prompt.

Prerequisites

For prerequisites, see the README in the javascriptv3 folder.

Run the example

node converse-tool-scenario.js

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the javascriptv3 folder.

Additional resources

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0