@convex-dev/agent 0.0.1 → 0.0.3-alpha.0

package/README.md

@@ -10,6 +10,7 @@ AI Agent framework built on Convex.
 - RAG for chat context, via hybrid text & vector search, with configuration options.
   Or use the API to query the history yourself and do it your way.
 - Opt-in search for messages from other threads (for the same specified user).
+- Support for generating and storing objects in messages (as JSON).
 - Tool calls via the AI SDK, along with Convex-specific helpers.
 - Easy workflow integration with the [Workflow component](https://convex.dev/components/workflow).
 - Reactive & realtime updates to asynchronous threads.
@@ -341,4 +342,30 @@ Read more in [this Stack post](https://stack.convex.dev/ai-agents).
 npm i @convex-dev/agent
 ```
 
+## Troubleshooting
+
+### Circular dependencies
+
+Having the return value of workflows depend on other Convex functions can lead to circular dependencies due to the
+`internal.foo.bar` way of specifying functions. The way to fix this is to explicitly type the return value of the
+workflow. When in doubt, add return types to more `handler` functions, like this:
+
+```diff
+ export const supportAgentWorkflow = workflow.define({
+   args: { prompt: v.string(), userId: v.string(), threadId: v.string() },
++  handler: async (step, { prompt, userId, threadId }): Promise<string> => {
+     // ...
+   },
+ });
+
+ // And regular functions too:
+ export const myFunction = action({
+   args: { prompt: v.string() },
++  handler: async (ctx, { prompt }): Promise<string> => {
+     // ...
+   },
+ });
+```
+
+
 <!-- END: Include on https://convex.dev/components -->