Get an app

Code sample

Python

For more information, see the Vertex AI Agent Builder Python API reference documentation.

To authenticate to Vertex AI Agent Builder, set up Application Default Credentials. For more information, see Set up authentication for a local development environment.

from google.api_core.client_options import ClientOptions
from google.cloud import discoveryengine_v1 as discoveryengine

# TODO(developer): Uncomment these variables before running the sample.
# project_id = "YOUR_PROJECT_ID"
# location = "YOUR_LOCATION" # Values: "global"
# engine_id = "YOUR_ENGINE_ID"


def get_engine_sample(
    project_id: str,
    location: str,
    engine_id: str,
) -> discoveryengine.Engine:
    #  For more information, refer to:
    # https://cloud.google.com/generative-ai-app-builder/docs/locations#specify_a_multi-region_for_your_data_store
    client_options = (
        ClientOptions(api_endpoint=f"{location}-discoveryengine.googleapis.com")
        if location != "global"
        else None
    )

    # Create a client
    client = discoveryengine.EngineServiceClient(client_options=client_options)

    # The full resource name of the engine
    # e.g. projects/{project}/locations/{location}/collections/default_collection/engines/{engine_id}
    name = client.engine_path(
        project=project_id,
        location=location,
        collection="default_collection",
        engine=engine_id,
    )

    # Make the request
    response = client.get_engine(name=name)

    # Handle response
    print(response)

    return response

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.