VinF Hybrid Inference: update docs (#8970)

Author: erikeldridge

common/api-review/firestore.api.md

@@ -375,15 +375,14 @@ export interface LoadBundleTaskProgress {
 export { LogLevel }
 
 // @public
-export interface MemoryCacheSettings {
+export type MemoryCacheSettings = {
     garbageCollector?: MemoryGarbageCollector;
-}
+};
 
 // @public
-export interface MemoryEagerGarbageCollector {
-    // (undocumented)
+export type MemoryEagerGarbageCollector = {
     kind: 'memoryEager';
-}
+};
 
 // @public
 export function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;
@@ -392,19 +391,17 @@ export function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;
 export type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;
 
 // @public
-export interface MemoryLocalCache {
-    // (undocumented)
+export type MemoryLocalCache = {
     kind: 'memory';
-}
+};
 
 // @public
 export function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;
 
 // @public
-export interface MemoryLruGarbageCollector {
-    // (undocumented)
+export type MemoryLruGarbageCollector = {
     kind: 'memoryLru';
-}
+};
 
 // @public
 export function memoryLruGarbageCollector(settings?: {
@@ -494,42 +491,39 @@ export class PersistentCacheIndexManager {
 }
 
 // @public
-export interface PersistentCacheSettings {
+export type PersistentCacheSettings = {
     cacheSizeBytes?: number;
     tabManager?: PersistentTabManager;
-}
+};
 
 // @public
-export interface PersistentLocalCache {
-    // (undocumented)
+export type PersistentLocalCache = {
     kind: 'persistent';
-}
+};
 
 // @public
 export function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;
 
 // @public
-export interface PersistentMultipleTabManager {
-    // (undocumented)
+export type PersistentMultipleTabManager = {
     kind: 'PersistentMultipleTab';
-}
+};
 
 // @public
 export function persistentMultipleTabManager(): PersistentMultipleTabManager;
 
 // @public
-export interface PersistentSingleTabManager {
-    // (undocumented)
+export type PersistentSingleTabManager = {
     kind: 'persistentSingleTab';
-}
+};
 
 // @public
 export function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;
 
 // @public
-export interface PersistentSingleTabManagerSettings {
+export type PersistentSingleTabManagerSettings = {
     forceOwnership?: boolean;
-}
+};
 
 // @public
 export type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

common/api-review/vertexai.api.md

@@ -112,7 +112,8 @@ export class BooleanSchema extends Schema {
 
 // @public
 export class ChatSession {
-    constructor(apiSettings: ApiSettings, model: string, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
+    // Warning: (ae-forgotten-export) The symbol "ChromeAdapter" needs to be exported by the entry point index.d.ts
+    constructor(apiSettings: ApiSettings, model: string, chromeAdapter: ChromeAdapter, params?: StartChatParams | undefined, requestOptions?: RequestOptions | undefined);
     getHistory(): Promise<Content[]>;
     // (undocumented)
     model: string;
@@ -392,8 +393,9 @@ export interface GenerativeContentBlob {
 
 // @public
 export class GenerativeModel extends AIModel {
-    constructor(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions);
+    constructor(ai: AI, modelParams: ModelParams, chromeAdapter: ChromeAdapter, requestOptions?: RequestOptions);
     countTokens(request: CountTokensRequest | string | Array<string | Part>): Promise<CountTokensResponse>;
+    static DEFAULT_HYBRID_IN_CLOUD_MODEL: string;
     generateContent(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentResult>;
     generateContentStream(request: GenerateContentRequest | string | Array<string | Part>): Promise<GenerateContentStreamResult>;
     // (undocumented)
@@ -415,7 +417,7 @@ export class GenerativeModel extends AIModel {
 export function getAI(app?: FirebaseApp, options?: AIOptions): AI;
 
 // @public
-export function getGenerativeModel(ai: AI, modelParams: ModelParams, requestOptions?: RequestOptions): GenerativeModel;
+export function getGenerativeModel(ai: AI, modelParams: ModelParams | HybridParams, requestOptions?: RequestOptions): GenerativeModel;
 
 // @beta
 export function getImagenModel(ai: AI, modelParams: ImagenModelParams, requestOptions?: RequestOptions): ImagenModel;
@@ -547,6 +549,14 @@ export enum HarmSeverity {
     HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSUPPORTED"
 }
 
+// @public
+export interface HybridParams {
+    inCloudParams?: ModelParams;
+    mode: InferenceMode;
+    // Warning: (ae-forgotten-export) The symbol "LanguageModelCreateOptions" needs to be exported by the entry point index.d.ts
+    onDeviceParams?: LanguageModelCreateOptions;
+}
+
 // @beta
 export enum ImagenAspectRatio {
     LANDSCAPE_16x9 = "16:9",
@@ -631,6 +641,9 @@ export interface ImagenSafetySettings {
     safetyFilterLevel?: ImagenSafetyFilterLevel;
 }
 
+// @public
+export type InferenceMode = 'prefer_on_device' | 'only_on_device' | 'only_in_cloud';
+
 // @public
 export interface InlineDataPart {
     // (undocumented)

docs-devsite/_toc.yaml

@@ -245,28 +245,10 @@ toc:
     path: /docs/reference/js/firestore_.loadbundletask.md
   - title: LoadBundleTaskProgress
     path: /docs/reference/js/firestore_.loadbundletaskprogress.md
-  - title: MemoryCacheSettings
-    path: /docs/reference/js/firestore_.memorycachesettings.md
-  - title: MemoryEagerGarbageCollector
-    path: /docs/reference/js/firestore_.memoryeagergarbagecollector.md
-  - title: MemoryLocalCache
-    path: /docs/reference/js/firestore_.memorylocalcache.md
-  - title: MemoryLruGarbageCollector
-    path: /docs/reference/js/firestore_.memorylrugarbagecollector.md
   - title: PersistenceSettings
     path: /docs/reference/js/firestore_.persistencesettings.md
   - title: PersistentCacheIndexManager
     path: /docs/reference/js/firestore_.persistentcacheindexmanager.md
-  - title: PersistentCacheSettings
-    path: /docs/reference/js/firestore_.persistentcachesettings.md
-  - title: PersistentLocalCache
-    path: /docs/reference/js/firestore_.persistentlocalcache.md
-  - title: PersistentMultipleTabManager
-    path: /docs/reference/js/firestore_.persistentmultipletabmanager.md
-  - title: PersistentSingleTabManager
-    path: /docs/reference/js/firestore_.persistentsingletabmanager.md
-  - title: PersistentSingleTabManagerSettings
-    path: /docs/reference/js/firestore_.persistentsingletabmanagersettings.md
   - title: Query
     path: /docs/reference/js/firestore_.query.md
   - title: QueryCompositeFilterConstraint
@@ -482,6 +464,8 @@ toc:
     path: /docs/reference/js/vertexai.aioptions.md
   - title: ArraySchema
     path: /docs/reference/js/vertexai.arrayschema.md
+  - title: Backend
+    path: /docs/reference/js/vertexai.backend.md
   - title: BaseParams
     path: /docs/reference/js/vertexai.baseparams.md
   - title: BooleanSchema
@@ -540,10 +524,14 @@ toc:
     path: /docs/reference/js/vertexai.generativecontentblob.md
   - title: GenerativeModel
     path: /docs/reference/js/vertexai.generativemodel.md
+  - title: GoogleAIBackend
+    path: /docs/reference/js/vertexai.googleaibackend.md
   - title: GroundingAttribution
     path: /docs/reference/js/vertexai.groundingattribution.md
   - title: GroundingMetadata
     path: /docs/reference/js/vertexai.groundingmetadata.md
+  - title: HybridParams
+    path: /docs/reference/js/vertexai.hybridparams.md
   - title: ImagenGCSImage
     path: /docs/reference/js/vertexai.imagengcsimage.md
   - title: ImagenGenerationConfig
@@ -606,6 +594,8 @@ toc:
     path: /docs/reference/js/vertexai.toolconfig.md
   - title: UsageMetadata
     path: /docs/reference/js/vertexai.usagemetadata.md
+  - title: VertexAIBackend
+    path: /docs/reference/js/vertexai.vertexaibackend.md
   - title: VertexAIOptions
     path: /docs/reference/js/vertexai.vertexaioptions.md
   - title: VideoMetadata