Skip to content

Commit da69609

Browse files
DennisTraubrlhagerm
DennisTraub
and
rlhagerm
authored
JavaScript examples for Amazon Nova and Amazon Nova Canvas (#7253)
* Add JavaScript examples for Amazon Nova and Amazon Nova Canvas * Update dependencies --------- Co-authored-by: Rachel Hagerman <110480692+rlhagerm@users.noreply.github.com>
1 parent f36435d commit da69609

12 files changed

Lines changed: 363 additions & 24 deletions

File tree

‎.doc_gen/metadata/bedrock-runtime_metadata.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,14 @@ bedrock-runtime_Converse_AmazonNovaText:
100100
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
101101
snippet_tags:
102102
- bedrock-runtime.java2.Converse_AmazonNovaText
103+
JavaScript:
104+
versions:
105+
- sdk_version: 3
106+
github: javascriptv3/example_code/bedrock-runtime
107+
excerpts:
108+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
109+
snippet_tags:
110+
- javascript.v3.bedrock-runtime.Converse_AmazonTitanText
103111
.NET:
104112
versions:
105113
- sdk_version: 3
@@ -423,6 +431,14 @@ bedrock-runtime_ConverseStream_AmazonNovaText:
423431
- description: Send a text message to Amazon Nova using Bedrock's Converse API and process the response stream in real-time.
424432
snippet_tags:
425433
- bedrock-runtime.java2.ConverseStream_AmazonNovaText
434+
JavaScript:
435+
versions:
436+
- sdk_version: 3
437+
github: javascriptv3/example_code/bedrock-runtime
438+
excerpts:
439+
- description: Send a text message to Amazon Nova using Bedrock's Converse API and process the response stream in real-time.
440+
snippet_tags:
441+
- javascript.v3.bedrock-runtime.Converse_Mistral
426442
.NET:
427443
versions:
428444
- sdk_version: 3
@@ -1235,6 +1251,14 @@ bedrock-runtime_InvokeModel_AmazonNovaImageGeneration:
12351251
- description: Create an image with Amazon Nova Canvas.
12361252
snippet_tags:
12371253
- bedrock-runtime.java2.InvokeModel_AmazonNovaImageGeneration
1254+
JavaScript:
1255+
versions:
1256+
- sdk_version: 3
1257+
github: javascriptv3/example_code/bedrock-runtime
1258+
excerpts:
1259+
- description: Create an image with Amazon Nova Canvas.
1260+
snippet_tags:
1261+
- javascript.v3.bedrock-runtime.InvokeModel_AmazonNovaImageGeneration
12381262
.NET:
12391263
versions:
12401264
- sdk_version: 3

‎javascriptv3/example_code/bedrock-runtime/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
/tempx/
2+
/output/

‎javascriptv3/example_code/bedrock-runtime/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ functions within the same service.
5050
- [Converse](models/ai21LabsJurassic2/converse.js#L4)
5151
- [InvokeModel](models/ai21LabsJurassic2/invoke_model.js)
5252

53+
### Amazon Nova
54+
55+
- [Converse](models/amazonTitanText/converse.js#L4)
56+
- [ConverseStream](models/mistral/converse.js#L4)
57+
58+
### Amazon Nova Canvas
59+
60+
- [InvokeModel](models/amazonNovaCanvas/invokeModel.js#L4)
61+
5362
### Amazon Titan Text
5463

5564
- [Converse](models/amazonTitanText/converse.js#L4)

‎javascriptv3/example_code/bedrock-runtime/models/amazonNovaCanvas/invokeModel.js‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// snippet-start:[javascript.v3.bedrock-runtime.InvokeModel_AmazonNovaImageGeneration]
5+
6+
import {
7+
BedrockRuntimeClient,
8+
InvokeModelCommand,
9+
} from "@aws-sdk/client-bedrock-runtime";
10+
import { saveImage } from "../../utils/image-creation.js";
11+
import { fileURLToPath } from "node:url";
12+
13+
/**
14+
* This example demonstrates how to use Amazon Nova Canvas to generate images.
15+
* It shows how to:
16+
* - Set up the Amazon Bedrock runtime client
17+
* - Configure the image generation parameters
18+
* - Send a request to generate an image
19+
* - Process the response and handle the generated image
20+
*
21+
* @returns {Promise<string>} Base64-encoded image data
22+
*/
23+
export const invokeModel = async () => {
24+
// Step 1: Create the Amazon Bedrock runtime client
25+
// Credentials will be automatically loaded from the environment
26+
const client = new BedrockRuntimeClient({ region: "us-east-1" });
27+
28+
// Step 2: Specify which model to use
29+
// For the latest available models, see:
30+
// https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html
31+
const modelId = "amazon.nova-canvas-v1:0";
32+
33+
// Step 3: Configure the request payload
34+
// First, set the main parameters:
35+
// - prompt: Text description of the image to generate
36+
// - seed: Random number for reproducible generation (0 to 858,993,459)
37+
const prompt = "A stylized picture of a cute old steampunk robot";
38+
const seed = Math.floor(Math.random() * 858993460);
39+
40+
// Then, create the payload using the following structure:
41+
// - taskType: TEXT_IMAGE (specifies text-to-image generation)
42+
// - textToImageParams: Contains the text prompt
43+
// - imageGenerationConfig: Contains optional generation settings (seed, quality, etc.)
44+
// For a list of available request parameters, see:
45+
// https://docs.aws.amazon.com/nova/latest/userguide/image-gen-req-resp-structure.html
46+
const payload = {
47+
taskType: "TEXT_IMAGE",
48+
textToImageParams: {
49+
text: prompt,
50+
},
51+
imageGenerationConfig: {
52+
seed,
53+
quality: "standard",
54+
},
55+
};
56+
57+
// Step 4: Send and process the request
58+
// - Embed the payload in a request object
59+
// - Send the request to the model
60+
// - Extract and return the generated image data from the response
61+
try {
62+
const request = {
63+
modelId,
64+
body: JSON.stringify(payload),
65+
};
66+
const response = await client.send(new InvokeModelCommand(request));
67+
68+
const decodedResponseBody = new TextDecoder().decode(response.body);
69+
// The response includes an array of base64-encoded PNG images
70+
/** @type {{images: string[]}} */
71+
const responseBody = JSON.parse(decodedResponseBody);
72+
return responseBody.images[0]; // Base64-encoded image data
73+
} catch (error) {
74+
console.error(`ERROR: Can't invoke '${modelId}'. Reason: ${error.message}`);
75+
throw error;
76+
}
77+
};
78+
79+
// If run directly, execute the example and save the generated image
80+
if (process.argv[1] === fileURLToPath(import.meta.url)) {
81+
console.log("Generating image. This may take a few seconds...");
82+
invokeModel()
83+
.then(async (imageData) => {
84+
const imagePath = await saveImage(imageData, "nova-canvas");
85+
// Example path: javascriptv3/example_code/bedrock-runtime/output/nova-canvas/image-01.png
86+
console.log(`Image saved to: ${imagePath}`);
87+
})
88+
.catch((error) => {
89+
console.error("Execution failed:", error);
90+
process.exitCode = 1;
91+
});
92+
}
93+
// snippet-end:[javascript.v3.bedrock-runtime.InvokeModel_AmazonNovaImageGeneration]

‎javascriptv3/example_code/bedrock-runtime/models/amazonNovaText/converse.js‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// snippet-start:[javascript.v3.bedrock-runtime.Converse_AmazonNovaText]
5+
// This example demonstrates how to use the Amazon Nova foundation models to generate text.
6+
// It shows how to:
7+
// - Set up the Amazon Bedrock runtime client
8+
// - Create a message
9+
// - Configure and send a request
10+
// - Process the response
11+
12+
import {
13+
BedrockRuntimeClient,
14+
ConversationRole,
15+
ConverseCommand,
16+
} from "@aws-sdk/client-bedrock-runtime";
17+
18+
// Step 1: Create the Amazon Bedrock runtime client
19+
// Credentials will be automatically loaded from the environment
20+
const client = new BedrockRuntimeClient({ region: "us-east-1" });
21+
22+
// Step 2: Specify which model to use:
23+
// Available Amazon Nova models and their characteristics:
24+
// - Amazon Nova Micro: Text-only model optimized for lowest latency and cost
25+
// - Amazon Nova Lite: Fast, low-cost multimodal model for image, video, and text
26+
// - Amazon Nova Pro: Advanced multimodal model balancing accuracy, speed, and cost
27+
//
28+
// For the most current model IDs, see:
29+
// https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html
30+
const modelId = "amazon.nova-lite-v1:0";
31+
32+
// Step 3: Create the message
33+
// The message includes the text prompt and specifies that it comes from the user
34+
const inputText =
35+
"Describe the purpose of a 'hello world' program in one line.";
36+
const message = {
37+
content: [{ text: inputText }],
38+
role: ConversationRole.USER,
39+
};
40+
41+
// Step 4: Configure the request
42+
// Optional parameters to control the model's response:
43+
// - maxTokens: maximum number of tokens to generate
44+
// - temperature: randomness (max: 1.0, default: 0.7)
45+
// OR
46+
// - topP: diversity of word choice (max: 1.0, default: 0.9)
47+
// Note: Use either temperature OR topP, but not both
48+
const request = {
49+
modelId,
50+
messages: [message],
51+
inferenceConfig: {
52+
maxTokens: 500, // The maximum response length
53+
temperature: 0.5, // Using temperature for randomness control
54+
//topP: 0.9, // Alternative: use topP instead of temperature
55+
},
56+
};
57+
58+
// Step 5: Send and process the request
59+
// - Send the request to the model
60+
// - Extract and return the generated text from the response
61+
try {
62+
const response = await client.send(new ConverseCommand(request));
63+
console.log(response.output.message.content[0].text);
64+
} catch (error) {
65+
console.error(`ERROR: Can't invoke '${modelId}'. Reason: ${error.message}`);
66+
throw error;
67+
}
68+
// snippet-end:[javascript.v3.bedrock-runtime.Converse_AmazonNovaText]

‎javascriptv3/example_code/bedrock-runtime/models/amazonNovaText/converseStream.js‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// snippet-start:[javascript.v3.bedrock-runtime.ConverseStream_AmazonNovaText]
5+
// This example demonstrates how to use the Amazon Nova foundation models
6+
// to generate streaming text responses.
7+
// It shows how to:
8+
// - Set up the Amazon Bedrock runtime client
9+
// - Create a message
10+
// - Configure a streaming request
11+
// - Process the streaming response
12+
13+
import {
14+
BedrockRuntimeClient,
15+
ConversationRole,
16+
ConverseStreamCommand,
17+
} from "@aws-sdk/client-bedrock-runtime";
18+
19+
// Step 1: Create the Amazon Bedrock runtime client
20+
// Credentials will be automatically loaded from the environment
21+
const client = new BedrockRuntimeClient({ region: "us-east-1" });
22+
23+
// Step 2: Specify which model to use
24+
// Available Amazon Nova models and their characteristics:
25+
// - Amazon Nova Micro: Text-only model optimized for lowest latency and cost
26+
// - Amazon Nova Lite: Fast, low-cost multimodal model for image, video, and text
27+
// - Amazon Nova Pro: Advanced multimodal model balancing accuracy, speed, and cost
28+
//
29+
// For the most current model IDs, see:
30+
// https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html
31+
const modelId = "amazon.nova-lite-v1:0";
32+
33+
// Step 3: Create the message
34+
// The message includes the text prompt and specifies that it comes from the user
35+
const inputText =
36+
"Describe the purpose of a 'hello world' program in one paragraph";
37+
const message = {
38+
content: [{ text: inputText }],
39+
role: ConversationRole.USER,
40+
};
41+
42+
// Step 4: Configure the streaming request
43+
// Optional parameters to control the model's response:
44+
// - maxTokens: maximum number of tokens to generate
45+
// - temperature: randomness (max: 1.0, default: 0.7)
46+
// OR
47+
// - topP: diversity of word choice (max: 1.0, default: 0.9)
48+
// Note: Use either temperature OR topP, but not both
49+
const request = {
50+
modelId,
51+
messages: [message],
52+
inferenceConfig: {
53+
maxTokens: 500, // The maximum response length
54+
temperature: 0.5, // Using temperature for randomness control
55+
//topP: 0.9, // Alternative: use topP instead of temperature
56+
},
57+
};
58+
59+
// Step 5: Send and process the streaming request
60+
// - Send the request to the model
61+
// - Process each chunk of the streaming response
62+
try {
63+
const response = await client.send(new ConverseStreamCommand(request));
64+
65+
for await (const chunk of response.stream) {
66+
if (chunk.contentBlockDelta) {
67+
// Print each text chunk as it arrives
68+
process.stdout.write(chunk.contentBlockDelta.delta?.text || "");
69+
}
70+
}
71+
} catch (error) {
72+
console.error(`ERROR: Can't invoke '${modelId}'. Reason: ${error.message}`);
73+
process.exitCode = 1;
74+
}
75+
// snippet-end:[javascript.v3.bedrock-runtime.ConverseStream_AmazonNovaText]

‎javascriptv3/example_code/bedrock-runtime/package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
"integration-test": "vitest run integration --reporter=junit --outputFile=test_results/bedrock-runtime-test-results.junit.xml"
99
},
1010
"devDependencies": {
11-
"vitest": "^1.6.0"
11+
"vitest": "^1.6.1"
1212
},
1313
"dependencies": {
14-
"@aws-sdk/client-bedrock-runtime": "^3.658.1"
14+
"@aws-sdk/client-bedrock-runtime": "^3.751.0"
1515
}
1616
}

‎javascriptv3/example_code/bedrock-runtime/tests/converse.integration.test.js‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,19 @@ describe("Converse with text generation models", () => {
88
const baseDirectory = path.join(__dirname, "..", "models");
99
const fileName = "converse.js";
1010

11-
const subdirectories = [
12-
"ai21LabsJurassic2",
13-
"amazonTitanText",
14-
"anthropicClaude",
15-
"cohereCommand",
16-
"metaLlama",
17-
"mistral",
18-
];
11+
const models = {
12+
ai21LabsJurassic2: "AI21 Labs Jurassic-2",
13+
amazonNovaText: "Amazon Nova",
14+
amazonTitanText: "Amazon Titan",
15+
anthropicClaude: "Anthropic Claude",
16+
cohereCommand: "Cohere Command",
17+
metaLlama: "Meta Llama",
18+
mistral: "Mistral",
19+
};
1920

20-
test.each(subdirectories)(
21-
"should invoke the model and return text",
22-
async (subdirectory) => {
21+
test.each(Object.entries(models).map(([sub, name]) => [name, sub]))(
22+
"should invoke %s and return text",
23+
async (_, subdirectory) => {
2324
const script = path.join(baseDirectory, subdirectory, fileName);
2425
const consoleLogSpy = vi.spyOn(console, "log");
2526

‎javascriptv3/example_code/bedrock-runtime/tests/converse_stream.integration.test.js‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,18 @@ describe("ConverseStream with text generation models", () => {
99
const fileName = "converseStream.js";
1010
const baseDirectory = path.join(__dirname, "..", "models");
1111

12-
const subdirectories = [
13-
"amazonTitanText",
14-
"anthropicClaude",
15-
"cohereCommand",
16-
"metaLlama",
17-
"mistral",
18-
];
12+
const models = {
13+
amazonNovaText: "Amazon Nova",
14+
amazonTitanText: "Amazon Titan",
15+
anthropicClaude: "Anthropic Claude",
16+
cohereCommand: "Cohere Command",
17+
metaLlama: "Meta Llama",
18+
mistral: "Mistral",
19+
};
1920

20-
test.each(subdirectories)(
21-
"should invoke the model and return text",
22-
async (subdirectory) => {
21+
test.each(Object.entries(models).map(([sub, name]) => [name, sub]))(
22+
"should invoke %s and return text",
23+
async (_, subdirectory) => {
2324
let output = "";
2425
const outputStream = new Writable({
2526
write(/** @type string */ chunk, encoding, callback) {

‎javascriptv3/example_code/bedrock-runtime/tests/image_generation.integration.test.js‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
import { describe, it } from "vitest";
5+
import { invokeModel } from "../models/amazonNovaCanvas/invokeModel.js";
6+
import { expectToBeANonEmptyString } from "./test_tools.js";
7+
8+
describe("Invoking Amazon Nova Canvas", () => {
9+
it("should return a response", async () => {
10+
const response = await invokeModel();
11+
expectToBeANonEmptyString(response);
12+
});
13+
});

0 commit comments

Comments
 (0)