Update collection (Lookup) v1.0.0 Help ​

Updates a Lookup collection with a new description, image, and settings.

How can I use the Step? ​

You can use this Step to modify the metadata or configuration of an existing collection in the Lookup system.

How does the Step work? ​

The Step updates a specified collection in the Lookup system based on the provided input settings. It supports updating the collection's description, image, and various model-specific settings.

Prerequisites ​

• For custom authentication, ensure proper cross-account settings with the Super Admin permission level for account and Flow and the necessary account ID or authentication token.

Input settings ​

• 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: maximum vector distance to query determining the semantic similarity of the retrieved information to the provided question/context. Float between 0 and 1. Defaults to 0.3.
  • 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 ​

If you have a proper permission level, you can add a property to a collection in a Lookup service for any Onereach account.

To set up the section, 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.
• description: [string] the new description of the collection.
• frequencyPenalty: [number] the frequency penalty value.
• maxDistance: [number] the maximum distance value.
• maxTokens: [number] the maximum tokens value.
• modelName: [string] the model name.
• name: [string] the name of the collection.
• presencePenalty: [number] the presence penalty value.
• temperature: [number] the temperature value.
• createdAt: [string] the date and time when the collection was created.
• updatedAt: [string] the date and time when the collection was last updated.
• countPassages: [number] the number of passages in the collection.
• properties: [array] an array of objects representing the properties of the collection. Each object has three properties:
  • name: [string] the name of the property.
  • dataType: [string] the data type of the property.
  • description: [string] the description of the property.

Example:

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "accountId": "01234567-89ab-cdef-0123-456789abcdef",
  "description": "This is a sample collection",
  "frequencyPenalty": 0,
  "maxDistance": 0,
  "maxTokens": 0,
  "modelName": "gpt-3.5-turbo-16k",
  "name": "Sample Collection",
  "presencePenalty": 0,
  "temperature": 0.7,
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "countPassages": 0,
  "properties": [
    {
      "name": "Property 1",
      "dataType": "text",
      "description": "This is property 1"
    },
    {
      "name": "Property 2",
      "dataType": "number",
      "description": "This is property 2"
    }
  ]
}

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "accountId": "01234567-89ab-cdef-0123-456789abcdef",
  "description": "This is a sample collection",
  "frequencyPenalty": 0,
  "maxDistance": 0,
  "maxTokens": 0,
  "modelName": "gpt-3.5-turbo-16k",
  "name": "Sample Collection",
  "presencePenalty": 0,
  "temperature": 0.7,
  "createdAt": "2021-01-01T00:00:00Z",
  "updatedAt": "2021-01-01T00:00:00Z",
  "countPassages": 0,
  "properties": [
    {
      "name": "Property 1",
      "dataType": "text",
      "description": "This is property 1"
    },
    {
      "name": "Property 2",
      "dataType": "number",
      "description": "This is property 2"
    }
  ]
}

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