docs: add ReplicateStream api-reference documentation (vercel#413)

docs/pages/docs/api-reference/_meta.json

@@ -1,12 +1,13 @@
 {
   "use-chat": "useChat",
   "use-completion": "useCompletion",
-  "huggingface-stream": "HuggingFaceStream",
+  "ai-stream": "AIStream",
   "anthropic-stream": "AnthropicStream",
+  "huggingface-stream": "HuggingFaceStream",
   "langchain-stream": "LangChainStream",
   "openai-stream": "OpenAIStream",
+  "replicate-stream": "ReplicateStream",
   "streaming-text-response": "StreamingTextResponse",
-  "ai-stream": "AIStream",
   "stream-to-response": "streamToResponse",
   "tokens": "<Tokens />"
 }

docs/pages/docs/api-reference/replicate-stream.mdx

@@ -0,0 +1,21 @@
+# ReplicateStream
+
+## `ReplicateStream(pre: Prediction, cb?: AIStreamCallbacks): Promise<ReadableStream>` [#replicatestream]
+
+The `ReplicateStream` function is a utility that handles extracting the stream from the output of [Replicate's](https://www.replicate.com) API.
+It expects a `Prediction` object as returned by the [Replicate JavaScript SDK](https://github.com/replicate/replicate-javascript), and returns a `ReadableStream`.
+Unlike other wrappers, `ReplicateStream` returns a `Promise` because it makes a `fetch` call to the [Replicate streaming API](https://github.com/replicate/replicate-javascript#streaming) under the hood.
+
+## Parameters
+
+### `pre: Prediction`
+
+The `Prediction` object returned by the Replicate JavaScript SDK
+
+### `cb?: AIStreamCallbacks`
+
+This optional parameter can be 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.
+
+## Example
+
+See our [Replicate Guide](/docs/guides/providers/replicate) for examples.

examples/next-huggingface/package.json

@@ -10,8 +10,8 @@
   },
   "dependencies": {
     "@huggingface/inference": "^2.5.1",
+    "next": "13.4.12",
     "ai": "2.1.32",
-    "next": "13.4.4-canary.11",
     "react": "18.2.0",
     "react-dom": "^18.2.0"
   },
@@ -21,7 +21,7 @@
     "@types/react-dom": "18.2.4",
     "autoprefixer": "^10.4.14",
     "eslint": "^7.32.0",
-    "eslint-config-next": "13.4.4-canary.11",
+    "eslint-config-next": "13.4.12",
     "postcss": "^8.4.23",
     "tailwindcss": "^3.3.2",
     "typescript": "5.1.3"

examples/next-langchain/package.json

@@ -11,7 +11,7 @@
   "dependencies": {
     "ai": "2.1.32",
     "langchain": "^0.0.103",
-    "next": "13.4.4-canary.11",
+    "next": "13.4.12",
     "react": "18.2.0",
     "react-dom": "^18.2.0"
   },
@@ -21,7 +21,7 @@
     "@types/react-dom": "18.2.4",
     "autoprefixer": "^10.4.14",
     "eslint": "^7.32.0",
-    "eslint-config-next": "13.4.4-canary.11",
+    "eslint-config-next": "13.4.12",
     "postcss": "^8.4.23",
     "tailwindcss": "^3.3.2",
     "typescript": "5.1.3"

examples/next-openai/package.json

@@ -9,8 +9,8 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "ai": "^2.1.32",
-    "next": "13.4.4-canary.11",
+    "ai": "^2.1.31",
+    "next": "13.4.12",
     "openai-edge": "^1.1.0",
     "react": "18.2.0",
     "react-dom": "^18.2.0"
@@ -21,7 +21,7 @@
     "@types/react-dom": "18.2.4",
     "autoprefixer": "^10.4.14",
     "eslint": "^7.32.0",
-    "eslint-config-next": "13.4.4-canary.11",
+    "eslint-config-next": "13.4.12",
     "postcss": "^8.4.23",
     "tailwindcss": "^3.3.2",
     "typescript": "5.1.3"

examples/next-replicate/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "ai": "^2.1.29",
-    "next": "13.4.4-canary.11",
+    "next": "13.4.12",
     "react": "18.2.0",
     "react-dom": "^18.2.0",
     "replicate": "^0.14.1"
@@ -21,7 +21,7 @@
     "@types/react-dom": "18.2.4",
     "autoprefixer": "^10.4.14",
     "eslint": "^7.32.0",
-    "eslint-config-next": "13.4.4-canary.11",
+    "eslint-config-next": "13.4.12",
     "postcss": "^8.4.23",
     "tailwindcss": "^3.3.2",
     "typescript": "5.1.3"