Update docs

Author: erikeldridge

common/api-review/vertexai.api.md

@@ -553,8 +553,7 @@ export enum HarmSeverity {
 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;
+    onDeviceParams?: OnDeviceParams;
 }
 
 // @beta
@@ -718,6 +717,18 @@ export interface ObjectSchemaInterface extends SchemaInterface {
     type: SchemaType.OBJECT;
 }
 
+// @public
+export interface OnDeviceParams {
+    // Warning: (ae-forgotten-export) The symbol "LanguageModelCreateOptions" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    createOptions?: LanguageModelCreateOptions;
+    // Warning: (ae-forgotten-export) The symbol "LanguageModelPromptOptions" needs to be exported by the entry point index.d.ts
+    //
+    // (undocumented)
+    promptOptions?: LanguageModelPromptOptions;
+}
+
 // @public
 export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart;
 

docs-devsite/_toc.yaml

@@ -562,6 +562,8 @@ toc:
     path: /docs/reference/js/vertexai.objectschema.md
   - title: ObjectSchemaInterface
     path: /docs/reference/js/vertexai.objectschemainterface.md
+  - title: OnDeviceParams
+    path: /docs/reference/js/vertexai.ondeviceparams.md
   - title: PromptFeedback
     path: /docs/reference/js/vertexai.promptfeedback.md
   - title: RequestOptions

docs-devsite/vertexai.hybridparams.md

