This page describes how to connect third-party data sources to Vertex AI Search. Third-party data source support is in preview with allowlist.
To connect a third-party data source, go to the section for the source you plan to use:
- Connect Confluence
- Connect Jira
- Connect Salesforce
- Connect ServiceNow
- Connect Sharepoint Online
- Connect Slack
To import data from a Google data source instead, see Create a search data store.
Connect Confluence
Use the following procedure to sync data from Confluence 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 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:
Instance URL. In the form
https://EXAMPLE.atlassian.net
—for example,https://google.atlassian.net
.Instance ID. This is the
cloudid
and can be found by going tohttps://EXAMPLE.atlassian.net/_edge/tenant_info
and copying the value ofcloudId
.
Enable OAuth 2.0 and get the client ID and client secret.
Use
https://vertexaisearch.cloud.google.com/console/oauth/confluence_oauth.html
as the callback URL. For information about enabling OAuth 2.0 for Confluence and getting the client ID and client secret, see OAuth 2.0 (3LO) apps in the Atlassian Developer documentation.When setting OAuth 2.0 permission scopes, configure the following scopes:
The following limitation applies:
- For user permissions to apply correctly, Confluence users must provide sharing consent.
Console
To use the Google Cloud console to sync data from Confluence 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 New data store.
On the Source page, select Confluence.
Enter your Confluence authentication information and click Continue.
Select which entities to sync.
Click Continue.
Select a location 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. Check the Documents tab to make sure your entities have been ingested correctly.
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 Jira
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, the data store syncs data from that source at a frequency that you select during setup.
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:
Instance URL. In the form
https://EXAMPLE.atlassian.net
—for example,https://google.atlassian.net
.Instance ID. This is the
cloudid
and can be found by going tohttps://EXAMPLE.atlassian.net/_edge/tenant_info
and copying the value ofcloudId
.Client ID and client secret. For information about OAuth 2.0 for Confluence and getting the client ID and client secret, see OAuth 2.0 (3LO) apps in the Atlassian Developer documentation.
When setting OAuth 2.0 permission scopes, configure the following scopes:
The following limitation applies:
- For user permissions to apply correctly, Jira users must provide sharing consent.
Console
To use the Google Cloud console to sync data from Jira 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 New data store.
On the Source page, select Jira.
Enter your Jira authentication information and click Continue.
Select which entities to sync.
Click Continue.
Select a location 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. Check the Documents tab to make sure your entities have been ingested correctly.
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 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 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:
- Instance URL
- Consumer ID
- Consumer Secret
The following limitation applies:
- To sync a user as an entity, the user must provide sharing consent.
Console
To use the Google Cloud console to sync data from Salesforce to Vertex AI Search, follow these steps:
Add Google Cloud to your Salesforce CORS allowlist. If you have already done this, skip to the next step.
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.
In the Google Cloud console, go to the Agent Builder page.
In the navigation menu, click Data stores.
Click New data store.
On the Source page, select Salesforce.
Enter your Salesforce authentication information and click Authenticate with Salesforce.
Select which entities to sync.
Click Continue.
Select a location 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. Check the Documents tab to make sure your entities have been ingested correctly.
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 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 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:
- Instance URL
- Client ID and client secret. For information about endpoint setup and getting the client ID and client secret, see Create an endpoint for clients to access the instance in the ServiceNow documentation.
- Username and password for the ServiceNow administrator role. See Base system roles in the ServiceNow documentation.
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 New data store.
On the Source page, select ServiceNow.
Enter your ServiceNow authentication information and click Continue.
Select which entities to sync.
Click Continue.
Select a location 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. Check the Documents tab to make sure your entities have been ingested correctly.
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 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 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 Sharepoint Online authentication information ready:
- Instance URL
- Tenant ID
- Client ID
- Client Secret
- Username
- Password
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 Source page, select Sharepoint Online.
Enter your Sharepoint Online authentication information and click Authenticate.
Select the entities to sync.
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 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 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 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 Slack authentication information ready:
- Workspace ID. For information about getting workspace IDs, see Specify the Slack source for your data store in the Slack documentation.
- Access token. For information about creating a client app and defining scopes, refer to Quickstart and How to quickly get and use a Slack API token in the Slack documentation.
The following limitation applies:
- Slack's default behavior restricts the crawling and syncing of content from private channels, multi-party instant messages, and 1:1 instant messages.
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 Source page, select Slack.
Enter your Slack authentication information and click Authenticate.
Select which entities to sync.
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 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.