1. Search experiences

Manage push sources

A push source is an index of content submitted directly to SitecoreAI using the Push API. When content is submitted, SitecoreAI validates the data, stores it in the source's index, and makes it available to connected search experiences.

Push sources let you determine what content is indexed, when updates are submitted, and how content changes are synchronized with SitecoreAI. They are well suited for content stored in external systems, content that cannot be crawled, and scenarios that require near real-time indexing.

Unlike site sources, which discover content by crawling websites, and content sources, which ingest content from the Content editor, push sources receive content through authenticated API requests.

To submit content to a push source, use the Ingestion Service API.

Create a push source

Before you create a push source, create a Push API key and ensure that you have securely stored it. The key is displayed only once. Push API keys are instance-wide, so a valid key can send documents to any source in the SCAI instance.

Define every field that you plan to send before you create the source. The Push API cannot create fields when it processes a request. For information about creating and managing keys and sending documents, see Ingestion Service API.

Tip

You can save a source as a draft while you configure it and continue working on it later.

To create a push source:

  1. On the menu bar, click Content > Search sources.
  2. On the Search Sources page, click Create Source.
  3. In the Create new search source dialog, click Push Source.
  4. In the Create new search source dialog, in the Source Name field, enter a name for your source.
  5. Optionally, enter a description of your source.
  6. Click Next step.
  7. Click the Locales drop-down list to choose the languages that this source will support, and then click Next Step.
  8. Configure the fields in your source and their behavior, and then click Next Step.
  9. Enable the advanced settings you want to use in this source and then click Save.

After the source is created, applications can ingest content by submitting authenticated requests to the Push API. See Ingestion Service API for request and response details.

View a push source

Clicking on a source allows you to view and edit that source's configurations, including fields and rules.

To view the details associated with a source:

  1. On the menu bar, click Content > Search sources.
  2. Click a source.
  3. Click any of the following tabs:
    • Fields - displays the list of fields indexed by the source, and their configurations.
    • Pinning Rules - displays a list of pinning rules active on the source. Click Add a pin to create a pin rule.
    • Boost/Bury Rules - displays a list of boost and bury rules active on the source. Click Add new rule to create a new boost or bury rule.
    • Settings - displays the source settings, such as the source name, ID, and advanced settings.
    • Preview - displays a preview of the content indexed in this source, and the number of fields that have been indexed for each item.
Important

Push sources do not retain a history of documents that you submit. To rebuild an index, you must submit the full set of documents again.

Delete a push source

Important

When you delete a source, search components connected to that source do not return results. You can select a new source in the Source Configuration Manager menu.

To delete a push source:

  1. On the menu bar, click Content > Search sources.
  2. Next to the source you want to delete, click Actions .
  3. Click Delete.
  4. To confirm the deletion, click Delete.

Configure a search component

After you have created a source, the next step is to configure a search component so your search experience can display the content indexed by that source.

If you have suggestions for improving this article, let us know!