@@ -24,7 +24,7 @@ export interface HybridParams
 |  --- | --- | --- |
 |  [inCloudParams](./vertexai.hybridparams.md#hybridparamsincloudparams) | [ModelParams](./vertexai.modelparams.md#modelparams_interface) | Optional. Specifies advanced params for in-cloud inference. |
 |  [mode](./vertexai.hybridparams.md#hybridparamsmode) | [InferenceMode](./vertexai.md#inferencemode) | Specifies on-device or in-cloud inference. Defaults to prefer on-device. |
-|  [onDeviceParams](./vertexai.hybridparams.md#hybridparamsondeviceparams) | LanguageModelCreateOptions | Optional. Specifies advanced params for on-device inference. |
+|  [onDeviceParams](./vertexai.hybridparams.md#hybridparamsondeviceparams) | [OnDeviceParams](./vertexai.ondeviceparams.md#ondeviceparams_interface) | Optional. Specifies advanced params for on-device inference. |
 
 ## HybridParams.inCloudParams
 
@@ -53,5 +53,5 @@ Optional. Specifies advanced params for on-device inference.
 <b>Signature:</b>
 
 ```typescript
-onDeviceParams?: LanguageModelCreateOptions;
+onDeviceParams?: OnDeviceParams;
 ```

docs-devsite/vertexai.md

@@ -108,6 +108,7 @@ The Firebase AI Web SDK.
 |  [ModalityTokenCount](./vertexai.modalitytokencount.md#modalitytokencount_interface) | Represents token counting info for a single modality. |
 |  [ModelParams](./vertexai.modelparams.md#modelparams_interface) | Params passed to [getGenerativeModel()](./vertexai.md#getgenerativemodel_c63f46a)<!-- -->. |
 |  [ObjectSchemaInterface](./vertexai.objectschemainterface.md#objectschemainterface_interface) | Interface for [ObjectSchema](./vertexai.objectschema.md#objectschema_class) class. |
+|  [OnDeviceParams](./vertexai.ondeviceparams.md#ondeviceparams_interface) | Encapsulates configuration for on-device inference. |
 |  [PromptFeedback](./vertexai.promptfeedback.md#promptfeedback_interface) | If the prompt was blocked, this will be populated with <code>blockReason</code> and the relevant <code>safetyRatings</code>. |
 |  [RequestOptions](./vertexai.requestoptions.md#requestoptions_interface) | Params passed to [getGenerativeModel()](./vertexai.md#getgenerativemodel_c63f46a)<!-- -->. |
 |  [RetrievedContextAttribution](./vertexai.retrievedcontextattribution.md#retrievedcontextattribution_interface) |  |

docs-devsite/vertexai.ondeviceparams.md

@@ -0,0 +1,42 @@
+Project: /docs/reference/js/_project.yaml
+Book: /docs/reference/_book.yaml
+page_type: reference
+
+{% comment %}
+DO NOT EDIT THIS FILE!
+This is generated by the JS SDK team, and any local changes will be
+overwritten. Changes should be made in the source code at
+https://github.com/firebase/firebase-js-sdk
+{% endcomment %}
+
+# OnDeviceParams interface
+Encapsulates configuration for on-device inference.
+
+<b>Signature:</b>
+
+```typescript
+export interface OnDeviceParams 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [createOptions](./vertexai.ondeviceparams.md#ondeviceparamscreateoptions) | LanguageModelCreateOptions |  |
+|  [promptOptions](./vertexai.ondeviceparams.md#ondeviceparamspromptoptions) | LanguageModelPromptOptions |  |
+
+## OnDeviceParams.createOptions
+
+<b>Signature:</b>
+
+```typescript
+createOptions?: LanguageModelCreateOptions;
+```
+
+## OnDeviceParams.promptOptions
+
+<b>Signature:</b>
+
+```typescript
+promptOptions?: LanguageModelPromptOptions;
+```

e2e/sample-apps/modular.js

@@ -314,7 +314,7 @@ async function callVertexAI(app) {
   console.log('[VERTEXAI] start');
   const vertexAI = getVertexAI(app);
 
-  const responseSchema = Schema.object({
+  const jsonSchema = Schema.object({
     properties: {
       characters: Schema.array({
         items: Schema.object({
@@ -331,26 +331,24 @@ async function callVertexAI(app) {
   });
 
   const model = getGenerativeModel(vertexAI, {
-    mode: 'prefer_on_device',
-    // mode: 'only_in_cloud'
-  });
-
-  const singleResult = await model.generateContent({
-    generationConfig: {
-      responseMimeType: 'application/json',
-      responseSchema
+    // mode: 'prefer_on_device',
+    mode: 'only_in_cloud',
+    inCloudParams: {
+      generationConfig: {
+        responseMimeType: 'application/json',
+        responseSchema: jsonSchema
+      }
     },
-    contents: [
-      {
-        role: 'user',
-        parts: [
-          {
-            text: "For use in a children's card game, generate 10 animal-based characters."
-          }
-        ]
+    onDeviceParams: {
+      promptOptions: {
+        responseConstraint: jsonSchema
       }
-    ]
+    }
   });
+
+  const singleResult = await model.generateContent(
+    "For use in a children's card game, generate 10 animal-based characters."
+  );
   console.log(`Generated text:`, JSON.parse(singleResult.response.text()));
   console.log(`[VERTEXAI] end`);
 }

packages/vertexai/src/methods/chrome-adapter.test.ts

@@ -86,14 +86,16 @@ describe('ChromeAdapter', () => {
         languageModelProvider,
         'availability'
       ).resolves(Availability.available);
-      const onDeviceParams = {
+      const createOptions = {
         // Explicitly sets expected inputs.
         expectedInputs: [{ type: 'text' }]
       } as LanguageModelCreateOptions;
       const adapter = new ChromeAdapter(
         languageModelProvider,
         'prefer_on_device',
-        onDeviceParams
+        {
+          createOptions
+        }
       );
       await adapter.isAvailable({
         contents: [
@@ -103,7 +105,7 @@ describe('ChromeAdapter', () => {
           }
         ]
       });
-      expect(availabilityStub).to.have.been.calledWith(onDeviceParams);
+      expect(availabilityStub).to.have.been.calledWith(createOptions);
     });
   });
   describe('isAvailable', () => {
@@ -211,20 +213,20 @@ describe('ChromeAdapter', () => {
       const createStub = stub(languageModelProvider, 'create').resolves(
         {} as LanguageModel
       );
-      const expectedOnDeviceParams = {
+      const createOptions = {
         expectedInputs: [{ type: 'image' }]
       } as LanguageModelCreateOptions;
       const adapter = new ChromeAdapter(
         languageModelProvider,
         'prefer_on_device',
-        expectedOnDeviceParams
+        { createOptions }
       );
       expect(
         await adapter.isAvailable({
           contents: [{ role: 'user', parts: [{ text: 'hi' }] }]
         })
       ).to.be.false;
-      expect(createStub).to.have.been.calledOnceWith(expectedOnDeviceParams);
+      expect(createStub).to.have.been.calledOnceWith(createOptions);
     });
     it('avoids redundant downloads', async () => {
       const languageModelProvider = {
@@ -311,21 +313,21 @@ describe('ChromeAdapter', () => {
       );
       const promptOutput = 'hi';
       const promptStub = stub(languageModel, 'prompt').resolves(promptOutput);
-      const expectedOnDeviceParams = {
+      const createOptions = {
         systemPrompt: 'be yourself',
         expectedInputs: [{ type: 'image' }]
       } as LanguageModelCreateOptions;
       const adapter = new ChromeAdapter(
         languageModelProvider,
         'prefer_on_device',
-        expectedOnDeviceParams
+        { createOptions }
       );
       const request = {
         contents: [{ role: 'user', parts: [{ text: 'anything' }] }]
       } as GenerateContentRequest;
       const response = await adapter.generateContent(request);
       // Asserts initialization params are proxied.
-      expect(createStub).to.have.been.calledOnceWith(expectedOnDeviceParams);
+      expect(createStub).to.have.been.calledOnceWith(createOptions);
       // Asserts Vertex input type is mapped to Chrome type.
       expect(promptStub).to.have.been.calledOnceWith([
         {
@@ -357,14 +359,14 @@ describe('ChromeAdapter', () => {
       );
       const promptOutput = 'hi';
       const promptStub = stub(languageModel, 'prompt').resolves(promptOutput);
-      const expectedOnDeviceParams = {
+      const createOptions = {
         systemPrompt: 'be yourself',
         expectedInputs: [{ type: 'image' }]
       } as LanguageModelCreateOptions;
       const adapter = new ChromeAdapter(
         languageModelProvider,
         'prefer_on_device',
-        expectedOnDeviceParams
+        { createOptions }
       );
       const request = {
         contents: [
@@ -384,7 +386,7 @@ describe('ChromeAdapter', () => {
       } as GenerateContentRequest;
       const response = await adapter.generateContent(request);
       // Asserts initialization params are proxied.
-      expect(createStub).to.have.been.calledOnceWith(expectedOnDeviceParams);
+      expect(createStub).to.have.been.calledOnceWith(createOptions);
       // Asserts Vertex input type is mapped to Chrome type.
       expect(promptStub).to.have.been.calledOnceWith([
         {
@@ -407,7 +409,7 @@ describe('ChromeAdapter', () => {
         ]
       });
     });
-    it('supports structured output by mapping responseSchema to responseConstraint', async () => {
+    it('honors prompt options', async () => {
       const languageModel = {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         prompt: (p: LanguageModelMessageContent[]) => Promise.resolve('')
@@ -417,17 +419,17 @@ describe('ChromeAdapter', () => {
       } as LanguageModel;
       const promptOutput = '{}';
       const promptStub = stub(languageModel, 'prompt').resolves(promptOutput);
+      const promptOptions = {
+        responseConstraint: Schema.object({
+          properties: {}
+        })
+      };
       const adapter = new ChromeAdapter(
         languageModelProvider,
-        'prefer_on_device'
+        'prefer_on_device',
+        { promptOptions }
       );
-      const responseSchema = Schema.object({
-        properties: {}
-      });
       const request = {
-        generationConfig: {
-          responseSchema
-        },
         contents: [{ role: 'user', parts: [{ text: 'anything' }] }]
       } as GenerateContentRequest;
       await adapter.generateContent(request);
@@ -438,9 +440,7 @@ describe('ChromeAdapter', () => {
             content: request.contents[0].parts[0].text
           }
         ],
-        {
-          responseConstraint: responseSchema
-        }
+        promptOptions
       );
     });
   });
@@ -499,19 +499,19 @@ describe('ChromeAdapter', () => {
           }
         })
       );
-      const expectedOnDeviceParams = {
+      const createOptions = {
         expectedInputs: [{ type: 'image' }]
       } as LanguageModelCreateOptions;
       const adapter = new ChromeAdapter(
         languageModelProvider,
         'prefer_on_device',
-        expectedOnDeviceParams
+        { createOptions }
       );
       const request = {
         contents: [{ role: 'user', parts: [{ text: 'anything' }] }]
       } as GenerateContentRequest;
       const response = await adapter.generateContentStream(request);
-      expect(createStub).to.have.been.calledOnceWith(expectedOnDeviceParams);
+      expect(createStub).to.have.been.calledOnceWith(createOptions);
       expect(promptStub).to.have.been.calledOnceWith([
         {
           type: 'text',
@@ -542,13 +542,13 @@ describe('ChromeAdapter', () => {
           }
         })
       );
-      const expectedOnDeviceParams = {
+      const createOptions = {
         expectedInputs: [{ type: 'image' }]
       } as LanguageModelCreateOptions;
       const adapter = new ChromeAdapter(
         languageModelProvider,
         'prefer_on_device',
-        expectedOnDeviceParams
+        { createOptions }
       );
       const request = {
         contents: [
@@ -567,7 +567,7 @@ describe('ChromeAdapter', () => {
         ]
       } as GenerateContentRequest;
       const response = await adapter.generateContentStream(request);
-      expect(createStub).to.have.been.calledOnceWith(expectedOnDeviceParams);
+      expect(createStub).to.have.been.calledOnceWith(createOptions);
       expect(promptStub).to.have.been.calledOnceWith([
         {
           type: 'text',
@@ -583,7 +583,7 @@ describe('ChromeAdapter', () => {
         `data: {"candidates":[{"content":{"role":"model","parts":[{"text":["${part}"]}]}}]}\n\n`
       ]);
     });
-    it('supports structured output by mapping responseSchema to responseConstraint', async () => {
+    it('honors prompt options', async () => {
       const languageModel = {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         promptStreaming: p => new ReadableStream()
@@ -594,17 +594,17 @@ describe('ChromeAdapter', () => {
       const promptStub = stub(languageModel, 'promptStreaming').returns(
         new ReadableStream()
       );
+      const promptOptions = {
+        responseConstraint: Schema.object({
+          properties: {}
+        })
+      };
       const adapter = new ChromeAdapter(
         languageModelProvider,
-        'prefer_on_device'
+        'prefer_on_device',
+        { promptOptions }
       );
-      const responseSchema = Schema.object({
-        properties: {}
-      });
       const request = {
-        generationConfig: {
-          responseSchema
-        },
         contents: [{ role: 'user', parts: [{ text: 'anything' }] }]
       } as GenerateContentRequest;
       await adapter.generateContentStream(request);
@@ -615,9 +615,7 @@ describe('ChromeAdapter', () => {
             content: request.contents[0].parts[0].text
           }
         ],
-        {
-          responseConstraint: responseSchema
-        }
+        promptOptions
       );
     });
   });