Get Collection (Lookup) v1.0.0 Help ​

Fetches a specific Lookup collection by its unique identifier.

How can I use the Step? ​

This Step is helpful when you need to retrieve detailed information about a specific collection, such as its content, structure, or associated metadata.

How does the Step work? ​

The Step requires the collection name as input. It interacts with the Lookup system to fetch the collection and returns detailed information about the collection, including its ID, account association, properties, creation date, and more.

Prerequisites ​

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

Input settings ​

  • Collection: A Lookup collection you wish to retrieve. This field is required.

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 returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output object has the following properties:

  • id: [string] the id of the collection.
  • accountId: [string] the id of the account that the collection belongs to.
  • description: [string] the description of the collection.
  • imageUrl: [string] the URL of the image associated with the collection.
  • maxDistance: [string] the maximum vector distance determines semantic similarity to the query.
  • name: [string] the name of the collection.
  • temperature: [number] the temperature of the collection.
  • createdAt: [string] the timestamp when the collection was created.
  • updatedAt: [string] the timestamp when the collection was last updated.
  • countPassages: [number] the number of passages in the collection.
  • properties: [array] an array of objects representing the properties of the collection. Each object has three properties:
    • name: [string] the name of the property.
    • dataType: [string] the data type of the property.
    • description: [string] the description of the property.

Example:

json
{
  "id": "string",
  "accountId": "string",
  "description": "string",
  "imageUrl": "string",
  "maxDistance": "string",
  "name": "string",
  "temperature": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "countPassages": 0,
  "properties": [
    {
      "name": "string",
      "dataType": "string",
      "description": "string"
    }
  ]
}
{
  "id": "string",
  "accountId": "string",
  "description": "string",
  "imageUrl": "string",
  "maxDistance": "string",
  "name": "string",
  "temperature": 0,
  "createdAt": "string",
  "updatedAt": "string",
  "countPassages": 0,
  "properties": [
    {
      "name": "string",
      "dataType": "string",
      "description": "string"
    }
  ]
}

Error handling ​

By default, the Step handles errors using a separate exit. So if any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, 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