types/schema.ts

Author: russellwheatley

packages/ai/lib/types/schema.ts

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 /**
  * Contains the list of OpenAPI data types
  * as defined by the
@@ -36,40 +37,59 @@ export enum SchemaType {
 }
 
 /**
- * Basic <code>{@link Schema}</code> properties shared across several Schema-related
+ * Basic {@link Schema} properties shared across several Schema-related
  * types.
  * @public
  */
 export interface SchemaShared<T> {
-  /** Optional. The format of the property. */
+  /** Optional. The format of the property.
+   * When using the Gemini Developer API ({@link GoogleAIBackend}), this must be either `'enum'` or
+   * `'date-time'`, otherwise requests will fail.
+   */
   format?: string;
   /** Optional. The description of the property. */
   description?: string;
+  /**
+   * The title of the property. This helps document the schema's purpose but does not typically
+   * constrain the generated value. It can subtly guide the model by clarifying the intent of a
+   * field.
+   */
+  title?: string;
   /** Optional. The items of the property. */
   items?: T;
+  /** The minimum number of items (elements) in a schema of type {@link SchemaType.ARRAY}. */
+  minItems?: number;
+  /** The maximum number of items (elements) in a schema of type {@link SchemaType.ARRAY}. */
+  maxItems?: number;
   /** Optional. Map of `Schema` objects. */
   properties?: {
     [k: string]: T;
   };
+  /** A hint suggesting the order in which the keys should appear in the generated JSON string. */
+  propertyOrdering?: string[];
   /** Optional. The enum of the property. */
   enum?: string[];
   /** Optional. The example of the property. */
   example?: unknown;
   /** Optional. Whether the property is nullable. */
   nullable?: boolean;
+  /** The minimum value of a numeric type. */
+  minimum?: number;
+  /** The maximum value of a numeric type. */
+  maximum?: number;
   [key: string]: unknown;
 }
 
 /**
- * Params passed to <code>{@link Schema}</code> static methods to create specific
- * <code>{@link Schema}</code> classes.
+ * Params passed to {@link Schema} static methods to create specific
+ * {@link Schema} classes.
  * @public
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface SchemaParams extends SchemaShared<SchemaInterface> {}
 
 /**
- * Final format for <code>{@link Schema}</code> params passed to backend requests.
+ * Final format for {@link Schema} params passed to backend requests.
  * @public
  */
 export interface SchemaRequest extends SchemaShared<SchemaRequest> {
@@ -83,7 +103,7 @@ export interface SchemaRequest extends SchemaShared<SchemaRequest> {
 }
 
 /**
- * Interface for <code>{@link Schema}</code> class.
+ * Interface for {@link Schema} class.
  * @public
  */
 export interface SchemaInterface extends SchemaShared<SchemaInterface> {
@@ -95,7 +115,7 @@ export interface SchemaInterface extends SchemaShared<SchemaInterface> {
 }
 
 /**
- * Interface for <code>{@link ObjectSchema}</code> class.
+ * Interface for {@link ObjectSchema} class.
  * @public
  */
 export interface ObjectSchemaInterface extends SchemaInterface {