Create Collection (Lookup) v1.0.0 Help ​

Creates a new storage unit in Lookup called a collection.

How can I use the Step? ​

Use this Step when you need to establish a new collection in Lookup for efficient document storage and retrieval. You can define custom metadata properties for your collection to manage data in a structured way.

How does the Step work? ​

The Step takes the input for collection name, description, and optional settings like image URL, custom properties, and model-specific configurations. It validates the input parameters for compliance with naming conventions and character limits, then creates the collection with the specified properties and settings in the Lookup system.

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 ​

Specify the following input parameters:

• Collection name: a unique name for the collection, adhering to character length and symbol constraints. Required.
• Collection description: a detailed description of the collection content. It must be between 3 and 500 characters long. Optional.

Advanced settings ​

Configure additional collection parameters:

• Image URL: Set a URL for the collection avatar. Optional.

• Use custom settings: Enables the custom settings for retrieval and generation. Most settings reflect the request body of the Create chat completion endpoint, which you must use as your primary reference:

  • Model: Defines a model to generate an answer. Defaults to OpenAI's gpt-3.5-turbo-16k.
  • Temperature: creativity level for responses. Defaults to Balanced.
  • Maximum distance: defines how closely information retrieved from the Lookup collection matches your question. It must be in a range from 0 to 1, where 0 means only extremely similar passages are accepted, while 1 allows for unrelated passages. Defaults to 0.3 for relevant and on-topic answers.
  • Max tokens: maximum token length for responses.
  • Frequency penalty: encourages the model to generate unique responses. Defaults to 0.
  • Presence penalty: encourages the model to stay on-topic. Defaults to 0.
  • Limit: number of search results. Defaults to 5.
  • Use custom prompt templates: option to modify answer/question instruction templates for context retrieval and answer generation. Optional.

• Add custom properties: enables the creation of custom properties for the collection. Optional. Each property has the following parameters:

  • Property name: a name of the custom property. Can contain only the following characters /[_A-Za-z][_0-9A-Za-z]*/ and must not include spaces. Required.
  • Data type: property data types like string, int, boolean, date, uuid, and their array counterparts. Required and defaults to string.
  • Description: property description. 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 collection.
• accountId: [string] the id of the account that the collection belongs to.
• name: [string] the name of the collection.
• description: [string] the description of the collection.
• properties: [array] an array of objects representing the collection's properties. Each object has three properties:
  • name: [string] the name of the property.
  • dataType: [string] the property's data type.
  • description: [string] the description of the property.

Response structure:

{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "description": "string",
  "properties": [
    {
      "name": "string",
      "dataType": "string",
      "description": "string"
    }
  ]
}

{
  "id": "string",
  "accountId": "string",
  "name": "string",
  "description": "string",
  "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