Typesense
Typesense is an open-source, in-memory search engine designed for fast, typo-tolerant, and relevance-focused full-text search across large datasets.
Categories: Artificial Intelligence
Type: typesense/v1
Connections
Version: 1
custom
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| protocol | Protocol | STRING | HTTP Protocol | true |
| host | Host | STRING | Hostname | true |
| port | Port | STRING | true | |
| apiKey | Typesense API Key | STRING | The API key for the Typesense API. | true |
| collection | Collection Name | STRING | The name of the collection to use. | true |
| embeddingDimension | Embedding Dimension | INTEGER | The dimension of the embeddings. | true |
| initializeSchema | Initialize Schema | BOOLEAN Optionstrue, false | Whether to initialize the schema. | true |
Actions
Search Data
Name: search
Query data from the vector store using LLM embeddings.
Properties
| Name | Label | Type | Description | Required |
|---|---|---|---|---|
| query | Query | STRING | The query to be executed. | true |
| topK | Top K | INTEGER | The top 'k' similar results to return. | false |
| similarityThreshold | Similarity Threshold | NUMBER | Similarity threshold score to filter the search response by. Only documents with similarity score equal or greater than the threshold will be returned. A threshold value of 0 means any similarity is accepted. A threshold value of 1 means an exact match is required. | false |
Example JSON Structure
{
"label" : "Search Data",
"name" : "search",
"parameters" : {
"query" : "",
"topK" : 1,
"similarityThreshold" : 0.0
},
"type" : "typesense/v1/search"
}Output
The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.
Load Data
Name: load
Loads data into the vector store using LLM embeddings.
Example JSON Structure
{
"label" : "Load Data",
"name" : "load",
"type" : "typesense/v1/load"
}Output
This action does not produce any output.
How is this guide?
Last updated on