Ask
Description
This Step template allows asking a question and generating an answer based on the documents in a collection. You can filter, sort, and limit the results using various parameters.
Authorization
There are two options for authorization:
- Inherit from previous Flow (chosen by default)
- Manual token (you can manually enter the token)
Parameters
- Collection ID: ID of the existing LookUp collection to which a new document should be added. This is a required field, it is empty by default.
- Question: the question to ask. This is a required field, it is empty by default.
Advanced settings
- Messages: an array of previous chat messages with roles 'user' and 'assistant'. This is not a required field and its default value is an empty array.
- Limit: limit the number of search results. This is not a required field and its default value is 1.
- Use minimal distance: this is not a required field and is turned off by default.
- Filtering: filtering query. Weaviate the filter object for advanced filtering. This is not a required field and is turned off by default.
- Select: an array of custom properties to include in the results. This is not a required field and its default value is an empty array.
Merge field settings
The content is returned at the requested URL. The returned data is an object.
Error handling
This is a checkbox field that is selected by default. If you deselect the checkbox, there won't be a log with an error leg. The Flow will proceed down this exit if an error occurred during the Step execution, such as an invalid API key, empty API key, empty required parameters, invalid required parameters, etc.
Timeout handling
Timeout is handled as a separate leg with a default value of 30 seconds. You can set up the timeout duration between 10 seconds and 30 minutes.
Reporting
This is a Step event.