@ai-sdk/google 4.0.0-canary.69 → 4.0.0-canary.71

package/docs/15-google.mdx

@@ -240,8 +240,14 @@ The following optional provider options are available for Google models:
 - **serviceTier** _'standard' | 'flex' | 'priority'_
 
   Optional. The service tier to use for the request.
-  Set to 'flex' for 50% cheaper processing at the cost of increased latency.
-  Set to 'priority' for ultra-low latency at a 75-100% price premium over 'standard'.
+  Set to `'flex'` for 50% cheaper processing at the cost of increased latency.
+  Set to `'priority'` for ultra-low latency at a 75-100% price premium over `'standard'`.
+
+  Because Priority can be gracefully downgraded to Standard under load, the
+  tier the request actually ran on is surfaced on
+  `result.providerMetadata.google.serviceTier`. See
+  [Priority inference](https://ai.google.dev/gemini-api/docs/priority-inference)
+  and [Flex inference](https://ai.google.dev/gemini-api/docs/flex-inference).
 
 - **threshold** _string_
 
@@ -1545,9 +1551,10 @@ Agents also chain through `previousInteractionId` like model-id calls.
 
 ### Managed Agents
 
-Managed agents run inside a sandboxed Linux environment provisioned per
-interaction. Pass the `environment` provider option to control how the
-sandbox is set up; the option is only accepted on agent calls.
+[Managed agents](https://ai.google.dev/gemini-api/docs/agents) run inside a
+sandboxed Linux environment provisioned per interaction. Pass the `environment`
+provider option to control how the sandbox is set up; the option is only
+accepted on agent calls.
 
 The simplest form provisions a fresh sandbox:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/google",
-  "version": "4.0.0-canary.69",
+  "version": "4.0.0-canary.71",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,

package/src/convert-google-usage.ts

@@ -12,6 +12,7 @@ export type GoogleUsageMetadata = {
   cachedContentTokenCount?: number | null;
   thoughtsTokenCount?: number | null;
   trafficType?: string | null;
+  serviceTier?: string | null;
   promptTokensDetails?: GoogleTokenDetail[] | null;
   candidatesTokensDetails?: GoogleTokenDetail[] | null;
 };

package/src/google-language-model-options.ts

@@ -207,9 +207,31 @@ export const googleLanguageModelOptions = lazySchema(() =>
       streamFunctionCallArguments: z.boolean().optional(),
 
       /**
-       * Optional. The service tier to use for the request.
+       * Optional. The service tier to use for the request. Sent as the
+       * `serviceTier` body field. Gemini API only.
        */
       serviceTier: z.enum(['standard', 'flex', 'priority']).optional(),
+
+      /**
+       * Optional. Vertex AI only. Sent as the
+       * `X-Vertex-AI-LLM-Shared-Request-Type` request header to select a
+       * shared (PayGo) tier. With Provisioned Throughput allocated and
+       * `requestType` unset, the request falls back to this tier only if
+       * PT capacity is exhausted.
+       *
+       * https://docs.cloud.google.com/vertex-ai/generative-ai/docs/priority-paygo
+       * https://docs.cloud.google.com/vertex-ai/generative-ai/docs/flex-paygo
+       */
+      sharedRequestType: z.enum(['priority', 'flex', 'standard']).optional(),
+
+      /**
+       * Optional. Vertex AI only. Sent as the `X-Vertex-AI-LLM-Request-Type`
+       * request header. Set to `'shared'` together with `sharedRequestType`
+       * to bypass Provisioned Throughput entirely.
+       *
+       * https://docs.cloud.google.com/vertex-ai/generative-ai/docs/priority-paygo
+       */
+      requestType: z.enum(['shared']).optional(),
     }),
   ),
 );
@@ -217,10 +239,3 @@ export const googleLanguageModelOptions = lazySchema(() =>
 export type GoogleLanguageModelOptions = InferSchema<
   typeof googleLanguageModelOptions
 >;
-
-// Vertex API requires another service tier format.
-export const VertexServiceTierMap = {
-  standard: 'SERVICE_TIER_STANDARD',
-  flex: 'SERVICE_TIER_FLEX',
-  priority: 'SERVICE_TIER_PRIORITY',
-} as const;

package/src/google-language-model.ts

@@ -43,7 +43,6 @@ import { getModelPath } from './get-model-path';
 import { googleFailedResponseHandler } from './google-error';
 import {
   googleLanguageModelOptions,
-  VertexServiceTierMap,
   type GoogleLanguageModelOptions,
   type GoogleModelId,
 } from './google-language-model-options';
@@ -183,11 +182,43 @@ export class GoogleLanguageModel implements LanguageModelV4 {
       });
     }
 
-    // Vertex API requires another service tier format.
-    let sanitizedServiceTier: string | undefined = googleOptions?.serviceTier;
     if (googleOptions?.serviceTier && isVertexProvider) {
-      sanitizedServiceTier = VertexServiceTierMap[googleOptions.serviceTier];
+      warnings.push({
+        type: 'other',
+        message:
+          "'serviceTier' is a Gemini API option and is not supported on Vertex AI. " +
+          "Use 'sharedRequestType' (and optionally 'requestType') instead. See " +
+          'https://docs.cloud.google.com/vertex-ai/generative-ai/docs/priority-paygo',
+      });
     }
