@upstash/qstash 2.6.2 → 2.6.3

package/README.md

@@ -55,11 +55,11 @@ import { Client } from "@upstash/qstash";
  */
 import "isomorphic-fetch";
 
-const c = new Client({
+const client = new Client({
   token: "<QSTASH_TOKEN>",
 });
 
-const res = await c.publishJSON({
+const res = await client.publishJSON({
   url: "https://my-api...",
   // or urlGroup: "the name or id of a url group"
   body: {
@@ -107,7 +107,7 @@ No need for complicated setup your LLM request. We'll call LLM and schedule it f
 ```ts
 import { Client, openai } from "@upstash/qstash";
 
-const c = new Client({
+const client = new Client({
   token: "<QSTASH_TOKEN>",
 });
 
@@ -131,7 +131,11 @@ const result = await client.publishJSON({
 You can easily start streaming Upstash or OpenAI responses from your favorite framework(Next.js) or library
 
 ```ts
-import { upstash } from "@upstash/qstash";
+import { Client, upstash } from "@upstash/qstash";
+
+const client = new Client({
+  token: "<QSTASH_TOKEN>",
+});
 
 const response = await client.chat().create({
   provider: upstash(), // Optionally, provider: "custom({token: "XXX", baseUrl: "https://api.openai.com"})". This will allow you to call every OpenAI compatible API out there.
@@ -151,6 +155,43 @@ const response = await client.chat().create({
 });
 ```
 
+### Add Observability via Helicone
+
+Helicone is a powerful observability platform that provides valuable insights into your LLM usage. Integrating Helicone with QStash is straightforward.
+
+To enable Helicone observability in QStash, you simply need to pass your Helicone API key when initializing your model. Here's how to do it for both custom models and OpenAI:
+
+#### For Custom Models (e.g., Meta-Llama)
+
+```ts
+import { Client, custom } from "@upstash/qstash";
+
+const client = new Client({
+  token: "<QSTASH_TOKEN>",
+});
+
+await client.publishJSON({
+  api: {
+    name: "llm",
+    provider: custom({
+      token: "XXX",
+      baseUrl: "https://api.together.xyz",
+    }),
+    analytics: { name: "helicone", token: process.env.HELICONE_API_KEY! },
+  },
+  body: {
+    model: "meta-llama/Llama-3-8b-chat-hf",
+    messages: [
+      {
+        role: "user",
+        content: "hello",
+      },
+    ],
+  },
+  callback: "https://oz.requestcatcher.com/",
+});
+```
+
 ## Docs
 
 See [the documentation](https://docs.upstash.com/qstash) for details.
@@ -158,3 +199,7 @@ See [the documentation](https://docs.upstash.com/qstash) for details.
 ## Contributing
 
 ### [Install Deno](https://deno.land/#installation)
+
+```
+
+```