Search

Description

This Step template allows searching for documents in a collection based on a specific query. You can use various parameters to filter, sort, and limit the results.

Authorization

There are two options for authorization:

  1. Inherit from previous Flow (set by default)
  2. Manual token (you can manually enter the token)

Parameters

  • Collection ID: the ID of the existing LookUp collection to which documents belong. This is a required field, it is empty by default.
  • Term: the search term, query, or keywords. This is a required field, it is empty by default.
  • Limit: limits the number of search results. It is not required and the default value is 15.

Advanced settings

  • Filtering: a weaviate filter object for advanced filtering. It is not required and is turned off by default.
  • Select: an array of custom properties to include in the results. It is not required and the default value is an empty array.

Merge field settings

The content is returned at the requested URL. The returned data is an object.

Error handling

This is a checkbox field that is selected by default. If you deselect the checkbox, there won't be a log with an error leg. The Flow will proceed down this exit if an error occurred during the Step execution, such as an invalid API key, empty API key, empty required parameters, invalid required parameters, etc.

Timeout Handling

Timeout is handled as a separate leg with a default value of 30 seconds. You can set up the timeout duration between 10 seconds and 30 minutes.

Reporting

This is a Step event.