James Ritchie
fade22015f
* Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com>
32 lines
1.2 KiB
Plaintext
32 lines
1.2 KiB
Plaintext
---
|
|
title: "Priority"
|
|
description: "Specify a priority when triggering a run."
|
|
---
|
|
|
|
You can set a priority when you trigger a run. This allows you to prioritize some of your runs over others, so they are started sooner. This is very useful when:
|
|
|
|
- You have critical work that needs to start more quickly (and you have long queues).
|
|
- You want runs for your premium users to take priority over free users.
|
|
|
|
The value for priority is a time offset in seconds that determines the order of dequeuing.
|
|
|
|
|
|
|
|
If you specify a priority of `10` the run will dequeue before runs that were triggered with no priority 8 seconds ago, like in this example:
|
|
|
|
```ts
|
|
// no priority = 0
|
|
await myTask.trigger({ foo: "bar" });
|
|
|
|
//... imagine 8s pass by
|
|
|
|
// this run will start before the run above that was triggered 8s ago (with no priority)
|
|
await myTask.trigger({ foo: "bar" }, { priority: 10 });
|
|
```
|
|
|
|
If you passed a value of `3600` the run would dequeue before runs that were triggered an hour ago (with no priority).
|
|
|
|
<Note>
|
|
Setting a high priority will not allow you to beat runs from other organizations. It will only affect the order of your own runs.
|
|
</Note>
|