Docs and naming changes

Author: dlarocque

common/api-review/ai.api.md

@@ -705,35 +705,32 @@ export class IntegerSchema extends Schema {
     constructor(schemaParams?: SchemaParams);
 }
 
-// Warning: (ae-internal-missing-underscore) The name "LiveClientContent" should be prefixed with an underscore because the declaration is marked as @internal
-//
 // @internal
-export interface LiveClientContent {
+export interface _LiveClientContent {
     // (undocumented)
     clientContent: {
         turns: [Content];
         turnComplete: boolean;
     };
 }
 
-// Warning: (ae-internal-missing-underscore) The name "LiveClientRealtimeInput" should be prefixed with an underscore because the declaration is marked as @internal
-//
 // @internal
-export interface LiveClientRealtimeInput {
+export interface _LiveClientRealtimeInput {
     // (undocumented)
     realtimeInput: {
         mediaChunks: GenerativeContentBlob[];
     };
 }
 
-// Warning: (ae-internal-missing-underscore) The name "LiveClientSetup" should be prefixed with an underscore because the declaration is marked as @internal
-//
 // @internal
-export interface LiveClientSetup {
+export interface _LiveClientSetup {
     // (undocumented)
     setup: {
         model: string;
         generationConfig?: LiveGenerationConfig;
+        tools?: Tool[];
+        toolConfig?: ToolConfig;
+        systemInstruction?: string | Part | Content;
     };
 }
 
@@ -752,8 +749,11 @@ export interface LiveGenerationConfig {
 
 // @beta
 export class LiveGenerativeModel extends AIModel {
+    // Warning: (ae-forgotten-export) The symbol "WebSocketHandler" needs to be exported by the entry point index.d.ts
+    //
     // @internal
-    constructor(ai: AI, modelParams: LiveModelParams, _webSocketHandler: WebSocketHandler);
+    constructor(ai: AI, modelParams: LiveModelParams,
+    _webSocketHandler: WebSocketHandler);
     connect(): Promise<LiveSession>;
     // (undocumented)
     generationConfig: LiveGenerationConfig;
@@ -763,11 +763,7 @@ export class LiveGenerativeModel extends AIModel {
     toolConfig?: ToolConfig;
     // (undocumented)
     tools?: Tool[];
-    // Warning: (ae-forgotten-export) The symbol "WebSocketHandler" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    _webSocketHandler: WebSocketHandler;
-}
+    }
 
 // @beta
 export interface LiveModelParams {

docs-devsite/ai.livegenerativemodel.md

@@ -30,7 +30,6 @@ export declare class LiveGenerativeModel extends AIModel
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [\_webSocketHandler](./ai.livegenerativemodel.md#livegenerativemodel_websockethandler) |  | WebSocketHandler | <b><i>(Public Preview)</i></b> |
 |  [generationConfig](./ai.livegenerativemodel.md#livegenerativemodelgenerationconfig) |  | [LiveGenerationConfig](./ai.livegenerationconfig.md#livegenerationconfig_interface) | <b><i>(Public Preview)</i></b> |
 |  [systemInstruction](./ai.livegenerativemodel.md#livegenerativemodelsysteminstruction) |  | [Content](./ai.content.md#content_interface) | <b><i>(Public Preview)</i></b> |
 |  [toolConfig](./ai.livegenerativemodel.md#livegenerativemodeltoolconfig) |  | [ToolConfig](./ai.toolconfig.md#toolconfig_interface) | <b><i>(Public Preview)</i></b> |
@@ -42,17 +41,6 @@ export declare class LiveGenerativeModel extends AIModel
 |  --- | --- | --- |
 |  [connect()](./ai.livegenerativemodel.md#livegenerativemodelconnect) |  | <b><i>(Public Preview)</i></b> Starts a [LiveSession](./ai.livesession.md#livesession_class)<!-- -->. |
 
-## LiveGenerativeModel.\_webSocketHandler
-
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-<b>Signature:</b>
-
-```typescript
-_webSocketHandler: WebSocketHandler;
-```
-
 ## LiveGenerativeModel.generationConfig
 
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

packages/ai/src/methods/live-session.ts

@@ -18,8 +18,8 @@
 import {
   AIErrorCode,
   GenerativeContentBlob,
-  LiveClientContent,
-  LiveClientRealtimeInput,
+  _LiveClientContent,
+  _LiveClientRealtimeInput,
   LiveResponseType,
   LiveServerContent,
   LiveServerToolCall,
@@ -76,7 +76,7 @@ export class LiveSession {
 
     const newContent = formatNewContent(request);
 
-    const message: LiveClientContent = {
+    const message: _LiveClientContent = {
       clientContent: {
         turns: [newContent],
         turnComplete
@@ -101,7 +101,7 @@ export class LiveSession {
       );
     }
 
-    const message: LiveClientRealtimeInput = {
+    const message: _LiveClientRealtimeInput = {
       realtimeInput: { mediaChunks }
     };
     this.webSocketHandler.send(JSON.stringify(message));

packages/ai/src/models/index.ts

@@ -17,5 +17,5 @@
 
 export * from './ai-model';
 export * from './generative-model';
-export * from './live-model';
+export * from './live-generative-model';
 export * from './imagen-model';

packages/ai/src/models/live-model.test.ts renamed to packages/ai/src/models/live-generative-model.test.ts

@@ -22,7 +22,7 @@ import { AI } from '../public-types';
 import { LiveSession } from '../methods/live-session';
 import { WebSocketHandler } from '../platform/websocket';
 import { GoogleAIBackend } from '../backend';
-import { LiveGenerativeModel } from './live-model';
+import { LiveGenerativeModel } from './live-generative-model';
 import { AIError } from '../errors';
 
 use(sinonChai);

packages/ai/src/models/live-model.ts renamed to packages/ai/src/models/live-generative-model.ts

@@ -26,7 +26,8 @@ import {
   LiveGenerationConfig,
   LiveModelParams,
   Tool,
-  ToolConfig
+  ToolConfig,
+  _LiveClientSetup
 } from '../public-types';
 import { WebSocketHandler } from '../platform/websocket';
 import { WebSocketUrl } from '../requests/request';
@@ -52,7 +53,10 @@ export class LiveGenerativeModel extends AIModel {
   constructor(
     ai: AI,
     modelParams: LiveModelParams,
-    public _webSocketHandler: WebSocketHandler
+    /**
+     * @internal
+     */
+    private _webSocketHandler: WebSocketHandler
   ) {
     super(ai, modelParams.model);
     this.generationConfig = modelParams.generationConfig || {};
@@ -82,11 +86,12 @@ export class LiveGenerativeModel extends AIModel {
       fullModelPath = `projects/${this._apiSettings.project}/locations/${this._apiSettings.location}/${this.model}`;
     }
 
-    const setupMessage = {
+    const setupMessage: _LiveClientSetup = {
       setup: {
         model: fullModelPath,
         generationConfig: this.generationConfig,
         tools: this.tools,
+        toolConfig: this.toolConfig,
         systemInstruction: this.systemInstruction
       }
     };

packages/ai/src/types/requests.ts

@@ -368,10 +368,14 @@ export interface ThinkingConfig {
  *
  * @internal
  */
-export interface LiveClientSetup {
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export interface _LiveClientSetup {
   setup: {
     model: string;
     generationConfig?: LiveGenerationConfig;
+    tools?: Tool[];
+    toolConfig?: ToolConfig;
+    systemInstruction?: string | Part | Content;
   };
 }
 
@@ -380,7 +384,8 @@ export interface LiveClientSetup {
  *
  * @internal
  */
-export interface LiveClientRealtimeInput {
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export interface _LiveClientRealtimeInput {
   realtimeInput: {
     mediaChunks: GenerativeContentBlob[];
   };
@@ -391,7 +396,8 @@ export interface LiveClientRealtimeInput {
  *
  * @internal
  */
-export interface LiveClientContent {
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export interface _LiveClientContent {
   clientContent: {
     turns: [Content];
     turnComplete: boolean;