ai 6.0.0-beta.148 → 6.0.0-beta.150

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 6.0.0-beta.150
+
+### Patch Changes
+
+- db62f7d: Added schema name and description for generateText and output
+
+## 6.0.0-beta.149
+
+### Patch Changes
+
+- 4e2b04d: fix(gateway): throw error with user-friendly message in non-production environments if `AI_GATEWAY_API_KEY` is not configured
+
 ## 6.0.0-beta.148
 
 ### Patch Changes

package/dist/index.d.mts

@@ -603,41 +603,91 @@ declare const text: () => Output<string, string>;
  * When the model generates a text response, it will return an object that matches the schema.
  *
  * @param schema - The schema of the object to generate.
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
  *
  * @returns An output specification for generating objects with the specified schema.
  */
-declare const object: <OBJECT>({ schema: inputSchema, }: {
+declare const object: <OBJECT>({ schema: inputSchema, name, description, }: {
     schema: FlexibleSchema<OBJECT>;
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
 }) => Output<OBJECT, DeepPartial<OBJECT>>;
 /**
  * Output specification for array generation.
  * When the model generates a text response, it will return an array of elements.
  *
  * @param element - The schema of the array elements to generate.
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
  *
  * @returns An output specification for generating an array of elements.
  */
-declare const array: <ELEMENT>({ element: inputElementSchema, }: {
+declare const array: <ELEMENT>({ element: inputElementSchema, name, description, }: {
     element: FlexibleSchema<ELEMENT>;
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
 }) => Output<Array<ELEMENT>, Array<ELEMENT>>;
 /**
  * Output specification for choice generation.
  * When the model generates a text response, it will return a one of the choice options.
  *
  * @param options - The available choices.
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
  *
  * @returns An output specification for generating a choice.
  */
-declare const choice: <CHOICE extends string>({ options: choiceOptions, }: {
+declare const choice: <CHOICE extends string>({ options: choiceOptions, name, description, }: {
     options: Array<CHOICE>;
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
 }) => Output<CHOICE, CHOICE>;
 /**
  * Output specification for unstructured JSON generation.
  * When the model generates a text response, it will return a JSON object.
  *
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+ *
  * @returns An output specification for generating JSON.
  */
-declare const json: () => Output<JSONValue$1, JSONValue$1>;
+declare const json: ({ name, description, }?: {
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
+}) => Output<JSONValue$1, JSONValue$1>;
 
 type output_Output<OUTPUT = any, PARTIAL = any> = Output<OUTPUT, PARTIAL>;
 declare const output_array: typeof array;

package/dist/index.d.ts

@@ -603,41 +603,91 @@ declare const text: () => Output<string, string>;
  * When the model generates a text response, it will return an object that matches the schema.
  *
  * @param schema - The schema of the object to generate.
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
  *
  * @returns An output specification for generating objects with the specified schema.
  */
-declare const object: <OBJECT>({ schema: inputSchema, }: {
+declare const object: <OBJECT>({ schema: inputSchema, name, description, }: {
     schema: FlexibleSchema<OBJECT>;
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
 }) => Output<OBJECT, DeepPartial<OBJECT>>;
 /**
  * Output specification for array generation.
  * When the model generates a text response, it will return an array of elements.
  *
  * @param element - The schema of the array elements to generate.
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
  *
  * @returns An output specification for generating an array of elements.
  */
-declare const array: <ELEMENT>({ element: inputElementSchema, }: {
+declare const array: <ELEMENT>({ element: inputElementSchema, name, description, }: {
     element: FlexibleSchema<ELEMENT>;
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
 }) => Output<Array<ELEMENT>, Array<ELEMENT>>;
 /**
  * Output specification for choice generation.
  * When the model generates a text response, it will return a one of the choice options.
  *
  * @param options - The available choices.
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
  *
  * @returns An output specification for generating a choice.
  */
-declare const choice: <CHOICE extends string>({ options: choiceOptions, }: {
+declare const choice: <CHOICE extends string>({ options: choiceOptions, name, description, }: {
     options: Array<CHOICE>;
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
 }) => Output<CHOICE, CHOICE>;
 /**
  * Output specification for unstructured JSON generation.
  * When the model generates a text response, it will return a JSON object.
  *
+ * @param name - Optional name of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+ * @param description - Optional description of the output that should be generated. Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+ *
  * @returns An output specification for generating JSON.
  */
-declare const json: () => Output<JSONValue$1, JSONValue$1>;
+declare const json: ({ name, description, }?: {
+    /**
+     * Optional name of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema name.
+     */
+    name?: string;
+    /**
+     * Optional description of the output that should be generated.
+     * Used by some providers for additional LLM guidance, e.g. via tool or schema description.
+     */
+    description?: string;
+}) => Output<JSONValue$1, JSONValue$1>;
 
 type output_Output<OUTPUT = any, PARTIAL = any> = Output<OUTPUT, PARTIAL>;
 declare const output_array: typeof array;

package/dist/index.js

@@ -962,7 +962,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.148" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.150" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -1817,14 +1817,28 @@ async function standardizePrompt(prompt) {
 var import_gateway2 = require("@ai-sdk/gateway");
 var import_provider20 = require("@ai-sdk/provider");
 function wrapGatewayError(error) {
-  if (import_gateway2.GatewayAuthenticationError.isInstance(error) || import_gateway2.GatewayModelNotFoundError.isInstance(error)) {
+  if (!import_gateway2.GatewayAuthenticationError.isInstance(error))
+    return error;
+  const isProductionEnv = (process == null ? void 0 : process.env.NODE_ENV) === "production";
+  const moreInfoURL = "https://v6.ai-sdk.dev/unauthenticated-ai-gateway";
+  if (isProductionEnv) {
     return new import_provider20.AISDKError({
       name: "GatewayError",
-      message: "Unauthenticated. Configure AI_GATEWAY_API_KEY or configure and use a provider module. Learn more: https://vercel.link/unauthenticated-ai-gateway-v6",
-      cause: error
+      message: `Unauthenticated. Configure AI_GATEWAY_API_KEY or use a provider module. Learn more: ${moreInfoURL}`
     });
   }
-  return error;
+  return Object.assign(
+    new Error(`\x1B[1m\x1B[31mUnauthenticated request to AI Gateway.\x1B[0m
+
+To authenticate, set the \x1B[33mAI_GATEWAY_API_KEY\x1B[0m environment variable with your API key.
+
+Alternatively, you can use a provider module instead of the AI Gateway.
+
+Learn more: \x1B[34m${moreInfoURL}\x1B[0m
+
+`),
+    { name: "GatewayAuthenticationError" }
+  );
 }
 
 // src/telemetry/assemble-operation-name.ts
@@ -2855,13 +2869,17 @@ var text = () => ({
   }
 });
 var object = ({
-  schema: inputSchema
+  schema: inputSchema,
+  name: name15,
+  description
 }) => {
   const schema = (0, import_provider_utils11.asSchema)(inputSchema);
   return {
     responseFormat: (0, import_provider_utils11.resolve)(schema.jsonSchema).then((jsonSchema2) => ({
       type: "json",
-      schema: jsonSchema2
+      schema: jsonSchema2,
+      ...name15 != null && { name: name15 },
+      ...description != null && { description }
     })),
     async parseCompleteOutput({ text: text2 }, context) {
       const parseResult = await (0, import_provider_utils11.safeParseJSON)({ text: text2 });
@@ -2910,7 +2928,9 @@ var object = ({
   };
 };
 var array = ({
-  element: inputElementSchema
+  element: inputElementSchema,
+  name: name15,
+  description
 }) => {
   const elementSchema = (0, import_provider_utils11.asSchema)(inputElementSchema);
   return {
@@ -2927,7 +2947,9 @@ var array = ({
           },
           required: ["elements"],
           additionalProperties: false
-        }
+        },
+        ...name15 != null && { name: name15 },
+        ...description != null && { description }
       };
     }),
     async parseCompleteOutput({ text: text2 }, context) {
@@ -3005,7 +3027,9 @@ var array = ({
   };
 };
 var choice = ({
-  options: choiceOptions
+  options: choiceOptions,
+  name: name15,
+  description
 }) => {
   return {
     // JSON schema that describes an enumeration:
@@ -3019,7 +3043,9 @@ var choice = ({
         },
         required: ["result"],
         additionalProperties: false
-      }
+      },
+      ...name15 != null && { name: name15 },
+      ...description != null && { description }
     }),
     async parseCompleteOutput({ text: text2 }, context) {
       const parseResult = await (0, import_provider_utils11.safeParseJSON)({ text: text2 });
@@ -3075,10 +3101,15 @@ var choice = ({
     }
   };
 };
-var json = () => {
+var json = ({
+  name: name15,
+  description
+} = {}) => {
   return {
     responseFormat: Promise.resolve({
-      type: "json"
+      type: "json",
+      ...name15 != null && { name: name15 },
+      ...description != null && { description }
     }),
     async parseCompleteOutput({ text: text2 }, context) {
       const parseResult = await (0, import_provider_utils11.safeParseJSON)({ text: text2 });