| Name | Type | Description | Notes |
|---|---|---|---|
| organisationId | String | the organisation (its guid id). | [default to null] |
| kbList | List | a list of knowledge-base id's (guids) to use | [default to null] |
| clientId | String | the client's id (a unique guid for keeping state against clients) | [default to null] |
| semanticSearch | Boolean | should we perform a semantic-search? | [default to null] |
| qnaQuery | Boolean | should we perform a Q&A search? | [default to null] |
| query | String | the user's search query | [default to null] |
| filter | String | a filter expression generated by the UX | [default to null] |
| numResults | Integer | the number of results to return for the Q&A system (recommend 1, which returns the 'best match' only) | [default to null] |
| scoreThreshold | Float | A threshold for answer rejection, recommend a value of around 81.25% (0.8125). This value is between 0.0 and 1.0. If this value is too low, you'll get bad answers, and if this value is too high you will only get exact matches. | [default to null] |
| page | Integer | search engine pagination, the offset page starting at 0 | [default to null] |
| pageSize | Integer | search engine pagination, the number of results per page | [default to null] |
| fragmentCount | Integer | search engine pagination, the number of sentences matching per document (aka. document-sentence fragments) | [default to null] |
| maxWordDistance | Integer | how far apart words are allowed to be before they stop matching. A value of zero (0) allows any distance within the document and is akin to a document level keyword search. | [default to null] |
| sourceId | String | The id of source (an integer) to filter results for. You can only filter on one source per knowledge-base. Leaving this value zero (0) indicates all sources should be searched. | [default to null] |
| shardSizeList | List | Index sharding values. These are used by the internal engine to determine the status of results across different shards in SimSage. Leave this value alone. It is set by SimSage. Pass it back to SimSage as you got it if you're paginating the same query. | [default to null] |
| spellingSuggest | Boolean | should the search-engine return spelling-suggestions for items not understood? | [default to null] |
| groupSimilarDocuments | Boolean | should the search-engine group similar documents together | [default to null] |
| sortByAge | Boolean | should the search-engine sort results by age | [default to null] |
| useQuestionAnsweringAi | Boolean | use ChatGPT or equivalent to answer queries | [default to null] |
| wordSynSet | Map | selected syn-sets for words | [default to null] |