ai 3.2.10 → 3.2.12

package/dist/index.d.mts

@@ -63,10 +63,11 @@ Embed a value using an embedding model. The type of the value is defined by the
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @returns A result object that contains the embedding, the value, and additional information.
  */
-declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
+declare function embed<VALUE>({ model, value, maxRetries, abortSignal, headers, }: {
     /**
   The embedding model to use.
        */
@@ -85,6 +86,11 @@ declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
   Abort signal.
    */
     abortSignal?: AbortSignal;
+    /**
+  Additional headers to include in the request.
+  Only applicable for HTTP-based providers.
+   */
+    headers?: Record<string, string>;
 }): Promise<EmbedResult<VALUE>>;
 /**
 The result of a `embed` call.
@@ -129,10 +135,11 @@ has a limit on how many embeddings can be generated in a single call.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @returns A result object that contains the embeddings, the value, and additional information.
  */
-declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, }: {
+declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, headers, }: {
     /**
   The embedding model to use.
        */
@@ -151,6 +158,11 @@ declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, }: {
   Abort signal.
    */
     abortSignal?: AbortSignal;
+    /**
+  Additional headers to include in the request.
+  Only applicable for HTTP-based providers.
+   */
+    headers?: Record<string, string>;
 }): Promise<EmbedManyResult<VALUE>>;
 /**
 The result of a `embedMany` call.
@@ -247,6 +259,11 @@ type CallSettings = {
   Abort signal.
      */
     abortSignal?: AbortSignal;
+    /**
+  Additional HTTP headers to be sent with the request.
+  Only applicable for HTTP-based providers.
+     */
+    headers?: Record<string, string | undefined>;
 };
 
 /**
@@ -452,11 +469,12 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+declare function generateObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, headers, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -570,11 +588,12 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, headers, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -919,13 +938,14 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1056,6 +1076,7 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param onFinish - Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
@@ -1063,7 +1084,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */

package/dist/index.d.ts

@@ -63,10 +63,11 @@ Embed a value using an embedding model. The type of the value is defined by the
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @returns A result object that contains the embedding, the value, and additional information.
  */
-declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
+declare function embed<VALUE>({ model, value, maxRetries, abortSignal, headers, }: {
     /**
   The embedding model to use.
        */
@@ -85,6 +86,11 @@ declare function embed<VALUE>({ model, value, maxRetries, abortSignal, }: {
   Abort signal.
    */
     abortSignal?: AbortSignal;
+    /**
+  Additional headers to include in the request.
+  Only applicable for HTTP-based providers.
+   */
+    headers?: Record<string, string>;
 }): Promise<EmbedResult<VALUE>>;
 /**
 The result of a `embed` call.
@@ -129,10 +135,11 @@ has a limit on how many embeddings can be generated in a single call.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @returns A result object that contains the embeddings, the value, and additional information.
  */
-declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, }: {
+declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, headers, }: {
     /**
   The embedding model to use.
        */
@@ -151,6 +158,11 @@ declare function embedMany<VALUE>({ model, values, maxRetries, abortSignal, }: {
   Abort signal.
    */
     abortSignal?: AbortSignal;
+    /**
+  Additional headers to include in the request.
+  Only applicable for HTTP-based providers.
+   */
+    headers?: Record<string, string>;
 }): Promise<EmbedManyResult<VALUE>>;
 /**
 The result of a `embedMany` call.
@@ -247,6 +259,11 @@ type CallSettings = {
   Abort signal.
      */
     abortSignal?: AbortSignal;
+    /**
+  Additional HTTP headers to be sent with the request.
+  Only applicable for HTTP-based providers.
+     */
+    headers?: Record<string, string | undefined>;
 };
 
 /**
@@ -452,11 +469,12 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @returns
 A result object that contains the generated object, the finish reason, the token usage, and additional information.
  */
-declare function generateObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, ...settings }: CallSettings & Prompt & {
+declare function generateObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, headers, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -570,11 +588,12 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @return
 A result object for accessing the partial object stream and additional information.
  */
-declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamObject<T>({ model, schema, mode, system, prompt, messages, maxRetries, abortSignal, headers, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -919,13 +938,14 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param maxToolRoundtrips - Maximal number of automatic roundtrips for tool calls.
 
 @returns
 A result object that contains the generated text, the results of the tool calls, and additional information.
  */
-declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
+declare function generateText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxAutomaticRoundtrips, maxToolRoundtrips, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1056,6 +1076,7 @@ If set and supported by the model, calls will generate deterministic results.
 
 @param maxRetries - Maximum number of retries. Set to 0 to disable retries. Default: 2.
 @param abortSignal - An optional abort signal that can be used to cancel the call.
+@param headers - Additional HTTP headers to be sent with the request. Only applicable for HTTP-based providers.
 
 @param onFinish - Callback that is called when the LLM response and all request tool executions
 (for tools that have an `execute` function) are finished.
@@ -1063,7 +1084,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, onFinish, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends Record<string, CoreTool>>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, onFinish, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */

package/dist/index.js

@@ -178,14 +178,12 @@ async function embed({
   model,
   value,
   maxRetries,
-  abortSignal
+  abortSignal,
+  headers
 }) {
   const retry = retryWithExponentialBackoff({ maxRetries });
   const modelResponse = await retry(
-    () => model.doEmbed({
-      values: [value],
-      abortSignal
-    })
+    () => model.doEmbed({ values: [value], abortSignal, headers })
   );
   return new EmbedResult({
     value,
@@ -218,13 +216,14 @@ async function embedMany({
   model,
   values,
   maxRetries,
-  abortSignal
+  abortSignal,
+  headers
 }) {
   const retry = retryWithExponentialBackoff({ maxRetries });
   const maxEmbeddingsPerCall = model.maxEmbeddingsPerCall;
   if (maxEmbeddingsPerCall == null) {
     const modelResponse = await retry(
-      () => model.doEmbed({ values, abortSignal })
+      () => model.doEmbed({ values, abortSignal, headers })
     );
     return new EmbedManyResult({
       values,
@@ -235,7 +234,7 @@ async function embedMany({
   const embeddings = [];
   for (const chunk of valueChunks) {
     const modelResponse = await retry(
-      () => model.doEmbed({ values: chunk, abortSignal })
+      () => model.doEmbed({ values: chunk, abortSignal, headers })
     );
     embeddings.push(...modelResponse.embeddings);
   }
@@ -643,6 +642,7 @@ async function generateObject({
   messages,
   maxRetries,
   abortSignal,
+  headers,
   ...settings
 }) {
   var _a, _b;
@@ -670,7 +670,8 @@ async function generateObject({
           ...prepareCallSettings(settings),
           inputFormat: validatedPrompt.type,
           prompt: convertToLanguageModelPrompt(validatedPrompt),
-          abortSignal
+          abortSignal,
+          headers
         });
       });
       if (generateResult.text === void 0) {
@@ -822,6 +823,7 @@ async function streamObject({
   messages,
   maxRetries,
   abortSignal,
+  headers,
   onFinish,
   ...settings
 }) {
@@ -844,7 +846,8 @@ async function streamObject({
         ...prepareCallSettings(settings),
         inputFormat: validatedPrompt.type,
         prompt: convertToLanguageModelPrompt(validatedPrompt),
-        abortSignal
+        abortSignal,
+        headers
       };
       transformer = {
         transform: (chunk, controller) => {
@@ -872,7 +875,8 @@ async function streamObject({
         ...prepareCallSettings(settings),
         inputFormat: validatedPrompt.type,
         prompt: convertToLanguageModelPrompt(validatedPrompt),
-        abortSignal
+        abortSignal,
+        headers
       };
       transformer = {
         transform: (chunk, controller) => {
@@ -908,7 +912,8 @@ async function streamObject({
         ...prepareCallSettings(settings),
         inputFormat: validatedPrompt.type,
         prompt: convertToLanguageModelPrompt(validatedPrompt),
-        abortSignal
+        abortSignal,
+        headers
       };
       transformer = {
         transform(chunk, controller) {
@@ -1229,6 +1234,7 @@ async function generateText({
   messages,
   maxRetries,
   abortSignal,
+  headers,
   maxAutomaticRoundtrips = 0,
   maxToolRoundtrips = maxAutomaticRoundtrips,
   ...settings
@@ -1255,7 +1261,8 @@ async function generateText({
         // once we have a roundtrip, we need to switch to messages format:
         inputFormat: roundtrips === 0 ? validatedPrompt.type : "messages",
         prompt: promptMessages,
-        abortSignal
+        abortSignal,
+        headers
       });
     });
     currentToolCalls = ((_a = currentModelResponse.toolCalls) != null ? _a : []).map(
@@ -1500,6 +1507,7 @@ async function streamText({
   messages,
   maxRetries,
   abortSignal,
+  headers,
   onFinish,
   ...settings
 }) {
@@ -1514,7 +1522,8 @@ async function streamText({
       ...prepareCallSettings(settings),
       inputFormat: validatedPrompt.type,
       prompt: convertToLanguageModelPrompt(validatedPrompt),
-      abortSignal
+      abortSignal,
+      headers
     })
   );
   return new StreamTextResult({