`InkeepStream`

InkeepStream has been removed in AI SDK 4.0.

InkeepStream is part of the legacy Inkeep integration. It is not compatible with the AI SDK 3.1 functions.

The InkeepStream function is a utility that transforms the output from Inkeep's API into a ReadableStream. It uses AIStream under the hood, applying a specific parser for the Inkeep's response data structure.

This works with the official Inkeep API, and it's supported in both Node.js, the Edge Runtime, and browser environments.

Import

React

import { InkeepStream } from "ai"

API Signature

Parameters

response:

Response

callbacks?:

AIStreamCallbacksAndOptions

onStart:

() => Promise<void>

onCompletion:

(completion: string) => Promise<void>

onFinal:

(completion: string) => Promise<void>

onToken:

(token: string) => Promise<void>

Returns

A ReadableStream.