@empathyco/x-components
Version:
Empathy X Components
288 lines (124 loc) • 3.73 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [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)<!-- --><[AiState](./x-components.aistate.md)<!-- -->>, [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>
() => void
</td><td>
Resets the ai state.
</td></tr>
<tr><td>
[setAiRelatedTags](./x-components.aimutations.setairelatedtags.md)
</td><td>
</td><td>
(relatedTags: RelatedTag\[\]) => void
</td><td>
Sets the related tags of the module.
</td></tr>
<tr><td>
[setIsNoResults](./x-components.aimutations.setisnoresults.md)
</td><td>
</td><td>
(isNoResults: boolean) => void
</td><td>
Sets the no results flag of the module.
</td></tr>
<tr><td>
[setOrigin](./x-components.aimutations.setorigin.md)
</td><td>
</td><td>
(origin: [QueryOrigin](./x-components.queryorigin.md) \| undefined \| null) => 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<unknown>) => 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\[\]) => void
</td><td>
Sets the queries from the streamed response.
</td></tr>
<tr><td>
[setResponseText](./x-components.aimutations.setresponsetext.md)
</td><td>
</td><td>
(responseText: string) => void
</td><td>
Sets the responseText from the streamed response.
</td></tr>
<tr><td>
[setSelectedFilters](./x-components.aimutations.setselectedfilters.md)
</td><td>
</td><td>
(selectedFilters: Filter\[\]) => void
</td><td>
Sets the selected filters of the module.
</td></tr>
<tr><td>
[setSuggestionsLoading](./x-components.aimutations.setsuggestionsloading.md)
</td><td>
</td><td>
(value: boolean) => void
</td><td>
Sets the loading for the suggestions response.
</td></tr>
<tr><td>
[setSuggestionsSearch](./x-components.aimutations.setsuggestionssearch.md)
</td><td>
</td><td>
(suggestionsSearch: AiSuggestionSearch\[\]) => void
</td><td>
Sets the suggestions search from the suggestions search response.
</td></tr>
<tr><td>
[setSuggestionsSearchLoading](./x-components.aimutations.setsuggestionssearchloading.md)
</td><td>
</td><td>
(value: boolean) => void
</td><td>
Sets the loading fot the suggestions search response.
</td></tr>
<tr><td>
[setSuggestionText](./x-components.aimutations.setsuggestiontext.md)
</td><td>
</td><td>
(suggestionText: string) => void
</td><td>
Sets the suggestionText from the streamed response.
</td></tr>
<tr><td>
[setTagging](./x-components.aimutations.settagging.md)
</td><td>
</td><td>
(tagging: AiSuggestionTagging) => void
</td><td>
Sets the tagging from the streamed response.
</td></tr>
</tbody></table>