IBM Cloud Docs
Coveo search extension setup

Coveo search extension setup

You can use Coveo to create and manage source documents. The Coveo Search API can issue search queries on an index. It is a configurable search that you can customize based on your use case. You can access Coveo search through an extension to your assistant.

To set up the extension for Coveo search:

Add an API key

In the Coveo Administration Console, add an API key. For detailed instructions, see Add an API Key in the Coveo documentation. Ensure that the API key is set to enable search and to allow Execute queries.

Download the OpenAPI specification

Download the OpenAPI specification file: coveo.openapi.json. Use this file to add the extension to your assistant.

The OpenAPI specification defines the following method:

  • GET /rest/search/v2: Search for content in a set of sources or documents.

For more information about the endpoints, see Perform a Query in the Coveo documentation.

Create and add the extension

  1. In your assistant, on the Integrations page, click Build custom extension and use the OpenAPI specification file to build a custom extension. For general instructions on building any custom extension, see Building a custom extension.

  2. After you build the Coveo extension, and it appears on your Integrations page, click Add to add it to your assistant. Use your Coveo API key to authenticate. For general instructions on adding any custom extension, see Adding an extension to your assistant.

Add the Coveo search starter kit action template

  1. Open the Actions page.

  2. If you have no actions, select Create a new action. If you already have some actions, select New action.

  3. On Create an action, select Quick start with templates.

    Quick start with templates is available in English-language assistants only.

  4. On Quick start with templates, add the Coveo search starter kit.

Edit system actions

  1. Click Set by assistant and open the No matches action.

  2. Delete the two default steps.

  3. Add a step. Set And then to Go to a subaction, and select the Coveo search action.

  4. If you are not connecting your customers to a live agent, you might want to edit the Fallback action in the same way as No matches.

Using your Coveo search extension

Issue a query to your assistant. If no action matches that query, then it uses Coveo to produce search results.