🤖 Merge PR DefinitelyTyped#75111 [dom-chromium-ai] Add samplingMode; make it mutually exclusive with topK/temperature by @tomayac

Author: tomayac

types/dom-chromium-ai/dom-chromium-ai-tests.ts

@@ -11,6 +11,22 @@ async function topLevel() {
         initialPrompts: [{ role: "assistant", content: "foo", prefix: true }],
     });
 
+    // samplingMode is valid on its own
+    await LanguageModel.create({ samplingMode: "most-creative" });
+    await LanguageModel.create({ samplingMode: "balanced" });
+
+    await LanguageModel.create({
+        samplingMode: "balanced",
+        // @ts-expect-error - samplingMode and topK/temperature are mutually exclusive.
+        topK: 1,
+    });
+
+    await LanguageModel.create({
+        samplingMode: "balanced",
+        // @ts-expect-error - samplingMode and topK/temperature are mutually exclusive.
+        temperature: 0.5,
+    });
+
     const languageModel = await LanguageModel.create({
         topK: 1,
         temperature: 0,

types/dom-chromium-ai/index.d.ts

@@ -116,25 +116,42 @@ interface LanguageModelParams {
     readonly maxTemperature: number;
 }
 
-interface LanguageModelCreateCoreOptions {
-    /** @deprecated Restricted to web extension contexts only. Use the topK option within LanguageModel.create() is now restricted to web extensions. */
-    topK?: number;
-    /** @deprecated Restricted to web extension contexts only. Use the temperature option within LanguageModel.create() is now restricted to web extensions. */
-    temperature?: number;
-
+type LanguageModelSamplingMode =
+    | "most-predictable"
+    | "predictable"
+    | "balanced"
+    | "creative"
+    | "most-creative";
+
+/**
+ * samplingMode and the raw sampling params (topK, temperature) are mutually exclusive.
+ * Providing both results in a TypeError at runtime.
+ * Note: topK and temperature are only available in Chrome extension contexts (Chrome 151+).
+ */
+type LanguageModelSamplingOptions =
+    | { samplingMode?: LanguageModelSamplingMode; topK?: never; temperature?: never }
+    | {
+        samplingMode?: never;
+        /** @deprecated Restricted to web extension contexts only. */
+        topK?: number;
+        /** @deprecated Restricted to web extension contexts only. */
+        temperature?: number;
+    };
+
+type LanguageModelCreateCoreOptions = {
     expectedInputs?: LanguageModelExpected[];
     expectedOutputs?: LanguageModelExpected[];
     tools?: LanguageModelTool[];
-}
+} & LanguageModelSamplingOptions;
 
-interface LanguageModelCreateOptions extends LanguageModelCreateCoreOptions {
+type LanguageModelCreateOptions = LanguageModelCreateCoreOptions & {
     signal?: AbortSignal;
     monitor?: CreateMonitorCallback;
 
     initialPrompts?:
         | [LanguageModelSystemMessage, ...LanguageModelMessage[]]
         | LanguageModelMessage[];
-}
+};
 
 interface LanguageModelPromptOptions {
     responseConstraint?: Record<string, unknown>;