Create an app

This page describes how to create a Gemini Enterprise app.

Note: You can't connect website data stores to your Gemini Enterprise search and assistant apps.

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. To provide your company's external name, expand Advanced options. 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.

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.

   Key Term: In Gemini Enterprise, the term app can be used interchangeably with the term engine in the context of APIs. A Gemini Enterprise engine is a generic search engine where the app_type field is set to APP_TYPE_INTRANET.

   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",
     "dataStoreEntityIds": ["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.

   Example command and result

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   -H "X-Goog-User-Project: my-project-123" \
   "https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines?engineId=my-app" \
   -d '{
     "displayName": "my-app",
     "dataStoreIds": ["slack_1234567890123_conversation", "slack_1234567890123_file", "slack_1234567890123_message"],
     "solutionType": "SOLUTION_TYPE_SEARCH",
     "industryVertical": "GENERIC",
     "appType": "APP_TYPE_INTRANET"
   }'
   
   {
     "name": "projects/123456/locations/global/collections/default_collection/operations/create-engine-12345678901234567890",
     "done": true,
     "response": {
       "@type": "type.googleapis.com/google.cloud.discoveryengine.v1.Engine",
       "name": "projects/123456/locations/global/collections/default_collection/engines/my-app",
       "displayName": "my-app",
       "dataStoreIds": [
         "slack_1234567890123_conversation",
         "slack_1234567890123_file",
         "slack_1234567890123_message"
       ],
       "solutionType": "SOLUTION_TYPE_SEARCH",
       "searchEngineConfig": {
         "searchTier": "SEARCH_TIER_STANDARD"
       },
       "industryVertical": "GENERIC",
       "appType": "APP_TYPE_INTRANET"
     }
   }
   

What's next

• To connect your data sources, see Connect a Google data source and Connect a third-party data source.
• Preview search results