This page describes how to connect third-party data sources to Vertex AI Search.
When you connect a third-party data source, Vertex AI Search creates a data connector, and associates data stores (called entity data stores) with it for the entities that you specify. Entity types are specific to the data source that you're connecting to. For example, Jira Cloud entities include issues, attachments, comments, and worklogs.
Third-party data sources are available only for generic search apps. Chat, recommendations, and agent apps can't use third-party data sources.
Third-party connectors are not CMEK-compliant.
To import data from a Google data source instead, see Create a search data store.
Before you begin
Contact your Google account team and ask to be added to the allowlist for third-party data source connectors.
Go to the section for the source you plan to use:
- Connect Adobe Experience Manager
- Connect AODocs (Additional allowlist)
- Connect Asana
- Connect Box
- Connect Coda (Additional allowlist)
- Connect Confluence Cloud
- Connect Confluence Data Center On-premises
- Connect Dropbox
- Connect Dynamics 365
- Connect Entra ID
- Connect GitHub (Additional allowlist)
- Connect GitLab (Additional allowlist)
- Connect Jira Cloud
- Connect Jira Data Center On-premises
- Connect Microsoft Outlook (Additional allowlist)
- Connect Microsoft Teams (Additional allowlist)
- Connect Monday
- Connect Notion (Additional allowlist)
- Connect Okta
- Connect OneDrive
- Connect Salesforce
- Connect ServiceNow
- Connect SharePoint Data Center On-premises
- Connect SharePoint Online
- Connect Slack
- Connect Trello
- Connect WordPress
- Connect Workday
- Connect Zendesk (Additional allowlist)
Connect Adobe Experience Manager
Use the following procedure to sync data from Adobe Experience Manager to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
An Adobe Experience Manager administrator must generate or obtain the following for integrating with Vertex AI Search:
- Service credentials of your Adobe Experience Manager instance
- Instance URL of your Adobe Experience Manager site
Create a Adobe Experience Manager connector
Console
To use the Google Cloud console to sync data from Adobe Experience Manager to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Adobe Experience Manager to connect your third-party source.
Enter your Adobe Experience Manager authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect AODocs
Use the following procedure to sync data from AODocs to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
An AODocs administrator must generate or obtain the following for integrating with Vertex AI Search:
- Instance ID (Domain URL of your AODocs instance)
- Client ID
- Client secret
Create a AODocs connector
Console
To use the Google Cloud console to sync data from AODocs to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for AODocs to connect your third-party source.
Enter your AODocs authentication information and click Authenticate. A new window appears.
Authenticate your account and confirm that it succeeded before returning to the Specify the AODocs source for your data store page.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Asana
Use the following procedure to sync data from Asana to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For information about setting up access control, see Use data source access control.
An Asana administrator must generate or obtain the personal access token (PAT) following for authentication. For more information, see Personal access token in the Asana documentation.
To invite a member to an Asana workspace, do the following:
Sign in to Asana application with your administrator account.
Click the profile icon and select Admin console.
Click Invite member. Enter the user's email address and project you want to add.
Click Send. The user accepts the invitation to ensure they are added to the project.
To generate a PAT, do the following:
Open the Asana Developer Console.
Click My apps.
Click
Create token.In the Create new token dialog, fill the required information.
Click Create token.
Copy the token for later use.
Click Done.
Create an Asana cloud connector
Console
To use the Google Cloud console to sync data from Asana to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, select Data Stores.
Click
Create data store.On the Select a data source page, scroll or search for Asana to connect your third-party source.
Enter authentication details, including the generated PAT.
Select the entities to synchronize and click Continue.
Choose a region for the data store.
Provide a name for the data store.
Set a synchronization frequency for the data store.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
To preview how your search results appear after your app and data store are set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Box
Use the following procedure to sync data from Box to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
You must have administrator access to the Box instance with 2FA enabled. All the set up instructions can only be performed from the administrator account.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Read Setup with JWT in the Box documentation for an overview of the setup with screenshots.
Create a Box app
- Sign in to the Box Developer Console with your administrator account.
- Click Create platform app.
- Select App type as Custom app.
- Enter the App name.
- Set the following properties:
- Purpose: Integration
- Categories: AI
- External system: Google Cloud Agent Builder
- Select Authentication method as Server authentication (with JWT).
- Click Create app.
Configure the Box app
- In the Box Developer Console, choose the Platform app and then go to the Configuration tab.
- In the App access level section, select App + Enterprise access.
In the Application scopes section, select the following scopes:
- Read all files and folders stored in Box
- Write all files and folders stored in Box
- Manage users
- Manage groups
- Manage enterprise properties
In the Advanced features section, select Make API calls using the as-user header.
In the Add and manage public keys section, click Generate a public/private keypair.
- The public key is automatically uploaded to the console with an ID. This ID is used when creating a connection.
- You can download a configuration file with the private key and passphrase. Make sure to keep this file for later use.
- Optionally, to generate your own key, see the Box keypair setup guide.
Click Save changes.
Authorize the Box app
- In the Box Developer Console, choose the Platform app and then go to the Authorization tab.
- Click Review and submit.
- In the Review app authorization submission dialog, click Submit.
- Sign in to the Box admin platform apps manager with your administrator account.
- Choose the Platform app that you have configured.
- Click the three dots (...) in the corresponding row.
- Select Authorize app from the drop-down list.
- In the Authorize app dialog, click Authorize to complete the authorization process.
Have the following Box authentication information ready:
- Enterprise ID: Obtain it from the General settings tab.
- Client ID and Client secret: Obtain it from the Configuration tab under OAuth 2.0 credentials.
- Private key, Key ID, and Passphrase: These parameters were already generated and downloaded to a local file from the Configuration tab under Add and manage public keys while configuring the app.
Create a Box connector
Console
To use the Google Cloud console to sync data from Box to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Box to connect your third-party source.
Enter your authentication information.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data store.
Select a synchronization frequency for your data store.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
To preview how your search results appear after your app and data store are set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Coda
Use the following procedure to sync data from Coda to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
A Coda administrator must generate or obtain the Coda API token to integrate with Vertex AI Search.
Create a Coda connector
Console
To use the Google Cloud console to sync data from Coda to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Coda to connect your third-party source.
Enter your Coda authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Confluence Cloud
Use the following procedure to sync data from Confluence Cloud to Vertex AI Search.
After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.
Before you begin
Before setting up your connection:
Verify that you have administrator access to the Confluence instance and project.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Set up authentication and permissions in Confluence
Make sure that you have the necessary authentication details and administrator access to your Confluence instance. Use the following instructions to create a client ID and client secret through the Atlassian Developer Console, configure the required OAuth 2.0 scopes, set up permissions for users, retrieve your instance URL and ID, configure roles, and authenticate to sync data between Confluence Cloud and Vertex AI Search. To enable OAuth 2.0 and obtain the client ID and secret, see OAuth 2.0 (3LO)apps in the Atlassian Developer documentation.
Create an OAuth 2.0 integration in the Atlassian Developer Console:
- Sign in to Atlassian Developer Console.
- Click the profile icon and select Atlassian Developer Console.
- Click Create and select OAuth 2.0 Integration.
- Enter a name for the app and do the following:
- Check the terms and conditions checkbox.
- Click Create.
- Click Authorization.
- In the Authorization type table, select Add for OAuth 2.0 (3LO).
- In the Callback URL field, enter
https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html
. - Click Save changes.
If you see the warning: Your app doesn't have any APIs. Add APIs to your app, proceed to step 2 and complete all the remaining steps. Otherwise, skip to step 4 and step 5.
Enable OAuth 2.0:
- Click Permissions.
- Go to Confluence API.
- Click Add.
- Click Configure.
- Go to the Granular scopes tab and click Edit scopes.
- Select the following scopes.
- Confirm that seven scopes are selected and save your changes.
Obtain the client ID and client secret:
- Click Distribution.
- Select Edit.
- Select Sharing to enable editing other fields.
- Fill out the remaining fields.
- Select Yes when you see
Does your app store personal data?
- Select Settings to copy your Client ID and Client secret.
Obtain the instance URL:
- Go to atlassian.net and sign in with your administrator account.
- Select the app you want to sync. For example, sync the first app.
- Find the instance URL. It appears as the subdomain in the address bar.
Obtain the instance ID:
- Open a new tab, copy the instance URL, and append
/_edge/tenant_info
to the instance URL. For example,https://YOUR-INSTANCE.atlassian.net/_edge/tenant_info
. - Navigate to the link to find the
cloudId
value. ThecloudId
is your instance ID.
- Open a new tab, copy the instance URL, and append
Set up permissions and roles
- Sign in to atlassian.com with your administrator account.
- Click the menu icon or go to admin.atlassian.com.
- On the Admin page, click Manage users and go to the Groups page.
- Go to your Atlassian domain site and open the Confluence Cloud instance.
- Navigate to IAM.
Grant the Confluence administrator the Discovery Engine role. This allows the Confluence administrator to configure the connector as outlined in Create a Confluence Cloud connector.
Grant a user the administrator role:
- Create a dedicated user account. Use this account for data store setup.
- Assign the Admin role to the new user.
Configure permissions in Atlassian:
Go to your Atlassian domain site and open the Confluence Cloud instance. Alternatively, go directly to admin.atlassian.com.
Click the menu icon and select the required option.
Optional: If prompted, select the appropriate organization from the landing page.
Create and configure groups:
- On the Administrator page, click the Manage users button if required and select Manage users from the drop-down list.
- On the User management page, select Groups.
- Click Create group and assign a name. Use this group for assigning permissions required by the connector.
Add permissions to the group: Assign the User access admin role.
Assign group members:
- On the Group page, click Add product and select the appropriate product role from the drop-down list.In this case, select User access admin.
- Click Add to confirm role assignment.
- Click Add group members to include user accounts or group members. Ensure the connector authenticates on behalf of these users to fetch documents.
For user permissions to apply correctly, each Confluence Cloud user must make their email visible to all users. To achieve this,
change the email visibility settings in Confluence Cloud and set the visibility to Anyone
. For more information, see
Set your email visibility in the Atlassian documentation.
Create a Confluence Cloud connector
Console
To use the Google Cloud console to sync data from Confluence Cloud to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Confluence to connect your third-party source.
Enter your authentication information and click Authenticate.
A new window appears. Enter the instance username and password. Check that the authentication succeeded before returning to the Specify the Confluence source for your data store page.
Select which entities to sync and click Continue.
Select a region for your data connector.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data Stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect Confluence Data Center On-premises
Use this procedure to create a Confluence Data Center data store and search app in Agent Builder, syncing on-premises Confluence data with Vertex AI Search.
After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.
Before you begin
Before setting up your connection, make sure that you have the following:
- Service attachment (required for private destination type only): Configure a service attachment for secure data transfer.
- Username and password: Obtain valid credentials for authentication from your Confluence administrator.
- Optional for private destination type: Domain URL: Specify the URL of the Confluence Data Center instance.
- Optional: Base domain name: Provide the base domain name for the Confluence instance.
- Optional: Destination port: Identify the port used for communication with the Confluence Data Center.
Use the following configuration guidelines to establish connections with Private Service Connect(PSC). Adjust or add resources as needed. Make sure the PSC service attachment is properly configured to connect to the private instance and meets the requirements for a published service.
Configure network settings:
Place the PSC service attachment and load balancer in different subnets within the same Virtual Private Cloud network.
The backend system must remain closed to the public network for security reasons. However, ensure it can accept traffic from the following sources:
For proxy-based/HTTP(s) load balancers (L4 proxy ILB, L7 ILB), configure the backend to accept requests from the proxy subnet in the Virtual Private Cloud network.
For more information, see the Proxy-only subnets for Envoy-based load balancers documentation.
Adjust firewall rules:
Ingress rules:
- Allow traffic from the PSC service attachment subnet to the internal load balancer (ILB) subnet.
- Make sure that the ILB can send traffic to the backend.
- Permit health check probes to reach the backend.
Egress rules: Enable egress traffic by default, unless specific deny rules apply.
Additional considerations: Make sure to keep all the components, including the PSC service attachment and load balancer, in the same region.
Generate a service attachment
Use the following steps to generate a service attachment:
Decide endpoint type: Select Public or Private endpoint.
For Public endpoint: If the Confluence Data Center Destination type is Public, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console when creating your connector.
For Private endpoint:
- Use private service connect (PSC) to enable connections from private instances to Google Cloud.
- Create a Virtual Private Cloud network and required subnets.
- Create a virtual machine (VM) instance and install the backend service.
- Optional: Set up a health check probe to monitor backend health.
- Add a load balancer to route traffic to the VM or backend.
- Define firewall rules to allow traffic between the PSC endpoint and the backend.
- Publish the endpoint by creating a PSC service attachment.
Create a Confluence Data Center user and set up permissions
To enable Vertex AI Search to obtain data from Confluence, you need to create a new user with the minimum permissions necessary. Follow these steps to create the user and set up the required permissions.
Sign in as an administrator:
- Go to your Atlassian domain site and open the Confluence Data Center instance.
- Enter the admin username and password.
- Click Log In.
Create a new user:
When creating a data store, you must create a user to obtain data from the third-party instance.
- Click the settings icon.
- Select User management.
- Enter the administrator credentials, if prompted.
- In the Administration page, click Create user.
- Enter the email address, full name, username, and password.
- Click Create user.
Assign user to a group:
- In the Confluence administration page, navigate to the Users and security tab and click Groups.
- Click Add group. Enter a name for the group and create it.
- In the Find group field, enter the group name to find the group.
- Click the settings icon.
- Select the profile account and navigate to User management.
- In the Users page, under List users, search for the newly created user in the Find user field.
- Click the user to open the View users page.
- Click Edit groups to open the Edit user group page.
- Select the checkbox for the created user group.
- Click Save to assign the user to the newly created group.
The added user is assigned in the Group members section.
Configure user permissions:
- In the Confluence administration page, navigate to the Issues tab.
- Locate Permissions.
- Select View global permissions.
- Select Edit permissions.
- In the Edit global permissions page, search for the group assigned to the user, and enable the can use option.
Configure the documentation space
- Click the Confluence icon to navigate to the Dashboard page.
- Click Create space.
- Select Documentation space and click Next.
- Enter all the necessary details and click Create to create the documentation space.
- Under My spaces, click the newly created space.
- Navigate to Pages, and open the menu (three dots).
- Select Restrictions.
- From the Restrictions drop-down menu, select the Viewing and editing restricted option.
- Search for the group and assign the can view permission.
- Click Apply. The user is created with minimum access and permissions are set for spaces. You can also assign permissions to the blogs.
Create a Confluence Data Center On-premises connector
Console
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Confluence data center to connect your third-party source.
Enter your authentication information and click Continue.
From the Destination type drop-down list, select Public or Private.
- For Public destination type, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console.
- For Private destination type, enter all the required information:
- If your instance has a domain URL:
- Service attachment: Enter your service attachment.
- Optional: Base domain name: Enter your base domain.
- Domain URL: Enter your domain URL.
- Optional: Destination port: Enter your destination port.
- If your instance does not have a domain URL:
- Service attachment: Enter your service attachment.
- Optional: Destination port: Enter your destination port.
- If your instance has a domain URL:
Click Continue.
Optional: Advanced options: Select and enable Proxy settings and SSL settings, if required.
Under the Entities to sync, select all the required entities to sync and click Continue.
Select a region for your data connector and enter a name for your data connector.
Select a synchronization frequency.
For Private destination type, after you submit the details for the connector, VAIS sends a connection request to your PSC. Navigate to your connector to see a message to allowlist a projectId
in the PSC. The connector remains in the Error state until you allow the connection in PSC. When you accept the connection request, the connector moves to the Active state during the next sync run. If you configure your PSC to accept all connections, the connector automatically moves to the Active state after creation.
For Public destination type, the connector automatically enters the Active state after submission.
To verify the state of the data store and the ingestion activity, do the following:
- Navigate to the connector in the data store list and monitor its state until it changes to Active.
- After the connector state changes to Active, click the required entity and confirm that all selected entities are ingested. The data store state transitions from Creating to Running when synchronization begins and changes to Active once ingestion completes, indicating that the data store is set up. Depending on the size of your data, ingestion can take several hours.
Next steps
- To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
- See Preview results for apps with third-party access control.
Connect Dropbox
Use the following procedure to sync data from Dropbox to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For more information, see Use data source access control.
Have the following Dropbox authentication information ready. For information about setting up these parameters, see the OAuth Guide in the Dropbox documentation.
- Client ID
- Client secret
Create a Dropbox connector
Console
To use the Google Cloud console to sync data from Dropbox to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data Stores.
Click
Create data store.On the Select a data source page, scroll or search for Dropbox to connect your third-party source.
Enter your Dropbox authentication information and click Authenticate. A new window appears.
Authenticate your account and confirm that it succeeded before returning to the Specify the Dropbox source for your data store page.
Select which entities to sync and click Continue.
Select a location for your data store.
Enter a name for your data store.
Select a synchronization frequency for your data store.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization. Check the Documents tab to make sure your entities have been ingested correctly.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
To preview how your search results appear after your app and data store are set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Dynamics 365
Use the following procedure to sync data from Dynamics 365 to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before you create a Dynamics 365 connector:
A Dynamics 365 administrator must generate or obtain the following for integrating with Vertex AI Search:
- Client ID
- Client secret
- Azure tenant
- Organization URL
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Create a Dynamics 365 connector
Console
To use the Google Cloud console to sync data from Dynamics 365 to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Dynamics 365 to connect your third-party source.
Enter your Dynamics 365 authentication information and click Continue.
Enter your Azure tenant and organization URL and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Entra ID
Use the following procedure to sync data from Entra ID to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For information about setting up access control, see Use data source access control.
To obtain the client ID and client secret, do the following:
Create an Entra ID application:
- Sign in to Microsoft Entra administrator center and click Application.
- In the Application drop-down list, click App registrations.
- In the App registrations page, click New registration.
- Click Add new registration and do the following:
- Enter a name for the application.
- Under Supported account types, select Accounts in the organizational directory only.
- Under Redirect URI, add a web redirect URI pointing
to:
https://login.microsoftonline.com/common/oauth2/nativeclient
.
- Click Register.
Save credentials:
On your registered application window, save the following values for later use:
- Use the Application (client) ID to set the Client ID parameter.
- Use the Directory (tenant) ID to set the Azure Tenant parameter.
Create client secret:
- Navigate to Certificates & secrets and create a new client secret:
- Click New client secret and specify the required duration.
- Save the client secret and copy the key value for later use.
Configure Entra ID API permissions
- On your registered application window, click API permissions.
Under Configured permissions, select Microsoft Graph and configure the following permission:
If you want to ingest
profileCardAttributes
, then configure the following permissions:Grant admin consent for all the added permissions. An administrator's consent is required to use client credentials in the authentication flow.
Create a Entra ID connector
Console
To use the Google Cloud console to sync data from Entra ID to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Entra ID to connect your third-party source.
Under Authentication settings, enter the client ID and client secret.
Skip the Destinations option and click Continue.
Under Advanced options, enter the Azure tenant ID.
Click Continue.
Under Entities to sync, select User profiles.
Click Continue.
In Configure your data connector, select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
When the connector state changes to Active, navigate to the Entity tab.
Click userprofiles entity.
Check the number of ingested documents and ensure it matches the number of users in Entra ID.
If the Entra ID app has the required permissions to ingest custom attributes, it ingests up to 15 profile card attributes per record. By default, the custom attributes are not searchable.
To make the custom attributes searchable, do the following:
- In the userprofiles page, navigate to the Schema tab.
- Click Edit.
Deselect the attributes, such as address, from being retrievable, searchable, and indexable, then click Save.
The Edit button remains inactive for a few minutes before reactivating.
When the Edit button is in Active state, click Edit.
Select the retrievable, searchable, and indexable boxes for the required custom attributes.
Enable search.
Click Save.
Test the search engine
After configuring your search engine, test its capabilities. This ensures it returns accurate results based on user access.
Enable web app:
- Go to the app integration configurations and toggle to Enable the web app.
Test web app:
Click Open next to the web app link and sign in as a user.
Verify that search results are restricted to items accessible by the user.
Preview people search results
In the search app, navigate to Preview and start searching within the console when using Google IdP.
- Alternatively, navigate to the provided link and sign in with your IdP to start searching.
- The search results appear as people cards, displaying user details such as Name, Job title, Email, and Profile picture.
Click a people card to view a detailed profile page, which includes the following:
- Name
- Profile picture
- Job title
- Department
- Management chain
- Direct reports
If custom attributes (profile card properties) are ingested and made indexable, searchable, and retrievable:
- Searching by a custom attribute value returns only person profiles containing those attributes.
- Custom attributes appear in search results, but can only be accessed through the API, not the Vertex Search user interface.
Configure the workforce pool for non-Google IdP without SSO
If your employees use a non-Google IdP, lack SSO with Google, or are not Google Workspace customers, set up a workforce pool as described in Use data source access control to enable the employee search.
The workforce pool lets you to manage and authenticate users from external identity providers, such as Azure or Okta, within Google Cloud console.
To configure your workforce pool and enable the web app for seamless user access, do the following:
Create workforce pool at the organization level in Google Cloud by following the appropriate setup manual:
Configure the workforce pool in Agent Builder > Settings for the region where you create your app.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect GitHub
Use the following procedure to sync data from GitHub to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
A GitHub administrator must obtain the GitHub instance personal access token to integrate with Vertex AI Search.
Create a GitHub connector
Console
To use the Google Cloud console to sync data from GitHub to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for GitHub to connect your third-party source.
Enter your GitHub authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect GitLab
Use the following procedure to sync data from GitLab to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
A GitLab administrator must obtain the GitLab instance personal access token to integrate with Vertex AI Search.
Create a GitLab connector
Console
To use the Google Cloud console to sync data from GitLab to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for GitLab to connect your third-party source.
Enter your GitLab authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Jira Cloud
Use the following procedure to sync data from Jira Cloud to Vertex AI Search.
After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.
Before you begin
Before setting up your connection:
- Set up access control. Ensure that access control is properly configured for your data source. This step ensures that only authorized users can access and manage the data. For more information, see Use data source access control documentation.
- For user permissions to apply correctly, Jira Cloud users must provide sharing consent.
- Make sure that you have an Atlassian account, Jira instance, and project.
- Verify that you have administrator access to the Jira instance, and project.
Set up authentication and permissions in Jira
Using the instructions in the following sections, ensure you have the necessary authentication details and administrator access to your Jira instance. Create a client ID and client secret through the Atlassian Developer Console, configure the required OAuth 2.0 scopes, set up permissions for users, retrieve your instance URL and ID, configure roles, and authenticate to sync data between Jira Cloud and Vertex AI Search.
Create client ID and client secret
Create an OAuth 2.0 integration in the Atlassian Developer Console:
- Sign in to the Atlassian Developer Console.
- Click the profile icon and select Developer Console.
- Click Create and select OAuth 2.0 Integration.
Enter a name for the app and do the following:
- Check the terms and conditions checkbox.
- Click Create.
- Click Authorization.
- In the Authorization type table, select Add for OAuth 2.0 (3LO).
In the Callback URL field, enter
https://vertexaisearch.cloud.google.com/console/oauth/jira_oauth.html
.Click Save changes.
If you see the warning: Your app doesn't have any APIs. Add APIs to your app, proceed to step 2 and complete all the remaining steps. Otherwise, skip to step 4 and step 5.
Enable OAuth 2.0:
Select Permissions:
- Go to Jira API.
- Click Add.
- Click Configure.
- Go to the Classic scopes tab and click Edit scopes. Select the following scopes:
Confirm that eight scopes are selected, then save your changes.
Obtain the client ID and client secret:
- Click Distribution.
Select Edit, and do the following:
- Select Sharing to enable editing other fields.
- Fill out the remaining fields.
- Select Yes when you see
Does your app store personal data?
Select Settings to copy your Client ID and Client Secret.
Obtain the instance URL:
- Go to atlassian.net and sign in with your administrator account.
- Select the app you want to sync. For example, sync the first app.
- Find the instance URL, which is the subdomain in the address bar.
Obtain the instance ID:
- Open a new tab, copy the instance URL, and append
/_edge/tenant_info
to the instance URL. For example,https://YOUR-INSTANCE.atlassian.net/_edge/tenant_info
. - Navigate to the link to find the
cloudId
value. ThecloudId
is your instance ID.
- Open a new tab, copy the instance URL, and append
Set up permissions and roles
- Sign in to atlassian.com with your administrator account.
- Click the menu icon on the top left or go to admin.atlassian.com.
- On the Admin page, click Manage users and go to the Groups page.
- Click Create group. Enter a name for the group and create it.
- Click Add product.
- On the Add products to group dialog, select User access admin as the product role.
- Click Add.
- On the Groups page, click Add group members to add users or accounts that the connector authenticates.
For user permissions to apply correctly, each Jira Cloud user must make their email visible to all users. To achieve this,
change the email visibility settings in Confluence Cloud and set the visibility to Anyone
. For more information, see
Set your email visibility in the Atlassian documentation.
Create a Jira Cloud connector
Console
To use the Google Cloud console to sync data from Jira Cloud to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data Stores.
Click
Create data store.On the Select a data source page, scroll or search for Jira Cloud to connect your third-party source.
Enter your authentication information and click Authenticate.
Enter the instance username and password.
Verify that the authentication succeeded before returning to the Specify the Jira source for your data store page.
Select which entities to sync, then click Continue.
Select a region for your data store.
Enter a name for your data store.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data Stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect Jira Data Center On-premises
Use this procedure to create a Jira Data Center data store and search app in Agent Builder, syncing on-premises Jira data with Vertex AI Search.
After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.
Before you begin
Before setting up your connection, make sure that you have the following:
- Service attachment (Required for private destination type only): Configure a service attachment for secure data transfer.
- Username and password: Obtain valid credentials for authentication from your Jira administrator.
- Optional for private destination type: Domain URL: Specify the URL of the Jira Data Center instance.
- Optional: Base domain name: Provide the base domain name for the Jira instance.
- Optional: Destination port: Identify the port used for communication with the Jira Data Center.
Use the following configuration guidelines to establish connections with Private Service Connect(PSC). Adjust or add resources as needed. Make sure the PSC service attachment is properly configured to connect to the private instance and meets the requirements for a published service.
Configure network settings:
Place the PSC service attachment and load balancer in different subnets within the same Virtual Private Cloud network.
The backend system must remain closed to the public network for security reasons. However, ensure it can accept traffic from the following sources:
For proxy-based/HTTP(s) load balancers (L4 proxy ILB, L7 ILB), configure the backend to accept requests from the proxy subnet in the Virtual Private Cloud network.
For more information, see the Proxy-only subnets for Envoy-based load balancers documentation.
Adjust firewall rules:
Ingress rules:
- Allow traffic from the PSC service attachment subnet to the internal load balancer (ILB) subnet.
- Make sure that the ILB can send traffic to the backend.
- Permit health check probes to reach the backend.
Egress rules: Enable egress traffic by default, unless specific deny rules apply.
Additional considerations: Make sure to keep all the components, including the PSC service attachment and load balancer, in the same region.
Generate a service attachment
Use the following steps to generate a service attachment:
Decide endpoint type: Select Public or Private endpoint.
For Public endpoint: If the Jira Data Center Destination type is Public, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console.
For Private endpoint:
- Use PSC to enable connections from private instances to Google Cloud.
- Create a Virtual Private Cloud network and required subnets.
- Create a virtual machine (VM) instance and install the backend service.
- Optional: Set up a health check probe to monitor backend health.
- Add a load balancer to route traffic to the VM or backend.
- Define firewall rules to allow traffic between the PSC endpoint and the backend.
- Publish the endpoint by creating a PSC service attachment.
Create a Jira Data Center user and set up permissions
To enable Vertex AI Search to obtain data from Jira, you need to create a new user with the minimum permissions necessary. Follow these steps to create the user and set up the required permissions.
Sign in as an administrator:
- Go to your Atlassian domain site and open Jira Data Center instance.
- Enter the administrator username and password.
- Click Log In.
Create a new user:
When creating a data store, you must create a user to obtain data from the third-party instance.
- Click the settings icon.
- Select User management.
- Enter the administrator credentials, if prompted.
- In the Administration page, click Create user.
- Enter the email address, full name, username, and password.
- Click Create user.
Assign user to a group:
- In the Administration page, under User management, click Groups.
- Create a group by entering a name and clicking Add group.
- Select the newly created group.
- Click Add/Remove users.
- Click the member icon located next to the Add members to selected groups box.
- Select the newly created user and click Save the selection.
- Click Add selected user to see new users in the group members section.
You can see the added user is assigned in the Group members section.
Configure user permissions:
- In the Administration page, navigate to the Issues tab.
- Select Permission schemes.
- Click Add permission scheme.
- Enter a name for the scheme and click Add.
- Select the scheme and click the Permission icon.
- Click Grant permission.
- Add the following permissions, assign these permissions to the group created earlier, and click Grant:
- Browse projects.
- Browse projects archive.
- Add this scheme to projects where users in the group need access to view the project, issues, comments, worklogs, and attachments.
You can add this scheme to the projects where the users in that group need access to view that project and issues, comments, worklogs, and attachments in that project.
Configure application access
- In the Administration page, navigate to the Applications tab.
- Under the Applications tab, select Application access.
- Search for the created group and select it.
- Verify that the group appears in the access list.
The user is created with minimum access. This schema is added to the projects. The Jira administrator can add more members to that group or add users to that project.
Create a Jira Data Center On-premises connector
Console
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Jira data center to connect your third-party source.
Enter your authentication information and click Continue.
From the Destination type drop-down list, select Public or Private.
For Public destination type, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console.
For Private destination type, enter all the required information:
- If your instance has a domain URL:
- Service attachment: Enter your service attachment.
- Optional: Base domain name: Enter your base domain.
- Domain URL: Enter your domain URL.
- Optional: Destination port: Enter your destination port.
- If your instance does not have a domain URL:
- Service attachment: Enter your service attachment.
- Optional: Destination port: Enter your destination port.
- If your instance has a domain URL:
Click Continue.
Optional: Advanced options: Select and enable Proxy settings and SSL settings, if required.
Under the Entities to sync, select all the required entities to sync and click Continue.
Select a region for your data connector and enter a name for your data connector.
Select a synchronization frequency.
For Private destination type, after you submit the details for the connector, VAIS sends a connection request to your PSC. Navigate to your connector to see a message to allowlist a projectId
in the PSC. The connector remains in the Error state until you allow the connection in PSC. When you accept the connection request, the connector moves to the Active state during the next sync run. If you configure your PSC to accept all connections, the connector automatically moves to the Active state after creation.
For Public destination type, the connector automatically enters the Active state after submission. To verify the state of the data store and the ingestion activity, do the following:
- Navigate to the connector in the data store list and monitor its state until it changes to Active.
- After the connector state changes to Active, click the required entity and confirm that all selected entities are ingested. The data store state transitions from Creating to Running when synchronization begins and changes to Active once ingestion completes, indicating that the data store is set up. Depending on the size of your data, ingestion can take several hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Microsoft Outlook
Use the following procedure to sync data from Microsoft Outlook to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
A Microsoft Outlook administrator must generate or obtain the following for integrating with Vertex AI Search:
- Client ID
- Client secret
- Tenant ID
Create a Microsoft Outlook connector
Console
To use the Google Cloud console to sync data from Microsoft Outlook to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Microsoft Outlook to connect your third-party source.
Enter your Microsoft Outlook authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Microsoft Teams
Use the following procedure to sync data from Microsoft Teams to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
A Microsoft Teams administrator must generate or obtain the following for integrating with Vertex AI Search:
- Client ID
- Client secret
- Tenant ID
Create a Microsoft Teams connector
Console
To use the Google Cloud console to sync data from Microsoft Teams to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Microsoft Teams to connect your third-party source.
Enter your Microsoft Teams authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Monday
Use the following procedure to sync data from Monday to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection, make sure that you have the domain URL, administrator access, and API token.
To generate the account URL and API token, do the following:
- Sign in to the Monday application with your administrator account.
- Click the Profile icon.
- Select Administration.
- Navigate to the General tab and enter the Account name and Account URL.
- Return to the Profile icon and select Developers.
- On the Monday developer center page, click My access tokens.
- Click Show to display the token.
- Copy the token for use in authentication.
Create a Monday connector
Console
To use the Google Cloud console to sync data from Monday to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
On the Data stores page, click
Create data store.On the Select a data source page, scroll or search for Monday to connect your third-party source.
Enter your Monday authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Notion
Use the following procedure to sync data from Notion to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connector:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
A Notion administrator must generate or obtain the following for integrating with Vertex AI Search:
- API token of the Notion instance
- Workspace ID
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Create a Notion connector
Console
To use the Google Cloud console to sync data from Notion to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Notion to connect your third-party source.
Enter your Notion authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Okta
Use the following procedure to sync data from Okta to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connector, make sure that you have the domain URL and administrator access to the Okta instance. Use the following steps to obtain the Okta instance URL, client ID, and API token.
To obtain the Okta instance URL, do the following:
- Sign in to the Okta login page with your administrator credentials.
- Click your profile icon or navigate directly to the Admin console. Your Okta instance URL appears as the subdomain in the address bar.
To generate the client ID and API token, do the following:
- Sign in to your Okta instance URL with your administrator account.
- Navigate to the Admin dashboard.
- Click the Applications icon and select Applications.
- Click Create app integration.
- Select OIDC - OpenID Connect.
- Select Web application as the application type, and then click Next.
- Enter a name in the App integration name field.
- Scroll to see Assignments, select Skip group assignment for now.
- Click Save.
- In the Client credentials window, click Edit.
- Select Public key / Private key.
- Under Public key, click Add key.
- Click Generate new key, and then click Done and Save.
- A dialog appears; click Save.
- Under General settings, click Edit.
- Select Client credentials, and then click Save.
Create a Okta connector
Console
To use the Google Cloud console to sync data from Okta to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Okta to connect your third-party source.
Enter your Okta authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect OneDrive
Use the following procedure to sync data from OneDrive to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Have the following OneDrive authentication information ready:
Client ID, client secret, and tenant ID. For information about setting up these parameters, see Quickstart: Register an application with the Microsoft identity platform in the Microsoft documentation.
Specify scopes for access. An administrator role is required. For more information, see Quickstart: Configure a client application to access a web API in the Microsoft documentation.
Configure the following scopes:
Create a OneDrive connector
Console
To use the Google Cloud console to sync data from OneDrive to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for OneDrive to connect your third-party source.
Enter your OneDrive authentication information.
Select which entities to sync and cick Continue.
Select a region for your data store.
Enter a name for your data store.
Select a synchronization frequency for your data store.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
To preview how your search results appear after your app and data store are set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Salesforce
Use the following procedure to sync data from Salesforce to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Have the following authentication information ready. For information about setting up client ID and client secret in Salesforce, see Configure a connected app for the OAuth 2.0 client credentials flow in the Salesforce documentation.
- Instance URL
- Consumer ID
- Consumer secret
The following limitations apply:
- Use either an Enterprise or Developer plan. Trial accounts are not supported.
- Make sure that you are using Sales Cloud. Service Cloud is not supported.
- Add Google Cloud to Salesforce CORS allowlist. Go the next step if you have already completed this task.
- Follow the instructions in the Salesforce documentation to configure the CORS allowlist.
- Enter
https://console.cloud.google.com/
as an origin URL and save your configuration.
Create a Salesforce connector
Console
To use the Google Cloud console to sync data from Salesforce to Vertex AI Search , follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Salesforce to connect your third-party source.
Enter your Salesforce authentication information.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data store.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect ServiceNow
Use the following procedure to sync data from ServiceNow to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection, ensure you have the following in place:
ServiceNow instance: Create a ServiceNow instance by following the instructions on the ServiceNow Developer documentation.
Google Cloud project: Set up a Google Cloud project with an admin account capable of managing organization-level configurations, ensuring the organization can set up a workforce pool.
Workforce pool: Make sure your organization is set up to manage a workforce pool.
Set up ServiceNow
ServiceNow offers two primary sites:
Main ServiceNow site: The site for your ServiceNow instance.
- Manages users, groups, and system administration tasks.
- URL: The URL for your ServiceNow instance.
- Sign in using your administrator credentials.
-
- Configures the knowledge base, sets up workflows, and develops custom applications.
- URL:
https://developer.service-now.com
. - Sign in using your ServiceNow ID.
To create an OAuth endpoint, do the following:
- Sign into the main ServiceNow instance with administrator privileges.
- Navigate to All > System OAuth > Application registry.
- Click New, then select Create an OAuth API endpoint for external clients. Retrieve the client ID and client secret.
Fill in the required information:
- Name: Unique name.
- Redirect URL:
https://vertexaisearch.cloud.google.com/console/oauth/servicenow_oauth.html
.
Click Submit to create the credential.
After submission, click the name to view the client secret.
The secret is masked. Click the lock icon next to it to unmask and view the secret.
Keep a copy of the client ID and secret to use when required.
Go to
developer.service-now.com
and click Manage instance password.Keep a copy of the username and password to use when required.
At this stage, all five pieces of information needed to set up a ServiceNow data store are available. If there are no concerns with using the Admin role to pull data, proceed to creating a data store.
Set up roles and permissions
You must have a security Admin role to create and manage users. If you don't have this role, elevate your role to security_admin by clicking Elevate role under your profile. Select the security_admin role and click Update. The security_admin role is required to create roles and manage users.
Create a custom role with ACL rules:
- Navigate to All > User administration > Roles.
- Click New to create a new role.
- Select a name and click Submit.
- Navigate to System security > Access Control (ACL) to create a new ACL rule.
- Click New to create a new ACL rule.
- Select a role, such as
sys_user_role
. - Click Submit and assign the role.
Repeat this process until all the table access is granted. The connector requires access to the following tables for each entity to run successfully:
- Incident:
incident
. - Catalog item:
sc_cat_item
,sc_cat_item_user_criteria_mtom
,sc_cat_item_user_criteria_no_mtom
,sc_cat_item_user_mtom
,sc_cat_item_user_no_mtom
. - Knowledge:
kb_knowledge
,kb_knowledge_base
,kb_uc_can_read_mtom
,kb_uc_can_contribute_mtom
. - Attachment: All listed items.
- Identity:
sys_user_role
,sys_user_has_role
,sys_user_group
,sys_user_grmember
,sys_user
. - Updated as new criteria are pulled:
core_company
,cmn_location
,cmn_department
. - User criteria:
user_criteria
.
- Incident:
Verify all ACLs are updated by navigating to
sys_security_acl_role_list.do
in the search bar.Select the role to verify.
Confirm that all the required ACLs are assigned to the selected role.
Grant the role to a service account:
- Go to All > User Administration > Users and select the user.
- Find the user to grant the role to and select the user.
If no user is available, navigate to System security > Users and groups > Users.
Click New to create a new service account in the User table.
Ensure to check the Web service access only checkbox.
Go to the Roles table at the bottom of the page.
Click Edit on the right.
Grant the role created earlier and assign it to the user. Depending on the type of role created, select the appropriate one and assign it.
Obtain the username and password for the user. From the same page, click Set password.
Auto-generate a password and save it for later use:
- User ID:
manager
. - Password: Enter the auto-generated password.
- User ID:
Configure the workforce pool
Follow the instructions to set up a workforce pool with one of the following configurations:
Create a ServiceNow connector
Console
To use the Google Cloud console to sync data from ServiceNow to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for ServiceNow to connect your third-party source.
Enter your ServiceNow authentication information.
Select which entities to sync and click Continue.
Select a region for your data connector.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect SharePoint Data Center On-premises
Use this procedure to create a SharePoint Data Center data store and search app in Agent Builder, syncing on-premises SharePoint data with Vertex AI Search.
After you set up your data source and import data the first time, you can choose how often the data store syncs with that source.
Before you begin
Before setting up your connection, do the following:
Service attachment (required for private destination type only): Use the following steps to generate a service attachment for secure data transfer.
- Decide endpoint type: Select Public or Private endpoint.
For Public endpoint: If the SharePoint Data Center Destination type is Public, you are not required to create the setup for service attachment. Instead, you can use your public URL in the Domain URL field of the Google Cloud console when creating your connector.
For Private endpoint:
- Use private service connect (PSC) to enable connections from private instances to Google Cloud
- Create a Virtual Private Cloud network and required subnets.
- Create a virtual machine (VM) instance and install the backend service.
- Optional: Set up a health check probe to monitor backend health.
- Add a load balancer to route traffic to the VM or backend.
- Define firewall rules to allow traffic between the PSC endpoint and the backend
- Publish the endpoint by creating a PSC service attachment.
Username and password: Obtain valid credentials for authentication from your SharePoint administrator.
Optional for the private destination type: Domain URL: Keep the domain URL of the SharePoint Data Center instance if the instance is behind a proxy or SSL-based connection.
Optional: Base domain name: Provide the base domain name for the SharePoint instance.
Optional: Destination port: Identify the port used for communication with the SharePoint Data Center.
Use the following configuration guidelines to establish connections with Private Service Connect(PSC). Adjust or add resources as needed. Make sure the PSC service attachment is properly configured to connect to the private instance and meets the requirements for a published service.
Configure network settings:
Place the PSC service attachment and load balancer in different subnets within the same Virtual Private Cloud network.
The backend system must remain closed to the public network for security reasons. However, ensure it can accept traffic from the following sources:
For proxy-based/HTTP(s) load balancers (L4 proxy ILB, L7 ILB), configure the backend to accept requests from the proxy subnet in the Virtual Private Cloud network.
For more information, see the Proxy-only subnets for Envoy-based load balancers documentation.
Adjust firewall rules:
Ingress rules:
- Allow traffic from the PSC service attachment subnet to the internal load balancer (ILB) subnet.
- Make sure that the ILB can send traffic to the backend.
- Permit health check probes to reach the backend.
Egress rules: Enable egress traffic by default, unless specific deny rules apply.
Additional considerations: Make sure to keep all the components, including the PSC service attachment and load balancer, in the same region.
Create a SharePoint Data Center user
To create a SharePoint Data Center user, obtain a username and password from an administrator. The administrator must follow these steps to create a new user in the SharePoint Data Center instance.
- Click Start menu.
- Navigate to Windows administrative tools > Active directory users and computers.
- Launch the Active directory users and computers application.
- Expand your organization unit and navigate to the Users container to add the new user.
- Right-click on Users and select New > User.
- In the New object: user dialog:
- Enter First name, Full name, and User logon name.
- Click Next.
- In the New object: user dialog:
- Fill in the required information:
- Password
- Confirm password
- Select the following options:
- User cannot change password
- Password never expires
- Click Next.
- Fill in the required information:
- Click Finish.
- Locate the created user in the Users section, double-click on it, and select Properties.
- In the Properties dialog:
- Add an email address for the user.
- Click Apply.
Configure the site collection in SharePoint
- Sign in to the SharePoint administrator console.
- In the Central administration page, navigate to Application management.
- Click Create site collections.
- In the Create site collection page, enter the required information in the Title and Description fields.
- In the Web sites address section, enter the URL name for the site.
- In the Primary site collection administrator section, click the Browse option next to the User name field.
- In the Select people dialog, enter the administrator username and click the search icon.
- Select the user and click Ok. The Site successfully created page appears, and the site URL is displayed.
- Copy the URL and open it in a new tab. The site appears.
Sign in with the created user
- Use the created user's credentials to sign in to the SharePoint site.
- Verify access and permissions for the user.
Create a SharePoint Data Center On-premises connector
Next steps
- To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
- See Preview results for apps with third-party access control.
Connect SharePoint Online
Use the following procedure to sync data from SharePoint Online to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Grant administrator consent. For information about how to grant consent, see Grant tenant-wide administrator consent to an application in the Microsoft Entra documentation.
Prepare the following Sharepoint Online authentication information to use during setup:
Instance URL. In the form
http://DOMAIN_OR_SERVER/[sites/]WEBSITE
.Federated authentication requires the tenant ID and client ID, while OAuth requires the tenant ID, client ID, and client secret. To register the application, select Accounts in this organizational directory only for the sign-in audience, and then locate this authentication information. For more information, see Quickstart: Register an application with the Microsoft identity platform in the Microsoft Entra documentation.
When registering the application, use
https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html
as the web callback URL.When configuring application permissions, add the following application permissions for Graph API:
When configuring application permissions, add the following delegated permissions for Sharepoint REST API:
The following table describes the roles that are recommended for configuration and their limitations.
Use this method for granular control over SharePoint REST API permissions, allowing you to restrict resource access on the user account. Make sure to create a new SharePoint user, which might add licensing costs. Use the OAuth 2.0 refresh token method to set up an Entra application registration and enable secure access to SharePoint.
Configure Entra application registration
Set up an Entra application registration to enable secure access to SharePoint. Choose between Federated credentials for token-based access or OAuth 2.0 refresh token for granular control. Use the following steps to configure the app registration, grant permissions, and establish authentication.
Federated credentials: Set up federated credentials to securely allow Google to access SharePoint using cryptographically signed tokens, avoiding the need for a real user principal. To configure permissions and grant access, do the following:
Obtain service account client ID:
- In the Google Cloud console, go to the Agent Builder page.
- In the navigation menu, click Data stores.
- Click Create data store.
- On the Select a data source page, scroll or search for SharePoint Online to connect your third-party source.
- Note the Subject identifier.
Register app in Microsoft Entra:
- Navigate to Entra administrator center.
Create an app registration:
- Supported account types: Accounts in the organizational directory only.
- Keep other settings default and click Register.
Note the Client ID and Tenant ID.
Add federated credentials:
Go to Certificates & secrets > Federated credentials > Add credential.
Use the following settings:
- Issuer:
https://accounts.google.com
- Subject identifier: Use the noted subject identifier.
- Name: Provide a unique name.
- Issuer:
Click Add to grant access.
Set API permissions:
Add and grant administrator consent for the following permissions:
GroupMember.Read.All
(Application): Read all group memberships.Sites.Read.All
(Application): Read all sites.User.Read.All
(Application): Read all users' full profiles.Sites.FullControl.All
(Application): Full control over all sites.
Use
Sites.Selected
to assign specific site permissions instead ofSites.FullControl.All
.Sites.Selected
cannot be directly configured through the UI. After selectingSites.Selected
, you must call the Microsoft Graph API to explicitly grant the fullcontrol role to the application for the sites you want to crawl.Grant
Sites.Read.All
for crawling all subsites under a root site URL.
OAuth 2.0 refresh token: Configure OAuth 2.0 authentication using a client secret and a refresh token from the SharePoint user to enable granular control over SharePoint API access. To set up app registration, add a client secret, and assign API permissions, do the following:
Create app registration:
Navigate to Entra administrator center.
Create an app registration:
- Supported account types: Accounts in the organizational directory only.
- Redirect URI:
https://vertexaisearch.cloud.google.com/console/oauth/sharepoint_oauth.html
.
Note the Client ID and Tenant ID.
Add client secret:
Go to Certificates & secrets > New client secret.
Note the secret string.
Set API permissions:
Add and grant administrator consent for the following permissions:
GroupMember.Read.All
: Read all group memberships.Sites.FullControl.All
: Full control of all site collections.User.Read.All
: Read all users' full profiles.AllSites.FullControl
: Full control over all sites.
Use a dedicated user account with limited access to specific sites.
Make sure the account has Owner access to the selected sites.
Create a SharePoint Online connector
Console
To use the Google Cloud console to sync data from Sharepoint Online to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for SharePoint Online to connect your third-party source.
Enter your Sharepoint Online authentication information and click Authenticate.
Enter the SharePoint site URL:
- For a single site:
https://<domain_name>.sharepoint.com/sites/<site_name>
. - For all first-level sites:
https://<domain_name>.sharepoint.com
.
- For a single site:
Select the entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data store.
Select a synchronization frequency for your data store.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Test the search engine
After configuring your search engine, test its capabilities. This ensures it returns accurate results based on user access.
Enable web app:
- Go to the app integration configurations and toggle to Enable the web app.
Test web app:
Click Open next to the web app link and sign in with a user in your workforce pool.
Verify that search results are restricted to items accessible by the logged-in user.
Configure the workforce pool
The workforce pool lets you to manage and authenticate users from external identity providers, such as Azure or Okta, within Google Cloud console. To configure your workforce pool and enable the web app for seamless user access, do the following:
Create workforce pool at the organization level in Google Cloud by following the appropriate setup manual:
Configure the workforce pool in Agent Builder > Settings for the region where you create your app.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect Slack
Use the following procedure to sync data from Slack to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Contact the workspace owner to provide the permissions to install new apps in your workspace.
Prepare the following Slack authentication information:
Workspace ID: Get the Workspace ID by following the instructions in Specify the Slack source for your data store in the Slack documentation.
Access token: Create a client app and define the required scopes. For more information, see Quickstart and How to quickly get and use a Slack API token in the Slack documentation.
When setting OAuth 2.0 permission scopes, configure the following scopes:
By default, Slack restricts crawling and syncing content from private channels, group messages, and direct messages.
Configure the Slack app
Obtain an access token to allow Vertex AI Search to ingest documents from your Slack workspace.
Generate a bot token to securely access private channels, instant messages (IMs), and multi-party instant messages (MPIMs). The bot token cannot crawl into the public channels it is not part of, and joining public channels generates a join message.
- Sign in to Slack API Apps.
- Click Create new app.
- Select From scratch.
- Enter a name for your app and select the workspace for integration.
- Click Create app.
- Click OAuth & permissions.
- Under Bot token scopes, add the following required scopes:
By default, the bot reads from the
#general
and#random
channels.To enable crawling, do the following:
- For public channels, grant the
channels:join
scope to allow the bot to join automatically. - For private channels, invite the bot manually.
- For public channels, grant the
Click Install to your username workspace.
Follow the on-screen instructions to install the app and retrieve the bot token.
Generate a user token to access all public channels without joining them first. The user token cannot crawl private channels, IMs, or MPIMs unless the user has access.
- Sign in to Slack API Apps.
- Click Create new app.
- Select From scratch.
- Enter a name for your app and select the workspace for integration.
- Click Create app.
- Click OAuth & permissions.
Under User token scopes, add the following required scopes:
Click Install to your username workspace.
Follow the on-screen instructions to install the app and retrieve the user token.
Create a Slack Cloud connector
Console
To use the Google Cloud console to sync data from Slack to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Slack to connect your third-party source.
Enter your Slack authentication information.
- Instance ID (Workspace ID): Obtain this from your Slack workspace by signing in through a browser. The workspace ID is the segment after
/client
in the URL. - Auth token: Use the token obtained from the previous section.
- Instance ID (Workspace ID): Obtain this from your Slack workspace by signing in through a browser. The workspace ID is the segment after
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data store.
Select a synchronization frequency for your data store.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your data store name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take minutes or hours.
Next steps
To attach your data store to an app, create an app and select your data store following the steps in Create a search app.
See Preview results for apps with third-party access control.
Connect Trello
Use the following procedure to sync data from Trello to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connector, make sure that the following steps are completed:
- Verify that you have Trello administrator access. A Trello administrator must generate an API key and token in the following section.
- Check that your project is added to the allowlist to use Trello.
- Set up access control for your data source. For information about setting up access control, see Use data source access control.
A Trello administrator must perform the following steps:
Generate an API key in Trello:
Sign in to the Trello instance using the provided test user credentials at Trello.
On the Trello Power-ups admin page, navigate to Access Power-up Admin.
Click New to create a new Power-up.
Fill in the required details:
Click Next to proceed, then generate an API key. Copy the API key and secret.
Generate an API token in Trello:
Click the Generate token link on the right to generate an API Token.
- Click Allow to grant access to your API token.
- Ensure that all required entities have the correct permissions in the scope.
Copy the generated API token. Use this token for the Trello connector on Vertex AI Search.
For more information about Trello API, see API introduction.
Create a Trello connector
Console
To use the Google Cloud console to sync data from Trello to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Trello to connect your third-party source.
Enter your Trello authentication information and click Continue.
Optional: To route HTTP traffic, click Add destination and enter the hostname or IP address of the proxy server. Then click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect WordPress
Use the following procedure to sync data from WordPress to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up the connection, ensure you have the following:
- Username and password: Obtain the credentials from the WordPress administrator.
- Site URL: Use this URL for data store creation.
Create a WordPress user
To create a WordPress user, obtain a username and password from an administrator. The administrator must sign in and follow these steps to create a new user in the WordPress instance.
Sign in as an administrator:
- Navigate to your hosting platform and sign in with your administrator credentials to access your WordPress website.
- Click the Website icon.
- Click WordPress admin for your site.
Create a new user:
- On the WordPress admin page, navigate to the Users tab.
- Click Add new.
- Fill in all the required details, including:
- Username
- Email address
- Optional: First and last name
- Role
- Password (if prompted)
- Click Add new user to save the changes.
Create a WordPress connector
Console
To use the Google Cloud console to sync data from WordPress to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for WordPress to connect your third-party source.
Enter your WordPress authentication information and click Continue.
In the URL field, enter your WordPress site URL and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Workday
Use the following procedure to sync data from Workday to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before you create a Workday connector:
A Workday administrator must generate or obtain the following for integrating with Vertex AI Search:
- Client ID. Obtain from the View API Clients page in Workday.
- Client secret. Obtain from the View API Clients page in Workday.
- Refresh token. Obtain from the View API Clients page in Workday.
- Optional: Proxy Server. The hostname or IP address of a proxy to route HTTP traffic through.
- Optional: Base URL. The base URL for the Workday connection.
- Optional: API URL. The complete URL to the API endpoint to use for making SOAP
requests. For example:
https://<var>host</var>.workday.com/ccx/service/<var>tenant</var>/<var>service</var>
- Workday tenant. The tenant for the account. For example,
abc_cms1
. You can get the name of the tenant in your Workday instance configuration details.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
Create a Workday connector
Console
To use the Google Cloud console to sync data from Workday to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Workday to connect your third-party source.
Enter your Workday authentication information and click Continue.
Optional: Enter your Workday destination information and click Continue.
Enter your Workday tenant and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.
Connect Zendesk
Use the following procedure to sync data from Zendesk to Vertex AI Search.
After you set up your data source and import data the first time, the data store syncs data from that source at a frequency that you select during setup.
Before you begin
Before setting up your connection:
In addition to the third-party connector allowlist, this connector requires that your project is added to an additional allowlist. To be added to this allowlist, contact your Vertex AI Search account team.
Set up access control for your data source. For information about setting up access control, see Use data source access control.
A Zendesk administrator must generate or obtain the following for integrating with Vertex AI Search:
- Access token. API Token of your Zendesk instance.
- Instance URI.
Create a Zendesk connector
Console
To use the Google Cloud console to sync data from Zendesk to Vertex AI Search, follow these steps:
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click
Create data store.On the Select a data source page, scroll or search for Zendesk to connect your third-party source.
Enter your Zendesk authentication information and click Continue.
Select which entities to sync and click Continue.
Select a region for your data store.
Enter a name for your data connector.
Select a synchronization frequency.
Click Create. Vertex AI Search creates your data store and displays your data stores on the Data stores page.
To check the status of your ingestion, go to the Data stores page and click your connector name to see details about it on its Data page. The Connector state changes from Creating to Running when it starts synchronizing data. When ingestion is complete, the state changes to Active to indicate that the connection to your data source is set up and awaiting the next scheduled synchronization.
Depending on the size of your data, ingestion can take several minutes or several hours.
Next steps
To attach your connector to an app, create an app and select your connector following the steps in Create a search app.
To preview how your search results appear after your app is set up, see Get search results. If you used third-party access control, see Preview results for apps with third-party access control.