Document HybridParams and InferenceMode

Author: erikeldridge

common/api-review/vertexai.api.md

@@ -502,13 +502,9 @@ export interface ImagenSafetySettings {
 
 // @public
 export interface HybridParams {
-    // (undocumented)
     mode?: InferenceMode;
-    // (undocumented)
     onCloudParams?: ModelParams;
     // Warning: (ae-forgotten-export) The symbol "AILanguageModelCreateOptionsWithSystemPrompt" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
     onDeviceParams?: AILanguageModelCreateOptionsWithSystemPrompt;
 }
 

packages/vertexai/src/types/enums.ts

@@ -246,7 +246,10 @@ export enum Modality {
  * @public
  */
 export enum InferenceMode {
+  // Specifies the SDK should use on-device if possible, or fall back to on-cloud.
   PREFER_ON_DEVICE = 'PREFER_ON_DEVICE',
+  // Specifies the SDK must use on-device or throw.
   ONLY_ON_DEVICE = 'ONLY_ON_DEVICE',
+  // Specifies the SDK must use on-cloud.
   ONLY_ON_CLOUD = 'ONLY_ON_CLOUD'
 }

packages/vertexai/src/types/requests.ts

@@ -221,7 +221,16 @@ export interface FunctionCallingConfig {
  * @public
  */
 export interface HybridParams {
+  /**
+   * Optional. Specifies on-device or on-cloud inference. Defaults to prefer on-device.
+   */
   mode?: InferenceMode;
+  /**
+   * Optional. Specifies advanced params for on-device inference
+   */
   onDeviceParams?: AILanguageModelCreateOptionsWithSystemPrompt;
+  /**
+   * Optional. Specifies advanced params for on-cloud inference.
+   */
   onCloudParams?: ModelParams;
 }