ai
Version:
AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript
94 lines (81 loc) • 2.82 kB
text/mdx
title: AWSBedrockCohereStream
description: Learn to use AWSBedrockCohereStream helper function in your application.
# `AWSBedrockCohereStream`
<Note type="warning">
AWSBedrockCohereStream has been removed in AI SDK 4.0.
</Note>
<Note type="warning">
AWSBedrockCohereStream is part of the legacy AWS Bedrock integration. It is
not compatible with the AI SDK 3.1 functions.
</Note>
## Import
The AWS Bedrock stream functions are utilties that transform the outputs from the AWS Bedrock API into a ReadableStream. It uses AIStream under the hood and handles parsing Bedrock's response.
### React
<Snippet text={`import { AWSBedrockCohereStream } from "ai"`} prompt={false} />
## API Signature
### Parameters
<PropertiesTable
content={[
{
name: 'response',
type: 'AWSBedrockResponse',
description: 'The response object returned from AWS Bedrock.',
properties: [
{
type: 'AWSBedrockResponse',
parameters: [
{
name: 'body',
isOptional: true,
type: 'AsyncIterable<{ chunk?: { bytes?: Uint8Array } }>',
description:
'An optional async iterable of objects containing optional binary data chunks.',
},
],
},
],
},
{
name: 'callbacks',
type: 'AIStreamCallbacksAndOptions',
isOptional: true,
description:
'An object containing callback functions to handle the start, each token, and completion of the AI response. In the absence of this parameter, default behavior is implemented.',
properties: [
{
type: 'AIStreamCallbacksAndOptions',
parameters: [
{
name: 'onStart',
type: '() => Promise<void>',
description:
'An optional function that is called at the start of the stream processing.',
},
{
name: 'onCompletion',
type: '(completion: string) => Promise<void>',
description:
"An optional function that is called for every completion. It's passed the completion as a string.",
},
{
name: 'onFinal',
type: '(completion: string) => Promise<void>',
description:
'An optional function that is called once when the stream is closed with the final completion message.',
},
{
name: 'onToken',
type: '(token: string) => Promise<void>',
description:
"An optional function that is called for each token in the stream. It's passed the token as a string.",
},
],
},
],
},
]}
/>
### Returns
A `ReadableStream`.