Create Passage (Lookup) v1.0.0 Help ​

Creates a passage within the specified document in a Lookup collection.

How can I use the Step? ​

Use this Step to add a passage to a document within a Lookup collection. It's beneficial for breaking down large documents into smaller, searchable text segments or passages, enhancing the granularity and precision of search within the collection.

How does the Step work? ​

The Step takes the collection and document names, along with the passage content and any additional properties. It validates the input, ensuring the content adheres to the specified character limits. The Step then creates the passage within the specified document in the Lookup collection.

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: Lookup collection. Required.
  • Document: a document within the selected Lookup collection to insert a passage. Required.
  • Content: a passage text. The character limit is between 3 and 5000. Required.

Note

Keep the passage content up to 1000 characters for optimal performance.

Advanced settings ​

  • Additional properties: a field to add passage properties if they exist in the collection schema. 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:

  • id: [string] the id of the created passage.
  • content: [string] the content of the created passage.
  • document: [array] an array containing the documents that the passage is associated with.
  • createdAt: [object] the date and time when the passage was created.
  • updatedAt: [object] the date and time when the passage was last updated.

Response structure:

json
{
  "id": "string",
  "content": "string",
  "document": [],
  "createdAt": {},
  "updatedAt": {}
}
{
  "id": "string",
  "content": "string",
  "document": [],
  "createdAt": {},
  "updatedAt": {}
}

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