Skip to content

Commit 23ab5b9

Browse files
authored
fix(ai): Update code execution and URL context doc comments to reflect they are public now (#9817)
1 parent 6db5af4 commit 23ab5b9

7 files changed

Lines changed: 17 additions & 31 deletions

File tree

.changeset/silent-trains-bake.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+
Update code execution and URL context features to reflect that they are generally available and no longer public preview.

common/api-review/ai.api.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ export interface CodeExecutionResultPart {
251251
thoughtSignature?: never;
252252
}
253253

254-
// @beta
254+
// @public
255255
export interface CodeExecutionTool {
256256
codeExecution: {};
257257
}
@@ -1514,9 +1514,6 @@ export const ThinkingLevel: {
15141514
// @public
15151515
export type ThinkingLevel = (typeof ThinkingLevel)[keyof typeof ThinkingLevel];
15161516

1517-
// Warning: (ae-incompatible-release-tags) The symbol "Tool" is marked as @public, but its signature references "CodeExecutionTool" which is marked as @beta
1518-
// Warning: (ae-incompatible-release-tags) The symbol "Tool" is marked as @public, but its signature references "URLContextTool" which is marked as @beta
1519-
//
15201517
// @public
15211518
export type Tool = FunctionDeclarationsTool | GoogleSearchTool | CodeExecutionTool | URLContextTool;
15221519

@@ -1534,7 +1531,7 @@ export interface Transcription {
15341531
// @public
15351532
export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanSchema | ObjectSchema | ArraySchema | AnyOfSchema;
15361533

1537-
// @beta
1534+
// @public
15381535
export interface URLContext {
15391536
}
15401537

@@ -1543,7 +1540,7 @@ export interface URLContextMetadata {
15431540
urlMetadata: URLMetadata[];
15441541
}
15451542

1546-
// @beta
1543+
// @public
15471544
export interface URLContextTool {
15481545
urlContext: URLContext;
15491546
}

docs-devsite/ai.codeexecutiontool.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ 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-
1613
A tool that enables the model to use code execution.
1714

1815
<b>Signature:</b>
@@ -25,14 +22,11 @@ export interface CodeExecutionTool
2522

2623
| Property | Type | Description |
2724
| --- | --- | --- |
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. |
25+
| [codeExecution](./ai.codeexecutiontool.md#codeexecutiontoolcodeexecution) | {} | Currently, this is an empty object, but it's reserved for future configuration options. |
2926

3027
## CodeExecutionTool.codeExecution
3128

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-
35-
Specifies the Google Search configuration. Currently, this is an empty object, but it's reserved for future configuration options.
29+
Currently, this is an empty object, but it's reserved for future configuration options.
3630

3731
<b>Signature:</b>
3832

docs-devsite/ai.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The Firebase AI Web SDK.
6868
| [CitationMetadata](./ai.citationmetadata.md#citationmetadata_interface) | Citation metadata that may be found on a [GenerateContentCandidate](./ai.generatecontentcandidate.md#generatecontentcandidate_interface)<!-- -->. |
6969
| [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | The results of code execution run by the model. |
7070
| [CodeExecutionResultPart](./ai.codeexecutionresultpart.md#codeexecutionresultpart_interface) | Represents the code execution result from the model. |
71-
| [CodeExecutionTool](./ai.codeexecutiontool.md#codeexecutiontool_interface) | <b><i>(Public Preview)</i></b> A tool that enables the model to use code execution. |
71+
| [CodeExecutionTool](./ai.codeexecutiontool.md#codeexecutiontool_interface) | A tool that enables the model to use code execution. |
7272
| [Content](./ai.content.md#content_interface) | Content type for both prompts and response candidates. |
7373
| [CountTokensRequest](./ai.counttokensrequest.md#counttokensrequest_interface) | Params for calling [GenerativeModel.countTokens()](./ai.generativemodel.md#generativemodelcounttokens) |
7474
| [CountTokensResponse](./ai.counttokensresponse.md#counttokensresponse_interface) | Response from calling [GenerativeModel.countTokens()](./ai.generativemodel.md#generativemodelcounttokens)<!-- -->. |
@@ -147,9 +147,9 @@ The Firebase AI Web SDK.
147147
| [ThinkingConfig](./ai.thinkingconfig.md#thinkingconfig_interface) | Configuration for "thinking" behavior of compatible Gemini models.<!-- -->Certain models utilize a thinking process before generating a response. This allows them to reason through complex problems and plan a more coherent and accurate answer. |
148148
| [ToolConfig](./ai.toolconfig.md#toolconfig_interface) | Tool config. This config is shared for all tools provided in the request. |
149149
| [Transcription](./ai.transcription.md#transcription_interface) | <b><i>(Public Preview)</i></b> Transcription of audio. This can be returned from a [LiveGenerativeModel](./ai.livegenerativemodel.md#livegenerativemodel_class) if transcription is enabled with the <code>inputAudioTranscription</code> or <code>outputAudioTranscription</code> properties on the [LiveGenerationConfig](./ai.livegenerationconfig.md#livegenerationconfig_interface)<!-- -->. |
150-
| [URLContext](./ai.urlcontext.md#urlcontext_interface) | <b><i>(Public Preview)</i></b> Specifies the URL Context configuration. |
150+
| [URLContext](./ai.urlcontext.md#urlcontext_interface) | Specifies the URL Context configuration. |
151151
| [URLContextMetadata](./ai.urlcontextmetadata.md#urlcontextmetadata_interface) | Metadata related to [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)<!-- -->. |
152-
| [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) | <b><i>(Public Preview)</i></b> A tool that allows you to provide additional context to the models in the form of public web URLs. By including URLs in your request, the Gemini model will access the content from those pages to inform and enhance its response. |
152+
| [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) | A tool that allows you to provide additional context to the models in the form of public web URLs. By including URLs in your request, the Gemini model will access the content from those pages to inform and enhance its response. |
153153
| [URLMetadata](./ai.urlmetadata.md#urlmetadata_interface) | Metadata for a single URL retrieved by the [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) tool. |
154154
| [UsageMetadata](./ai.usagemetadata.md#usagemetadata_interface) | Usage metadata about a [GenerateContentResponse](./ai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->. |
155155
| [VideoMetadata](./ai.videometadata.md#videometadata_interface) | Describes the input video content. |

docs-devsite/ai.urlcontext.md

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

1212
# URLContext 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-
1613
Specifies the URL Context configuration.
1714

1815
<b>Signature:</b>

docs-devsite/ai.urlcontexttool.md

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

1212
# URLContextTool 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-
1613
A tool that allows you to provide additional context to the models in the form of public web URLs. By including URLs in your request, the Gemini model will access the content from those pages to inform and enhance its response.
1714

1815
<b>Signature:</b>
@@ -25,13 +22,10 @@ export interface URLContextTool
2522

2623
| Property | Type | Description |
2724
| --- | --- | --- |
28-
| [urlContext](./ai.urlcontexttool.md#urlcontexttoolurlcontext) | [URLContext](./ai.urlcontext.md#urlcontext_interface) | <b><i>(Public Preview)</i></b> Specifies the URL Context configuration. |
25+
| [urlContext](./ai.urlcontexttool.md#urlcontexttoolurlcontext) | [URLContext](./ai.urlcontext.md#urlcontext_interface) | Specifies the URL Context configuration. |
2926

3027
## URLContextTool.urlContext
3128

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-
3529
Specifies the URL Context configuration.
3630

3731
<b>Signature:</b>

packages/ai/src/types/requests.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -422,11 +422,10 @@ export interface GoogleSearchTool {
422422
/**
423423
* A tool that enables the model to use code execution.
424424
*
425-
* @beta
425+
* @public
426426
*/
427427
export interface CodeExecutionTool {
428428
/**
429-
* Specifies the Google Search configuration.
430429
* Currently, this is an empty object, but it's reserved for future configuration options.
431430
*/
432431
codeExecution: {};
@@ -446,7 +445,7 @@ export interface GoogleSearch {}
446445
* URLs. By including URLs in your request, the Gemini model will access the content from those
447446
* pages to inform and enhance its response.
448447
*
449-
* @beta
448+
* @public
450449
*/
451450
export interface URLContextTool {
452451
/**
@@ -458,7 +457,7 @@ export interface URLContextTool {
458457
/**
459458
* Specifies the URL Context configuration.
460459
*
461-
* @beta
460+
* @public
462461
*/
463462
export interface URLContext {}
464463

0 commit comments

Comments
 (0)