> For the complete documentation index, see [llms.txt](https://docs.workflowgen.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.workflowgen.com/admin/10.0/workflow-applications/semanticsearch.md). # SEMANTICSEARCH The **SEMANTICSEARCH** workflow application performs a hybrid full-text and semantic search on requests, with customizable filters and scoring. It returns structured JSON results for use in process logic. ## Required parameters
ParameterTypeDirectionDescription
QUERYTEXTINThe main search query (full-text and similarity)
QUERY_DATA_<NAME>TEXTINQuery for a specific data field (e.g. QUERY_DATA_TITLE)
RESULTTEXTOUTJSON string containing the search results
{% hint style="info" %} At least one of `QUERY` or `QUERY_DATA_` must be provided. {% endhint %} ## Optional parameters
ParameterTypeDirectionDescription
REQUEST_IDNUMERICINThe request number to filter on
REQUEST_STATETEXTINRequest state: OPEN or CLOSED
REQUEST_SUBSTATETEXTIN

Substate:

  • For OPEN, use NOT_RUNNING_NOT_STARTED or RUNNING
  • For CLOSED, use COMPLETED or ABORTED
REQUEST_CREATED_AT_FROMDATETIMEINFilter: request created at (from)
REQUEST_CREATED_AT_TODATETIMEINFilter: request created at (to)
REQUEST_CLOSED_AT_FROMDATETIMEINFilter: request closed at (from)
REQUEST_CLOSED_AT_TODATETIMEINFilter: request closed at (to)
REQUESTER_USERNAMETEXTINRequester's username
PROCESS_NAMETEXTINProcess name
PROCESS_VERSIONNUMERICINProcess version
QUERY_SCORENUMERICINScore threshold for the main query (default: 0.5); see Query scores below for more information
QUERY_SCORE_DATA_<NAME>NUMERICINScore threshold for the specific data field query (e.g. QUERY_SCORE_DATA_SUBJECT); see Query scores below for more information
SELECT_DATA_LISTTEXTINComma- or semicolon-separated list of data fields to include in the search result
{% hint style="info" %} `QUERY_SCORE_DATA_` is required if you have a `QUERY_DATA_` parameter. {% endhint %} #### Query scores * Query scores are applicable to semantic search only, not full-text search. * The default score of `0.5` is equivalent to a 50% similarity threshold. * For stricter matching, use a score closer to `1.0` (e.g. `0.75` for a 75% similarity threshold). * For looser matching, use a score closer to `0.0` (e.g. `0.25` for a 25% similarity threshold). This applies to both the `QUERY_SCORE` and the `QUERY_SCORE_` parameters. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.workflowgen.com/admin/10.0/workflow-applications/semanticsearch.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.