Skip to content

Commit 7e52134

Browse files
committed
Fix docs
1 parent 7ec4544 commit 7e52134

File tree

4 files changed

+16
-96
lines changed

4 files changed

+16
-96
lines changed

common/api-review/ai.api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -580,9 +580,9 @@ export function getTemplateImagenModel(ai: AI, requestOptions?: RequestOptions):
580580
// @public
581581
export class GoogleAIBackend extends Backend {
582582
constructor();
583-
// (undocumented)
583+
// @internal (undocumented)
584584
_getModelPath(project: string, model: string): string;
585-
// (undocumented)
585+
// @internal (undocumented)
586586
_getTemplatePath(project: string, templateId: string): string;
587587
}
588588

@@ -1445,9 +1445,9 @@ export interface UsageMetadata {
14451445
// @public
14461446
export class VertexAIBackend extends Backend {
14471447
constructor(location?: string);
1448-
// (undocumented)
1448+
// @internal (undocumented)
14491449
_getModelPath(project: string, model: string): string;
1450-
// (undocumented)
1450+
// @internal (undocumented)
14511451
_getTemplatePath(project: string, templateId: string): string;
14521452
readonly location: string;
14531453
}

docs-devsite/ai.googleaibackend.md

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,6 @@ export declare class GoogleAIBackend extends Backend
2727
| --- | --- | --- |
2828
| [(constructor)()](./ai.googleaibackend.md#googleaibackendconstructor) | | Creates a configuration object for the Gemini Developer API backend. |
2929
30-
## Methods
31-
32-
| Method | Modifiers | Description |
33-
| --- | --- | --- |
34-
| [\_getModelPath(project, model)](./ai.googleaibackend.md#googleaibackend_getmodelpath) | | |
35-
| [\_getTemplatePath(project, templateId)](./ai.googleaibackend.md#googleaibackend_gettemplatepath) | | |
36-
3730
## GoogleAIBackend.(constructor)
3831
3932
Creates a configuration object for the Gemini Developer API backend.
@@ -43,42 +36,3 @@ Creates a configuration object for the Gemini Developer API backend.
4336
```typescript
4437
constructor();
4538
```
46-
47-
## GoogleAIBackend.\_getModelPath()
48-
49-
<b>Signature:</b>
50-
51-
```typescript
52-
_getModelPath(project: string, model: string): string;
53-
```
54-
55-
#### Parameters
56-
57-
| Parameter | Type | Description |
58-
| --- | --- | --- |
59-
| project | string | |
60-
| model | string | |
61-
62-
<b>Returns:</b>
63-
64-
string
65-
66-
## GoogleAIBackend.\_getTemplatePath()
67-
68-
<b>Signature:</b>
69-
70-
```typescript
71-
_getTemplatePath(project: string, templateId: string): string;
72-
```
73-
74-
#### Parameters
75-
76-
| Parameter | Type | Description |
77-
| --- | --- | --- |
78-
| project | string | |
79-
| templateId | string | |
80-
81-
<b>Returns:</b>
82-
83-
string
84-

docs-devsite/ai.vertexaibackend.md

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,6 @@ export declare class VertexAIBackend extends Backend
3333
| --- | --- | --- | --- |
3434
| [location](./ai.vertexaibackend.md#vertexaibackendlocation) | | string | The region identifier. See [Vertex AI locations](https://firebase.google.com/docs/vertex-ai/locations#available-locations) for a list of supported locations. |
3535
36-
## Methods
37-
38-
| Method | Modifiers | Description |
39-
| --- | --- | --- |
40-
| [\_getModelPath(project, model)](./ai.vertexaibackend.md#vertexaibackend_getmodelpath) | | |
41-
| [\_getTemplatePath(project, templateId)](./ai.vertexaibackend.md#vertexaibackend_gettemplatepath) | | |
42-
4336
## VertexAIBackend.(constructor)
4437
4538
Creates a configuration object for the Vertex AI backend.
@@ -65,42 +58,3 @@ The region identifier. See [Vertex AI locations](https://firebase.google.com/doc
6558
```typescript
6659
readonly location: string;
6760
```
68-
69-
## VertexAIBackend.\_getModelPath()
70-
71-
<b>Signature:</b>
72-
73-
```typescript
74-
_getModelPath(project: string, model: string): string;
75-
```
76-
77-
#### Parameters
78-
79-
| Parameter | Type | Description |
80-
| --- | --- | --- |
81-
| project | string | |
82-
| model | string | |
83-
84-
<b>Returns:</b>
85-
86-
string
87-
88-
## VertexAIBackend.\_getTemplatePath()
89-
90-
<b>Signature:</b>
91-
92-
```typescript
93-
_getTemplatePath(project: string, templateId: string): string;
94-
```
95-
96-
#### Parameters
97-
98-
| Parameter | Type | Description |
99-
| --- | --- | --- |
100-
| project | string | |
101-
| templateId | string | |
102-
103-
<b>Returns:</b>
104-
105-
string
106-

packages/ai/src/backend.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,16 @@ export class GoogleAIBackend extends Backend {
6767
super(BackendType.GOOGLE_AI);
6868
}
6969

70+
/**
71+
* @internal
72+
*/
7073
_getModelPath(project: string, model: string): string {
7174
return `/${DEFAULT_API_VERSION}/projects/${project}/${model}`;
7275
}
7376

77+
/**
78+
* @internal
79+
*/
7480
_getTemplatePath(project: string, templateId: string): string {
7581
return `/${DEFAULT_API_VERSION}/projects/${project}/templates/${templateId}`;
7682
}
@@ -108,10 +114,16 @@ export class VertexAIBackend extends Backend {
108114
}
109115
}
110116

117+
/**
118+
* @internal
119+
*/
111120
_getModelPath(project: string, model: string): string {
112121
return `/${DEFAULT_API_VERSION}/projects/${project}/locations/${this.location}/${model}`;
113122
}
114123

124+
/**
125+
* @internal
126+
*/
115127
_getTemplatePath(project: string, templateId: string): string {
116128
return `/${DEFAULT_API_VERSION}/projects/${project}/locations/${this.location}/templates/${templateId}`;
117129
}

0 commit comments

Comments
 (0)