UNPKG

@empathyco/x-components

Version:
269 lines (116 loc) • 3.65 kB
<!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [AiMutations](./x-components.aimutations.md) ## AiMutations interface Ai module mutations. **Signature:** ```typescript export interface AiMutations extends ConfigMutations<AiState>, QueryMutations ``` **Extends:** [ConfigMutations](./x-components.configmutations.md)<!-- -->&lt;[AiState](./x-components.aistate.md)<!-- -->&gt;, [QueryMutations](./x-components.querymutations.md) ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td> [resetAiState](./x-components.aimutations.resetaistate.md) </td><td> </td><td> () =&gt; void </td><td> Resets the ai state. </td></tr> <tr><td> [setAiRelatedTags](./x-components.aimutations.setairelatedtags.md) </td><td> </td><td> (relatedTags: RelatedTag\[\]) =&gt; void </td><td> Sets the related tags of the module. </td></tr> <tr><td> [setExcludedResultIds](./x-components.aimutations.setexcludedresultids.md) </td><td> </td><td> (resultIds: Result\['id'\]\[\]) =&gt; void </td><td> Sets the result ids to exclude from the suggestion search response. </td></tr> <tr><td> [setOrigin](./x-components.aimutations.setorigin.md) </td><td> </td><td> (origin: [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null) =&gt; void </td><td> Sets the origin of the module. </td></tr> <tr><td> [setParams](./x-components.aimutations.setparams.md) </td><td> </td><td> (params: Dictionary&lt;unknown&gt;) =&gt; void </td><td> Sets the extra params of the module. </td></tr> <tr><td> [setQueries](./x-components.aimutations.setqueries.md) </td><td> </td><td> (queries: AiSuggestionQuery\[\]) =&gt; void </td><td> Sets the queries from the streamed response. </td></tr> <tr><td> [setSearchTotalResults](./x-components.aimutations.setsearchtotalresults.md) </td><td> </td><td> (totalResults: number) =&gt; void </td><td> Sets the total results of the search response. </td></tr> <tr><td> [setSelectedFilters](./x-components.aimutations.setselectedfilters.md) </td><td> </td><td> (selectedFilters: Filter\[\]) =&gt; void </td><td> Sets the selected filters of the module. </td></tr> <tr><td> [setSuggestionsSearch](./x-components.aimutations.setsuggestionssearch.md) </td><td> </td><td> (suggestionsSearch: AiSuggestionSearch\[\]) =&gt; void </td><td> Sets the suggestions search from the suggestions search response. </td></tr> <tr><td> [setSuggestionsSearchStatus](./x-components.aimutations.setsuggestionssearchstatus.md) </td><td> </td><td> (status: [RequestStatus](./x-components.requeststatus.md)<!-- -->) =&gt; void </td><td> Sets the status for the suggestions search response. </td></tr> <tr><td> [setSuggestionsStatus](./x-components.aimutations.setsuggestionsstatus.md) </td><td> </td><td> (status: [RequestStatus](./x-components.requeststatus.md)<!-- -->) =&gt; void </td><td> Sets the status for the suggestions response. </td></tr> <tr><td> [setTagging](./x-components.aimutations.settagging.md) </td><td> </td><td> (tagging: AiSuggestionTagging) =&gt; void </td><td> Sets the tagging from the streamed response. </td></tr> </tbody></table>