Create Batch Passages (Lookup) v1.0.0 Help ​

Creates multiple passages within the specified document in a single request.

How can I use the Step? ​

Utilize this Step when you need to add multiple passages to documents in a Lookup collection. It's particularly useful for importing bulk data into a searchable format.

How does the Step work? ​

The Step validates the inputs, processes the passages, and imports them into the specified collection document. It ensures the passages meet the length requirements and adhere to the schema.

Prerequisites ​

• An existing Lookup collection with documents to add passages to.
• 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. This field is required.
• Document: a document within the selected Lookup collection to add passages to. This field is required.
• Passages: forms a list of passages to add with the following parameters for each passage:
  • Content: a passage text. The character limit is between 3 and 5000. This field is required.
  • Additional properties: a field to add passage properties if they exist in the collection schema. This field is 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 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 properties are as follows:

• total: [number] the total number of passages created.
• items: [array] an array of objects representing the created passages. Each object has the following properties:
  • content: [string] the content of the passage.
  • document: [array] an array of objects representing the document that the passage belongs to. Each object has the following properties:
    • _additional: [object] additional properties of the document.
      • id: [string] the id of the document.
  • id: [string] the id of the passage.
  • createdAt: [string] the creation date of the passage.
  • updatedAt: [string] the last update date of the passage.

Response structure:

{
  "total": 0,
  "items": [
    {
      "content": "string",
      "document": [
        {
          "_additional": {
            "id": "string"
          }
        }
      ],
      "id": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}

{
  "total": 0,
  "items": [
    {
      "content": "string",
      "document": [
        {
          "_additional": {
            "id": "string"
          }
        }
      ],
      "id": "string",
      "createdAt": "string",
      "updatedAt": "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