Support passing extra parameters

[nightire]

In my case, I want to organize messages by conversation, which means in internal query getHistory, I need to change this:

const allMessages = await context.db.query("messages").collect()

to this:

const allMessages = await context.db
  .query("messages")
  .withIndex("by_conversation", (q) => q.eq("conversationId", conversationId))
  .collect()

However, as useStream only allow to pass the streamId, I can't pass the active conversationId to the http route, thus I never get the chance to pass conversationId to internal query getHistory.

In order to provide more control to the developers, I suggest allow useStream to accept more arguments than streamId only. Maybe something like this:

useQuery<RestArguments>(getBody, url, true, { streamId, ...rest })

[ianmacartney]

You're trying to return more data from the query than the stream body?
Can you instead have a second query for all the other messages?
The query for the stream body will re-execute every time the stream changes, which will be very expensive if it's fetching all other messages too on every update.
I would do useQuery(api.foo.getMessages) separate from useStream(streamId)

[nightire]

@ianmacartney I don't know if I'm misinterpreting, but I see this line in the example code:

persistent-text-streaming/example/convex/messages.ts

Line 39 in e080e12

const allMessages = await ctx.db.query("userMessages").collect();

This line of code comes from getHistory and is then called by streamChat, which is the handler for the HTTP interface called by useStream. i.e. useStream triggers a query for the userMessages resource anyway. Is that correct?

BTW: This query does not mean to return more data, it's used for gathering the history messages and feed it to the next AI prompt (which is exactly what the example code does).

If this is a code smell, as your said, a very expensive action, then how should developers to provide history messages? I think we should gathering the history before calling useStream, but currently there's no way to passing anything other than streamId.

[ianmacartney]

On the client, you do useQuery(api.example.listMessages, { conversationId }) not useQuery(api.example.getHistory).
The latter is an internal query you can use from an action. The action won't re-run a query when it changes - it's a single query, so it's fine here.
see

persistent-text-streaming/example/src/components/ChatWindow.tsx

Line 11 in e080e12

const messages = useQuery(api.messages.listMessages);

But I see what you mean for streamChat which is an http action -
For that, you can store the associated conversationId along with the chatId when you do the sendMessage here:

persistent-text-streaming/example/convex/messages.ts

Line 27 in e080e12

const chatId = await ctx.db.insert("userMessages", {

Then in streamChat you can do a getHistory passing in the streamId

[ianmacartney]

However I'd highly recommend you check out the Agent component to manage the message history for you. it makes it very easy and also supports streaming

[cabyambo]

For that, you can store the associated conversationId along with the chatId when you do the sendMessage here:

So is it correct to say the persistent text streaming component does not have plans to accept arguments other than the streamId?

Personally, I'd also like the feature initially requested here. It would be ideal to not need to store an additional table mapping stream id to conversation id.

[nightire]

However I'd highly recommend you check out the Agent component to manage the message history for you. it makes it very easy and also supports streaming

Agent is good, but we don't want to lock-in the ai-sdk unfortunately

[ianmacartney]

You can pass in custom headers to the useStream hook, then extract them as headers in the httpAction. Is that what you're looking for here?

I hear you on the ai-sdk. I hope we can separate that out a bit more, as I'm a bit frustrated with it at times.

[SharmaTanishq]

@nightire were you able to resolve this? I am doing something similar not able to figure it out. SMH

[nightire]

@SharmaTanishq You can attach extra arguments through url search params or headers, then extract them in the http action