Get All Collections (Lookup) v1.0.0 Help ​

Retrieves all collections associated with the OneReach.ai account.

How can I use the Step? ​

You can use this Step to overview or analyze collections within your current account. It's beneficial for administrative or analytical purposes where you need to retrieve, sort, or filter collections based on specific criteria.

How does the Step work? ​

The Step constructs a request with the specified query or sorting parameters and sends it to the Lookup service. The response contains all collections that match the criteria, organized and paginated as defined in the input settings.

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 ​

Configure the search or sorting parameters for retrieval:

  • Query - Sorting: an option to search for collections using query or sorting with corresponding parameters:
    • Query: a search query. If it's empty, the Step fetches all collections.
    • Search mode: a searching approach, 'bm25' for full-text search or 'vector' for vector similarity search. Defaults to 'bm25'.
    • Order property: the property to order the collections by, such as description, name, status, id, createdAt, or updatedAt.
    • Order direction: the ordering direction, either ascending or descending. If nothing is chosen, documents are displayed in ascending order.
  • Limit: the number of collections to display per page. The minimum value is 1, and the maximum is 100. Defaults to 10.
  • Offset: the number of collections to skip in the search results. Defaults to 0.

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:

  • items: [array] an array of objects representing the collections that match the specified query or sorting criteria. Each object in the array has the following properties:
    • answerInstruction: [string] the answer instruction of the collection.
    • description: [string] the description of the collection.
    • greetingInstruction: [string] the greeting instruction of the collection.
    • imageUrl: [string] the URL of the image associated with the collection.
    • name: [string] the name of the collection.
    • questionInstruction: [string] the question instruction of the collection.
    • id: [string] the id of the collection.
    • createdAt: [string] the date and time when the collection was created.
    • updatedAt: [string] the date and time when the collection was last updated.
  • total: [number] the total number of collections matching the specified query or sorting criteria.

Example:

json
{
  "items": [
    {
      "answerInstruction": "string",
      "description": "string",
      "greetingInstruction": "string",
      "imageUrl": "string",
      "name": "string",
      "questionInstruction": "string",
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 1
}
{
  "items": [
    {
      "answerInstruction": "string",
      "description": "string",
      "greetingInstruction": "string",
      "imageUrl": "string",
      "name": "string",
      "questionInstruction": "string",
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 1
}

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