--- title: InkeepStream description: Learn to use InkeepStream helper function in your application. --- # `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](https://inkeep.com)'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 ## API Signature ### Parameters Promise', description: 'An optional function that is called at the start of the stream processing.', }, { name: 'onCompletion', type: '(completion: string) => Promise', description: "An optional function that is called for every completion. It's passed the completion as a string.", }, { name: 'onFinal', type: '(completion: string) => Promise', description: 'An optional function that is called once when the stream is closed with the final completion message.', }, { name: 'onToken', type: '(token: string) => Promise', description: "An optional function that is called for each token in the stream. It's passed the token as a string.", }, ], }, ], }, ]} /> ### Returns A `ReadableStream`.