Support abortion of tool execution

[wong2]

Feature Description

Let's say I have a web search tool, it sends out an HTTP request to do a web search when it's executed.

const tools = {
  web_search: tool({
    .......
  }),
}

streamText({
  model: openai('gpt-4o'),
  prompt: '...',
  tools,
  abortSignal: req.signal,
})

Now I really wish I had a way to stop search requests in web_search when an abort happens, but it seems like there's no way to do it right now.

[lgrammel]

Would you want to use the same abort signal that we use for the main request? we could add it as an optional parameter to the tools, then you could use it in the tool implementation. alternatively you can use the abort signal from the closure when you create the tool

[wong2]

I think using the same abort signal I passed to streamText is enough.

[wong2]

Yeah, something like this would be cool :

execute: async ({ query }, { abortSignal }) => {
   ...  
}

[lgrammel]

#3277

[wong2]

Thanks, good job as always!

[wong2]

I've gave it a try, and get the following type error:

execute: async ({ query }, { abortSignal }) => {
  const searchResults = await searchWeb(query, numResults, abortSignal)
  return { searchResults }    
}

    Type '({ query }: { query: string; }, { abortSignal }: { abortSignal?: AbortSignal | undefined; }) => Promise<SpecificErrorInstance<[], { query: string; }, CustomClass, AggregateErrors, unknown> | { ...; }>' is not assignable to type '((args: { query: string; }, options: { abortSignal?: AbortSignal | undefined; }) => PromiseLike<SpecificErrorInstance<[], { query: string; }, CustomClass, AggregateErrors, unknown> | { ...; }>) & ((args: { ...; }) => PromiseLike<...>)'.
      Type '({ query }: { query: string; }, { abortSignal }: { abortSignal?: AbortSignal | undefined; }) => Promise<SpecificErrorInstance<[], { query: string; }, CustomClass, AggregateErrors, unknown> | { ...; }>' is not assignable to type '(args: { query: string; }) => PromiseLike<SpecificErrorInstance<[], { query: string; }, CustomClass, AggregateErrors, unknown> | { searchResults: WebSearchResult[]; }>'.
        Target signature provides too few arguments. Expected 2 or more, but got 1.
  Overload 2 of 2, '(tool: CoreTool<ZodObject<{ query: ZodString; }, "strip", ZodTypeAny, { query: string; }, { query: string; }>, SpecificErrorInstance<[], { query: string; }, CustomClass, AggregateErrors, unknown> | { ...; }> & { ...; }): CoreTool<...> & { ...; }', gave the following error.
    Type '({ query }: { query: string; }, { abortSignal }: { abortSignal?: AbortSignal | undefined; }) => Promise<SpecificErrorInstance<[], { query: string; }, CustomClass, AggregateErrors, unknown> | { ...; }>' is not assignable to type 'undefined'.ts(2769)

[lgrammel]

#3285