Skip to content

Commit d67e2ff

Browse files
monadierickxmonadierickx
authored
Swift: code example for Amazon Nova Converse and ConverseStream, Bedrock Runtime (#7412)
* Amazon Nova converse text * Regenerate documentation * Added SPDX header, moved snipped-start tag, regenerated documentation * ConverseStream * ConverseStream * Unnecessary imports and dependencies deleted, moved snippet-ends to exclude call to function * no lines longer then characters, spelling error fixed
1 parent 5ab1226 commit d67e2ff

File tree

5 files changed

+281
-0
lines changed

5 files changed

+281
-0
lines changed

‎.doc_gen/metadata/bedrock-runtime_metadata.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ bedrock-runtime_Converse_AmazonNovaText:
132132
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
133133
snippet_tags:
134134
- python.example_code.bedrock-runtime.Converse_AmazonNovaText
135+
Swift:
136+
versions:
137+
- sdk_version: 1
138+
github: swift/example_code/bedrock-runtime
139+
excerpts:
140+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API.
141+
snippet_tags:
142+
- swift.example_code.bedrock-runtime.Converse_AmazonNovaText
135143
services:
136144
bedrock-runtime: {Converse}
137145

@@ -501,6 +509,14 @@ bedrock-runtime_ConverseStream_AmazonNovaText:
501509
- description: Send a text message to Amazon Nova, using Bedrock's Converse API and process the response stream in real-time.
502510
snippet_tags:
503511
- python.example_code.bedrock-runtime.ConverseStream_AmazonNovaText
512+
Swift:
513+
versions:
514+
- sdk_version: 1
515+
github: swift/example_code/bedrock-runtime
516+
excerpts:
517+
- description: Send a text message to Amazon Nova, using Bedrock's Converse API and process the response stream in real-time.
518+
snippet_tags:
519+
- swift.example_code.bedrock-runtime.ConverseStream_AmazonNovaText
504520
services:
505521
bedrock-runtime: {ConverseStream}
506522

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

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Amazon Bedrock Runtime code examples for the SDK for Swift
2+
3+
## Overview
4+
5+
Shows how to use the AWS SDK for Swift to work with Amazon Bedrock Runtime.
6+
7+
<!--custom.overview.start-->
8+
<!--custom.overview.end-->
9+
10+
_Amazon Bedrock Runtime is a fully managed service that makes it easy to use foundation models from third-party providers and Amazon._
11+
12+
## ⚠ Important
13+
14+
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
15+
* Running the tests might result in charges to your AWS account.
16+
* 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
17+
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
18+
19+
<!--custom.important.start-->
20+
<!--custom.important.end-->
21+
22+
## Code examples
23+
24+
### Prerequisites
25+
26+
For prerequisites, see the [README](../../README.md#Prerequisites) in the `swift` folder.
27+
28+
29+
<!--custom.prerequisites.start-->
30+
<!--custom.prerequisites.end-->
31+
### Amazon Nova
32+
33+
- [Converse](models/amazon-nova/amazon-nova-text/Sources/Converse/main.swift#L4)
34+
- [ConverseStream](models/amazon-nova/amazon-nova-text/Sources/ConverseStream/main.swift#L4)
35+
36+
37+
<!--custom.examples.start-->
38+
<!--custom.examples.end-->
39+
40+
## Run the examples
41+
42+
### Instructions
43+
44+
To build any of these examples from a terminal window, navigate into its
45+
directory, then use the following command:
46+
47+
```
48+
$ swift build
49+
```
50+
51+
To build one of these examples in Xcode, navigate to the example's directory
52+
(such as the `ListUsers` directory, to build that example). Then type `xed.`
53+
to open the example directory in Xcode. You can then use standard Xcode build
54+
and run commands.
55+
56+
<!--custom.instructions.start-->
57+
<!--custom.instructions.end-->
58+
59+
60+
61+
### Tests
62+
63+
⚠ Running tests might result in charges to your AWS account.
64+
65+
66+
To find instructions for running these tests, see the [README](../../README.md#Tests)
67+
in the `swift` folder.
68+
69+
70+
71+
<!--custom.tests.start-->
72+
<!--custom.tests.end-->
73+
74+
## Additional resources
75+
76+
- [Amazon Bedrock Runtime User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-bedrock.html)
77+
- [Amazon Bedrock Runtime API Reference](https://docs.aws.amazon.com/bedrock/latest/APIReference/welcome.html)
78+
- [SDK for Swift Amazon Bedrock Runtime reference](https://sdk.amazonaws.com/swift/api/awsbedrockruntime/latest/documentation/awsbedrockruntime)
79+
80+
<!--custom.resources.start-->
81+
<!--custom.resources.end-->
82+
83+
---
84+
85+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
86+
87+
SPDX-License-Identifier: Apache-2.0

‎swift/example_code/bedrock-runtime/models/amazon-nova/amazon-nova-text/Package.swift

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// swift-tools-version: 6.1
2+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
// SPDX-License-Identifier: Apache-2.0
4+
//
5+
// The swift-tools-version declares the minimum version of Swift required to build this package.
6+
7+
import PackageDescription
8+
9+
let package = Package(
10+
name: "AmazonNovaText",
11+
// Let Xcode know the minimum Apple platforms supported.
12+
platforms: [
13+
.macOS(.v13),
14+
.iOS(.v15)
15+
],
16+
dependencies: [
17+
// Dependencies declare other packages that this package depends on.
18+
.package(url: "https://github.com/awslabs/aws-sdk-swift", from: "1.2.61")
19+
],
20+
targets: [
21+
// Targets are the basic building blocks of a package, defining a module or a test suite.
22+
// Targets can depend on other targets in this package and products from dependencies.
23+
.executableTarget(
24+
name: "Converse",
25+
dependencies: [
26+
.product(name: "AWSBedrockRuntime", package: "aws-sdk-swift"),
27+
],
28+
path: "Sources/Converse"
29+
),
30+
.executableTarget(
31+
name: "ConverseStream",
32+
dependencies: [
33+
.product(name: "AWSBedrockRuntime", package: "aws-sdk-swift"),
34+
],
35+
path: "Sources/ConverseStream"
36+
)
37+
]
38+
)

‎swift/example_code/bedrock-runtime/models/amazon-nova/amazon-nova-text/Sources/Converse/main.swift

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
//
4+
// snippet-start:[swift.example_code.bedrock-runtime.Converse_AmazonNovaText]
5+
// An example demonstrating how to use the Conversation API to send
6+
// a text message to Amazon Nova.
7+
8+
import AWSBedrockRuntime
9+
10+
func converse(_ textPrompt: String) async throws -> String {
11+
12+
// Create a Bedrock Runtime client in the AWS Region you want to use.
13+
let config =
14+
try await BedrockRuntimeClient.BedrockRuntimeClientConfiguration(
15+
region: "us-east-1"
16+
)
17+
let client = BedrockRuntimeClient(config: config)
18+
19+
// Set the model ID.
20+
let modelId = "amazon.nova-micro-v1:0"
21+
22+
// Start a conversation with the user message.
23+
let message = BedrockRuntimeClientTypes.Message(
24+
content: [.text(textPrompt)],
25+
role: .user
26+
)
27+
28+
// Optionally use inference parameters
29+
let inferenceConfig =
30+
BedrockRuntimeClientTypes.InferenceConfiguration(
31+
maxTokens: 512,
32+
stopSequences: ["END"],
33+
temperature: 0.5,
34+
topp: 0.9
35+
)
36+
37+
// Create the ConverseInput to send to the model
38+
let input = ConverseInput(
39+
inferenceConfig: inferenceConfig, messages: [message], modelId: modelId)
40+
41+
// Send the ConverseInput to the model
42+
let response = try await client.converse(input: input)
43+
44+
// Extract and return the response text.
45+
if case let .message(msg) = response.output {
46+
if case let .text(textResponse) = msg.content![0] {
47+
return textResponse
48+
} else {
49+
return "No text response found in message content"
50+
}
51+
} else {
52+
return "No message found in converse output"
53+
}
54+
}
55+
56+
// snippet-end:[swift.example_code.bedrock-runtime.Converse_AmazonNovaText]
57+
58+
do {
59+
let reply = try await converse(
60+
"Describe the purpose of a 'hello world' program in one line."
61+
)
62+
print(reply)
63+
} catch {
64+
print("An error occurred: \(error)")
65+
}

‎swift/example_code/bedrock-runtime/models/amazon-nova/amazon-nova-text/Sources/ConverseStream/main.swift

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:[swift.example_code.bedrock-runtime.ConverseStream_AmazonNovaText]
5+
// An example demonstrating how to use the Conversation API to send a text message
6+
// to Amazon Nova and print the response stream
7+
8+
import AWSBedrockRuntime
9+
10+
func printConverseStream(_ textPrompt: String) async throws {
11+
12+
// Create a Bedrock Runtime client in the AWS Region you want to use.
13+
let config =
14+
try await BedrockRuntimeClient.BedrockRuntimeClientConfiguration(
15+
region: "us-east-1"
16+
)
17+
let client = BedrockRuntimeClient(config: config)
18+
19+
// Set the model ID.
20+
let modelId = "amazon.nova-lite-v1:0"
21+
22+
// Start a conversation with the user message.
23+
let message = BedrockRuntimeClientTypes.Message(
24+
content: [.text(textPrompt)],
25+
role: .user
26+
)
27+
28+
// Optionally use inference parameters.
29+
let inferenceConfig =
30+
BedrockRuntimeClientTypes.InferenceConfiguration(
31+
maxTokens: 512,
32+
stopSequences: ["END"],
33+
temperature: 0.5,
34+
topp: 0.9
35+
)
36+
37+
// Create the ConverseStreamInput to send to the model.
38+
let input = ConverseStreamInput(
39+
inferenceConfig: inferenceConfig, messages: [message], modelId: modelId)
40+
41+
// Send the ConverseStreamInput to the model.
42+
let response = try await client.converseStream(input: input)
43+
44+
// Extract the streaming response.
45+
guard let stream = response.stream else {
46+
print("No stream available")
47+
return
48+
}
49+
50+
// Extract and print the streamed response text in real-time.
51+
for try await event in stream {
52+
switch event {
53+
case .messagestart(_):
54+
print("\nNova Lite:")
55+
56+
case .contentblockdelta(let deltaEvent):
57+
if case .text(let text) = deltaEvent.delta {
58+
print(text, terminator: "")
59+
}
60+
61+
default:
62+
break
63+
}
64+
}
65+
}
66+
67+
// snippet-end:[swift.example_code.bedrock-runtime.ConverseStream_AmazonNovaText]
68+
69+
do {
70+
try await printConverseStream(
71+
"Describe the purpose of a 'hello world' program in two paragraphs."
72+
)
73+
} catch {
74+
print("An error occurred: \(error)")
75+
}

0 commit comments

Comments
 (0)