Skip to content

Commit 683f696

Browse files
dlarocquedlarocque
committed
Docs and naming changes
1 parent 0277497 commit 683f696

File tree

7 files changed

+34
-39
lines changed

7 files changed

+34
-39
lines changed

‎common/api-review/ai.api.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -705,35 +705,32 @@ export class IntegerSchema extends Schema {
705705
constructor(schemaParams?: SchemaParams);
706706
}
707707

708-
// Warning: (ae-internal-missing-underscore) The name "LiveClientContent" should be prefixed with an underscore because the declaration is marked as @internal
709-
//
710708
// @internal
711-
export interface LiveClientContent {
709+
export interface _LiveClientContent {
712710
// (undocumented)
713711
clientContent: {
714712
turns: [Content];
715713
turnComplete: boolean;
716714
};
717715
}
718716

719-
// Warning: (ae-internal-missing-underscore) The name "LiveClientRealtimeInput" should be prefixed with an underscore because the declaration is marked as @internal
720-
//
721717
// @internal
722-
export interface LiveClientRealtimeInput {
718+
export interface _LiveClientRealtimeInput {
723719
// (undocumented)
724720
realtimeInput: {
725721
mediaChunks: GenerativeContentBlob[];
726722
};
727723
}
728724

729-
// Warning: (ae-internal-missing-underscore) The name "LiveClientSetup" should be prefixed with an underscore because the declaration is marked as @internal
730-
//
731725
// @internal
732-
export interface LiveClientSetup {
726+
export interface _LiveClientSetup {
733727
// (undocumented)
734728
setup: {
735729
model: string;
736730
generationConfig?: LiveGenerationConfig;
731+
tools?: Tool[];
732+
toolConfig?: ToolConfig;
733+
systemInstruction?: string | Part | Content;
737734
};
738735
}
739736

@@ -752,8 +749,11 @@ export interface LiveGenerationConfig {
752749

753750
// @beta
754751
export class LiveGenerativeModel extends AIModel {
752+
// Warning: (ae-forgotten-export) The symbol "WebSocketHandler" needs to be exported by the entry point index.d.ts
753+
//
755754
// @internal
756-
constructor(ai: AI, modelParams: LiveModelParams, _webSocketHandler: WebSocketHandler);
755+
constructor(ai: AI, modelParams: LiveModelParams,
756+
_webSocketHandler: WebSocketHandler);
757757
connect(): Promise<LiveSession>;
758758
// (undocumented)
759759
generationConfig: LiveGenerationConfig;
@@ -763,11 +763,7 @@ export class LiveGenerativeModel extends AIModel {
763763
toolConfig?: ToolConfig;
764764
// (undocumented)
765765
tools?: Tool[];
766-
// Warning: (ae-forgotten-export) The symbol "WebSocketHandler" needs to be exported by the entry point index.d.ts
767-
//
768-
// (undocumented)
769-
_webSocketHandler: WebSocketHandler;
770-
}
766+
}
771767

772768
// @beta
773769
export interface LiveModelParams {

‎docs-devsite/ai.livegenerativemodel.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ export declare class LiveGenerativeModel extends AIModel
3030
3131
| Property | Modifiers | Type | Description |
3232
| --- | --- | --- | --- |
33-
| [\_webSocketHandler](./ai.livegenerativemodel.md#livegenerativemodel_websockethandler) | | WebSocketHandler | <b><i>(Public Preview)</i></b> |
3433
| [generationConfig](./ai.livegenerativemodel.md#livegenerativemodelgenerationconfig) | | [LiveGenerationConfig](./ai.livegenerationconfig.md#livegenerationconfig_interface) | <b><i>(Public Preview)</i></b> |
3534
| [systemInstruction](./ai.livegenerativemodel.md#livegenerativemodelsysteminstruction) | | [Content](./ai.content.md#content_interface) | <b><i>(Public Preview)</i></b> |
3635
| [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
4241
| --- | --- | --- |
4342
| [connect()](./ai.livegenerativemodel.md#livegenerativemodelconnect) | | <b><i>(Public Preview)</i></b> Starts a [LiveSession](./ai.livesession.md#livesession_class)<!-- -->. |
4443
45-
## LiveGenerativeModel.\_webSocketHandler
46-
47-
> 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.
48-
>
49-
50-
<b>Signature:</b>
51-
52-
```typescript
53-
_webSocketHandler: WebSocketHandler;
54-
```
55-
5644
## LiveGenerativeModel.generationConfig
5745
5846
> 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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
import {
1919
AIErrorCode,
2020
GenerativeContentBlob,
21-
LiveClientContent,
22-
LiveClientRealtimeInput,
21+
_LiveClientContent,
22+
_LiveClientRealtimeInput,
2323
LiveResponseType,
2424
LiveServerContent,
2525
LiveServerToolCall,
@@ -76,7 +76,7 @@ export class LiveSession {
7676

7777
const newContent = formatNewContent(request);
7878

79-
const message: LiveClientContent = {
79+
const message: _LiveClientContent = {
8080
clientContent: {
8181
turns: [newContent],
8282
turnComplete
@@ -101,7 +101,7 @@ export class LiveSession {
101101
);
102102
}
103103

104-
const message: LiveClientRealtimeInput = {
104+
const message: _LiveClientRealtimeInput = {
105105
realtimeInput: { mediaChunks }
106106
};
107107
this.webSocketHandler.send(JSON.stringify(message));

‎packages/ai/src/models/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@
1717

1818
export * from './ai-model';
1919
export * from './generative-model';
20-
export * from './live-model';
20+
export * from './live-generative-model';
2121
export * from './imagen-model';

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import { AI } from '../public-types';
2222
import { LiveSession } from '../methods/live-session';
2323
import { WebSocketHandler } from '../platform/websocket';
2424
import { GoogleAIBackend } from '../backend';
25-
import { LiveGenerativeModel } from './live-model';
25+
import { LiveGenerativeModel } from './live-generative-model';
2626
import { AIError } from '../errors';
2727

2828
use(sinonChai);

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

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ import {
2626
LiveGenerationConfig,
2727
LiveModelParams,
2828
Tool,
29-
ToolConfig
29+
ToolConfig,
30+
_LiveClientSetup
3031
} from '../public-types';
3132
import { WebSocketHandler } from '../platform/websocket';
3233
import { WebSocketUrl } from '../requests/request';
@@ -52,7 +53,10 @@ export class LiveGenerativeModel extends AIModel {
5253
constructor(
5354
ai: AI,
5455
modelParams: LiveModelParams,
55-
public _webSocketHandler: WebSocketHandler
56+
/**
57+
* @internal
58+
*/
59+
private _webSocketHandler: WebSocketHandler
5660
) {
5761
super(ai, modelParams.model);
5862
this.generationConfig = modelParams.generationConfig || {};
@@ -82,11 +86,12 @@ export class LiveGenerativeModel extends AIModel {
8286
fullModelPath = `projects/${this._apiSettings.project}/locations/${this._apiSettings.location}/${this.model}`;
8387
}
8488

85-
const setupMessage = {
89+
const setupMessage: _LiveClientSetup = {
8690
setup: {
8791
model: fullModelPath,
8892
generationConfig: this.generationConfig,
8993
tools: this.tools,
94+
toolConfig: this.toolConfig,
9095
systemInstruction: this.systemInstruction
9196
}
9297
};

‎packages/ai/src/types/requests.ts

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -368,10 +368,14 @@ export interface ThinkingConfig {
368368
*
369369
* @internal
370370
*/
371-
export interface LiveClientSetup {
371+
// eslint-disable-next-line @typescript-eslint/naming-convention
372+
export interface _LiveClientSetup {
372373
setup: {
373374
model: string;
374375
generationConfig?: LiveGenerationConfig;
376+
tools?: Tool[];
377+
toolConfig?: ToolConfig;
378+
systemInstruction?: string | Part | Content;
375379
};
376380
}
377381

@@ -380,7 +384,8 @@ export interface LiveClientSetup {
380384
*
381385
* @internal
382386
*/
383-
export interface LiveClientRealtimeInput {
387+
// eslint-disable-next-line @typescript-eslint/naming-convention
388+
export interface _LiveClientRealtimeInput {
384389
realtimeInput: {
385390
mediaChunks: GenerativeContentBlob[];
386391
};
@@ -391,7 +396,8 @@ export interface LiveClientRealtimeInput {
391396
*
392397
* @internal
393398
*/
394-
export interface LiveClientContent {
399+
// eslint-disable-next-line @typescript-eslint/naming-convention
400+
export interface _LiveClientContent {
395401
clientContent: {
396402
turns: [Content];
397403
turnComplete: boolean;

0 commit comments

Comments
 (0)