Get All Passages in Collection (Lookup) v1.0.0 Help ​

Retrieves all passages from a specific Lookup collection.

How can I use the Step? ​

Utilize this Step to retrieve passages from a specific Lookup collection. It's ideal for instances where you need to review, analyze, or manage the content within your collections, particularly when dealing with a large number of passages.

How does the Step work? ​

The Step requires the collection name and optional query or sorting parameters as input. It interacts with the Lookup system, fetching passages from the specified collection based on the provided criteria. The results include detailed information about each passage, including content, associated documents, and metadata.

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 passages 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 passages by, such as description, name, status, id, createdAt, or updatedAt.
    • Order direction: the ordering direction, either ascending or descending. If nothing is chosen, passages are displayed in ascending order.
  • Limit: the number of passages to display per page. The minimum value is 1, and the maximum is 100. Defaults to 10.
  • Offset: the number of passages 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 passages in the collection. Each object has the following properties:
    • id: [string] the id of the passage.
    • content: [string] the content of the passage.
    • document: [array] an array of objects representing the documents associated with the passage. Each document object can have additional properties.
    • loaderMetadata: [string] the loader metadata of the passage.
    • sourceUrl: [string] the source URL of the passage.
    • createdAt: [string] the creation date of the passage.
    • updatedAt: [string] the update date of the passage.
  • total: [number] the total number of passages in the collection.

Example:

json
{
  "items": [
    {
      "id": "string",
      "content": "string",
      "document": [
        {
          "_additional": {
            "id": "string"
          }
        }
      ],
      "loaderMetadata": "string",
      "sourceUrl": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 123
}
{
  "items": [
    {
      "id": "string",
      "content": "string",
      "document": [
        {
          "_additional": {
            "id": "string"
          }
        }
      ],
      "loaderMetadata": "string",
      "sourceUrl": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "total": 123
}

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