hanzoai/firebase-js-sdk
2
0
Fork 0
mirror of https://github.com/hanzoai/firebase-js-sdk.git synced 2026-09-24 16:59:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(ai): Remove preview tags from code execution and URL context features (#9475)

Browse Source
This commit is contained in:
Christina Holland
2026-01-30 09:59:13 -08:00
committed by GitHub
parent 1ede45b3c5
commit 25f8814306
12 changed files with 65 additions and 169 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/pink-brooms-compare.md
+6
View File
@@ -0,0 +1,6 @@
---
'@firebase/ai': minor
'firebase': minor
---
Remove "preview" tags from code execution and URL context documentation.
common/api-review/ai.api.md
+12 -17
View File
@@ -185,13 +185,13 @@ export interface CitationMetadata {
citations: Citation[];
}
// @beta
// @public
export interface CodeExecutionResult {
outcome?: Outcome;
output?: string;
}
// @beta
// @public
export interface CodeExecutionResultPart {
// (undocumented)
codeExecutionResult?: CodeExecutionResult;
@@ -283,13 +283,13 @@ export interface ErrorDetails {
reason?: string;
}
// @beta
// @public
export interface ExecutableCode {
code?: string;
language?: Language;
}
// @beta
// @public
export interface ExecutableCodePart {
// (undocumented)
codeExecutionResult?: never;
@@ -461,8 +461,6 @@ export interface GenerateContentCandidate {
index: number;
// (undocumented)
safetyRatings?: SafetyRating[];
// Warning: (ae-incompatible-release-tags) The symbol "urlContextMetadata" is marked as @public, but its signature references "URLContextMetadata" which is marked as @beta
//
// (undocumented)
urlContextMetadata?: URLContextMetadata;
}
@@ -873,13 +871,13 @@ export class IntegerSchema extends Schema {
constructor(schemaParams?: SchemaParams);
}
// @beta
// @public
export const Language: {
UNSPECIFIED: string;
PYTHON: string;
};
// @beta
// @public
export type Language = (typeof Language)[keyof typeof Language];
// @beta
@@ -1113,7 +1111,7 @@ export interface OnDeviceParams {
promptOptions?: LanguageModelPromptOptions;
}
// @beta
// @public
export const Outcome: {
UNSPECIFIED: string;
OK: string;
@@ -1121,12 +1119,9 @@ export const Outcome: {
DEADLINE_EXCEEDED: string;
};
// @beta
// @public
export type Outcome = (typeof Outcome)[keyof typeof Outcome];
// Warning: (ae-incompatible-release-tags) The symbol "Part" is marked as @public, but its signature references "ExecutableCodePart" which is marked as @beta
// Warning: (ae-incompatible-release-tags) The symbol "Part" is marked as @public, but its signature references "CodeExecutionResultPart" which is marked as @beta
//
// @public
export type Part = TextPart | InlineDataPart | FunctionCallPart | FunctionResponsePart | FileDataPart | ExecutableCodePart | CodeExecutionResultPart;
@@ -1422,7 +1417,7 @@ export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanS
export interface URLContext {
}
// @beta
// @public
export interface URLContextMetadata {
urlMetadata: URLMetadata[];
}
@@ -1432,13 +1427,13 @@ export interface URLContextTool {
urlContext: URLContext;
}
// @beta
// @public
export interface URLMetadata {
retrievedUrl?: string;
urlRetrievalStatus?: URLRetrievalStatus;
}
// @beta
// @public
export const URLRetrievalStatus: {
URL_RETRIEVAL_STATUS_UNSPECIFIED: string;
URL_RETRIEVAL_STATUS_SUCCESS: string;
@@ -1447,7 +1442,7 @@ export const URLRetrievalStatus: {
URL_RETRIEVAL_STATUS_UNSAFE: string;
};
// @beta
// @public
export type URLRetrievalStatus = (typeof URLRetrievalStatus)[keyof typeof URLRetrievalStatus];
// @public
docs-devsite/ai.codeexecutionresult.md
+2 -11
View File
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}
# CodeExecutionResult interface
> 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.
>
The results of code execution run by the model.
<b>Signature:</b>
@@ -25,14 +22,11 @@ export interface CodeExecutionResult
| Property | Type | Description |
| --- | --- | --- |
| [outcome](./ai.codeexecutionresult.md#codeexecutionresultoutcome) | [Outcome](./ai.md#outcome) | <b><i>(Public Preview)</i></b> The result of the code execution. |
| [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. |
| [outcome](./ai.codeexecutionresult.md#codeexecutionresultoutcome) | [Outcome](./ai.md#outcome) | The result of the code execution. |
| [output](./ai.codeexecutionresult.md#codeexecutionresultoutput) | string | The output from the code execution, or an error message if it failed. |
## CodeExecutionResult.outcome
> 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.
>
The result of the code execution.
<b>Signature:</b>
@@ -43,9 +37,6 @@ outcome?: Outcome;
## CodeExecutionResult.output
> 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.
>
The output from the code execution, or an error message if it failed.
<b>Signature:</b>
docs-devsite/ai.codeexecutionresultpart.md
+8 -35
View File
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}
# CodeExecutionResultPart interface
> 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.
>
Represents the code execution result from the model.
<b>Signature:</b>
@@ -25,20 +22,17 @@ export interface CodeExecutionResultPart
| Property | Type | Description |
| --- | --- | --- |
| [codeExecutionResult](./ai.codeexecutionresultpart.md#codeexecutionresultpartcodeexecutionresult) | [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | <b><i>(Public Preview)</i></b> |
| [executableCode](./ai.codeexecutionresultpart.md#codeexecutionresultpartexecutablecode) | never | <b><i>(Public Preview)</i></b> |
| [fileData](./ai.codeexecutionresultpart.md#codeexecutionresultpartfiledata) | never | <b><i>(Public Preview)</i></b> |
| [functionCall](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctioncall) | never | <b><i>(Public Preview)</i></b> |
| [functionResponse](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctionresponse) | never | <b><i>(Public Preview)</i></b> |
| [inlineData](./ai.codeexecutionresultpart.md#codeexecutionresultpartinlinedata) | never | <b><i>(Public Preview)</i></b> |
| [text](./ai.codeexecutionresultpart.md#codeexecutionresultparttext) | never | <b><i>(Public Preview)</i></b> |
| [thought](./ai.codeexecutionresultpart.md#codeexecutionresultpartthought) | never | <b><i>(Public Preview)</i></b> |
| [codeExecutionResult](./ai.codeexecutionresultpart.md#codeexecutionresultpartcodeexecutionresult) | [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | |
| [executableCode](./ai.codeexecutionresultpart.md#codeexecutionresultpartexecutablecode) | never | |
| [fileData](./ai.codeexecutionresultpart.md#codeexecutionresultpartfiledata) | never | |
| [functionCall](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctioncall) | never | |
| [functionResponse](./ai.codeexecutionresultpart.md#codeexecutionresultpartfunctionresponse) | never | |
| [inlineData](./ai.codeexecutionresultpart.md#codeexecutionresultpartinlinedata) | never | |
| [text](./ai.codeexecutionresultpart.md#codeexecutionresultparttext) | never | |
| [thought](./ai.codeexecutionresultpart.md#codeexecutionresultpartthought) | never | |
## CodeExecutionResultPart.codeExecutionResult
> 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
@@ -47,9 +41,6 @@ codeExecutionResult?: CodeExecutionResult;
## CodeExecutionResultPart.executableCode
> 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
@@ -58,9 +49,6 @@ executableCode?: never;
## CodeExecutionResultPart.fileData
> 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
@@ -69,9 +57,6 @@ fileData: never;
## CodeExecutionResultPart.functionCall
> 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
@@ -80,9 +65,6 @@ functionCall?: never;
## CodeExecutionResultPart.functionResponse
> 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
@@ -91,9 +73,6 @@ functionResponse?: never;
## CodeExecutionResultPart.inlineData
> 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
@@ -102,9 +81,6 @@ inlineData?: never;
## CodeExecutionResultPart.text
> 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
@@ -113,9 +89,6 @@ text?: never;
## CodeExecutionResultPart.thought
> 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
docs-devsite/ai.executablecode.md
+2 -11
View File
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}
# ExecutableCode interface
> 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.
>
An interface for executable code returned by the model.
<b>Signature:</b>
@@ -25,14 +22,11 @@ export interface ExecutableCode
| Property | Type | Description |
| --- | --- | --- |
| [code](./ai.executablecode.md#executablecodecode) | string | <b><i>(Public Preview)</i></b> The source code to be executed. |
| [language](./ai.executablecode.md#executablecodelanguage) | [Language](./ai.md#language) | <b><i>(Public Preview)</i></b> The programming language of the code. |
| [code](./ai.executablecode.md#executablecodecode) | string | The source code to be executed. |
| [language](./ai.executablecode.md#executablecodelanguage) | [Language](./ai.md#language) | The programming language of the code. |
## ExecutableCode.code
> 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.
>
The source code to be executed.
<b>Signature:</b>
@@ -43,9 +37,6 @@ code?: string;
## ExecutableCode.language
> 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.
>
The programming language of the code.
<b>Signature:</b>
docs-devsite/ai.executablecodepart.md
+8 -35
View File
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}
# ExecutableCodePart interface
> 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.
>
Represents the code that is executed by the model.
<b>Signature:</b>
@@ -25,20 +22,17 @@ export interface ExecutableCodePart
| Property | Type | Description |
| --- | --- | --- |
| [codeExecutionResult](./ai.executablecodepart.md#executablecodepartcodeexecutionresult) | never | <b><i>(Public Preview)</i></b> |
| [executableCode](./ai.executablecodepart.md#executablecodepartexecutablecode) | [ExecutableCode](./ai.executablecode.md#executablecode_interface) | <b><i>(Public Preview)</i></b> |
| [fileData](./ai.executablecodepart.md#executablecodepartfiledata) | never | <b><i>(Public Preview)</i></b> |
| [functionCall](./ai.executablecodepart.md#executablecodepartfunctioncall) | never | <b><i>(Public Preview)</i></b> |
| [functionResponse](./ai.executablecodepart.md#executablecodepartfunctionresponse) | never | <b><i>(Public Preview)</i></b> |
| [inlineData](./ai.executablecodepart.md#executablecodepartinlinedata) | never | <b><i>(Public Preview)</i></b> |
| [text](./ai.executablecodepart.md#executablecodeparttext) | never | <b><i>(Public Preview)</i></b> |
| [thought](./ai.executablecodepart.md#executablecodepartthought) | never | <b><i>(Public Preview)</i></b> |
| [codeExecutionResult](./ai.executablecodepart.md#executablecodepartcodeexecutionresult) | never | |
| [executableCode](./ai.executablecodepart.md#executablecodepartexecutablecode) | [ExecutableCode](./ai.executablecode.md#executablecode_interface) | |
| [fileData](./ai.executablecodepart.md#executablecodepartfiledata) | never | |
| [functionCall](./ai.executablecodepart.md#executablecodepartfunctioncall) | never | |
| [functionResponse](./ai.executablecodepart.md#executablecodepartfunctionresponse) | never | |
| [inlineData](./ai.executablecodepart.md#executablecodepartinlinedata) | never | |
| [text](./ai.executablecodepart.md#executablecodeparttext) | never | |
| [thought](./ai.executablecodepart.md#executablecodepartthought) | never | |
## ExecutableCodePart.codeExecutionResult
> 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
@@ -47,9 +41,6 @@ codeExecutionResult?: never;
## ExecutableCodePart.executableCode
> 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
@@ -58,9 +49,6 @@ executableCode?: ExecutableCode;
## ExecutableCodePart.fileData
> 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
@@ -69,9 +57,6 @@ fileData: never;
## ExecutableCodePart.functionCall
> 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
@@ -80,9 +65,6 @@ functionCall?: never;
## ExecutableCodePart.functionResponse
> 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
@@ -91,9 +73,6 @@ functionResponse?: never;
## ExecutableCodePart.inlineData
> 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
@@ -102,9 +81,6 @@ inlineData?: never;
## ExecutableCodePart.text
> 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
@@ -113,9 +89,6 @@ text?: never;
## ExecutableCodePart.thought
> 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
docs-devsite/ai.md
+12 -30
View File
@@ -65,8 +65,8 @@ The Firebase AI Web SDK.
| [ChromeAdapter](./ai.chromeadapter.md#chromeadapter_interface) | <b><i>(Public Preview)</i></b> Defines an inference "backend" that uses Chrome's on-device model, and encapsulates logic for detecting when on-device inference is possible.<!-- -->These methods should not be called directly by the user. |
| [Citation](./ai.citation.md#citation_interface) | A single citation. |
| [CitationMetadata](./ai.citationmetadata.md#citationmetadata_interface) | Citation metadata that may be found on a [GenerateContentCandidate](./ai.generatecontentcandidate.md#generatecontentcandidate_interface)<!-- -->. |
| [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | <b><i>(Public Preview)</i></b> The results of code execution run by the model. |
| [CodeExecutionResultPart](./ai.codeexecutionresultpart.md#codeexecutionresultpart_interface) | <b><i>(Public Preview)</i></b> Represents the code execution result from the model. |
| [CodeExecutionResult](./ai.codeexecutionresult.md#codeexecutionresult_interface) | The results of code execution run by the model. |
| [CodeExecutionResultPart](./ai.codeexecutionresultpart.md#codeexecutionresultpart_interface) | Represents the code execution result from the model. |
| [CodeExecutionTool](./ai.codeexecutiontool.md#codeexecutiontool_interface) | <b><i>(Public Preview)</i></b> A tool that enables the model to use code execution. |
| [Content](./ai.content.md#content_interface) | Content type for both prompts and response candidates. |
| [CountTokensRequest](./ai.counttokensrequest.md#counttokensrequest_interface) | Params for calling [GenerativeModel.countTokens()](./ai.generativemodel.md#generativemodelcounttokens) |
@@ -75,8 +75,8 @@ The Firebase AI Web SDK.
| [Date\_2](./ai.date_2.md#date_2_interface) | Protobuf google.type.Date |
| [EnhancedGenerateContentResponse](./ai.enhancedgeneratecontentresponse.md#enhancedgeneratecontentresponse_interface) | Response object wrapped with helper methods. |
| [ErrorDetails](./ai.errordetails.md#errordetails_interface) | Details object that may be included in an error response. |
| [ExecutableCode](./ai.executablecode.md#executablecode_interface) | <b><i>(Public Preview)</i></b> An interface for executable code returned by the model. |
| [ExecutableCodePart](./ai.executablecodepart.md#executablecodepart_interface) | <b><i>(Public Preview)</i></b> Represents the code that is executed by the model. |
| [ExecutableCode](./ai.executablecode.md#executablecode_interface) | An interface for executable code returned by the model. |
| [ExecutableCodePart](./ai.executablecodepart.md#executablecodepart_interface) | Represents the code that is executed by the model. |
| [FileData](./ai.filedata.md#filedata_interface) | Data pointing to a file uploaded on Google Cloud Storage. |
| [FileDataPart](./ai.filedatapart.md#filedatapart_interface) | Content part interface if the part represents [FileData](./ai.filedata.md#filedata_interface) |
| [FunctionCall](./ai.functioncall.md#functioncall_interface) | A predicted [FunctionCall](./ai.functioncall.md#functioncall_interface) returned from the model that contains a string representing the [FunctionDeclaration.name](./ai.functiondeclaration.md#functiondeclarationname) and a structured JSON object containing the parameters and their values. |
@@ -143,9 +143,9 @@ The Firebase AI Web SDK.
| [ToolConfig](./ai.toolconfig.md#toolconfig_interface) | Tool config. This config is shared for all tools provided in the request. |
| [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)<!-- -->. |
| [URLContext](./ai.urlcontext.md#urlcontext_interface) | <b><i>(Public Preview)</i></b> Specifies the URL Context configuration. |
| [URLContextMetadata](./ai.urlcontextmetadata.md#urlcontextmetadata_interface) | <b><i>(Public Preview)</i></b> Metadata related to [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)<!-- -->. |
| [URLContextMetadata](./ai.urlcontextmetadata.md#urlcontextmetadata_interface) | Metadata related to [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)<!-- -->. |
| [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. |
| [URLMetadata](./ai.urlmetadata.md#urlmetadata_interface) | <b><i>(Public Preview)</i></b> Metadata for a single URL retrieved by the [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) tool. |
| [URLMetadata](./ai.urlmetadata.md#urlmetadata_interface) | Metadata for a single URL retrieved by the [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) tool. |
| [UsageMetadata](./ai.usagemetadata.md#usagemetadata_interface) | Usage metadata about a [GenerateContentResponse](./ai.generatecontentresponse.md#generatecontentresponse_interface)<!-- -->. |
| [VideoMetadata](./ai.videometadata.md#videometadata_interface) | Describes the input video content. |
| [VoiceConfig](./ai.voiceconfig.md#voiceconfig_interface) | <b><i>(Public Preview)</i></b> Configuration for the voice to used in speech synthesis. |
@@ -171,15 +171,15 @@ The Firebase AI Web SDK.
| [ImagenSafetyFilterLevel](./ai.md#imagensafetyfilterlevel) | A filter level controlling how aggressively to filter sensitive content.<!-- -->Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, <code>violence</code>, <code>sexual</code>, <code>derogatory</code>, and <code>toxic</code>). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details. |
| [InferenceMode](./ai.md#inferencemode) | <b><i>(Public Preview)</i></b> Determines whether inference happens on-device or in-cloud. |
| [InferenceSource](./ai.md#inferencesource) | <b><i>(Public Preview)</i></b> Indicates whether inference happened on-device or in-cloud. |
| [Language](./ai.md#language) | <b><i>(Public Preview)</i></b> The programming language of the code. |
| [Language](./ai.md#language) | The programming language of the code. |
| [LiveResponseType](./ai.md#liveresponsetype) | <b><i>(Public Preview)</i></b> The types of responses that can be returned by [LiveSession.receive()](./ai.livesession.md#livesessionreceive)<!-- -->. |
| [Modality](./ai.md#modality) | Content part modality. |
| [Outcome](./ai.md#outcome) | <b><i>(Public Preview)</i></b> Represents the result of the code execution. |
| [Outcome](./ai.md#outcome) | Represents the result of the code execution. |
| [POSSIBLE\_ROLES](./ai.md#possible_roles) | Possible roles. |
| [ResponseModality](./ai.md#responsemodality) | <b><i>(Public Preview)</i></b> Generation modalities to be returned in generation responses. |
| [SchemaType](./ai.md#schematype) | Contains the list of OpenAPI data types as defined by the [OpenAPI specification](https://swagger.io/docs/specification/data-models/data-types/) |
| [ThinkingLevel](./ai.md#thinkinglevel) | A preset that controls the model's "thinking" process. Use <code>ThinkingLevel.LOW</code> for faster responses on less complex tasks, and <code>ThinkingLevel.HIGH</code> for better reasoning on more complex tasks. |
| [URLRetrievalStatus](./ai.md#urlretrievalstatus) | <b><i>(Public Preview)</i></b> The status of a URL retrieval. |
| [URLRetrievalStatus](./ai.md#urlretrievalstatus) | The status of a URL retrieval. |
## Type Aliases
@@ -200,13 +200,13 @@ The Firebase AI Web SDK.
| [ImagenSafetyFilterLevel](./ai.md#imagensafetyfilterlevel) | A filter level controlling how aggressively to filter sensitive content.<!-- -->Text prompts provided as inputs and images (generated or uploaded) through Imagen on Vertex AI are assessed against a list of safety filters, which include 'harmful categories' (for example, <code>violence</code>, <code>sexual</code>, <code>derogatory</code>, and <code>toxic</code>). This filter level controls how aggressively to filter out potentially harmful content from responses. See the [documentation](http://firebase.google.com/docs/vertex-ai/generate-images) and the [Responsible AI and usage guidelines](https://cloud.google.com/vertex-ai/generative-ai/docs/image/responsible-ai-imagen#safety-filters) for more details. |
| [InferenceMode](./ai.md#inferencemode) | <b><i>(Public Preview)</i></b> Determines whether inference happens on-device or in-cloud. |
| [InferenceSource](./ai.md#inferencesource) | <b><i>(Public Preview)</i></b> Indicates whether inference happened on-device or in-cloud. |
| [Language](./ai.md#language) | <b><i>(Public Preview)</i></b> The programming language of the code. |
| [Language](./ai.md#language) | The programming language of the code. |
| [LanguageModelMessageContentValue](./ai.md#languagemodelmessagecontentvalue) | <b><i>(Public Preview)</i></b> Content formats that can be provided as on-device message content. |
| [LanguageModelMessageRole](./ai.md#languagemodelmessagerole) | <b><i>(Public Preview)</i></b> Allowable roles for on-device language model usage. |
| [LanguageModelMessageType](./ai.md#languagemodelmessagetype) | <b><i>(Public Preview)</i></b> Allowable types for on-device language model messages. |
| [LiveResponseType](./ai.md#liveresponsetype) | <b><i>(Public Preview)</i></b> The types of responses that can be returned by [LiveSession.receive()](./ai.livesession.md#livesessionreceive)<!-- -->. This is a property on all messages that can be used for type narrowing. This property is not returned by the server, it is assigned to a server message object once it's parsed. |
| [Modality](./ai.md#modality) | Content part modality. |
| [Outcome](./ai.md#outcome) | <b><i>(Public Preview)</i></b> Represents the result of the code execution. |
| [Outcome](./ai.md#outcome) | Represents the result of the code execution. |
| [Part](./ai.md#part) | Content part - includes text, image/video, or function call/response part types. |
| [ResponseModality](./ai.md#responsemodality) | <b><i>(Public Preview)</i></b> Generation modalities to be returned in generation responses. |
| [Role](./ai.md#role) | Role is the producer of the content. |
@@ -214,7 +214,7 @@ The Firebase AI Web SDK.
| [ThinkingLevel](./ai.md#thinkinglevel) | A preset that controls the model's "thinking" process. Use <code>ThinkingLevel.LOW</code> for faster responses on less complex tasks, and <code>ThinkingLevel.HIGH</code> for better reasoning on more complex tasks. |
| [Tool](./ai.md#tool) | Defines a tool that model can call to access external knowledge. |
| [TypedSchema](./ai.md#typedschema) | A type that includes all specific Schema types. |
| [URLRetrievalStatus](./ai.md#urlretrievalstatus) | <b><i>(Public Preview)</i></b> The status of a URL retrieval. |
| [URLRetrievalStatus](./ai.md#urlretrievalstatus) | The status of a URL retrieval. |
## function(app, ...)
@@ -721,9 +721,6 @@ InferenceSource: {
## Language
> 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.
>
The programming language of the code.
<b>Signature:</b>
@@ -772,9 +769,6 @@ Modality: {
## Outcome
> 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.
>
Represents the result of the code execution.
<b>Signature:</b>
@@ -849,9 +843,6 @@ ThinkingLevel: {
## URLRetrievalStatus
> 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.
>
The status of a URL retrieval.
<b>URL\_RETRIEVAL\_STATUS\_UNSPECIFIED:</b> Unspecified retrieval status. <br/> <b>URL\_RETRIEVAL\_STATUS\_SUCCESS:</b> The URL retrieval was successful. <br/> <b>URL\_RETRIEVAL\_STATUS\_ERROR:</b> The URL retrieval failed. <br/> <b>URL\_RETRIEVAL\_STATUS\_PAYWALL:</b> The URL retrieval failed because the content is behind a paywall. <br/> <b>URL\_RETRIEVAL\_STATUS\_UNSAFE:</b> The URL retrieval failed because the content is unsafe. <br/>
@@ -1033,9 +1024,6 @@ export type InferenceSource = (typeof InferenceSource)[keyof typeof InferenceSou
## Language
> 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.
>
The programming language of the code.
<b>Signature:</b>
@@ -1108,9 +1096,6 @@ export type Modality = (typeof Modality)[keyof typeof Modality];
## Outcome
> 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.
>
Represents the result of the code execution.
<b>Signature:</b>
@@ -1194,9 +1179,6 @@ export type TypedSchema = IntegerSchema | NumberSchema | StringSchema | BooleanS
## URLRetrievalStatus
> 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.
>
The status of a URL retrieval.
<b>URL\_RETRIEVAL\_STATUS\_UNSPECIFIED:</b> Unspecified retrieval status. <br/> <b>URL\_RETRIEVAL\_STATUS\_SUCCESS:</b> The URL retrieval was successful. <br/> <b>URL\_RETRIEVAL\_STATUS\_ERROR:</b> The URL retrieval failed. <br/> <b>URL\_RETRIEVAL\_STATUS\_PAYWALL:</b> The URL retrieval failed because the content is behind a paywall. <br/> <b>URL\_RETRIEVAL\_STATUS\_UNSAFE:</b> The URL retrieval failed because the content is unsafe. <br/>
docs-devsite/ai.urlcontextmetadata.md
+1 -7
View File
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}
# URLContextMetadata interface
> 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.
>
Metadata related to [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface)<!-- -->.
<b>Signature:</b>
@@ -25,13 +22,10 @@ export interface URLContextMetadata
| Property | Type | Description |
| --- | --- | --- |
| [urlMetadata](./ai.urlcontextmetadata.md#urlcontextmetadataurlmetadata) | [URLMetadata](./ai.urlmetadata.md#urlmetadata_interface)<!-- -->\[\] | <b><i>(Public Preview)</i></b> List of URL metadata used to provide context to the Gemini model. |
| [urlMetadata](./ai.urlcontextmetadata.md#urlcontextmetadataurlmetadata) | [URLMetadata](./ai.urlmetadata.md#urlmetadata_interface)<!-- -->\[\] | List of URL metadata used to provide context to the Gemini model. |
## URLContextMetadata.urlMetadata
> 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.
>
List of URL metadata used to provide context to the Gemini model.
<b>Signature:</b>
docs-devsite/ai.urlmetadata.md
+2 -11
View File
@@ -10,9 +10,6 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}
# URLMetadata interface
> 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.
>
Metadata for a single URL retrieved by the [URLContextTool](./ai.urlcontexttool.md#urlcontexttool_interface) tool.
<b>Signature:</b>
@@ -25,14 +22,11 @@ export interface URLMetadata
| Property | Type | Description |
| --- | --- | --- |
| [retrievedUrl](./ai.urlmetadata.md#urlmetadataretrievedurl) | string | <b><i>(Public Preview)</i></b> The retrieved URL. |
| [urlRetrievalStatus](./ai.urlmetadata.md#urlmetadataurlretrievalstatus) | [URLRetrievalStatus](./ai.md#urlretrievalstatus) | <b><i>(Public Preview)</i></b> The status of the URL retrieval. |
| [retrievedUrl](./ai.urlmetadata.md#urlmetadataretrievedurl) | string | The retrieved URL. |
| [urlRetrievalStatus](./ai.urlmetadata.md#urlmetadataurlretrievalstatus) | [URLRetrievalStatus](./ai.md#urlretrievalstatus) | The status of the URL retrieval. |
## URLMetadata.retrievedUrl
> 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.
>
The retrieved URL.
<b>Signature:</b>
@@ -43,9 +37,6 @@ retrievedUrl?: string;
## URLMetadata.urlRetrievalStatus
> 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.
>
The status of the URL retrieval.
<b>Signature:</b>
packages/ai/src/types/content.ts
+4 -4
View File
@@ -155,7 +155,7 @@ export interface FileDataPart {
/**
* Represents the code that is executed by the model.
*
* @beta
* @public
*/
export interface ExecutableCodePart {
text?: never;
@@ -175,7 +175,7 @@ export interface ExecutableCodePart {
/**
* Represents the code execution result from the model.
*
* @beta
* @public
*/
export interface CodeExecutionResultPart {
text?: never;
@@ -195,7 +195,7 @@ export interface CodeExecutionResultPart {
/**
* An interface for executable code returned by the model.
*
* @beta
* @public
*/
export interface ExecutableCode {
/**
@@ -211,7 +211,7 @@ export interface ExecutableCode {
/**
* The results of code execution run by the model.
*
* @beta
* @public
*/
export interface CodeExecutionResult {
/**
packages/ai/src/types/enums.ts
+4 -4
View File
@@ -400,7 +400,7 @@ export type InferenceSource =
/**
* Represents the result of the code execution.
*
* @beta
* @public
*/
export const Outcome = {
UNSPECIFIED: 'OUTCOME_UNSPECIFIED',
@@ -412,14 +412,14 @@ export const Outcome = {
/**
* Represents the result of the code execution.
*
* @beta
* @public
*/
export type Outcome = (typeof Outcome)[keyof typeof Outcome];
/**
* The programming language of the code.
*
* @beta
* @public
*/
export const Language = {
UNSPECIFIED: 'LANGUAGE_UNSPECIFIED',
@@ -429,7 +429,7 @@ export const Language = {
/**
* The programming language of the code.
*
* @beta
* @public
*/
export type Language = (typeof Language)[keyof typeof Language];
packages/ai/src/types/responses.ts
+4 -4
View File
@@ -380,7 +380,7 @@ export interface Segment {
/**
* Metadata related to {@link URLContextTool}.
*
* @beta
* @public
*/
export interface URLContextMetadata {
/**
@@ -392,7 +392,7 @@ export interface URLContextMetadata {
/**
* Metadata for a single URL retrieved by the {@link URLContextTool} tool.
*
* @beta
* @public
*/
export interface URLMetadata {
/**
@@ -420,7 +420,7 @@ export interface URLMetadata {
* <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
* <br/>
*
* @beta
* @public
*/
export const URLRetrievalStatus = {
/**
@@ -460,7 +460,7 @@ export const URLRetrievalStatus = {
* <b>URL_RETRIEVAL_STATUS_UNSAFE:</b> The URL retrieval failed because the content is unsafe.
* <br/>
*
* @beta
* @public
*/
export type URLRetrievalStatus =
(typeof URLRetrievalStatus)[keyof typeof URLRetrievalStatus];