Create an app

This page describes how to create a Gemini Enterprise app.

Create an app

Console

  1. In the Google Cloud console, go to the Gemini Enterprise page.
  2. On the Apps page, click Create app.
  3. In the App name field, enter a name for your app.
  4. To update the automatically generated app ID, click Edit. The app ID cannot be updated after you create the app.
  5. In the Choose a location section, select a Multi-region. Use the default global (Global) multi-region unless you need to restrict your data to a specific geography.

  6. Optional. Expand Advanced options and configure the following:

    1. In the Company name field, enter your company's external name, omitting suffixes such as Inc or LLC. This helps the LLM identify the company the app represents.

    2. If you are connecting a Google Drive data store, you can allow the app to search documents outside your organization. To enable this feature, select the Include cross-domain documents checkbox.

  7. Click Create.

REST

Before you use the command line to create an app, you must have an existing data store. If you don't have a data store, you need to connect a Google data source or a third-party data source to your app.

To use the engines.create method to create an app from the command line, follow these steps:

  1. Find your data store ID. If you already have your data store ID, skip to the next step.

    1. In the Google Cloud console, go to the Gemini Enterprise page and in the navigation menu, click Data Stores.

      Go to the Data Stores page

    2. Click the name of your data store.

    3. On the Data page for your data store, get the data store ID.

  2. Create an app and connect it to a data store.

    curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "displayName": "APP_DISPLAY_NAME",
  "dataStoreIds": ["DATA_STORE_ENTITY_ID_1", "DATA_STORE_ENTITY_ID_2", "DATA_STORE_ENTITY_ID_3"],
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET"
}'

    Replace the following:

    • PROJECT_ID: the ID of your project.
    • APP_ID: the ID of the app that you want to create.
    • APP_DISPLAY_NAME: the display name of the app that you want to create.
    • DATA_STORE_ENTITY_ID: if your data store contains entities, use the specific entity IDs. If your data store does not contain entities, use the data store ID instead.

    You can include the following optional configurations in the JSON payload:

    • To provide your company's external name, include the following:

      "commonConfig": {
  "companyName": "COMPANY_NAME"
}

      Replace COMPANY_NAME with your company's external name, omitting suffixes such as Inc or LLC.

    • If you are connecting a Google Drive data store, you can allow the app to search and index documents outside your organization. To enable this feature, include the following in the JSON payload:

      "includeCrossDomainDocuments": true

What's next