Skip to content

Search Tools Area

BETA

Agent Gateway is in BETA, and we're continuing to expand its capabilities. Your feedback helps shape what we build next—reach out to us through Relewise Support.

Search Tools control how Relewise interprets search terms, redirects searches, changes search results, and organizes Search Indexes. Connected tools can discover and inspect the current configuration. The REST API can also approve or disapprove supported rules without replacing their definitions.

The Search Tools area must be allowed in the Agent Gateway Configuration before its REST endpoints or MCP tools can be used.

Available Capabilities

Search ToolREST APIMCP ToolsUpdates
Stemming rulesList and getlist_stemming_rules, get_stemming_ruleREST approval state
Redirect rulesList and getlist_redirect_rules, get_redirect_ruleREST approval state
Search Term Modifier rulesList and getlist_search_term_modifier_rules, get_search_term_modifier_ruleREST approval state
Decompounding rulesList and getlist_decompounding_rules, get_decompounding_ruleREST approval state
Search Result Modifier rulesList and getlist_search_result_modifier_rules, get_search_result_modifier_ruleREST approval state
Synonym rulesListlist_synonym_rulesNot available
Search IndexesList and getlist_search_indexes, get_search_indexNot available

Creating, replacing, and deleting Search Tools rules are not available through Agent Gateway.

Rule Endpoints

Rule FamilyCollection Endpoint
Stemming/search-tools/stemming-rules
Redirect/search-tools/redirects
Search Term Modifier/search-tools/search-term-modifiers
Decompounding/search-tools/decompounding-rules
Search Result Modifier/search-tools/search-result-modifiers
Synonym/search-tools/synonyms

For the first five rule families, use GET on the collection endpoint to list compact summaries and append /{Rule ID} to retrieve a rule's complete configuration. Use PATCH on /{Rule ID} with an isApproved value to approve or disapprove a rule. Omitting isApproved or setting it to null preserves the current value.

Synonym rules currently support listing only. Getting an individual Synonym rule and changing its approval state are not available through Agent Gateway.

List endpoints support the optional term, approved, pageNumber, and pageSize query parameters. Page numbers are one-based. The default page number is 1, the default page size is 50, and REST page sizes can range from 10 through 100. List responses include pagination metadata.

MCP list tools return at most the first 50 matching rules and do not expose page selection. Use term and approved to narrow a large result set. MCP pagination will be extended through MCP Resources in a future release.

Search Indexes

Use GET /search-tools/search-indexes or list_search_indexes to discover Search Index IDs and their enabled, default, and rebuild states. Use GET /search-tools/search-indexes/{Search Index ID} or get_search_index to retrieve the languages, rebuild state, and complete configuration for one Search Index.

The isDefault value identifies the default Search Index. Do not infer the default state from the Search Index ID.

The complete Search Index configuration is returned as a raw JSON string in indexJson. Parse the string as JSON before inspecting it and preserve Relewise $type metadata if the value is stored or forwarded. See Search Indexes for more information about Search Index configuration.

Rule Details and Raw JSON

List operations return compact summaries intended for discovery. Use the corresponding get operation when you need the complete condition tree, actions, words, modifiers, or other rule-specific configuration.

Search Result Modifier filter collections are returned as raw JSON strings in filtersJson. Parse the string as JSON before inspecting it and preserve Relewise $type metadata if the value is stored or forwarded. See Filters for the available filter types and their meanings.

REST endpoint paths on this page are relative to:

text
https://my.relewise.com/agents/api/v1/datasets/{Dataset ID}

See Get Started with Agent Gateway for connection and authentication instructions.

Don't know us? Don't worry - you can find more information about us, by visiting our main page www.relewise.com