+    if (
+      (googleOptions?.sharedRequestType || googleOptions?.requestType) &&
+      !isVertexProvider
+    ) {
+      warnings.push({
+        type: 'other',
+        message:
+          "'sharedRequestType' and 'requestType' are Vertex AI options and " +
+          `are ignored with the current Google provider (${this.config.provider}).`,
+      });
+    }
+
+    const vertexPaygoHeaders: Record<string, string> | undefined =
+      isVertexProvider &&
+      (googleOptions?.sharedRequestType || googleOptions?.requestType)
+        ? {
+            ...(googleOptions.sharedRequestType && {
+              'X-Vertex-AI-LLM-Shared-Request-Type':
+                googleOptions.sharedRequestType,
+            }),
+            ...(googleOptions.requestType && {
+              'X-Vertex-AI-LLM-Request-Type': googleOptions.requestType,
+            }),
+          }
+        : undefined;
+    const bodyServiceTier = isVertexProvider
+      ? undefined
+      : googleOptions?.serviceTier;
 
     const isGemmaModel = this.modelId.toLowerCase().startsWith('gemma-');
     const supportsFunctionResponseParts = this.modelId.startsWith('gemini-3');
@@ -288,17 +319,18 @@ export class GoogleLanguageModel implements LanguageModelV4 {
         toolConfig,
         cachedContent: googleOptions?.cachedContent,
         labels: googleOptions?.labels,
-        serviceTier: sanitizedServiceTier,
+        serviceTier: bodyServiceTier,
       },
       warnings: [...warnings, ...toolWarnings],
       providerOptionsNames,
+      extraHeaders: vertexPaygoHeaders,
     };
   }
 
   async doGenerate(
     options: LanguageModelV4CallOptions,
   ): Promise<LanguageModelV4GenerateResult> {
-    const { args, warnings, providerOptionsNames } =
+    const { args, warnings, providerOptionsNames, extraHeaders } =
       await this.getArgs(options);
     const wrapProviderMetadata = (payload: Record<string, unknown>) =>
       Object.fromEntries(
@@ -308,6 +340,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     const mergedHeaders = combineHeaders(
       this.config.headers ? await resolve(this.config.headers) : undefined,
       options.headers,
+      extraHeaders,
     );
 
     const {
@@ -485,7 +518,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
         safetyRatings: candidate.safetyRatings ?? null,
         usageMetadata: usageMetadata ?? null,
         finishMessage: candidate.finishMessage ?? null,
-        serviceTier: response.serviceTier ?? null,
+        serviceTier: usageMetadata?.serviceTier ?? null,
       } satisfies GoogleProviderMetadata),
       request: { body: args },
       response: {
@@ -499,10 +532,8 @@ export class GoogleLanguageModel implements LanguageModelV4 {
   async doStream(
     options: LanguageModelV4CallOptions,
   ): Promise<LanguageModelV4StreamResult> {
-    const { args, warnings, providerOptionsNames } = await this.getArgs(
-      options,
-      { isStreaming: true },
-    );
+    const { args, warnings, providerOptionsNames, extraHeaders } =
+      await this.getArgs(options, { isStreaming: true });
     const wrapProviderMetadata = (payload: Record<string, unknown>) =>
       Object.fromEntries(
         providerOptionsNames.map(name => [name, payload]),
@@ -511,6 +542,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     const headers = combineHeaders(
       this.config.headers ? await resolve(this.config.headers) : undefined,
       options.headers,
+      extraHeaders,
     );
 
     const { responseHeaders, value: response } = await postJsonToApi({
@@ -533,7 +565,6 @@ export class GoogleLanguageModel implements LanguageModelV4 {
     let providerMetadata: SharedV4ProviderMetadata | undefined = undefined;
     let lastGroundingMetadata: GroundingMetadataSchema | null = null;
     let lastUrlContextMetadata: UrlContextMetadataSchema | null = null;
-    let serviceTier: string | null = null;
 
     const generateId = this.config.generateId;
     let hasToolCalls = false;
@@ -621,10 +652,6 @@ export class GoogleLanguageModel implements LanguageModelV4 {
               usage = usageMetadata;
             }
 
-            if (value.serviceTier != null) {
-              serviceTier = value.serviceTier;
-            }
-
             const candidate = value.candidates?.[0];
 
             // sometimes the API returns an empty candidates array
@@ -1022,7 +1049,7 @@ export class GoogleLanguageModel implements LanguageModelV4 {
                 safetyRatings: candidate.safetyRatings ?? null,
                 usageMetadata: usageMetadata ?? null,
                 finishMessage: candidate.finishMessage ?? null,
-                serviceTier,
+                serviceTier: usage?.serviceTier ?? null,
               } satisfies GoogleProviderMetadata);
             }
           },
@@ -1435,6 +1462,7 @@ const usageSchema = z.object({
   totalTokenCount: z.number().nullish(),
   // https://cloud.google.com/vertex-ai/generative-ai/docs/reference/rest/v1/GenerateContentResponse#TrafficType
   trafficType: z.string().nullish(),
+  serviceTier: z.string().nullish(),
   // https://ai.google.dev/api/generate-content#Modality
   promptTokensDetails: tokenDetailsSchema,
   candidatesTokensDetails: tokenDetailsSchema,
@@ -1473,7 +1501,6 @@ const responseSchema = lazySchema(() =>
           safetyRatings: z.array(getSafetyRatingSchema()).nullish(),
         })
         .nullish(),
-      serviceTier: z.string().nullish(),
     }),
   ),
 );
@@ -1522,7 +1549,6 @@ const chunkSchema = lazySchema(() =>
           safetyRatings: z.array(getSafetyRatingSchema()).nullish(),
         })
         .nullish(),
-      serviceTier: z.string().nullish(),
     }),
   ),
 );