web_example.py

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import os

from vertexai.generative_models import GenerationResponse

PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")


def generate_text_with_grounding_web() -> GenerationResponse:
    # [START generativeaionvertexai_gemini_grounding_with_web]
    import vertexai

    from vertexai.generative_models import (
        GenerationConfig,
        GenerativeModel,
        Tool,
        grounding,
    )

    # TODO(developer): Update and un-comment below line
    # PROJECT_ID = "your-project-id"
    vertexai.init(project=PROJECT_ID, location="us-central1")

    model = GenerativeModel("gemini-1.5-flash-001")

    # Use Google Search for grounding
    tool = Tool.from_google_search_retrieval(
        grounding.GoogleSearchRetrieval(
            # Optional: For Dynamic Retrieval
            dynamic_retrieval_config=grounding.DynamicRetrievalConfig(
                mode=grounding.DynamicRetrievalConfig.Mode.MODE_DYNAMIC,
                dynamic_threshold=0.7,
            )
        )
    )

    prompt = "When is the next total solar eclipse in US?"
    response = model.generate_content(
        prompt,
        tools=[tool],
        generation_config=GenerationConfig(
            temperature=0.0,
        ),
    )

    print(response)
    # Example response:
    # The next total solar eclipse visible from the contiguous United States will be on **August 23, 2044**.

    # [END generativeaionvertexai_gemini_grounding_with_web]
    return response


if __name__ == "__main__":
    generate_text_with_grounding_web()