Set up a GitHub data store

This page describes how to create a data store and connect GitHub to Gemini Enterprise.

Before you begin

Before setting up your GitHub connection, ensure you have the following in place:

  • Grant the Discovery Engine Editor role (roles/discoveryengine.editor). This role is required for the user to create the data store. To grant this role, do the following:

    1. In the Google Cloud console, go to the IAM page.

      Go to IAM

    2. Locate the user account and click the edit Edit icon.
    3. Grant the Discovery Engine Editor role to the user. For more information, see IAM roles and permissions.

  • Sign in to your GitHub account and obtain authentication credentials.

Create GitHub data store

To create a GitHub data store, perform the following steps:

  1. In the Google Cloud console, go to the Gemini Enterprise page.

    Gemini Enterprise

  2. Select or create a Google Cloud project.

  3. In the navigation menu, click Data stores.

  4. Click Create data store.

  5. In the Source section, search for GitHub, and click Select.

  6. In the Data section:

    1. In the Authentication settings section, enter the following details:

      • Client ID: The OAuth client ID for your application.
      • Client Secret: The OAuth client secret for your application.

      For more information about credentials, see GitHub configuration.

    2. Click Log in and complete the GitHub sign-in and authorization.

    3. In the Advanced options section, enter the organization name in the Owner login field.

    4. Click Continue.

    5. In the Entities to search section, select all the required entities.

  7. Click Continue.

  8. In the Configuration section:

    1. From the Multi-region list, select the location for your data connector.
    2. In the Your data connector name field, enter a name for your connector.
    3. If you selected us or eu as the location, configure the Encryption settings:
      • Optional: If you haven't configured single-region keys, click Go to settings page to do so. For more information, see Register a single-region key for third-party connectors.
      • Select Google-managed encryption key or Cloud KMS key.
      • If you selected Cloud KMS key:
        • In the Key management type list, select the appropriate type.
        • In the Cloud KMS key list, select the key.
      For more information, see Customer-managed encryption keys.

  9. Click Continue.

  10. In the Billing section, select General pricing or Configurable pricing. For more information, see Verify the billing status of your projects and Licenses.

  11. Click Create. Gemini Enterprise creates your data store and displays your data stores on the Data Stores page.

On the Data Stores page, click your data store name to see the status. After the data store state changes from Creating to Active, the GitHub connector is ready to be used.

After creating the data store, you can attach it to an existing app or create a new app and connect the data store to the app. For more information, see What's next.

Data handling and query execution

This section describes how Gemini Enterprise manages your query and the privacy implications of using the federated data store.

Query execution

After you authorize GitHub and send a search query to Gemini Enterprise:

  • Gemini Enterprise sends your search query directly to the GitHub API.
  • Gemini Enterprise blends the results with those from other connected data sources and displays a comprehensive search result.

Data handling

When using third-party federated search, the following data handling rules apply:

  • Your query string is sent to the third-party search backend (GitHub API).
  • These third parties may associate queries with your identity.
  • If multiple federated search data sources are enabled, the query might be sent to all of them.
  • After the data reaches the third-party system, it is governed by that system's terms of service and privacy policies.

What's next