KosmoKrator

data

Typesense Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Typesense KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.typesense.*. Use lua_read_doc("integrations.typesense") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Typesense workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.typesense.clear_cached_responses_search_requests_lru_cache({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("typesense"))' --json
kosmo integrations:lua --eval 'print(docs.read("typesense.clear_cached_responses_search_requests_lru_cache"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local typesense = app.integrations.typesense
local result = typesense.clear_cached_responses_search_requests_lru_cache({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.typesense, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.typesense.default.* or app.integrations.typesense.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Typesense, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Typesense Lua Docs

Namespace: typesense

This integration is generated from Typesense’s official OpenAPI schema and exposes 79 operations. Use it for search collections, documents, aliases, API keys, synonym sets, curation sets, analytics rules, presets, stopwords, overrides, health/debug endpoints, and cluster operations.

Authentication

Configure a Typesense API key and node URL. Requests use the X-TYPESENSE-API-KEY header.

Common Tools

  • typesense_list_collections, typesense_get_collection, typesense_create_collection
  • typesense_search_documents, typesense_index_document, typesense_get_document
  • typesense_get_keys, typesense_create_key, typesense_delete_key
  • typesense_get_aliases, typesense_upsert_alias, typesense_delete_alias
  • typesense_get_health, typesense_debug

Generated Operation Pattern

Path and query parameters use snake_case names. For write operations, pass the JSON payload as body. Extra top-level arguments that are not path, query, or header parameters are sent as the JSON body.

The official spec represents search as a searchParameters query object. In Lua, pass it as search_parameters, or pass q, query_by, filter_by, and other search keys directly; the integration flattens them into Typesense query parameters.

local results = typesense.typesense_search_documents({
  collection_name = "companies",
  search_parameters = {
    q = "acme",
    query_by = "name,description",
    per_page = 10
  }
})

local created = typesense.typesense_create_collection({
  body = {
    name = "companies",
    fields = {
      { name = "name", type = "string" }
    }
  }
})

Return values are the parsed Typesense JSON response for the selected operation.

Raw agent markdown 
# Typesense Lua Docs

Namespace: `typesense`

This integration is generated from Typesense's official OpenAPI schema and exposes 79 operations. Use it for search collections, documents, aliases, API keys, synonym sets, curation sets, analytics rules, presets, stopwords, overrides, health/debug endpoints, and cluster operations.

## Authentication

Configure a Typesense API key and node URL. Requests use the `X-TYPESENSE-API-KEY` header.

## Common Tools

- `typesense_list_collections`, `typesense_get_collection`, `typesense_create_collection`
- `typesense_search_documents`, `typesense_index_document`, `typesense_get_document`
- `typesense_get_keys`, `typesense_create_key`, `typesense_delete_key`
- `typesense_get_aliases`, `typesense_upsert_alias`, `typesense_delete_alias`
- `typesense_get_health`, `typesense_debug`

## Generated Operation Pattern

Path and query parameters use snake_case names. For write operations, pass the JSON payload as `body`. Extra top-level arguments that are not path, query, or header parameters are sent as the JSON body.

The official spec represents search as a `searchParameters` query object. In Lua, pass it as `search_parameters`, or pass `q`, `query_by`, `filter_by`, and other search keys directly; the integration flattens them into Typesense query parameters.

```lua
local results = typesense.typesense_search_documents({
  collection_name = "companies",
  search_parameters = {
    q = "acme",
    query_by = "name,description",
    per_page = 10
  }
})

local created = typesense.typesense_create_collection({
  body = {
    name = "companies",
    fields = {
      { name = "name", type = "string" }
    }
  }
})
```

Return values are the parsed Typesense JSON response for the selected operation.
Metadata-derived Lua example 
local result = app.integrations.typesense.clear_cached_responses_search_requests_lru_cache({})
print(result)

Functions

clear_cached_responses_search_requests_lru_cache Write

Clear the cached responses of search requests in the LRU cache. Clear the cached responses of search requests that are sent with `use_cache` parameter in the LRU cache.

Lua path
app.integrations.typesense.clear_cached_responses_search_requests_lru_cache
Full name
typesense.typesense_clear_cache
ParameterTypeRequiredDescription
No parameters.
compacting_disk_database Write

Compacting the on-disk database Typesense uses RocksDB to store your documents on the disk. If you do frequent writes or updates, you could benefit from running a compaction of the underlying RocksDB database. This could reduce the size of the database and decrease read latency. While the database will not block during this operation, we recommend running it during off-peak hours.

Lua path
app.integrations.typesense.compacting_disk_database
Full name
typesense.typesense_compact_db
ParameterTypeRequiredDescription
No parameters.
create_analytics_event Write

Create an analytics event Submit a single analytics event. The event must correspond to an existing analytics rule by name.

Lua path
app.integrations.typesense.create_analytics_event
Full name
typesense.typesense_create_analytics_event
ParameterTypeRequiredDescription
No parameters.
create_analytics_rule Write

Create analytics rule(s) Create one or more analytics rules. You can send a single rule object or an array of rule objects.

Lua path
app.integrations.typesense.create_analytics_rule
Full name
typesense.typesense_create_analytics_rule
ParameterTypeRequiredDescription
No parameters.
create_new_collection Write

Create a new collection When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.

Lua path
app.integrations.typesense.create_new_collection
Full name
typesense.typesense_create_collection
ParameterTypeRequiredDescription
No parameters.
create_conversation_model Write

Create a conversation model Create a Conversation Model

Lua path
app.integrations.typesense.create_conversation_model
Full name
typesense.typesense_create_conversation_model
ParameterTypeRequiredDescription
No parameters.
create_api_key Write

Create an API Key with fine-grain access control. You can restrict access on both a per-collection and per-action level. The generated key is returned only during creation. You want to store this key carefully in a secure place.

Lua path
app.integrations.typesense.create_api_key
Full name
typesense.typesense_create_key
ParameterTypeRequiredDescription
No parameters.
create_nl_search_model Write

Create a NL search model Create a new NL search model.

Lua path
app.integrations.typesense.create_nl_search_model
Full name
typesense.typesense_create_n_l_search_model
ParameterTypeRequiredDescription
No parameters.
delete_alias Write

Delete an alias

Lua path
app.integrations.typesense.delete_alias
Full name
typesense.typesense_delete_alias
ParameterTypeRequiredDescription
No parameters.
delete_analytics_rule Write

Delete an analytics rule Permanently deletes an analytics rule, given it's name

Lua path
app.integrations.typesense.delete_analytics_rule
Full name
typesense.typesense_delete_analytics_rule
ParameterTypeRequiredDescription
No parameters.
delete_collection Write

Delete a collection Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.

Lua path
app.integrations.typesense.delete_collection
Full name
typesense.typesense_delete_collection
ParameterTypeRequiredDescription
No parameters.
delete_conversation_model Write

Delete a conversation model

Lua path
app.integrations.typesense.delete_conversation_model
Full name
typesense.typesense_delete_conversation_model
ParameterTypeRequiredDescription
No parameters.
delete_curation_set Write

Delete a curation set Delete a specific curation set by its name

Lua path
app.integrations.typesense.delete_curation_set
Full name
typesense.typesense_delete_curation_set
ParameterTypeRequiredDescription
No parameters.
delete_curation_set_item Write

Delete a curation set item Delete a specific curation item by its id

Lua path
app.integrations.typesense.delete_curation_set_item
Full name
typesense.typesense_delete_curation_set_item
ParameterTypeRequiredDescription
No parameters.
delete_document Write

Delete a document Delete an individual document from a collection by using its ID.

Lua path
app.integrations.typesense.delete_document
Full name
typesense.typesense_delete_document
ParameterTypeRequiredDescription
No parameters.
delete_bunch_documents Write

Delete a bunch of documents that match a specific filter condition. Use the `batch_size` parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.

Lua path
app.integrations.typesense.delete_bunch_documents
Full name
typesense.typesense_delete_documents
ParameterTypeRequiredDescription
No parameters.
delete_api_key_given_its_id Write

Delete an API key given its ID.

Lua path
app.integrations.typesense.delete_api_key_given_its_id
Full name
typesense.typesense_delete_key
ParameterTypeRequiredDescription
No parameters.
delete_nl_search_model Write

Delete a NL search model Delete a specific NL search model by its ID.

Lua path
app.integrations.typesense.delete_nl_search_model
Full name
typesense.typesense_delete_n_l_search_model
ParameterTypeRequiredDescription
No parameters.
delete_preset Write

Delete a preset. Permanently deletes a preset, given it's name.

Lua path
app.integrations.typesense.delete_preset
Full name
typesense.typesense_delete_preset
ParameterTypeRequiredDescription
No parameters.
delete_stopwords_set Write

Delete a stopwords set. Permanently deletes a stopwords set, given it's name.

Lua path
app.integrations.typesense.delete_stopwords_set
Full name
typesense.typesense_delete_stopwords_set
ParameterTypeRequiredDescription
No parameters.
delete_synonym_set Write

Delete a synonym set Delete a specific synonym set by its name

Lua path
app.integrations.typesense.delete_synonym_set
Full name
typesense.typesense_delete_synonym_set
ParameterTypeRequiredDescription
No parameters.
delete_synonym_set_item Write

Delete a synonym set item Delete a specific synonym item by its id

Lua path
app.integrations.typesense.delete_synonym_set_item
Full name
typesense.typesense_delete_synonym_set_item
ParameterTypeRequiredDescription
No parameters.
export_all_documents_collection Read

Export all documents in a collection in JSON lines format.

Lua path
app.integrations.typesense.export_all_documents_collection
Full name
typesense.typesense_export_documents
ParameterTypeRequiredDescription
No parameters.
flush_memory_analytics_disk Write

Flush in-memory analytics to disk Triggers a flush of analytics data to persistent storage.

Lua path
app.integrations.typesense.flush_memory_analytics_disk
Full name
typesense.typesense_flush_analytics
ParameterTypeRequiredDescription
No parameters.
retrieve_alias Read

Retrieve an alias Find out which collection an alias points to by fetching it

Lua path
app.integrations.typesense.retrieve_alias
Full name
typesense.typesense_get_alias
ParameterTypeRequiredDescription
No parameters.
list_all_aliases Read

List all aliases and the corresponding collections that they map to.

Lua path
app.integrations.typesense.list_all_aliases
Full name
typesense.typesense_get_aliases
ParameterTypeRequiredDescription
No parameters.
retrieve_analytics_events Read

Retrieve analytics events Retrieve the most recent events for a user and rule.

Lua path
app.integrations.typesense.retrieve_analytics_events
Full name
typesense.typesense_get_analytics_events
ParameterTypeRequiredDescription
No parameters.
get_analytics_subsystem_status Read

Get analytics subsystem status Returns sizes of internal analytics buffers and queues.

Lua path
app.integrations.typesense.get_analytics_subsystem_status
Full name
typesense.typesense_get_analytics_status
ParameterTypeRequiredDescription
No parameters.
retrieve_single_collection Read

Retrieve a single collection Retrieve the details of a collection, given its name.

Lua path
app.integrations.typesense.retrieve_single_collection
Full name
typesense.typesense_get_collection
ParameterTypeRequiredDescription
No parameters.
retrieve_document Read

Retrieve a document Fetch an individual document from a collection by using its ID.

Lua path
app.integrations.typesense.retrieve_document
Full name
typesense.typesense_get_document
ParameterTypeRequiredDescription
No parameters.
checks_if_server_is_ready_accept_requests Read

Checks if Typesense server is ready to accept requests.

Lua path
app.integrations.typesense.checks_if_server_is_ready_accept_requests
Full name
typesense.typesense_get_health
ParameterTypeRequiredDescription
No parameters.
retrieve_metadata_about_key Read

Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key.

Lua path
app.integrations.typesense.retrieve_metadata_about_key
Full name
typesense.typesense_get_key
ParameterTypeRequiredDescription
No parameters.
retrieve_metadata_about_all_keys Read

Retrieve (metadata about) all keys.

Lua path
app.integrations.typesense.retrieve_metadata_about_all_keys
Full name
typesense.typesense_get_keys
ParameterTypeRequiredDescription
No parameters.
get_status_progress_schema_change_operations Read

Get the status of in-progress schema change operations Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response.

Lua path
app.integrations.typesense.get_status_progress_schema_change_operations
Full name
typesense.typesense_get_schema_changes
ParameterTypeRequiredDescription
No parameters.
retrieve_stemming_dictionary Read

Retrieve a stemming dictionary Fetch details of a specific stemming dictionary.

Lua path
app.integrations.typesense.retrieve_stemming_dictionary
Full name
typesense.typesense_get_stemming_dictionary
ParameterTypeRequiredDescription
No parameters.
import_documents_into_collection Write

Import documents into a collection The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.

Lua path
app.integrations.typesense.import_documents_into_collection
Full name
typesense.typesense_import_documents
ParameterTypeRequiredDescription
No parameters.
import_stemming_dictionary Write

Import a stemming dictionary Upload a JSONL file containing word mappings to create or update a stemming dictionary.

Lua path
app.integrations.typesense.import_stemming_dictionary
Full name
typesense.typesense_import_stemming_dictionary
ParameterTypeRequiredDescription
No parameters.
index_document Write

Index a document A document to be indexed in a given collection must conform to the schema of the collection.

Lua path
app.integrations.typesense.index_document
Full name
typesense.typesense_index_document
ParameterTypeRequiredDescription
No parameters.
list_all_collections Read

List all collections Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

Lua path
app.integrations.typesense.list_all_collections
Full name
typesense.typesense_list_collections
ParameterTypeRequiredDescription
No parameters.
list_all_stemming_dictionaries Read

List all stemming dictionaries Retrieve a list of all available stemming dictionaries.

Lua path
app.integrations.typesense.list_all_stemming_dictionaries
Full name
typesense.typesense_list_stemming_dictionaries
ParameterTypeRequiredDescription
No parameters.
send_multiple_search_requests_single_http_request Write

send multiple search requests in a single HTTP request This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.

Lua path
app.integrations.typesense.send_multiple_search_requests_single_http_request
Full name
typesense.typesense_multi_search
ParameterTypeRequiredDescription
No parameters.
get_stats_about_api_endpoints Read

Get stats about API endpoints. Retrieve the stats about API endpoints.

Lua path
app.integrations.typesense.get_stats_about_api_endpoints
Full name
typesense.typesense_retrieve_a_p_i_stats
ParameterTypeRequiredDescription
No parameters.
list_all_conversation_models Read

List all conversation models Retrieve all conversation models

Lua path
app.integrations.typesense.list_all_conversation_models
Full name
typesense.typesense_retrieve_all_conversation_models
ParameterTypeRequiredDescription
No parameters.
list_all_nl_search_models Read

List all NL search models Retrieve all NL search models.

Lua path
app.integrations.typesense.list_all_nl_search_models
Full name
typesense.typesense_retrieve_all_n_l_search_models
ParameterTypeRequiredDescription
No parameters.
retrieves_all_presets Read

Retrieves all presets. Retrieve the details of all presets

Lua path
app.integrations.typesense.retrieves_all_presets
Full name
typesense.typesense_retrieve_all_presets
ParameterTypeRequiredDescription
No parameters.
retrieves_analytics_rule Read

Retrieves an analytics rule Retrieve the details of an analytics rule, given it's name

Lua path
app.integrations.typesense.retrieves_analytics_rule
Full name
typesense.typesense_retrieve_analytics_rule
ParameterTypeRequiredDescription
No parameters.
retrieve_analytics_rules Read

Retrieve analytics rules Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results.

Lua path
app.integrations.typesense.retrieve_analytics_rules
Full name
typesense.typesense_retrieve_analytics_rules
ParameterTypeRequiredDescription
No parameters.
retrieve_conversation_model Read

Retrieve a conversation model

Lua path
app.integrations.typesense.retrieve_conversation_model
Full name
typesense.typesense_retrieve_conversation_model
ParameterTypeRequiredDescription
No parameters.
retrieve_curation_set Read

Retrieve a curation set Retrieve a specific curation set by its name

Lua path
app.integrations.typesense.retrieve_curation_set
Full name
typesense.typesense_retrieve_curation_set
ParameterTypeRequiredDescription
No parameters.
retrieve_curation_set_item Read

Retrieve a curation set item Retrieve a specific curation item by its id

Lua path
app.integrations.typesense.retrieve_curation_set_item
Full name
typesense.typesense_retrieve_curation_set_item
ParameterTypeRequiredDescription
No parameters.
list_items_curation_set Read

List items in a curation set Retrieve all curation items in a set

Lua path
app.integrations.typesense.list_items_curation_set
Full name
typesense.typesense_retrieve_curation_set_items
ParameterTypeRequiredDescription
No parameters.
list_all_curation_sets Read

List all curation sets Retrieve all curation sets

Lua path
app.integrations.typesense.list_all_curation_sets
Full name
typesense.typesense_retrieve_curation_sets
ParameterTypeRequiredDescription
No parameters.
get_current_ram_cpu_disk_network_usage_metrics Read

Get current RAM, CPU, Disk & Network usage metrics. Retrieve the metrics.

Lua path
app.integrations.typesense.get_current_ram_cpu_disk_network_usage_metrics
Full name
typesense.typesense_retrieve_metrics
ParameterTypeRequiredDescription
No parameters.
retrieve_nl_search_model Read

Retrieve a NL search model Retrieve a specific NL search model by its ID.

Lua path
app.integrations.typesense.retrieve_nl_search_model
Full name
typesense.typesense_retrieve_n_l_search_model
ParameterTypeRequiredDescription
No parameters.
retrieves_preset Read

Retrieves a preset. Retrieve the details of a preset, given it's name.

Lua path
app.integrations.typesense.retrieves_preset
Full name
typesense.typesense_retrieve_preset
ParameterTypeRequiredDescription
No parameters.
retrieves_stopwords_set Read

Retrieves a stopwords set. Retrieve the details of a stopwords set, given it's name.

Lua path
app.integrations.typesense.retrieves_stopwords_set
Full name
typesense.typesense_retrieve_stopwords_set
ParameterTypeRequiredDescription
No parameters.
retrieves_all_stopwords_sets Read

Retrieves all stopwords sets. Retrieve the details of all stopwords sets

Lua path
app.integrations.typesense.retrieves_all_stopwords_sets
Full name
typesense.typesense_retrieve_stopwords_sets
ParameterTypeRequiredDescription
No parameters.
retrieve_synonym_set Read

Retrieve a synonym set Retrieve a specific synonym set by its name

Lua path
app.integrations.typesense.retrieve_synonym_set
Full name
typesense.typesense_retrieve_synonym_set
ParameterTypeRequiredDescription
No parameters.
retrieve_synonym_set_item Read

Retrieve a synonym set item Retrieve a specific synonym item by its id

Lua path
app.integrations.typesense.retrieve_synonym_set_item
Full name
typesense.typesense_retrieve_synonym_set_item
ParameterTypeRequiredDescription
No parameters.
list_items_synonym_set Read

List items in a synonym set Retrieve all synonym items in a set

Lua path
app.integrations.typesense.list_items_synonym_set
Full name
typesense.typesense_retrieve_synonym_set_items
ParameterTypeRequiredDescription
No parameters.
list_all_synonym_sets Read

List all synonym sets Retrieve all synonym sets

Lua path
app.integrations.typesense.list_all_synonym_sets
Full name
typesense.typesense_retrieve_synonym_sets
ParameterTypeRequiredDescription
No parameters.
search_documents_collection Read

Search for documents in a collection that match the search criteria.

Lua path
app.integrations.typesense.search_documents_collection
Full name
typesense.typesense_search_documents
ParameterTypeRequiredDescription
No parameters.
creates_point_time_snapshot_node_state_and_data_specified_directory Write

Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed.

Lua path
app.integrations.typesense.creates_point_time_snapshot_node_state_and_data_specified_directory
Full name
typesense.typesense_take_snapshot
ParameterTypeRequiredDescription
No parameters.
toggle_slow_request_log Write

Toggle Slow Request Log Enable logging of requests that take over a defined threshold of time. Default is `-1` which disables slow request logging. Slow requests are logged to the primary log file, with the prefix SLOW REQUEST.

Lua path
app.integrations.typesense.toggle_slow_request_log
Full name
typesense.typesense_toggle_slow_request_log
ParameterTypeRequiredDescription
No parameters.
update_collection Write

Update a collection's schema to modify the fields and their types.

Lua path
app.integrations.typesense.update_collection
Full name
typesense.typesense_update_collection
ParameterTypeRequiredDescription
No parameters.
update_conversation_model Write

Update a conversation model

Lua path
app.integrations.typesense.update_conversation_model
Full name
typesense.typesense_update_conversation_model
ParameterTypeRequiredDescription
No parameters.
update_document Write

Update a document Update an individual document from a collection by using its ID. The update can be partial.

Lua path
app.integrations.typesense.update_document
Full name
typesense.typesense_update_document
ParameterTypeRequiredDescription
No parameters.
update_documents_with_conditional_query Write

Update documents with conditional query The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version `0.25.0.rc12` or later.

Lua path
app.integrations.typesense.update_documents_with_conditional_query
Full name
typesense.typesense_update_documents
ParameterTypeRequiredDescription
No parameters.
update_nl_search_model Write

Update a NL search model Update an existing NL search model.

Lua path
app.integrations.typesense.update_nl_search_model
Full name
typesense.typesense_update_n_l_search_model
ParameterTypeRequiredDescription
No parameters.
create_or_update_collection_alias Write

Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.

Lua path
app.integrations.typesense.create_or_update_collection_alias
Full name
typesense.typesense_upsert_alias
ParameterTypeRequiredDescription
No parameters.
upserts_analytics_rule Write

Upserts an analytics rule with the given name.

Lua path
app.integrations.typesense.upserts_analytics_rule
Full name
typesense.typesense_upsert_analytics_rule
ParameterTypeRequiredDescription
No parameters.
create_or_update_curation_set Write

Create or update a curation set with the given name

Lua path
app.integrations.typesense.create_or_update_curation_set
Full name
typesense.typesense_upsert_curation_set
ParameterTypeRequiredDescription
No parameters.
create_or_update_curation_set_item Write

Create or update a curation set item with the given id

Lua path
app.integrations.typesense.create_or_update_curation_set_item
Full name
typesense.typesense_upsert_curation_set_item
ParameterTypeRequiredDescription
No parameters.
upserts_preset Write

Upserts a preset. Create or update an existing preset.

Lua path
app.integrations.typesense.upserts_preset
Full name
typesense.typesense_upsert_preset
ParameterTypeRequiredDescription
No parameters.
upserts_stopwords_set Write

Upserts a stopwords set. When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.

Lua path
app.integrations.typesense.upserts_stopwords_set
Full name
typesense.typesense_upsert_stopwords_set
ParameterTypeRequiredDescription
No parameters.
create_or_update_synonym_set Write

Create or update a synonym set with the given name

Lua path
app.integrations.typesense.create_or_update_synonym_set
Full name
typesense.typesense_upsert_synonym_set
ParameterTypeRequiredDescription
No parameters.
create_or_update_synonym_set_item Write

Create or update a synonym set item with the given id

Lua path
app.integrations.typesense.create_or_update_synonym_set_item
Full name
typesense.typesense_upsert_synonym_set_item
ParameterTypeRequiredDescription
No parameters.
triggers_follower_node_initiate_raft_voting_process_which_triggers_leader_re_election Write

Triggers a follower node to initiate the raft voting process, which triggers leader re-election. The follower node that you run this operation against will become the new leader, once this command succeeds.

Lua path
app.integrations.typesense.triggers_follower_node_initiate_raft_voting_process_which_triggers_leader_re_election
Full name
typesense.typesense_vote
ParameterTypeRequiredDescription
No parameters.