IBM Watson Discovery (EMS)

The IBM Watson Discovery modules allow you to search the collection in your IBM Watson Discovery account.

Getting Started with IBM Watson Discovery

Prerequisites

The module dialog fields that are displayed in bold (in the Integromat scenario, not in this documentation article) are mandatory!

Connecting IBM Watson Discovery to Integromat

To connect your IBM Watson Discovery account to Integromat you need to obtain the Service-Specific Key from your IBM Watson Discovery account and insert it in the Create a connection dialog in the Integromat module.

1. Log in to your IBM Watson Discovery account.

2. Click Your Registered Service > Resource List

3. Copy the API Key mentioned at the end of the URL address to your clipboard. 



4. Go to Integromat and open the IBM Watson Discovery module's Create a connection dialog.

5. In the Connection name field, enter a name for the connection.

6. In the Region field, enter your account's region. For example, the us-east. You can find the region on your resource page. 

7. In the Instance ID/GUID field, enter your resource ID. You can find the Instance ID by clicking the service.

8. In the Service-specific API Key field, enter the API token copied in step 3 and click Continue.

The connection has been established.

Query

Query a Collection

Performs a query over a collection.

ConnectionEstablish a connection to your IBM Watson Discovery account.
Environment IDEnter (map) the Environment ID of the collection whose documents you want to search.
Collection IDEnter (map) the ID of the collection whose documents you want to search.
QueryEnter (map) the word or phrase or query to search all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
Natural Language QueryEnter (map) the natural language query that returns relevant documents by utilizing training data and natural language understanding.
FilterEnter (map) a cacheable query to exclude the documents that do not contain the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set. To know more about the differences between the filter and query parameters, see here.
SortAdd the fields to sort the results:
Field
Select or map the field to sort the
Direction

Select or map the order in which you want to display the results.
HighlightSelect whether you want to highlight the matching queries with <em></em> tags around the matching query terms.
ReturnA comma-separated list of the portion of the document hierarchy to return.
BiasWhen a date type field is specified returned results are biased towards field values closer to the current date.
When a number type field is specified, returned results are biased towards higher field values.
Note: This parameter cannot be used in the same query as the sort parameter.
Opt out LoggingSelect whether you do not want to store the queries in the Discovery Logs endpoint.
CountSet the maximum number of results Integromat should return during one execution cycle.

Query a Collection 

Performs an advanced query over a collection. Optionally aggregates the results or returns related passages.

ConnectionEstablish a connection to your IBM Watson Discovery account.
Environment IDEnter (map) the Environment ID of the collection whose documents you want to search.
Collection IDEnter (map) the ID of the collection whose documents you want to search.
QueryEnter (map) the word or phrase or query to search all documents in your data set with full enrichments and full text, but with the most relevant documents listed first.
Natural Language QueryEnter (map) the natural language query that returns relevant documents by utilizing training data and natural language understanding.
AggregationEnter (map) the array of aggregations. For more information about aggregations, see here
FilterEnter (map) a cacheable query to exclude the documents that do not contain the query content. Filter searches are better for metadata-type searches and for assessing the concepts in the data set. To know more about the differences between the filter and query parameters, see here.
SortAdd the fields to sort the results:
Field
Select or map the field to sort the
Direction

Select or map the order in which you want to display the results.
HighlightSelect whether you want to highlight the matching queries with <em></em> tags around the matching query terms.
ReturnAdd the portion of the document hierarchy to return. For example, text
PassagesSelect whether you want to return the most relevant passages from the results.
SimilarSelect whether you want similar results based on the specified document ID.
DeduplicateDuplicate comparison is limited to the current query only, offset is not considered. This parameter is currently Beta functionality. 
BiasEnter (map) a date or number against which the returned results will be biased.
When a date type field is specified returned results are biased towards field values closer to the current date.
When a number type field is specified, returned results are biased towards higher field values.
Note: This parameter cannot be used in the same query as the sort parameter.
Spelling SuggestionsSelect whether you receive spelling suggestions. This field is only valid when using the Cloud Pak version of IBM Watson Discovery. 
Opt out LoggingSelect whether you do not want to store the queries in the Discovery Logs endpoint.
OffsetEnter (map) the number of query results to skip at the beginning.
CountSet the maximum number of results Integromat should return during one execution cycle.

Other

Make a V1 API Call

Performs an arbitrary authorized API call.

ConnectionEstablish a connection to your IBM Watson Discovery account.
URL

Enter a path relative to https://api.{region}.discovery.watson.cloud.ibm.com/instances/{instance}/v1  For example: /environments 

For the list of available endpoints, refer to the IBM Watson Discovery API Documentation.

MethodSelect the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
HeadersEnter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query StringEnter the request query string.
BodyEnter the body content for your API call.

Example of Use - Get Environment

The following API call returns all the conversations from your IBM Watson Discovery account:

URL:
/environment

Method:
GET

Matches of the search can be found in the module's Output under Bundle > Body > data
In our example, 1 environment was returned:


Popular use cases from our blog

procur

How to Automate Procurement in Your Shopify Store - Part 1

Using Notion as CMS for Webflow -Tutorial- -illustration.png

How to Use Notion as a CMS for Your Webflow Site [Tutorial]

Basic-tutorial-for-Revolut-users-illustration.png

How to Create Your First Revolut Business Automation [Tutorial]

cancelled saas subscriptions-ILLUSTRATION.png

How to Track SaaS Subscriptions to Reduce Churn [Tutorial]

jira-excel-automation.png

How to Export From Jira to Excel Using Integromat [Tutorial]

influencer partner code sign up tracking-Illustration.png

How to Track Influencer Campaigns With Integromat

Didn’t find what you were looking for?

Ticket

Create a ticket

Contact our world-class support team and tell us what’s happening.

Create a ticket
Expert

Find an expert

We feature a network of 450+ certified partners across the globe who are ready to help

Find an expert

Automate any workflow in your business

Sign up for a free account today. No credit card required, no time limits on free plan.