ai 6.0.0-beta.69 → 6.0.0-beta.70

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.0-beta.70
+
+### Patch Changes
+
+- d7bae86: feat(ai): add Output.choice()
+
 ## 6.0.0-beta.69
 
 ### Patch Changes

package/dist/index.d.mts

@@ -672,12 +672,14 @@ interface Output<OUTPUT = any, PARTIAL = any> {
 }
 /**
  * Output specification for text generation.
+ * This is the default output mode that generates plain text.
  *
  * @returns An output specification for generating text.
  */
 declare const text: () => Output<string, string>;
 /**
  * Output specification for typed object generation using schemas.
+ * 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.
  *
@@ -686,18 +688,37 @@ declare const text: () => Output<string, string>;
 declare const object: <OUTPUT>({ schema: inputSchema, }: {
     schema: FlexibleSchema<OUTPUT>;
 }) => Output<OUTPUT, DeepPartial<OUTPUT>>;
+/**
+ * Array output specification for text generation.
+ * When the model generates a text response, it will return an array of elements.
+ *
+ * @param element - The schema of the element to generate.
+ * @returns An output specification for generating an array of elements.
+ */
 declare const array: <ELEMENT>({ element: inputElementSchema, }: {
     element: FlexibleSchema<ELEMENT>;
 }) => Output<Array<ELEMENT>, Array<ELEMENT>>;
+/**
+ * Choice output specification for text generation.
+ * When the model generates a text response, it will return a one of the choice options.
+ *
+ * @param options - The options to choose from.
+ * @returns An output specification for generating a choice.
+ */
+declare const choice: <ELEMENT extends string>({ options: choiceOptions, }: {
+    options: Array<ELEMENT>;
+}) => Output<ELEMENT, ELEMENT>;
 
 type output_Output<OUTPUT = any, PARTIAL = any> = Output<OUTPUT, PARTIAL>;
 declare const output_array: typeof array;
+declare const output_choice: typeof choice;
 declare const output_object: typeof object;
 declare const output_text: typeof text;
 declare namespace output {
   export {
     output_Output as Output,
     output_array as array,
+    output_choice as choice,
     output_object as object,
     output_text as text,
   };

package/dist/index.d.ts

@@ -672,12 +672,14 @@ interface Output<OUTPUT = any, PARTIAL = any> {
 }
 /**
  * Output specification for text generation.
+ * This is the default output mode that generates plain text.
  *
  * @returns An output specification for generating text.
  */
 declare const text: () => Output<string, string>;
 /**
  * Output specification for typed object generation using schemas.
+ * 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.
  *
@@ -686,18 +688,37 @@ declare const text: () => Output<string, string>;
 declare const object: <OUTPUT>({ schema: inputSchema, }: {
     schema: FlexibleSchema<OUTPUT>;
 }) => Output<OUTPUT, DeepPartial<OUTPUT>>;
+/**
+ * Array output specification for text generation.
+ * When the model generates a text response, it will return an array of elements.
+ *
+ * @param element - The schema of the element to generate.
+ * @returns An output specification for generating an array of elements.
+ */
 declare const array: <ELEMENT>({ element: inputElementSchema, }: {
     element: FlexibleSchema<ELEMENT>;
 }) => Output<Array<ELEMENT>, Array<ELEMENT>>;
+/**
+ * Choice output specification for text generation.
+ * When the model generates a text response, it will return a one of the choice options.
+ *
+ * @param options - The options to choose from.
+ * @returns An output specification for generating a choice.
+ */
+declare const choice: <ELEMENT extends string>({ options: choiceOptions, }: {
+    options: Array<ELEMENT>;
+}) => Output<ELEMENT, ELEMENT>;
 
 type output_Output<OUTPUT = any, PARTIAL = any> = Output<OUTPUT, PARTIAL>;
 declare const output_array: typeof array;
+declare const output_choice: typeof choice;
 declare const output_object: typeof object;
 declare const output_text: typeof text;
 declare namespace output {
   export {
     output_Output as Output,
     output_array as array,
+    output_choice as choice,
     output_object as object,
     output_text as text,
   };

package/dist/index.js

@@ -876,7 +876,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.69" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.70" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -9120,6 +9120,7 @@ var DefaultSpeechResult = class {
 var output_exports = {};
 __export(output_exports, {
   array: () => array,
+  choice: () => choice,
   object: () => object,
   text: () => text
 });
@@ -9201,7 +9202,7 @@ var array = ({
   const elementSchema = (0, import_provider_utils29.asSchema)(inputElementSchema);
   return {
     type: "object",
-    // returns a JSON schema that describes an array of elements:
+    // JSON schema that describes an array of elements:
     responseFormat: (0, import_provider_utils29.resolve)(elementSchema.jsonSchema).then((jsonSchema3) => {
       const { $schema, ...itemSchema } = jsonSchema3;
       return {
@@ -9295,6 +9296,82 @@ var array = ({
     }
   };
 };
+var choice = ({
+  options: choiceOptions
+}) => {
+  return {
+    type: "object",
+    // JSON schema that describes an enumeration:
+    responseFormat: Promise.resolve({
+      type: "json",
+      schema: {
+        $schema: "http://json-schema.org/draft-07/schema#",
+        type: "object",
+        properties: {
+          result: { type: "string", enum: choiceOptions }
+        },
+        required: ["result"],
+        additionalProperties: false
+      }
+    }),
+    async parseOutput({ text: text2 }, context) {
+      const parseResult = await (0, import_provider_utils29.safeParseJSON)({ text: text2 });
+      if (!parseResult.success) {
+        throw new NoObjectGeneratedError({
+          message: "No object generated: could not parse the response.",
+          cause: parseResult.error,
+          text: text2,
+          response: context.response,
+          usage: context.usage,
+          finishReason: context.finishReason
+        });
+      }
+      const outerValue = parseResult.value;
+      if (outerValue == null || typeof outerValue !== "object" || !("result" in outerValue) || typeof outerValue.result !== "string" || !choiceOptions.includes(outerValue.result)) {
+        throw new NoObjectGeneratedError({
+          message: "No object generated: response did not match schema.",
+          cause: new import_provider28.TypeValidationError({
+            value: outerValue,
+            cause: "response must be an object that contains a choice value."
+          }),
+          text: text2,
+          response: context.response,
+          usage: context.usage,
+          finishReason: context.finishReason
+        });
+      }
+      return outerValue.result;
+    },
+    async parsePartial({ text: text2 }) {
+      const result = await parsePartialJson(text2);
+      switch (result.state) {
+        case "failed-parse":
+        case "undefined-input": {
+          return void 0;
+        }
+        case "repaired-parse":
+        case "successful-parse": {
+          const outerValue = result.value;
+          if (outerValue == null || typeof outerValue !== "object" || !("result" in outerValue) || typeof outerValue.result !== "string") {
+            return void 0;
+          }
+          const potentialMatches = choiceOptions.filter(
+            (choiceOption) => choiceOption.startsWith(outerValue.result)
+          );
+          if (result.state === "successful-parse") {
+            return potentialMatches.includes(outerValue.result) ? { partial: outerValue.result } : void 0;
+          } else {
+            return potentialMatches.length === 1 ? { partial: potentialMatches[0] } : void 0;
+          }
+        }
+        default: {
+          const _exhaustiveCheck = result.state;
+          throw new Error(`Unsupported parse state: ${_exhaustiveCheck}`);
+        }
+      }
+    }
+  };
+};
 
 // src/generate-text/prune-messages.ts
 function pruneMessages({