Skip to content

Commit 7a7634f

Browse files
authored
docs(ai): tag code execution with "beta" tag (public preview) (#9274)
1 parent 0ffcb26 commit 7a7634f

File tree

11 files changed

+147
-48
lines changed

11 files changed

+147
-48
lines changed

.changeset/tender-meals-clap.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@firebase/ai': patch
3+
---
4+
5+
Tag code execution with beta tag (public preview).

common/api-review/ai.api.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -175,13 +175,13 @@ export interface CitationMetadata {
175175
citations: Citation[];
176176
}
177177

178-
// @public
178+
// @beta
179179
export interface CodeExecutionResult {
180180
outcome?: Outcome;
181181
output?: string;
182182
}
183183

184-
// @public
184+
// @beta
185185
export interface CodeExecutionResultPart {
186186
// (undocumented)
187187
codeExecutionResult?: CodeExecutionResult;
@@ -203,7 +203,7 @@ export interface CodeExecutionResultPart {
203203
thoughtSignature?: never;
204204
}
205205

206-
// @public
206+
// @beta
207207
export interface CodeExecutionTool {
208208
codeExecution: {};
209209
}
@@ -271,13 +271,13 @@ export interface ErrorDetails {
271271
reason?: string;
272272
}
273273

274-
// @public
274+
// @beta
275275
export interface ExecutableCode {
276276
code?: string;
277277
language?: Language;
278278
}
279279

280-
// @public
280+
// @beta
281281
export interface ExecutableCodePart {
282282
// (undocumented)
283283
codeExecutionResult?: never;
@@ -842,13 +842,13 @@ export class IntegerSchema extends Schema {
842842
constructor(schemaParams?: SchemaParams);
843843
}
844844

845-
// @public
845+
// @beta
846846
export const Language: {
847847
UNSPECIFIED: string;
848848
PYTHON: string;
849849
};
850850

851-
// @public
851+
// @beta
852852
export type Language = (typeof Language)[keyof typeof Language];
853853

854854
// @beta
@@ -1064,17 +1064,20 @@ export interface OnDeviceParams {
10641064
promptOptions?: LanguageModelPromptOptions;
10651065
}
10661066

1067-
// @public
1067+
// @beta
10681068
export const Outcome: {
10691069
UNSPECIFIED: string;
10701070
OK: string;
10711071
FAILED: string;
10721072
DEADLINE_EXCEEDED: string;
10731073
};
10741074

1075-
// @public
1075+
// @beta
10761076
export type Outcome = (typeof Outcome)[keyof typeof Outcome];
10771077

1078+
// Warning: (ae-incompatible-release-tags) The symbol "Part" is marked as @public, but its signature references "ExecutableCodePart" which is marked as @beta
1079+
// Warning: (ae-incompatible-release-tags) The symbol "Part" is marked as @public, but its signature references "CodeExecutionResultPart" which is marked as @beta
1080+
//
10781081
// @public
10791082
export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
10801083

@@ -1310,6 +1313,7 @@ export interface ThinkingConfig {
13101313
thinkingBudget?: number;
13111314
}
13121315

1316+
// Warning: (ae-incompatible-release-tags) The symbol "Tool" is marked as @public, but its signature references "CodeExecutionTool" which is marked as @beta
13131317
// Warning: (ae-incompatible-release-tags) The symbol "Tool" is marked as @public, but its signature references "URLContextTool" which is marked as @beta
13141318
//
13151319
// @public

docs-devsite/ai.codeexecutionresult.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# CodeExecutionResult interface
13+
> 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.
14+
>
15+
1316
The results of code execution run by the model.
1417

1518
<b>Signature:</b>
@@ -22,11 +25,14 @@ export interface CodeExecutionResult
2225

2326
| Property | Type | Description |
2427
| --- | --- | --- |
25-
| [outcome](./ai.codeexecutionresult.md#codeexecutionresultoutcome) | [Outcome](./ai.md#outcome) | The result of the code execution. |
26-
| [output](./ai.codeexecutionresult.md#codeexecutionresultoutput) | string | The output from the code execution, or an error message if it failed. |
28+
| [outcome](./ai.codeexecutionresult.md#codeexecutionresultoutcome) | [Outcome](./ai.md#outcome) | <b><i>(Public Preview)</i></b> The result of the code execution. |
29+
| [output](./ai.codeexecutionresult.md#codeexecutionresultoutput) | string | <b><i>(Public Preview)</i></b> The output from the code execution, or an error message if it failed. |
2730

2831
## CodeExecutionResult.outcome
2932

33+
> 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.
34+
>
35+
3036
The result of the code execution.
3137

3238
<b>Signature:</b>
@@ -37,6 +43,9 @@ outcome?: Outcome;
3743

3844
## CodeExecutionResult.output
3945

46+
> 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.
47+
>
48+
4049
The output from the code execution, or an error message if it failed.
4150

4251
<b>Signature:</b>

docs-devsite/ai.codeexecutionresultpart.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# CodeExecutionResultPart interface
13+
> 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.
14+
>
15+
1316
Represents the code execution result from the model.
1417

1518
<b>Signature:</b>
@@ -22,17 +25,20 @@ export interface CodeExecutionResultPart
2225

2326
| Property | Type | Description |
2427
| --- | --- | --- |
25-
| [codeExecutionResult](./ai.codeexecutionresultpart.md#codeexecutionresultpartcodeexecutionresult) | [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | |
26-
| [executableCode](./ai.codeexecutionresultpart.md#codeexecutionresultpartexecutablecode) | never | |
27-
| [fileData](./ai.codeexecutionresultpart.md#codeexecutionresultpartfiledata) | never | |
28-
| [functionCall](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctioncall) | never | |
29-
| [functionResponse](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctionresponse) | never | |
30-
| [inlineData](./ai.codeexecutionresultpart.md#codeexecutionresultpartinlinedata) | never | |
31-
| [text](./ai.codeexecutionresultpart.md#codeexecutionresultparttext) | never | |
32-
| [thought](./ai.codeexecutionresultpart.md#codeexecutionresultpartthought) | never | |
28+
| [codeExecutionResult](./ai.codeexecutionresultpart.md#codeexecutionresultpartcodeexecutionresult) | [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | <b><i>(Public Preview)</i></b> |
29+
| [executableCode](./ai.codeexecutionresultpart.md#codeexecutionresultpartexecutablecode) | never | <b><i>(Public Preview)</i></b> |
30+
| [fileData](./ai.codeexecutionresultpart.md#codeexecutionresultpartfiledata) | never | <b><i>(Public Preview)</i></b> |
31+
| [functionCall](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctioncall) | never | <b><i>(Public Preview)</i></b> |
32+
| [functionResponse](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctionresponse) | never | <b><i>(Public Preview)</i></b> |
33+
| [inlineData](./ai.codeexecutionresultpart.md#codeexecutionresultpartinlinedata) | never | <b><i>(Public Preview)</i></b> |
34+
| [text](./ai.codeexecutionresultpart.md#codeexecutionresultparttext) | never | <b><i>(Public Preview)</i></b> |
35+
| [thought](./ai.codeexecutionresultpart.md#codeexecutionresultpartthought) | never | <b><i>(Public Preview)</i></b> |
3336

3437
## CodeExecutionResultPart.codeExecutionResult
3538

39+
> 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.
40+
>
41+
3642
<b>Signature:</b>
3743

3844
```typescript
@@ -41,6 +47,9 @@ codeExecutionResult?: CodeExecutionResult;
4147

4248
## CodeExecutionResultPart.executableCode
4349

50+
> 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.
51+
>
52+
4453
<b>Signature:</b>
4554

4655
```typescript
@@ -49,6 +58,9 @@ executableCode?: never;
4958

5059
## CodeExecutionResultPart.fileData
5160

61+
> 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.
62+
>
63+
5264
<b>Signature:</b>
5365

5466
```typescript
@@ -57,6 +69,9 @@ fileData: never;
5769

5870
## CodeExecutionResultPart.functionCall
5971

72+
> 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.
73+
>
74+
6075
<b>Signature:</b>
6176

6277
```typescript
@@ -65,6 +80,9 @@ functionCall?: never;
6580

6681
## CodeExecutionResultPart.functionResponse
6782

83+
> 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.
84+
>
85+
6886
<b>Signature:</b>
6987

7088
```typescript
@@ -73,6 +91,9 @@ functionResponse?: never;
7391

7492
## CodeExecutionResultPart.inlineData
7593

94+
> 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.
95+
>
96+
7697
<b>Signature:</b>
7798

7899
```typescript
@@ -81,6 +102,9 @@ inlineData?: never;
81102

82103
## CodeExecutionResultPart.text
83104

105+
> 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.
106+
>
107+
84108
<b>Signature:</b>
85109

86110
```typescript
@@ -89,6 +113,9 @@ text?: never;
89113

90114
## CodeExecutionResultPart.thought
91115

116+
> 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.
117+
>
118+
92119
<b>Signature:</b>
93120

94121
```typescript

docs-devsite/ai.codeexecutiontool.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# CodeExecutionTool interface
13+
> 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.
14+
>
15+
1316
A tool that enables the model to use code execution.
1417

1518
<b>Signature:</b>
@@ -22,10 +25,13 @@ export interface CodeExecutionTool
2225

2326
| Property | Type | Description |
2427
| --- | --- | --- |
25-
| [codeExecution](./ai.codeexecutiontool.md#codeexecutiontoolcodeexecution) | {} | Specifies the Google Search configuration. Currently, this is an empty object, but it's reserved for future configuration options. |
28+
| [codeExecution](./ai.codeexecutiontool.md#codeexecutiontoolcodeexecution) | {} | <b><i>(Public Preview)</i></b> Specifies the Google Search configuration. Currently, this is an empty object, but it's reserved for future configuration options. |
2629

2730
## CodeExecutionTool.codeExecution
2831

32+
> 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.
33+
>
34+
2935
Specifies the Google Search configuration. Currently, this is an empty object, but it's reserved for future configuration options.
3036

3137
<b>Signature:</b>

docs-devsite/ai.executablecode.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# ExecutableCode interface
13+
> 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.
14+
>
15+
1316
An interface for executable code returned by the model.
1417

1518
<b>Signature:</b>
@@ -22,11 +25,14 @@ export interface ExecutableCode
2225

2326
| Property | Type | Description |
2427
| --- | --- | --- |
25-
| [code](./ai.executablecode.md#executablecodecode) | string | The source code to be executed. |
26-
| [language](./ai.executablecode.md#executablecodelanguage) | [Language](./ai.md#language) | The programming language of the code. |
28+
| [code](./ai.executablecode.md#executablecodecode) | string | <b><i>(Public Preview)</i></b> The source code to be executed. |
29+
| [language](./ai.executablecode.md#executablecodelanguage) | [Language](./ai.md#language) | <b><i>(Public Preview)</i></b> The programming language of the code. |
2730

2831
## ExecutableCode.code
2932

33+
> 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.
34+
>
35+
3036
The source code to be executed.
3137

3238
<b>Signature:</b>
@@ -37,6 +43,9 @@ code?: string;
3743

3844
## ExecutableCode.language
3945

46+
> 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.
47+
>
48+
4049
The programming language of the code.
4150

4251
<b>Signature:</b>

0 commit comments

Comments
 (0)