Back to Firebase Js Sdk

WebGroundingChunk interface

docs-devsite/ai.webgroundingchunk.md

12.12.12.0 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

WebGroundingChunk interface

A grounding chunk from the web.

Important: If using Grounding with Google Search, you are required to comply with the Service Specific Terms for "Grounding with Google Search".

<b>Signature:</b>

typescript
export interface WebGroundingChunk 

Properties

PropertyTypeDescription
domainstringThe domain of the original URI from which the content was retrieved.<!-- -->This property is only supported in the Vertex AI Gemini API (VertexAIBackend<!-- -->). When using the Gemini Developer API (GoogleAIBackend<!-- -->), this property will be <code>undefined</code>.
titlestringThe title of the retrieved web page.
uristringThe URI of the retrieved web page.

WebGroundingChunk.domain

The domain of the original URI from which the content was retrieved.

This property is only supported in the Vertex AI Gemini API (VertexAIBackend<!-- -->). When using the Gemini Developer API (GoogleAIBackend<!-- -->), this property will be undefined<!-- -->.

<b>Signature:</b>

typescript
domain?: string;

WebGroundingChunk.title

The title of the retrieved web page.

<b>Signature:</b>

typescript
title?: string;

WebGroundingChunk.uri

The URI of the retrieved web page.

<b>Signature:</b>

typescript
uri?: string;