@aws-sdk/client-bedrock-runtime
Description
AWS SDK for JavaScript BedrockRuntime Client for Node.js, Browser and React Native.
Describes the API operations for running inference using Amazon Bedrock models.
Installing
To install this package, use the CLI of your favorite package manager:
npm install @aws-sdk/client-bedrock-runtime
yarn add @aws-sdk/client-bedrock-runtime
pnpm add @aws-sdk/client-bedrock-runtime
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the BedrockRuntimeClient and
the commands you need, for example ListAsyncInvokesCommand:
const { BedrockRuntimeClient, ListAsyncInvokesCommand } = require("@aws-sdk/client-bedrock-runtime");
import { BedrockRuntimeClient, ListAsyncInvokesCommand } from "@aws-sdk/client-bedrock-runtime";
Usage
To send a request:
- Instantiate a client with configuration (e.g. credentials, region).
- Instantiate a command with input parameters.
- Call the
send operation on the client, providing the command object as input.
const client = new BedrockRuntimeClient({ region: "REGION" });
const params = { };
const command = new ListAsyncInvokesCommand(params);
Async/await
We recommend using the await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
Promises
You can also use Promise chaining.
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Aggregated client
The aggregated client class is exported from the same package, but without the "Client" suffix.
BedrockRuntime extends BedrockRuntimeClient and additionally supports all operations, waiters, and paginators as methods.
This style may be familiar to you from the AWS SDK for JavaScript v2.
If you are bundling the AWS SDK, we recommend using only the bare-bones client (BedrockRuntimeClient).
More details are in the blog post on
modular packages in AWS SDK for JavaScript.
import { BedrockRuntime } from "@aws-sdk/client-bedrock-runtime";
const client = new BedrockRuntime({ region: "REGION" });
try {
const data = await client.listAsyncInvokes(params);
} catch (error) {
}
client
.listAsyncInvokes(params)
.then((data) => {
})
.catch((error) => {
});
client.listAsyncInvokes(params, (err, data) => {
});
Troubleshooting
When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
See also docs/ERROR_HANDLING.
Getting Help
Please use these community resources for getting help.
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.
Contributing
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-bedrock-runtime package is updated.
To contribute to client you can check our generate clients scripts.
License
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
Client Commands (Operations List)
ApplyGuardrail
Command API Reference / Input / Output
Converse
Command API Reference / Input / Output
ConverseStream
Command API Reference / Input / Output
CountTokens
Command API Reference / Input / Output
GetAsyncInvoke
Command API Reference / Input / Output
InvokeGuardrailChecks
Command API Reference / Input / Output
InvokeModel
Command API Reference / Input / Output
InvokeModelWithBidirectionalStream
Command API Reference / Input / Output
InvokeModelWithResponseStream
Command API Reference / Input / Output
ListAsyncInvokes
Command API Reference / Input / Output
StartAsyncInvoke
Command API Reference / Input / Output