Search (Lookup) v1.0.0 Help ​

Performs advanced search within a specific Lookup collection.

How can I use the Step? ​

Utilize this Step to search for specific content or answers within documents in a Lookup collection. It's particularly useful for retrieving precise information from large volumes of text or when dealing with complex queries.

How does the Step work? ​

The Step executes a search query against a specified collection in the Lookup system. It uses parameters like query term, limit, maximum distance, filtering, and selected properties to narrow down and fetch the most relevant search results.

Prerequisites ​

  • A Lookup collection for querying.
  • For custom authentication, ensure proper cross-account settings with the Super Admin permission level for account and Flow and the necessary account ID or authentication token.

Input settings ​

  • Collection: an existing Lookup collection to perform the search. Required.
  • Query: text inputs like the term, question, or keywords to search within the selected collection. Required.
  • Limit: the maximum number of search results to return. It must be greater than or equal to 1. Required and defaults to 5.
  • Maximum distance: defines how closely information retrieved from the Lookup collection matches your question. It must be in a range from 0 to 1, where 0 means only extremely similar passages are accepted, while 1 allows for unrelated passages. Required and defaults to 0.3 for relevant and on-topic answers.

Advanced settings ​

  • Properties: properties to include in the search results. Optional.
  • Filtering: Weaviate filter object for advanced result filtering. Optional.

Cross-account settings ​

To access the Lookup service of another Onereach account, take these steps:

  1. Enable Use custom authentication token.
  2. Choose one of the following access types:
    • Authentication token
    • Account ID
  3. Enter the token or account ID (depending on the chosen access type).

Merge field settings ​

The Step outputs results as a JSON object, stored under the Merge field name. Learn more at Merge fields guide.

Output example ​

The output object has the following properties:

  • id: [string] the id of the search result.
  • distance: [number] the distance of the result from the search term.
  • content: [string] the content of the search result.
  • loaderMetadata: [object] metadata about the loader.
  • sourceUrl: [string] the URL of the source.
  • document: [object] an object representing the document.
    • name: [string] the name of the document.
    • id: [string] the id of the document.

Example:

json
[
  {
    "id": "string",
    "distance": 0,
    "content": "string",
    "loaderMetadata": {},
    "sourceUrl": "string",
    "document": {
      "name": "string",
      "id": "string"
    }
  }
]
[
  {
    "id": "string",
    "distance": 0,
    "content": "string",
    "loaderMetadata": {},
    "sourceUrl": "string",
    "document": {
      "name": "string",
      "id": "string"
    }
  }
]

Error handling ​

By default, the Step uses a separate exit for error handling. If an error occurs, the Flow continues down the error exit. For more info, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events

Service dependencies ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release